@obbyx/x402-obyte
v0.4.0
Published
x402 payment mechanisms for the Obyte network: exact (on-chain unit) and batch-settlement (AA payment channels)
Maintainers
Readme
@obbyx/x402-obyte
x402 payment mechanisms for the Obyte
network, for the official @x402/* packages and for obbyx.
exact— the client signs one Obyte unit per request; the facilitator verifies and broadcasts it.batch-settlement— instant, fee-free per call over Obyte AA payment channels (cumulative vouchers).
Networks: obyte:livenet, obyte:testnet (v1: obyte-livenet, obyte-testnet).
npm i @obbyx/x402-obyte obyte @x402/fetchPay with the official @x402/fetch
import obyte from 'obyte';
import { wrapFetchWithPayment, x402Client } from '@x402/fetch';
import { ExactObyteClient } from '@obbyx/x402-obyte';
import { createLogger } from '@obbyx/obyte/logger';
import { loadWallet } from '@obbyx/obyte/wallet';
import { OBYTE_NETWORKS } from '@obbyx/obyte';
const network = OBYTE_NETWORKS.testnet;
const wallet = loadWallet(network); // ~/.obbyx/wallet-testnet.json (create it with `obbyx init`)
const client = new obyte.Client(network.defaultHubUrl, { testnet: true, reconnect: true });
const paidFetch = wrapFetchWithPayment(
fetch,
new x402Client()
// GBYTE is not a default USD asset: allow it explicitly, with a cap per payment
.setSpendControls({
allowedAssets: [{ network: 'obyte:testnet', asset: 'base', maxAmountPerPayment: '50000' }],
})
.register(
'obyte:testnet',
new ExactObyteClient({
client,
network: 'obyte:testnet',
privateKey: wallet.privateKey,
logger: createLogger(),
}),
),
);
const res = await paidFetch('https://api.example/paid');For channel payments register a BatchObyteClient as well: it confirms or
releases its voucher from the seller's PAYMENT-RESPONSE through the client's
onPaymentResponse hook.
Add a ReservingComposer (composer option) when one wallet pays concurrently:
it guarantees two payments never pick the same coins.
What is inside
| Export | Role |
| --------------------------------------------------------------------------- | -------------------------------------------------------- |
| ExactObyteClient, BatchObyteClient | x402 client mechanisms (SchemeNetworkClient) |
| ExactObyteFacilitator, ExactObyteFacilitatorV1, BatchObyteFacilitator | facilitator mechanisms (SchemeNetworkFacilitator) |
| SettlementStore, BatchStore, WatcherGateway | storage / watcher ports (+ node:sqlite reference stores) |
| ReservingComposer, CoinReservations | coin reservation for concurrent payments |
| computeBinding, bindingsEqual | binding of a payment to one request |
| hubCall, startHeartbeat, parseHistory, … | hub access with timeouts and validated answers |
Scheme specs, the facilitator, the seller SDK and the CLI: github.com/Taump/obbyx.
Node.js ≥ 24. MIT.
