Skip to main content

Protocol integration quickstart

For a first wallet or DApp integration, construct an output offline, then complete funding, discovery, payment and recovery in a test environment. This path does not use the hosted merchant API.

1. Choose the application goal​

Start with SDKs for direct private fund management. For standard payment sessions, begin with IPP and Facilitator integration. The payer wallet still selects and authorizes actual execution.

2. Prepare compatible infrastructure​

ConfigurationSourceWhy pin it
Chain ID and chain RPCSelected test networkIndependently verify blocks, receipts and native finality
Core address, code identity and deployment blockTrusted deployment configurationAvoid the wrong instance and define scan coverage
Protocol RPC /v1 URLTrusted provider or self-hosted serviceIndexes, candidates and deployment discovery
Token address and decimalsAsset configuration and contract readsCorrect base-unit conversion
SDK, ABI and proving resourcesCompatible packages and authenticated catalogsA shared version number is not a compatibility check
Signing and authenticated decryptionApplication wallet capabilitiesKeep keys in the host and present reviewable authorization

Check compatibility, validate read-only access and deployment identity, then use test funds.

3. Construct an output offline​

Run the TypeScript example, or use Go / Rust. This checks receiving material and output encoding without funding or submission.

4. Make the first deposit​

Replace illustrative addresses with actual test deployments and assets. Use the Shield preparation function, verify payer, amount, Core allowance and gas, then submit through the host signer and save the hash.

Confirm insertion positions from successful canonical receipts. Wait for your required confirmation level; acceptance and broadcasting are not receipt of funds.

5. Discover and spend Notes​

Open WalletSession with a persistent Store and complete refresh() plus authenticated decryption. Inspect coverage and available balance before preparing a Note payment. Retain reservations and keep authorization, proving, submission and reconciliation on the same operation.

For Broadcaster, freeze the final quote before signing and proving. Follow Provenance bindings when source evidence is required.

6. Exercise recovery​

Test rejection, network failure, restart after submission, indexing lag, reorganization and unavailable native finality. Recover by the original operation ID and hash, preventing duplicate payment and premature reservation release.

7. Connect application requests​

Use IPP to bind standard payment or credit requests to execution and receipts. A Core Note does not automatically establish IPP redemption or justify repeated fulfillment of your business order.