@x402nano/exact

Implementation of exact scheme for fixed-amount Nano (XNO) payments over x402 protocol

Features

• Enables fixed-amount Nano (XNO) payments of any size over x402 protocol
• Client, Resource Server & Facilitator implementations
• Supports the nano:* family of networks e.g. nano:mainnet, nano:betanet
• Ready-to-run examples (Client ↔ Resource Server ↔ Facilitator)

Implementations

| | Role | Used By | | ------------------- | --------------------------------- | ----------------------------------------------------------------------- | | Client | Controls a payer's Nano account, capable of generating and signing send state blocks to pay for a resource. | Wallet developers | | Resource Server | Defines payment requirements for a resource (e.g. API, content), and delivers the resource to Client on successful payment. | API providers, content providers | Facilitator | Service that verifies and/or settles payments for a Resource Server (performed by a third-party or the Resource Server itself). | API providers, content providers |

See /examples/ folder for complete runnable versions of all three implementations.

Installation

TypeScript

npm install @x402nano/exact @x402nano/helper

Usage

Project Structure

src/typescript/
 ├── client/          # "exact" scheme implementation for Clients
 ├── server/          # "exact" scheme implementation for Resource Servers
 ├── facilitator/     # "exact" scheme implementation for Facilitators
 ├── common.ts        # Shared functions and constants
 └── examples/        # Ready-to-run example files

Development

TypeScript

# Install dependencies
npm install

# Build (ESM + CJS + types)
npm run build

# Run unit tests
npm run test

Security Notes 🚨

This is new software and hasn't yet been deployed heavily in production environments yet. Please test with small amounts of Nano only! The authors and contributors shall not be held liable for any use of this software's functionality, intentional or unintentional, that leads to an undesired lose of funds.

Contributing

We welcome developers to submit implementations of the exact scheme in other languages e.g. Python, Go, etc...

Join the x402 Nano Discord for coordination and discussion!

Related Projects

• @x402nano/helper – Helper module used by exact scheme
• x402.org – Official x402 protocol website
• nano.org – Official Nano website

License

MIT