@piprail/sdk 2.2.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +130 -1
- package/dist/algorand-TMA62DN2.cjs +678 -0
- package/dist/algorand-WB6PBJU4.js +678 -0
- package/dist/aptos-JQMZNTMD.cjs +673 -0
- package/dist/aptos-QAAXIUY3.js +673 -0
- package/dist/index.cjs +262 -86
- package/dist/index.d.cts +88 -26
- package/dist/index.d.ts +88 -26
- package/dist/index.js +255 -79
- package/dist/{solana-E4MD6JJ6.js → solana-3FMCWSEE.js} +20 -0
- package/dist/{solana-TLHL2KNY.cjs → solana-M3VOHCMO.cjs} +20 -0
- package/package.json +1 -1
- package/dist/algorand-GSFVZTBF.js +0 -389
- package/dist/algorand-HZS43N4P.cjs +0 -389
- package/dist/aptos-RIL56C7L.js +0 -352
- package/dist/aptos-TRCCJRZA.cjs +0 -352
package/dist/index.d.cts
CHANGED
|
@@ -88,8 +88,14 @@ interface X402ExactAcceptEntry {
|
|
|
88
88
|
* `spender` is the canonical x402ExactPermit2Proxy and whose `witness.to` binds the
|
|
89
89
|
* recipient. **Solana (SVM): `'svm'`** — the payer partial-signs an SPL
|
|
90
90
|
* `TransferChecked` transaction whose fee payer is the merchant (`feePayer` below),
|
|
91
|
-
* and the gate co-signs as fee payer + broadcasts.
|
|
92
|
-
|
|
91
|
+
* and the gate co-signs as fee payer + broadcasts. **Algorand: `'algorand'`** — the payer
|
|
92
|
+
* signs an ASA `axfer` to `payTo` at fee 0, atomically grouped with a 0-ALGO `pay` from
|
|
93
|
+
* the `feePayer` that pools the group fee (per `scheme_exact_algo.md`); the gate (or a
|
|
94
|
+
* keyless facilitator) signs that fee txn + submits. **Aptos: `'aptos'`** — the payer signs a
|
|
95
|
+
* fee-payer (sponsored) `primary_fungible_store::transfer` to `payTo` (per
|
|
96
|
+
* `scheme_exact_aptos.md`); the gate (or a keyless facilitator) adds the fee-payer signature
|
|
97
|
+
* + submits, paying gas. PipRail self-settles ALL. */
|
|
98
|
+
assetTransferMethod: 'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos';
|
|
93
99
|
/** EIP-712 domain name of the token. OPTIONAL per the exact-EVM scheme (only
|
|
94
100
|
* `assetTransferMethod` is required) — a foreign rail may omit it. NEVER assumed
|
|
95
101
|
* from the symbol (USDC's on-chain name() is "USD Coin", not "USDC"); a PipRail gate
|
|
@@ -97,11 +103,12 @@ interface X402ExactAcceptEntry {
|
|
|
97
103
|
name?: string;
|
|
98
104
|
/** EIP-712 domain version of the token (USDC: "2"). OPTIONAL (see `name`); read/re-derived on-chain. */
|
|
99
105
|
version?: string;
|
|
100
|
-
/** **SVM
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
106
|
+
/** **SVM / Algorand / Aptos** — the fee-payer (gas sponsor) address. The buyer builds the
|
|
107
|
+
* transaction with this account as the gas payer (so the buyer spends ZERO native coin),
|
|
108
|
+
* leaving its signature for whoever sponsors; the gate (self mode) or a keyless facilitator
|
|
109
|
+
* fills it and submits. On **SVM** it must differ from `payTo` (the fee payer must never
|
|
110
|
+
* appear in an instruction — a MUST-rule); on **Algorand/Aptos** the fee txn/signature is
|
|
111
|
+
* separate from the transfer, so `feePayer === payTo` is allowed. */
|
|
105
112
|
feePayer?: string;
|
|
106
113
|
/** **SVM only, OPTIONAL** — a ≤256-byte reconciliation memo the buyer attaches to the
|
|
107
114
|
* transaction (the SVM scheme's optional `extra.memo`). */
|
|
@@ -216,9 +223,41 @@ interface Permit2PaymentPayload {
|
|
|
216
223
|
interface ExactSvmPaymentPayload {
|
|
217
224
|
transaction: string;
|
|
218
225
|
}
|
|
226
|
+
/**
|
|
227
|
+
* The `payload` a client sends for the **Algorand `exact`** variant, per
|
|
228
|
+
* `scheme_exact_algo.md`: an atomically-grouped set of base64-encoded msgpack transactions,
|
|
229
|
+
* and the index within it of the transaction that pays the resource server. The buyer's ASA
|
|
230
|
+
* `axfer` (to `payTo`, fee 0) is SIGNED; a 0-ALGO `pay` from the `feePayer` that pools the
|
|
231
|
+
* group fee is left UNSIGNED for whoever sponsors (the gate's relayer in self mode, or a
|
|
232
|
+
* keyless facilitator). The group itself IS the proof — there's no separate authorization
|
|
233
|
+
* object (the Algorand analogue of EIP-3009's `authorization` / SVM's `transaction`).
|
|
234
|
+
*/
|
|
235
|
+
interface ExactAlgorandPaymentPayload {
|
|
236
|
+
/** Index into `paymentGroup` of the txn that pays the resource server (the buyer's `axfer`). */
|
|
237
|
+
paymentIndex: number;
|
|
238
|
+
/** The atomic group: each element is a base64-encoded, msgpack-encoded (signed or unsigned)
|
|
239
|
+
* Algorand transaction. ≤ 16 elements (the protocol's atomic-group cap). */
|
|
240
|
+
paymentGroup: string[];
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* The `payload` a client sends for the **Aptos `exact`** variant, per `scheme_exact_aptos.md`:
|
|
244
|
+
* a fee-payer (sponsored, AIP-39) `primary_fungible_store::transfer`. `transaction` is the base64
|
|
245
|
+
* BCS-serialized `SimpleTransaction` (raw tx + the bound `feePayerAddress`); `senderAuth` is the
|
|
246
|
+
* base64 BCS-serialized buyer (sender) authenticator. The buyer leaves the fee-payer signature for
|
|
247
|
+
* whoever sponsors (the gate's relayer in self mode, or a keyless facilitator), who adds it +
|
|
248
|
+
* submits. The (tx + sender authenticator) IS the proof — there's no separate `authorization`
|
|
249
|
+
* object (the Aptos analogue of EIP-3009's `authorization` / SVM's `transaction`). The two-field
|
|
250
|
+
* shape (a `senderAuth` alongside `transaction`) also distinguishes it from the SVM payload.
|
|
251
|
+
*/
|
|
252
|
+
interface ExactAptosPaymentPayload {
|
|
253
|
+
/** Base64 BCS-serialized `SimpleTransaction` (raw transaction + the bound `feePayerAddress`). */
|
|
254
|
+
transaction: string;
|
|
255
|
+
/** Base64 BCS-serialized buyer (sender) `AccountAuthenticator`. */
|
|
256
|
+
senderAuth: string;
|
|
257
|
+
}
|
|
219
258
|
/** Any `exact`-rail payload shape — EIP-3009 (`authorization`), Permit2 (`permit2Authorization`),
|
|
220
|
-
* or
|
|
221
|
-
type ExactPaymentPayloadAny = ExactPaymentPayload | Permit2PaymentPayload | ExactSvmPaymentPayload;
|
|
259
|
+
* SVM (`transaction`), Algorand (`paymentGroup`), or Aptos (`transaction` + `senderAuth`). */
|
|
260
|
+
type ExactPaymentPayloadAny = ExactPaymentPayload | Permit2PaymentPayload | ExactSvmPaymentPayload | ExactAlgorandPaymentPayload | ExactAptosPaymentPayload;
|
|
222
261
|
interface ParsedExactBase {
|
|
223
262
|
x402Version: number;
|
|
224
263
|
/** The client's claimed network (slug or CAIP-2) — for matching, not trust. */
|
|
@@ -236,7 +275,9 @@ interface ParsedExactBase {
|
|
|
236
275
|
* re-derives every verified field from its own trusted rail. A discriminated union on
|
|
237
276
|
* `method`, so narrowing on `method` narrows `payload`: `'eip3009'` → {@link ExactPaymentPayload}
|
|
238
277
|
* (`authorization`), `'permit2'` → {@link Permit2PaymentPayload} (`permit2Authorization`),
|
|
239
|
-
* `'svm'` → {@link ExactSvmPaymentPayload} (`transaction`)
|
|
278
|
+
* `'svm'` → {@link ExactSvmPaymentPayload} (`transaction`), `'algorand'` →
|
|
279
|
+
* {@link ExactAlgorandPaymentPayload} (`paymentGroup`); `'aptos'` →
|
|
280
|
+
* {@link ExactAptosPaymentPayload} (`transaction` + `senderAuth`).
|
|
240
281
|
*/
|
|
241
282
|
type ParsedExactPayment = (ParsedExactBase & {
|
|
242
283
|
method: 'eip3009';
|
|
@@ -247,6 +288,12 @@ type ParsedExactPayment = (ParsedExactBase & {
|
|
|
247
288
|
}) | (ParsedExactBase & {
|
|
248
289
|
method: 'svm';
|
|
249
290
|
payload: ExactSvmPaymentPayload;
|
|
291
|
+
}) | (ParsedExactBase & {
|
|
292
|
+
method: 'algorand';
|
|
293
|
+
payload: ExactAlgorandPaymentPayload;
|
|
294
|
+
}) | (ParsedExactBase & {
|
|
295
|
+
method: 'aptos';
|
|
296
|
+
payload: ExactAptosPaymentPayload;
|
|
250
297
|
});
|
|
251
298
|
interface X402Receipt {
|
|
252
299
|
scheme: 'onchain-proof' | 'exact';
|
|
@@ -4266,9 +4313,10 @@ interface DiscoverySigner {
|
|
|
4266
4313
|
* chain-agnostic — it never names a family, it just merges `extra`.
|
|
4267
4314
|
*/
|
|
4268
4315
|
interface ExactRailInfo {
|
|
4269
|
-
method: 'eip3009' | 'permit2' | 'svm';
|
|
4316
|
+
method: 'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos';
|
|
4270
4317
|
/** Family-specific `extra` keys merged into the exact accept (e.g. `{ name, version }`
|
|
4271
|
-
* for EVM EIP-3009, `{ feePayer, tokenProgram }` for Solana
|
|
4318
|
+
* for EVM EIP-3009, `{ feePayer, tokenProgram }` for Solana, `{ feePayer }` for
|
|
4319
|
+
* Algorand/Aptos). */
|
|
4272
4320
|
extra?: Record<string, unknown>;
|
|
4273
4321
|
}
|
|
4274
4322
|
/**
|
|
@@ -4349,7 +4397,7 @@ interface ResolvedNetwork {
|
|
|
4349
4397
|
reason?: RecipientReason;
|
|
4350
4398
|
}>;
|
|
4351
4399
|
/**
|
|
4352
|
-
* OPTIONAL (EVM EIP-3009/Permit2 + Solana SVM) — the BUYER counterpart to {@link settleExactSelf}.
|
|
4400
|
+
* OPTIONAL (EVM EIP-3009/Permit2 + Solana SVM + Algorand + Aptos) — the BUYER counterpart to {@link settleExactSelf}.
|
|
4353
4401
|
* Build + EIP-712-sign an EIP-3009 `transferWithAuthorization` for a standard x402
|
|
4354
4402
|
* `exact` rail, so a PipRail agent can PAY any standard x402 server (not just PipRail's
|
|
4355
4403
|
* own `onchain-proof` gates). The client frames the returned `payload` + `accepted` echo
|
|
@@ -4404,7 +4452,7 @@ interface ResolvedNetwork {
|
|
|
4404
4452
|
* (the merchant's own bound self-settle wallet, in self mode); `feePayer` takes precedence.
|
|
4405
4453
|
* RPC-read (EVM reads the token's EIP-712 domain; Solana reads the mint's token program); MAY
|
|
4406
4454
|
* throw a typed config error for an explicitly-requested-but-unsupported method (EVM does). A
|
|
4407
|
-
* family that omits this method offers no `exact` rail (today: every
|
|
4455
|
+
* family that omits this method offers no `exact` rail (today: every family except EVM, Solana, Algorand, and Aptos).
|
|
4408
4456
|
*/
|
|
4409
4457
|
resolveExactRail?(input: {
|
|
4410
4458
|
asset: string;
|
|
@@ -4438,10 +4486,12 @@ interface ResolvedNetwork {
|
|
|
4438
4486
|
*/
|
|
4439
4487
|
exactPermit2Supported?(): boolean;
|
|
4440
4488
|
/**
|
|
4441
|
-
* OPTIONAL (EVM-
|
|
4442
|
-
* locally, then SELF-SETTLE it by broadcasting
|
|
4443
|
-
*
|
|
4444
|
-
*
|
|
4489
|
+
* OPTIONAL (EVM EIP-3009/Permit2 + Solana SVM + Algorand + Aptos) — verify a standard x402 `exact`
|
|
4490
|
+
* payment locally, then SELF-SETTLE it by broadcasting from the merchant's own `relayer`
|
|
4491
|
+
* wallet (the merchant pays the network fee to receive; EVM broadcasts
|
|
4492
|
+
* `transferWithAuthorization`, Solana co-signs the fee payer, Algorand signs the pooled fee
|
|
4493
|
+
* txn + submits the group, Aptos adds the fee-payer signature + submits — the transfer
|
|
4494
|
+
* binds `payTo`, so no redirect risk). RETURNS a `VerifyResult`:
|
|
4445
4495
|
* - `{ ok:false, error }` for a CLIENT-fixable fault (bad signature, expired,
|
|
4446
4496
|
* wrong recipient/amount, used nonce, simulation revert) → gate replies 402;
|
|
4447
4497
|
* - `{ ok:true, receipt }` once the settle tx is mined.
|
|
@@ -4930,7 +4980,7 @@ interface SpendSummary {
|
|
|
4930
4980
|
}
|
|
4931
4981
|
|
|
4932
4982
|
/** The payment schemes a client can settle: PipRail's native `onchain-proof` (the
|
|
4933
|
-
* default) and the standard x402 `exact` rail (EVM EIP-3009/Permit2 + Solana SVM, opt-in). */
|
|
4983
|
+
* default) and the standard x402 `exact` rail (EVM EIP-3009/Permit2 + Solana SVM + Algorand, opt-in). */
|
|
4934
4984
|
type PaymentScheme = 'onchain-proof' | 'exact';
|
|
4935
4985
|
|
|
4936
4986
|
/** Observability events. `ref` is the proof — a chain-specific id (EVM tx hash, Solana signature, TON locator, Stellar tx hash). */
|
|
@@ -5485,7 +5535,7 @@ declare class PipRailClient {
|
|
|
5485
5535
|
* before publishing, so retry with a brief backoff if a fresh listing is missing.
|
|
5486
5536
|
* - Results are cross-scheme (mostly the mainstream `exact` scheme); `fetch()` pays
|
|
5487
5537
|
* `onchain-proof` rails by default, and standard `exact` rails too once you opt in
|
|
5488
|
-
* with `schemes: ['onchain-proof', 'exact']` (EVM EIP-3009/Permit2 + Solana SVM).
|
|
5538
|
+
* with `schemes: ['onchain-proof', 'exact']` (EVM EIP-3009/Permit2 + Solana SVM + Algorand).
|
|
5489
5539
|
*/
|
|
5490
5540
|
discover(opts?: DiscoverOptions): Promise<DiscoveredResource[]>;
|
|
5491
5541
|
/**
|
|
@@ -5902,7 +5952,7 @@ declare function describeChallenge(challenge: X402Challenge): string;
|
|
|
5902
5952
|
* literally, so a wrong name or order actively misleads. A test pins the load-
|
|
5903
5953
|
* bearing phrases.
|
|
5904
5954
|
*/
|
|
5905
|
-
declare const PIPRAIL_AGENT_GUIDE = "# Paying with PipRail \u2014 the agent contract\n\nYou can pay for x402 \"402 Payment Required\" resources autonomously. Money moves\nstraight from your wallet to the server; PipRail custodies nothing. Follow this.\n\n## Landing cold \u2014 read the self-description\nEvery PipRail 402 self-describes. Read challenge.extensions.piprail for { name, what, pay[]\n(each rail's how-to-pay), sdk.install, mcp, docs } \u2014 never guess what an endpoint is. If your\ntooling can't pay a rail (e.g. a stock x402 client can't pay the onchain-proof scheme), the\nblock says how: install @piprail/sdk (npm i @piprail/sdk) or run the MCP (npx -y @piprail/mcp)\nand pay with the tools below.\n\n## The loop: quote \u2192 plan \u2192 pay\n1. piprail_quote_payment(url) \u2014 PRICE it. Returns the amount, token, chain, and\n whether it is within your spend policy. No funds move. Use it to decide if a\n resource is worth buying.\n2. piprail_plan_payment(url) \u2014 can I afford it NOW? Reads your balance, native gas,\n and recipient-readiness across every rail, and returns { payable, best,\n fundingHint, session? }. If payable is false, do NOT attempt the payment \u2014\n fundingHint says exactly what to fix.\n3. piprail_pay_request(url, method?, body?) \u2014 PAY (only if the plan was payable)\n and return the result.\nAlways plan before you pay so you never commit to a payment you cannot finish.\n\n## Gasless \u2014 the exact rail (zero gas for you)\nA 402 may offer up to two rails; you don't choose per payment \u2014 the client does, automatically:\n- onchain-proof (PipRail's default): you broadcast the payment yourself and pay the network gas\n (the native coin \u2014 ETH/SOL/\u2026). Works on every chain.\n- exact (the ratified x402 rail, opt-in): you only SIGN; the server \u2014 or a facilitator it chose\n (e.g. PayAI) \u2014 broadcasts it, so you pay ZERO gas (you need only the token, no native coin). It\n works on EVM +
|
|
5955
|
+
declare const PIPRAIL_AGENT_GUIDE = "# Paying with PipRail \u2014 the agent contract\n\nYou can pay for x402 \"402 Payment Required\" resources autonomously. Money moves\nstraight from your wallet to the server; PipRail custodies nothing. Follow this.\n\n## Landing cold \u2014 read the self-description\nEvery PipRail 402 self-describes. Read challenge.extensions.piprail for { name, what, pay[]\n(each rail's how-to-pay), sdk.install, mcp, docs } \u2014 never guess what an endpoint is. If your\ntooling can't pay a rail (e.g. a stock x402 client can't pay the onchain-proof scheme), the\nblock says how: install @piprail/sdk (npm i @piprail/sdk) or run the MCP (npx -y @piprail/mcp)\nand pay with the tools below.\n\n## The loop: quote \u2192 plan \u2192 pay\n1. piprail_quote_payment(url) \u2014 PRICE it. Returns the amount, token, chain, and\n whether it is within your spend policy. No funds move. Use it to decide if a\n resource is worth buying.\n2. piprail_plan_payment(url) \u2014 can I afford it NOW? Reads your balance, native gas,\n and recipient-readiness across every rail, and returns { payable, best,\n fundingHint, session? }. If payable is false, do NOT attempt the payment \u2014\n fundingHint says exactly what to fix.\n3. piprail_pay_request(url, method?, body?) \u2014 PAY (only if the plan was payable)\n and return the result.\nAlways plan before you pay so you never commit to a payment you cannot finish.\n\n## Gasless \u2014 the exact rail (zero gas for you)\nA 402 may offer up to two rails; you don't choose per payment \u2014 the client does, automatically:\n- onchain-proof (PipRail's default): you broadcast the payment yourself and pay the network gas\n (the native coin \u2014 ETH/SOL/\u2026). Works on every chain.\n- exact (the ratified x402 rail, opt-in): you only SIGN; the server \u2014 or a facilitator it chose\n (e.g. PayAI) \u2014 broadcasts it, so you pay ZERO gas (you need only the token, no native coin). It\n works on EVM, Solana + Algorand, and the on-chain method (EIP-3009 / Permit2 / SVM / Algorand\n fee-pooled group) is picked automatically.\nWhen the exact scheme is enabled AND balance-aware routing is on, paying picks the cheapest\nsettleable rail \u2014 i.e. the gasless exact one. Nothing changes in your loop: quote \u2192 plan \u2192 pay is\nidentical. The exact scheme is OPT-IN by the operator (MCP: PIPRAIL_SCHEMES=onchain-proof,exact);\nyou can't enable it yourself, but you can report when a 402 needs it (see UNSUPPORTED_SCHEME below).\n\n## Reading a refusal \u2014 never crash, never double-spend\nA failed pay returns a STRUCTURED object, never a thrown error you must catch:\n { ok:false, code, reason, explain, ref?, reasonCode?, declined? }\nBranch on `code` (always reliable). Key cases:\n- declined:true with reasonCode:'SESSION_EXPIRED' \u2014 your time budget is over. This\n is TERMINAL: STOP. Do not retry ANY payment this process; it cannot be undone\n without a restart / a longer TTL.\n- declined:true with reasonCode:'APPROVAL' \u2014 a human (or hook) declined this\n payment. Terminal for this pay: do NOT auto-retry \u2014 they said no, or no one\n answered.\n- declined:true with reasonCode:'OUTSIDE_WINDOW' \u2014 your rolling rate-limit is\n exhausted. Wait for it to free, then retry; do not raise the amount.\n- declined:true with reasonCode:'POLICY' or 'BUDGET' \u2014 a spend cap or allowlist\n refused it. Don't retry the same payment; pick a cheaper/allowed one.\n- code:'INSUFFICIENT_FUNDS' \u2014 top up the wallet (token and/or native gas), retry.\n- code:'PAYMENT_TIMEOUT' / 'MAX_RETRIES_EXCEEDED' / 'CONFIRMATION_TIMEOUT' \u2014 the\n payment may ALREADY be on-chain. Recover using the proof on `.ref` (re-verify\n or re-submit it); never re-pay \u2014 a fresh payment would double-spend. On a gasless\n exact rail `.ref` is the authorization NONCE, not a tx hash: re-present the SAME\n signed authorization, never sign a fresh one (that would risk a double-spend).\n- code:'NO_COMPATIBLE_ACCEPT' / 'UNSUPPORTED_SCHEME' \u2014 the 402 isn't payable on\n your chain/scheme; `explain` says whether it's the wrong chain or a scheme to enable.\n If it's a standard x402 server offering an exact rail, that's a config fix the operator makes\n once (enable the exact scheme); report it, don't retry the same call blindly.\n\n## Knowing your leash \u2014 call piprail_budget\npiprail_budget tells you how much budget and time you have left, per\n(network, asset), plus your spend so far. Read-only; moves no funds. Use it in\nMode A to self-check before paying.\n\n## Two modes\n- Mode A (headless, default): you run FREE inside a pre-set budget + time\n envelope. The policy IS the consent \u2014 there is no per-payment prompt. Stay\n inside it; piprail_budget shows what's left.\n- Mode B (supervised): the host may ask a human to approve each payment. A\n decline/cancel/timeout comes back as declined:true (reasonCode:'APPROVAL') \u2014\n do NOT retry it as if it were a transient error.\n\n## Hard facts\n- Spend caps are PER (network, asset). There is no single cross-token dollar cap \u2014\n budgets aren't summed across tokens (no price oracle).\n- Spend totals and the time envelope live IN-MEMORY for THIS process; they reset on restart\n (a convenience, not a durable ledger).\n";
|
|
5906
5956
|
/** Returns {@link PIPRAIL_AGENT_GUIDE} (a parity accessor for callers that prefer a function). */
|
|
5907
5957
|
declare function agentGuide(): string;
|
|
5908
5958
|
|
|
@@ -6370,7 +6420,11 @@ interface AcceptOption {
|
|
|
6370
6420
|
* relayer key needed. (EVM facilitators are also the path onto Coinbase's Bazaar directory.)
|
|
6371
6421
|
*/
|
|
6372
6422
|
interface ExactRailOption {
|
|
6373
|
-
|
|
6423
|
+
/** How the gate settles an inbound `exact` payment. `'self'` = your own `relayer` broadcasts
|
|
6424
|
+
* (you pay gas). `'keyless'` = auto-pick a known KEYLESS facilitator for the chain (it sponsors
|
|
6425
|
+
* gas — zero-config; the same resolution as the top-level `exact: true` shorthand). `{ facilitator }`
|
|
6426
|
+
* = a specific facilitator you name — pin this in production rather than relying on the auto-pick. */
|
|
6427
|
+
settle: 'self' | 'keyless' | {
|
|
6374
6428
|
facilitator: string;
|
|
6375
6429
|
authHeaders?: () => Promise<Record<string, string>>;
|
|
6376
6430
|
/** Solana only — the facilitator's fee-payer pubkey, if you'd rather set it than have the
|
|
@@ -6462,9 +6516,17 @@ interface RequirePaymentOptions {
|
|
|
6462
6516
|
/**
|
|
6463
6517
|
* ALSO advertise a standard x402 `exact` rail so any standard x402 client can pay this
|
|
6464
6518
|
* gate — opt-in, EVM (EIP-3009/Permit2) + Solana (SVM). See {@link ExactRailOption}.
|
|
6465
|
-
*
|
|
6519
|
+
* Shorthand **`exact: true`** === `{ settle: 'keyless' }`: the gate auto-picks a known KEYLESS
|
|
6520
|
+
* facilitator for each offered chain (from `KNOWN_FACILITATORS`), so neither buyer nor merchant
|
|
6521
|
+
* pays gas, zero-config. It is a SOFT, best-effort flag — a chain with no available keyless
|
|
6522
|
+
* facilitator DEGRADES GRACEFULLY to the always-present `onchain-proof` rail (the buyer pays gas,
|
|
6523
|
+
* the only option left when no facilitator can sponsor) with a LOUD warning; it never bricks the
|
|
6524
|
+
* gate. For guaranteed gasless, pin `settle: { facilitator }` (recommended in production) or
|
|
6525
|
+
* self-settle `settle: 'self'`; an EXPLICIT `settle` that can't carry exact throws loudly (a config
|
|
6526
|
+
* error you should fix). `false`/omitted keeps the gate exactly as today (`onchain-proof` only —
|
|
6527
|
+
* byte-identical).
|
|
6466
6528
|
*/
|
|
6467
|
-
exact?: ExactRailOption;
|
|
6529
|
+
exact?: boolean | ExactRailOption;
|
|
6468
6530
|
/**
|
|
6469
6531
|
* Make this gate's 402 self-describing for the open indexes — **x402scan REQUIRES
|
|
6470
6532
|
* an input schema or it won't list the resource.** Set `true` for a no-input GET,
|
|
@@ -6697,7 +6759,7 @@ interface KnownFacilitator {
|
|
|
6697
6759
|
/** The x402 schemes it settles (today only `exact`). */
|
|
6698
6760
|
schemes: ReadonlyArray<'exact'>;
|
|
6699
6761
|
/** The exact transfer methods it can settle on this network. */
|
|
6700
|
-
settles: ReadonlyArray<'eip3009' | 'permit2' | 'svm'>;
|
|
6762
|
+
settles: ReadonlyArray<'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos'>;
|
|
6701
6763
|
/** A short human note (who it is / caveat). */
|
|
6702
6764
|
note?: string;
|
|
6703
6765
|
}
|
|
@@ -6718,7 +6780,7 @@ declare function knownFacilitatorsFor(network: Caip2): ReadonlyArray<KnownFacili
|
|
|
6718
6780
|
* specific transfer `method`). Returns `undefined` when none is known — the `exact: true`
|
|
6719
6781
|
* shorthand branches on that to throw a coverage-specific guidance error.
|
|
6720
6782
|
*/
|
|
6721
|
-
declare function firstKeylessFacilitator(network: Caip2, method?: 'eip3009' | 'permit2' | 'svm'): KnownFacilitator | undefined;
|
|
6783
|
+
declare function firstKeylessFacilitator(network: Caip2, method?: 'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos'): KnownFacilitator | undefined;
|
|
6722
6784
|
|
|
6723
6785
|
/**
|
|
6724
6786
|
* Reliable receipt delivery — the durable webhook a stateless gate can't be.
|
package/dist/index.d.ts
CHANGED
|
@@ -88,8 +88,14 @@ interface X402ExactAcceptEntry {
|
|
|
88
88
|
* `spender` is the canonical x402ExactPermit2Proxy and whose `witness.to` binds the
|
|
89
89
|
* recipient. **Solana (SVM): `'svm'`** — the payer partial-signs an SPL
|
|
90
90
|
* `TransferChecked` transaction whose fee payer is the merchant (`feePayer` below),
|
|
91
|
-
* and the gate co-signs as fee payer + broadcasts.
|
|
92
|
-
|
|
91
|
+
* and the gate co-signs as fee payer + broadcasts. **Algorand: `'algorand'`** — the payer
|
|
92
|
+
* signs an ASA `axfer` to `payTo` at fee 0, atomically grouped with a 0-ALGO `pay` from
|
|
93
|
+
* the `feePayer` that pools the group fee (per `scheme_exact_algo.md`); the gate (or a
|
|
94
|
+
* keyless facilitator) signs that fee txn + submits. **Aptos: `'aptos'`** — the payer signs a
|
|
95
|
+
* fee-payer (sponsored) `primary_fungible_store::transfer` to `payTo` (per
|
|
96
|
+
* `scheme_exact_aptos.md`); the gate (or a keyless facilitator) adds the fee-payer signature
|
|
97
|
+
* + submits, paying gas. PipRail self-settles ALL. */
|
|
98
|
+
assetTransferMethod: 'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos';
|
|
93
99
|
/** EIP-712 domain name of the token. OPTIONAL per the exact-EVM scheme (only
|
|
94
100
|
* `assetTransferMethod` is required) — a foreign rail may omit it. NEVER assumed
|
|
95
101
|
* from the symbol (USDC's on-chain name() is "USD Coin", not "USDC"); a PipRail gate
|
|
@@ -97,11 +103,12 @@ interface X402ExactAcceptEntry {
|
|
|
97
103
|
name?: string;
|
|
98
104
|
/** EIP-712 domain version of the token (USDC: "2"). OPTIONAL (see `name`); read/re-derived on-chain. */
|
|
99
105
|
version?: string;
|
|
100
|
-
/** **SVM
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
106
|
+
/** **SVM / Algorand / Aptos** — the fee-payer (gas sponsor) address. The buyer builds the
|
|
107
|
+
* transaction with this account as the gas payer (so the buyer spends ZERO native coin),
|
|
108
|
+
* leaving its signature for whoever sponsors; the gate (self mode) or a keyless facilitator
|
|
109
|
+
* fills it and submits. On **SVM** it must differ from `payTo` (the fee payer must never
|
|
110
|
+
* appear in an instruction — a MUST-rule); on **Algorand/Aptos** the fee txn/signature is
|
|
111
|
+
* separate from the transfer, so `feePayer === payTo` is allowed. */
|
|
105
112
|
feePayer?: string;
|
|
106
113
|
/** **SVM only, OPTIONAL** — a ≤256-byte reconciliation memo the buyer attaches to the
|
|
107
114
|
* transaction (the SVM scheme's optional `extra.memo`). */
|
|
@@ -216,9 +223,41 @@ interface Permit2PaymentPayload {
|
|
|
216
223
|
interface ExactSvmPaymentPayload {
|
|
217
224
|
transaction: string;
|
|
218
225
|
}
|
|
226
|
+
/**
|
|
227
|
+
* The `payload` a client sends for the **Algorand `exact`** variant, per
|
|
228
|
+
* `scheme_exact_algo.md`: an atomically-grouped set of base64-encoded msgpack transactions,
|
|
229
|
+
* and the index within it of the transaction that pays the resource server. The buyer's ASA
|
|
230
|
+
* `axfer` (to `payTo`, fee 0) is SIGNED; a 0-ALGO `pay` from the `feePayer` that pools the
|
|
231
|
+
* group fee is left UNSIGNED for whoever sponsors (the gate's relayer in self mode, or a
|
|
232
|
+
* keyless facilitator). The group itself IS the proof — there's no separate authorization
|
|
233
|
+
* object (the Algorand analogue of EIP-3009's `authorization` / SVM's `transaction`).
|
|
234
|
+
*/
|
|
235
|
+
interface ExactAlgorandPaymentPayload {
|
|
236
|
+
/** Index into `paymentGroup` of the txn that pays the resource server (the buyer's `axfer`). */
|
|
237
|
+
paymentIndex: number;
|
|
238
|
+
/** The atomic group: each element is a base64-encoded, msgpack-encoded (signed or unsigned)
|
|
239
|
+
* Algorand transaction. ≤ 16 elements (the protocol's atomic-group cap). */
|
|
240
|
+
paymentGroup: string[];
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* The `payload` a client sends for the **Aptos `exact`** variant, per `scheme_exact_aptos.md`:
|
|
244
|
+
* a fee-payer (sponsored, AIP-39) `primary_fungible_store::transfer`. `transaction` is the base64
|
|
245
|
+
* BCS-serialized `SimpleTransaction` (raw tx + the bound `feePayerAddress`); `senderAuth` is the
|
|
246
|
+
* base64 BCS-serialized buyer (sender) authenticator. The buyer leaves the fee-payer signature for
|
|
247
|
+
* whoever sponsors (the gate's relayer in self mode, or a keyless facilitator), who adds it +
|
|
248
|
+
* submits. The (tx + sender authenticator) IS the proof — there's no separate `authorization`
|
|
249
|
+
* object (the Aptos analogue of EIP-3009's `authorization` / SVM's `transaction`). The two-field
|
|
250
|
+
* shape (a `senderAuth` alongside `transaction`) also distinguishes it from the SVM payload.
|
|
251
|
+
*/
|
|
252
|
+
interface ExactAptosPaymentPayload {
|
|
253
|
+
/** Base64 BCS-serialized `SimpleTransaction` (raw transaction + the bound `feePayerAddress`). */
|
|
254
|
+
transaction: string;
|
|
255
|
+
/** Base64 BCS-serialized buyer (sender) `AccountAuthenticator`. */
|
|
256
|
+
senderAuth: string;
|
|
257
|
+
}
|
|
219
258
|
/** Any `exact`-rail payload shape — EIP-3009 (`authorization`), Permit2 (`permit2Authorization`),
|
|
220
|
-
* or
|
|
221
|
-
type ExactPaymentPayloadAny = ExactPaymentPayload | Permit2PaymentPayload | ExactSvmPaymentPayload;
|
|
259
|
+
* SVM (`transaction`), Algorand (`paymentGroup`), or Aptos (`transaction` + `senderAuth`). */
|
|
260
|
+
type ExactPaymentPayloadAny = ExactPaymentPayload | Permit2PaymentPayload | ExactSvmPaymentPayload | ExactAlgorandPaymentPayload | ExactAptosPaymentPayload;
|
|
222
261
|
interface ParsedExactBase {
|
|
223
262
|
x402Version: number;
|
|
224
263
|
/** The client's claimed network (slug or CAIP-2) — for matching, not trust. */
|
|
@@ -236,7 +275,9 @@ interface ParsedExactBase {
|
|
|
236
275
|
* re-derives every verified field from its own trusted rail. A discriminated union on
|
|
237
276
|
* `method`, so narrowing on `method` narrows `payload`: `'eip3009'` → {@link ExactPaymentPayload}
|
|
238
277
|
* (`authorization`), `'permit2'` → {@link Permit2PaymentPayload} (`permit2Authorization`),
|
|
239
|
-
* `'svm'` → {@link ExactSvmPaymentPayload} (`transaction`)
|
|
278
|
+
* `'svm'` → {@link ExactSvmPaymentPayload} (`transaction`), `'algorand'` →
|
|
279
|
+
* {@link ExactAlgorandPaymentPayload} (`paymentGroup`); `'aptos'` →
|
|
280
|
+
* {@link ExactAptosPaymentPayload} (`transaction` + `senderAuth`).
|
|
240
281
|
*/
|
|
241
282
|
type ParsedExactPayment = (ParsedExactBase & {
|
|
242
283
|
method: 'eip3009';
|
|
@@ -247,6 +288,12 @@ type ParsedExactPayment = (ParsedExactBase & {
|
|
|
247
288
|
}) | (ParsedExactBase & {
|
|
248
289
|
method: 'svm';
|
|
249
290
|
payload: ExactSvmPaymentPayload;
|
|
291
|
+
}) | (ParsedExactBase & {
|
|
292
|
+
method: 'algorand';
|
|
293
|
+
payload: ExactAlgorandPaymentPayload;
|
|
294
|
+
}) | (ParsedExactBase & {
|
|
295
|
+
method: 'aptos';
|
|
296
|
+
payload: ExactAptosPaymentPayload;
|
|
250
297
|
});
|
|
251
298
|
interface X402Receipt {
|
|
252
299
|
scheme: 'onchain-proof' | 'exact';
|
|
@@ -4266,9 +4313,10 @@ interface DiscoverySigner {
|
|
|
4266
4313
|
* chain-agnostic — it never names a family, it just merges `extra`.
|
|
4267
4314
|
*/
|
|
4268
4315
|
interface ExactRailInfo {
|
|
4269
|
-
method: 'eip3009' | 'permit2' | 'svm';
|
|
4316
|
+
method: 'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos';
|
|
4270
4317
|
/** Family-specific `extra` keys merged into the exact accept (e.g. `{ name, version }`
|
|
4271
|
-
* for EVM EIP-3009, `{ feePayer, tokenProgram }` for Solana
|
|
4318
|
+
* for EVM EIP-3009, `{ feePayer, tokenProgram }` for Solana, `{ feePayer }` for
|
|
4319
|
+
* Algorand/Aptos). */
|
|
4272
4320
|
extra?: Record<string, unknown>;
|
|
4273
4321
|
}
|
|
4274
4322
|
/**
|
|
@@ -4349,7 +4397,7 @@ interface ResolvedNetwork {
|
|
|
4349
4397
|
reason?: RecipientReason;
|
|
4350
4398
|
}>;
|
|
4351
4399
|
/**
|
|
4352
|
-
* OPTIONAL (EVM EIP-3009/Permit2 + Solana SVM) — the BUYER counterpart to {@link settleExactSelf}.
|
|
4400
|
+
* OPTIONAL (EVM EIP-3009/Permit2 + Solana SVM + Algorand + Aptos) — the BUYER counterpart to {@link settleExactSelf}.
|
|
4353
4401
|
* Build + EIP-712-sign an EIP-3009 `transferWithAuthorization` for a standard x402
|
|
4354
4402
|
* `exact` rail, so a PipRail agent can PAY any standard x402 server (not just PipRail's
|
|
4355
4403
|
* own `onchain-proof` gates). The client frames the returned `payload` + `accepted` echo
|
|
@@ -4404,7 +4452,7 @@ interface ResolvedNetwork {
|
|
|
4404
4452
|
* (the merchant's own bound self-settle wallet, in self mode); `feePayer` takes precedence.
|
|
4405
4453
|
* RPC-read (EVM reads the token's EIP-712 domain; Solana reads the mint's token program); MAY
|
|
4406
4454
|
* throw a typed config error for an explicitly-requested-but-unsupported method (EVM does). A
|
|
4407
|
-
* family that omits this method offers no `exact` rail (today: every
|
|
4455
|
+
* family that omits this method offers no `exact` rail (today: every family except EVM, Solana, Algorand, and Aptos).
|
|
4408
4456
|
*/
|
|
4409
4457
|
resolveExactRail?(input: {
|
|
4410
4458
|
asset: string;
|
|
@@ -4438,10 +4486,12 @@ interface ResolvedNetwork {
|
|
|
4438
4486
|
*/
|
|
4439
4487
|
exactPermit2Supported?(): boolean;
|
|
4440
4488
|
/**
|
|
4441
|
-
* OPTIONAL (EVM-
|
|
4442
|
-
* locally, then SELF-SETTLE it by broadcasting
|
|
4443
|
-
*
|
|
4444
|
-
*
|
|
4489
|
+
* OPTIONAL (EVM EIP-3009/Permit2 + Solana SVM + Algorand + Aptos) — verify a standard x402 `exact`
|
|
4490
|
+
* payment locally, then SELF-SETTLE it by broadcasting from the merchant's own `relayer`
|
|
4491
|
+
* wallet (the merchant pays the network fee to receive; EVM broadcasts
|
|
4492
|
+
* `transferWithAuthorization`, Solana co-signs the fee payer, Algorand signs the pooled fee
|
|
4493
|
+
* txn + submits the group, Aptos adds the fee-payer signature + submits — the transfer
|
|
4494
|
+
* binds `payTo`, so no redirect risk). RETURNS a `VerifyResult`:
|
|
4445
4495
|
* - `{ ok:false, error }` for a CLIENT-fixable fault (bad signature, expired,
|
|
4446
4496
|
* wrong recipient/amount, used nonce, simulation revert) → gate replies 402;
|
|
4447
4497
|
* - `{ ok:true, receipt }` once the settle tx is mined.
|
|
@@ -4930,7 +4980,7 @@ interface SpendSummary {
|
|
|
4930
4980
|
}
|
|
4931
4981
|
|
|
4932
4982
|
/** The payment schemes a client can settle: PipRail's native `onchain-proof` (the
|
|
4933
|
-
* default) and the standard x402 `exact` rail (EVM EIP-3009/Permit2 + Solana SVM, opt-in). */
|
|
4983
|
+
* default) and the standard x402 `exact` rail (EVM EIP-3009/Permit2 + Solana SVM + Algorand, opt-in). */
|
|
4934
4984
|
type PaymentScheme = 'onchain-proof' | 'exact';
|
|
4935
4985
|
|
|
4936
4986
|
/** Observability events. `ref` is the proof — a chain-specific id (EVM tx hash, Solana signature, TON locator, Stellar tx hash). */
|
|
@@ -5485,7 +5535,7 @@ declare class PipRailClient {
|
|
|
5485
5535
|
* before publishing, so retry with a brief backoff if a fresh listing is missing.
|
|
5486
5536
|
* - Results are cross-scheme (mostly the mainstream `exact` scheme); `fetch()` pays
|
|
5487
5537
|
* `onchain-proof` rails by default, and standard `exact` rails too once you opt in
|
|
5488
|
-
* with `schemes: ['onchain-proof', 'exact']` (EVM EIP-3009/Permit2 + Solana SVM).
|
|
5538
|
+
* with `schemes: ['onchain-proof', 'exact']` (EVM EIP-3009/Permit2 + Solana SVM + Algorand).
|
|
5489
5539
|
*/
|
|
5490
5540
|
discover(opts?: DiscoverOptions): Promise<DiscoveredResource[]>;
|
|
5491
5541
|
/**
|
|
@@ -5902,7 +5952,7 @@ declare function describeChallenge(challenge: X402Challenge): string;
|
|
|
5902
5952
|
* literally, so a wrong name or order actively misleads. A test pins the load-
|
|
5903
5953
|
* bearing phrases.
|
|
5904
5954
|
*/
|
|
5905
|
-
declare const PIPRAIL_AGENT_GUIDE = "# Paying with PipRail \u2014 the agent contract\n\nYou can pay for x402 \"402 Payment Required\" resources autonomously. Money moves\nstraight from your wallet to the server; PipRail custodies nothing. Follow this.\n\n## Landing cold \u2014 read the self-description\nEvery PipRail 402 self-describes. Read challenge.extensions.piprail for { name, what, pay[]\n(each rail's how-to-pay), sdk.install, mcp, docs } \u2014 never guess what an endpoint is. If your\ntooling can't pay a rail (e.g. a stock x402 client can't pay the onchain-proof scheme), the\nblock says how: install @piprail/sdk (npm i @piprail/sdk) or run the MCP (npx -y @piprail/mcp)\nand pay with the tools below.\n\n## The loop: quote \u2192 plan \u2192 pay\n1. piprail_quote_payment(url) \u2014 PRICE it. Returns the amount, token, chain, and\n whether it is within your spend policy. No funds move. Use it to decide if a\n resource is worth buying.\n2. piprail_plan_payment(url) \u2014 can I afford it NOW? Reads your balance, native gas,\n and recipient-readiness across every rail, and returns { payable, best,\n fundingHint, session? }. If payable is false, do NOT attempt the payment \u2014\n fundingHint says exactly what to fix.\n3. piprail_pay_request(url, method?, body?) \u2014 PAY (only if the plan was payable)\n and return the result.\nAlways plan before you pay so you never commit to a payment you cannot finish.\n\n## Gasless \u2014 the exact rail (zero gas for you)\nA 402 may offer up to two rails; you don't choose per payment \u2014 the client does, automatically:\n- onchain-proof (PipRail's default): you broadcast the payment yourself and pay the network gas\n (the native coin \u2014 ETH/SOL/\u2026). Works on every chain.\n- exact (the ratified x402 rail, opt-in): you only SIGN; the server \u2014 or a facilitator it chose\n (e.g. PayAI) \u2014 broadcasts it, so you pay ZERO gas (you need only the token, no native coin). It\n works on EVM +
|
|
5955
|
+
declare const PIPRAIL_AGENT_GUIDE = "# Paying with PipRail \u2014 the agent contract\n\nYou can pay for x402 \"402 Payment Required\" resources autonomously. Money moves\nstraight from your wallet to the server; PipRail custodies nothing. Follow this.\n\n## Landing cold \u2014 read the self-description\nEvery PipRail 402 self-describes. Read challenge.extensions.piprail for { name, what, pay[]\n(each rail's how-to-pay), sdk.install, mcp, docs } \u2014 never guess what an endpoint is. If your\ntooling can't pay a rail (e.g. a stock x402 client can't pay the onchain-proof scheme), the\nblock says how: install @piprail/sdk (npm i @piprail/sdk) or run the MCP (npx -y @piprail/mcp)\nand pay with the tools below.\n\n## The loop: quote \u2192 plan \u2192 pay\n1. piprail_quote_payment(url) \u2014 PRICE it. Returns the amount, token, chain, and\n whether it is within your spend policy. No funds move. Use it to decide if a\n resource is worth buying.\n2. piprail_plan_payment(url) \u2014 can I afford it NOW? Reads your balance, native gas,\n and recipient-readiness across every rail, and returns { payable, best,\n fundingHint, session? }. If payable is false, do NOT attempt the payment \u2014\n fundingHint says exactly what to fix.\n3. piprail_pay_request(url, method?, body?) \u2014 PAY (only if the plan was payable)\n and return the result.\nAlways plan before you pay so you never commit to a payment you cannot finish.\n\n## Gasless \u2014 the exact rail (zero gas for you)\nA 402 may offer up to two rails; you don't choose per payment \u2014 the client does, automatically:\n- onchain-proof (PipRail's default): you broadcast the payment yourself and pay the network gas\n (the native coin \u2014 ETH/SOL/\u2026). Works on every chain.\n- exact (the ratified x402 rail, opt-in): you only SIGN; the server \u2014 or a facilitator it chose\n (e.g. PayAI) \u2014 broadcasts it, so you pay ZERO gas (you need only the token, no native coin). It\n works on EVM, Solana + Algorand, and the on-chain method (EIP-3009 / Permit2 / SVM / Algorand\n fee-pooled group) is picked automatically.\nWhen the exact scheme is enabled AND balance-aware routing is on, paying picks the cheapest\nsettleable rail \u2014 i.e. the gasless exact one. Nothing changes in your loop: quote \u2192 plan \u2192 pay is\nidentical. The exact scheme is OPT-IN by the operator (MCP: PIPRAIL_SCHEMES=onchain-proof,exact);\nyou can't enable it yourself, but you can report when a 402 needs it (see UNSUPPORTED_SCHEME below).\n\n## Reading a refusal \u2014 never crash, never double-spend\nA failed pay returns a STRUCTURED object, never a thrown error you must catch:\n { ok:false, code, reason, explain, ref?, reasonCode?, declined? }\nBranch on `code` (always reliable). Key cases:\n- declined:true with reasonCode:'SESSION_EXPIRED' \u2014 your time budget is over. This\n is TERMINAL: STOP. Do not retry ANY payment this process; it cannot be undone\n without a restart / a longer TTL.\n- declined:true with reasonCode:'APPROVAL' \u2014 a human (or hook) declined this\n payment. Terminal for this pay: do NOT auto-retry \u2014 they said no, or no one\n answered.\n- declined:true with reasonCode:'OUTSIDE_WINDOW' \u2014 your rolling rate-limit is\n exhausted. Wait for it to free, then retry; do not raise the amount.\n- declined:true with reasonCode:'POLICY' or 'BUDGET' \u2014 a spend cap or allowlist\n refused it. Don't retry the same payment; pick a cheaper/allowed one.\n- code:'INSUFFICIENT_FUNDS' \u2014 top up the wallet (token and/or native gas), retry.\n- code:'PAYMENT_TIMEOUT' / 'MAX_RETRIES_EXCEEDED' / 'CONFIRMATION_TIMEOUT' \u2014 the\n payment may ALREADY be on-chain. Recover using the proof on `.ref` (re-verify\n or re-submit it); never re-pay \u2014 a fresh payment would double-spend. On a gasless\n exact rail `.ref` is the authorization NONCE, not a tx hash: re-present the SAME\n signed authorization, never sign a fresh one (that would risk a double-spend).\n- code:'NO_COMPATIBLE_ACCEPT' / 'UNSUPPORTED_SCHEME' \u2014 the 402 isn't payable on\n your chain/scheme; `explain` says whether it's the wrong chain or a scheme to enable.\n If it's a standard x402 server offering an exact rail, that's a config fix the operator makes\n once (enable the exact scheme); report it, don't retry the same call blindly.\n\n## Knowing your leash \u2014 call piprail_budget\npiprail_budget tells you how much budget and time you have left, per\n(network, asset), plus your spend so far. Read-only; moves no funds. Use it in\nMode A to self-check before paying.\n\n## Two modes\n- Mode A (headless, default): you run FREE inside a pre-set budget + time\n envelope. The policy IS the consent \u2014 there is no per-payment prompt. Stay\n inside it; piprail_budget shows what's left.\n- Mode B (supervised): the host may ask a human to approve each payment. A\n decline/cancel/timeout comes back as declined:true (reasonCode:'APPROVAL') \u2014\n do NOT retry it as if it were a transient error.\n\n## Hard facts\n- Spend caps are PER (network, asset). There is no single cross-token dollar cap \u2014\n budgets aren't summed across tokens (no price oracle).\n- Spend totals and the time envelope live IN-MEMORY for THIS process; they reset on restart\n (a convenience, not a durable ledger).\n";
|
|
5906
5956
|
/** Returns {@link PIPRAIL_AGENT_GUIDE} (a parity accessor for callers that prefer a function). */
|
|
5907
5957
|
declare function agentGuide(): string;
|
|
5908
5958
|
|
|
@@ -6370,7 +6420,11 @@ interface AcceptOption {
|
|
|
6370
6420
|
* relayer key needed. (EVM facilitators are also the path onto Coinbase's Bazaar directory.)
|
|
6371
6421
|
*/
|
|
6372
6422
|
interface ExactRailOption {
|
|
6373
|
-
|
|
6423
|
+
/** How the gate settles an inbound `exact` payment. `'self'` = your own `relayer` broadcasts
|
|
6424
|
+
* (you pay gas). `'keyless'` = auto-pick a known KEYLESS facilitator for the chain (it sponsors
|
|
6425
|
+
* gas — zero-config; the same resolution as the top-level `exact: true` shorthand). `{ facilitator }`
|
|
6426
|
+
* = a specific facilitator you name — pin this in production rather than relying on the auto-pick. */
|
|
6427
|
+
settle: 'self' | 'keyless' | {
|
|
6374
6428
|
facilitator: string;
|
|
6375
6429
|
authHeaders?: () => Promise<Record<string, string>>;
|
|
6376
6430
|
/** Solana only — the facilitator's fee-payer pubkey, if you'd rather set it than have the
|
|
@@ -6462,9 +6516,17 @@ interface RequirePaymentOptions {
|
|
|
6462
6516
|
/**
|
|
6463
6517
|
* ALSO advertise a standard x402 `exact` rail so any standard x402 client can pay this
|
|
6464
6518
|
* gate — opt-in, EVM (EIP-3009/Permit2) + Solana (SVM). See {@link ExactRailOption}.
|
|
6465
|
-
*
|
|
6519
|
+
* Shorthand **`exact: true`** === `{ settle: 'keyless' }`: the gate auto-picks a known KEYLESS
|
|
6520
|
+
* facilitator for each offered chain (from `KNOWN_FACILITATORS`), so neither buyer nor merchant
|
|
6521
|
+
* pays gas, zero-config. It is a SOFT, best-effort flag — a chain with no available keyless
|
|
6522
|
+
* facilitator DEGRADES GRACEFULLY to the always-present `onchain-proof` rail (the buyer pays gas,
|
|
6523
|
+
* the only option left when no facilitator can sponsor) with a LOUD warning; it never bricks the
|
|
6524
|
+
* gate. For guaranteed gasless, pin `settle: { facilitator }` (recommended in production) or
|
|
6525
|
+
* self-settle `settle: 'self'`; an EXPLICIT `settle` that can't carry exact throws loudly (a config
|
|
6526
|
+
* error you should fix). `false`/omitted keeps the gate exactly as today (`onchain-proof` only —
|
|
6527
|
+
* byte-identical).
|
|
6466
6528
|
*/
|
|
6467
|
-
exact?: ExactRailOption;
|
|
6529
|
+
exact?: boolean | ExactRailOption;
|
|
6468
6530
|
/**
|
|
6469
6531
|
* Make this gate's 402 self-describing for the open indexes — **x402scan REQUIRES
|
|
6470
6532
|
* an input schema or it won't list the resource.** Set `true` for a no-input GET,
|
|
@@ -6697,7 +6759,7 @@ interface KnownFacilitator {
|
|
|
6697
6759
|
/** The x402 schemes it settles (today only `exact`). */
|
|
6698
6760
|
schemes: ReadonlyArray<'exact'>;
|
|
6699
6761
|
/** The exact transfer methods it can settle on this network. */
|
|
6700
|
-
settles: ReadonlyArray<'eip3009' | 'permit2' | 'svm'>;
|
|
6762
|
+
settles: ReadonlyArray<'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos'>;
|
|
6701
6763
|
/** A short human note (who it is / caveat). */
|
|
6702
6764
|
note?: string;
|
|
6703
6765
|
}
|
|
@@ -6718,7 +6780,7 @@ declare function knownFacilitatorsFor(network: Caip2): ReadonlyArray<KnownFacili
|
|
|
6718
6780
|
* specific transfer `method`). Returns `undefined` when none is known — the `exact: true`
|
|
6719
6781
|
* shorthand branches on that to throw a coverage-specific guidance error.
|
|
6720
6782
|
*/
|
|
6721
|
-
declare function firstKeylessFacilitator(network: Caip2, method?: 'eip3009' | 'permit2' | 'svm'): KnownFacilitator | undefined;
|
|
6783
|
+
declare function firstKeylessFacilitator(network: Caip2, method?: 'eip3009' | 'permit2' | 'svm' | 'algorand' | 'aptos'): KnownFacilitator | undefined;
|
|
6722
6784
|
|
|
6723
6785
|
/**
|
|
6724
6786
|
* Reliable receipt delivery — the durable webhook a stateless gate can't be.
|