Developers and agents

Start from the machine-readable files.

People can use the dashboard. Software agents should begin with the manifest and the runtime, then verify readiness before moving any funds.

Canonical files

Where an agent should look first.

  1. Read /pob-agent.json.
  2. Use window.SPAAdapter on the dashboard, or the headless bootstrap in /node_runtime.mjs.
  3. Verify with payment-ready-check.

Entry points

Three ways in.

Browser

await window.SPAAdapter.login({ userId, password });
await window.SPAAdapter.connectWallet(rpcUrl);
const contract = await window.SPAAdapter
  .getContractFromRegistry("venue merchant");
const wallets = await window.SPAAdapter
  .getSettlementWalletsForContract(contract.address);

Command line

node cli.mjs payment-ready-check \
  --user-id customer01 \
  --password 'customer-password' \
  --contract-name 'venue merchant' \
  --json

Headless JavaScript

import { setupNodeRuntime }
  from "./node_runtime.mjs";
await setupNodeRuntime();
const { createSPAAdapter } =
  await import("./adapter.js");

Getting payment-ready

Enroll a customer with a merchant.

Payment-ready means the merchant contract resolves in the registry, the token address and the merchant and fee owners are configured, and the customer's settlement wallet is linked. Funds and allowance are separate checks.

01

Connect the wallet

Register or log in as the customer, then connect the wallet to the selected chain.

02

Select the merchant

Resolve the merchant contract from the registry and inspect its merchant and fee owner addresses.

03

Register with the merchant

Run merchantRegister(contractAddress) from the customer session to link a settlement wallet.

04

Verify readiness

Run payment-ready-check, then confirm funds and allowance before paying.

Want the full picture?

The whitepaper covers the design behind the runtime, including private chains, escrow, and agent payments.