@ftptech/x402-canton-client 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 FTP Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,64 @@
+# @ftptech/x402-canton-client
+
+Payer-side SDK for Canton x402. Lets an autonomous agent pay for
+x402-gated HTTP resources using a `CantonSigner` that submits a CIP-56
+`TransferFactory_Transfer` from the agent's Canton participant.
+
+## Install
+
+```bash
+npm i @ftptech/x402-canton-client
+```
+
+> Note: the `@ftp` npm scope is not final — it may change before the
+> first public release (see [`docs/PUBLISHING.md`](https://github.com/sunstrike228/canton-x402/blob/main/docs/PUBLISHING.md)).
+> Pin the version you install and check the README for the current
+> package name.
+
+## What's in here
+
+- `CantonSigner` interface — abstracts how a CIP-56 transfer is
+  signed and submitted (real participant via `Cip56KeyfileSigner`,
+  mock for tests, hosted-party variants).
+- `Cip56KeyfileSigner` + `makeCip56KeyfileSigner(config)` — production
+  signer that loads an Ed25519 key from a PEM file (or env-var PEM
+  string) and drives the participant's interactive-submission
+  prepare/sign/execute flow for `TransferFactory_Transfer`.
+- `ExactCantonScheme` — builds x402 v2 PaymentPayload envelopes
+  from PaymentRequirements + a signer.
+- `wrapFetchWithCantonPayment(fetch, signer)` — drop-in fetch
+  replacement that detects 402, decodes `PAYMENT-REQUIRED`, calls
+  the signer, retries with `PAYMENT-SIGNATURE`, throws
+  `X402PaymentError` with a stable `code` field on failure.
+- `readPaymentResponseHeader(response)` — decodes the v2
+  `PAYMENT-RESPONSE` settlement header.
+
+## Quick example
+
+```ts
+import {
+  wrapFetchWithCantonPayment,
+  readPaymentResponseHeader,
+  makeCip56KeyfileSigner,
+} from "@ftptech/x402-canton-client";
+
+const signer = makeCip56KeyfileSigner({
+  participantUrl:   "https://your-participant/ledger-api",
+  participantToken: "<bearer>",
+  scanUrl:          "https://scan.your-sv/api/scan",
+  party:            "agent_party::1220...",
+  keyPath:          "/run/secrets/agent.pem",
+});
+
+const fetchWithPay = wrapFetchWithCantonPayment(fetch, signer);
+const res = await fetchWithPay("https://api.example.com/data");
+const settle = readPaymentResponseHeader(res);
+```
+
+See [`docs/quickstart.md`](https://github.com/sunstrike228/canton-x402/blob/main/docs/quickstart.md)
+for the full demo flow and `examples/agent-buyer/` for a runnable
+agent.
+
+## Project
+
+[github.com/sunstrike228/canton-x402](https://github.com/sunstrike228/canton-x402).

package/dist/cip56-signer.d.ts

@@ -0,0 +1,82 @@
+/**
+ * `Cip56KeyfileSigner` — production CantonSigner implementation
+ * for the CIP-56 Token Standard path.
+ *
+ * Mirrors `KeyfileSigner` (which targets the Splice TransferCommand
+ * path for Canton Coin) but exercises `TransferFactory_Transfer`
+ * via interactive-submission/prepare+execute. The factory
+ * implementation can be from ANY token issuer that conforms to
+ * Splice's CIP-56 — USDC, EURC, the splice-token-test-dummy-holding,
+ * custom institutional stablecoins, etc.
+ *
+ * Flow per `signCip56Transfer`:
+ *
+ *   1. Build the `TransferFactory_Transfer` choice argument using
+ *      the merchant-supplied factory cid, instrumentId,
+ *      facilitator, and the caller's transferMeta (with x402
+ *      paymentId).
+ *   2. Wrap as a JsCommand with the factory's templateId.
+ *   3. `CantonExternalPartySigner.prepareSignAndExecute` lands the
+ *      submission; returns the updateId.
+ *   4. Read the transaction tree by updateId to find the
+ *      TransferInstructionResult — was it Completed (synchronous)
+ *      or Pending (instruction cid returned)?
+ *   5. Return `{updateId, transferInstructionCid?}` for the caller
+ *      to wrap in the PaymentPayload.
+ *
+ * Resolving `transferFactoryTemplateId`: the caller must supply
+ * it. Either:
+ *   - The merchant publishes it in `extra.transferFactoryTemplateId`
+ *     (we don't currently put it in the spec; merchant SDK should
+ *     resolve via Scan's CIP-56 registry endpoint at startup).
+ *   - The signer fetches it from `/v2/state/active-contracts`
+ *     filtered to the factory cid.
+ *
+ * For v0.1 we make the caller pass it through; future versions can
+ * add an automatic resolver.
+ */
+import { CantonClient, CantonExternalPartySigner, ScanClient, type ExternalPartyKey, type ScanFlavor } from "@ftptech/x402-canton-ledger";
+import type { CantonSigner, SignCip56TransferInput, SignedCip56Transfer } from "./signer.js";
+export interface Cip56KeyfileSignerDeps {
+    /** Wraps interactive-submission/prepare + execute. */
+    signer: CantonExternalPartySigner;
+    /** ACS lookup to extract TransferInstruction cid from result. */
+    client: CantonClient;
+    /** Optional: Scan client for future factory-lookup automation. */
+    scan?: ScanClient;
+    /** The Ed25519 keypair this signer signs with. */
+    key: ExternalPartyKey;
+    /** The agent's Canton party id. */
+    party: string;
+    /** Ledger user id submitted in the JsCommands envelope. */
+    userId?: string;
+    /** Default Transfer.executeBefore window in seconds. Default 60. */
+    defaultExpirySeconds?: number;
+}
+export declare class Cip56KeyfileSigner implements CantonSigner {
+    private readonly deps;
+    readonly party: string;
+    constructor(deps: Cip56KeyfileSignerDeps);
+    signCip56Transfer(input: SignCip56TransferInput): Promise<SignedCip56Transfer>;
+}
+export interface MakeCip56KeyfileSignerConfig {
+    keyPath?: string;
+    keyPem?: string;
+    fingerprint?: string;
+    party: string;
+    participantUrl: string;
+    participantToken: string;
+    packageName?: string;
+    scanUrl?: string;
+    scanToken?: string;
+    scanFlavor?: ScanFlavor;
+    userId?: string;
+    defaultExpirySeconds?: number;
+    timeoutMs?: number;
+}
+/**
+ * Convenience builder mirroring `makeKeyfileSigner` but constructing
+ * the CIP-56 variant.
+ */
+export declare function makeCip56KeyfileSigner(config: MakeCip56KeyfileSignerConfig): Cip56KeyfileSigner;
+//# sourceMappingURL=cip56-signer.d.ts.map

package/dist/cip56-signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cip56-signer.d.ts","sourceRoot":"","sources":["../src/cip56-signer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAIH,OAAO,EACL,YAAY,EACZ,yBAAyB,EACzB,UAAU,EAIV,KAAK,gBAAgB,EACrB,KAAK,UAAU,EAGhB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,sBAAsB;IACrC,sDAAsD;IACtD,MAAM,EAAE,yBAAyB,CAAC;IAClC,iEAAiE;IACjE,MAAM,EAAE,YAAY,CAAC;IACrB,kEAAkE;IAClE,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,kDAAkD;IAClD,GAAG,EAAE,gBAAgB,CAAC;IACtB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,qBAAa,kBAAmB,YAAW,YAAY;IAGzC,OAAO,CAAC,QAAQ,CAAC,IAAI;IAFjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAEM,IAAI,EAAE,sBAAsB;IAInD,iBAAiB,CACrB,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,mBAAmB,CAAC;CA0GhC;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,4BAA4B,GACnC,kBAAkB,CAgDpB"}

package/dist/cip56-signer.js

@@ -0,0 +1,183 @@
+/**
+ * `Cip56KeyfileSigner` — production CantonSigner implementation
+ * for the CIP-56 Token Standard path.
+ *
+ * Mirrors `KeyfileSigner` (which targets the Splice TransferCommand
+ * path for Canton Coin) but exercises `TransferFactory_Transfer`
+ * via interactive-submission/prepare+execute. The factory
+ * implementation can be from ANY token issuer that conforms to
+ * Splice's CIP-56 — USDC, EURC, the splice-token-test-dummy-holding,
+ * custom institutional stablecoins, etc.
+ *
+ * Flow per `signCip56Transfer`:
+ *
+ *   1. Build the `TransferFactory_Transfer` choice argument using
+ *      the merchant-supplied factory cid, instrumentId,
+ *      facilitator, and the caller's transferMeta (with x402
+ *      paymentId).
+ *   2. Wrap as a JsCommand with the factory's templateId.
+ *   3. `CantonExternalPartySigner.prepareSignAndExecute` lands the
+ *      submission; returns the updateId.
+ *   4. Read the transaction tree by updateId to find the
+ *      TransferInstructionResult — was it Completed (synchronous)
+ *      or Pending (instruction cid returned)?
+ *   5. Return `{updateId, transferInstructionCid?}` for the caller
+ *      to wrap in the PaymentPayload.
+ *
+ * Resolving `transferFactoryTemplateId`: the caller must supply
+ * it. Either:
+ *   - The merchant publishes it in `extra.transferFactoryTemplateId`
+ *     (we don't currently put it in the spec; merchant SDK should
+ *     resolve via Scan's CIP-56 registry endpoint at startup).
+ *   - The signer fetches it from `/v2/state/active-contracts`
+ *     filtered to the factory cid.
+ *
+ * For v0.1 we make the caller pass it through; future versions can
+ * add an automatic resolver.
+ */
+import { readFileSync } from "node:fs";
+import { createPrivateKey, createPublicKey } from "node:crypto";
+import { CantonClient, CantonExternalPartySigner, ScanClient, ed25519KeyFromNodeKeyPair, CIP56_CHOICES, CIP56_TEMPLATE_SUFFIXES, } from "@ftptech/x402-canton-ledger";
+export class Cip56KeyfileSigner {
+    deps;
+    party;
+    constructor(deps) {
+        this.deps = deps;
+        this.party = deps.party;
+    }
+    async signCip56Transfer(input) {
+        if (!input.transferFactoryTemplateId) {
+            throw new Error("Cip56KeyfileSigner.signCip56Transfer: transferFactoryTemplateId required (resolve from Scan or merchant config)");
+        }
+        const nowMs = Date.now();
+        const defaultExpiry = (this.deps.defaultExpirySeconds ?? 60) * 1000;
+        const executeBeforeMs = input.executeBeforeMs ?? nowMs + defaultExpiry;
+        const transfer = {
+            sender: this.party,
+            receiver: input.receiver,
+            amount: input.amount,
+            instrumentId: input.instrumentId,
+            // requestedAt MUST be in the past at submit time — backstop
+            // by 1s so clock skew doesn't fail the check.
+            requestedAt: new Date(nowMs - 1000).toISOString(),
+            executeBefore: new Date(executeBeforeMs).toISOString(),
+            inputHoldingCids: [],
+            meta: {
+                values: input.transferMeta ?? {},
+            },
+        };
+        const choiceArgument = {
+            expectedAdmin: input.factoryAdmin,
+            transfer,
+            extraArgs: input.extraArgs ?? {
+                context: { values: {} },
+                meta: { values: {} },
+            },
+        };
+        const commandId = `xfer-cip56-${nowMs}-${Math.random()
+            .toString(36)
+            .slice(2, 10)}`;
+        const userId = this.deps.userId ?? "x402-agent";
+        const result = await this.deps.signer.prepareSignAndExecute({
+            userId,
+            commandId,
+            actAs: [this.party],
+            synchronizerId: input.synchronizerId,
+            // The factory contract is DSO-signed (or issuer-signed);
+            // typically already visible to the sender's participant.
+            // If not, caller must include a disclosedContracts entry —
+            // future API addition.
+            disclosedContracts: [],
+            commands: [
+                {
+                    ExerciseCommand: {
+                        templateId: input.transferFactoryTemplateId,
+                        contractId: input.transferFactoryCid,
+                        choice: CIP56_CHOICES.transferFactoryTransfer,
+                        choiceArgument: choiceArgument,
+                    },
+                },
+            ],
+        }, this.deps.key);
+        // Inspect THIS specific transaction (by updateId) to find the
+        // TransferInstruction CreatedEvent — if any — inside its
+        // events. ACS-scanning is unsafe: a sender with any unrelated
+        // outstanding TransferInstruction (e.g. from a prior pending
+        // transfer) would get the wrong cid picked up, and the
+        // facilitator's /verify would reject the wrong contract.
+        let transferInstructionCid = null;
+        try {
+            const tx = await this.deps.client.getTransactionById({
+                updateId: result.updateId,
+                requestingParties: [this.party],
+            });
+            for (const e of tx.events) {
+                const created = e.CreatedEvent;
+                if (created &&
+                    created.templateId.endsWith(CIP56_TEMPLATE_SUFFIXES.transferInstruction)) {
+                    transferInstructionCid = created.contractId;
+                    break;
+                }
+            }
+        }
+        catch {
+            // Tree fetch failed (network blip, party visibility issue).
+            // Fall through with transferInstructionCid=null — the
+            // PaymentPayload will then default to the Completed variant
+            // and surface just the updateId. The facilitator's /verify
+            // accepts updateId as proof in that case.
+        }
+        return {
+            payerParty: this.party,
+            updateId: result.updateId,
+            transferInstructionCid,
+        };
+    }
+}
+/**
+ * Convenience builder mirroring `makeKeyfileSigner` but constructing
+ * the CIP-56 variant.
+ */
+export function makeCip56KeyfileSigner(config) {
+    const client = new CantonClient({
+        participantUrl: config.participantUrl,
+        token: config.participantToken,
+        packageName: config.packageName ?? "splice-api-token-transfer-instruction-v1",
+        ...(config.timeoutMs !== undefined ? { timeoutMs: config.timeoutMs } : {}),
+    });
+    const scan = config.scanUrl
+        ? new ScanClient({
+            scanUrl: config.scanUrl,
+            ...(config.scanToken !== undefined ? { token: config.scanToken } : {}),
+            ...(config.scanFlavor !== undefined ? { flavor: config.scanFlavor } : {}),
+            ...(config.timeoutMs !== undefined ? { timeoutMs: config.timeoutMs } : {}),
+        })
+        : undefined;
+    const ipSigner = new CantonExternalPartySigner(client);
+    const pem = config.keyPem ??
+        (config.keyPath ? readFileSync(config.keyPath, "utf8") : null);
+    if (!pem) {
+        throw new Error("makeCip56KeyfileSigner: provide keyPath or keyPem");
+    }
+    const privateKey = createPrivateKey({ key: pem, format: "pem" });
+    const publicKey = createPublicKey(privateKey);
+    const key = ed25519KeyFromNodeKeyPair({
+        privateKey,
+        publicKey,
+        ...(config.fingerprint !== undefined
+            ? { fingerprint: config.fingerprint }
+            : {}),
+    });
+    return new Cip56KeyfileSigner({
+        signer: ipSigner,
+        client,
+        ...(scan !== undefined ? { scan } : {}),
+        key,
+        party: config.party,
+        ...(config.userId !== undefined ? { userId: config.userId } : {}),
+        ...(config.defaultExpirySeconds !== undefined
+            ? { defaultExpirySeconds: config.defaultExpirySeconds }
+            : {}),
+    });
+}
+//# sourceMappingURL=cip56-signer.js.map

package/dist/cip56-signer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cip56-signer.js","sourceRoot":"","sources":["../src/cip56-signer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAkB,MAAM,aAAa,CAAC;AAChF,OAAO,EACL,YAAY,EACZ,yBAAyB,EACzB,UAAU,EACV,yBAAyB,EACzB,aAAa,EACb,uBAAuB,GAKxB,MAAM,6BAA6B,CAAC;AAwBrC,MAAM,OAAO,kBAAkB;IAGA;IAFpB,KAAK,CAAS;IAEvB,YAA6B,IAA4B;QAA5B,SAAI,GAAJ,IAAI,CAAwB;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,KAA6B;QAE7B,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,iHAAiH,CAClH,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,aAAa,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;QACpE,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,GAAG,aAAa,CAAC;QAEvE,MAAM,QAAQ,GAAkB;YAC9B,MAAM,EAAE,IAAI,CAAC,KAAK;YAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,4DAA4D;YAC5D,8CAA8C;YAC9C,WAAW,EAAE,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE;YACjD,aAAa,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE;YACtD,gBAAgB,EAAE,EAAE;YACpB,IAAI,EAAE;gBACJ,MAAM,EAAE,KAAK,CAAC,YAAY,IAAI,EAAE;aACjC;SACF,CAAC;QAEF,MAAM,cAAc,GAAgC;YAClD,aAAa,EAAE,KAAK,CAAC,YAAY;YACjC,QAAQ;YACR,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI;gBAC5B,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBACvB,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;aACrB;SACF,CAAC;QAEF,MAAM,SAAS,GAAG,cAAc,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;aACnD,QAAQ,CAAC,EAAE,CAAC;aACZ,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC;QAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,CACzD;YACE,MAAM;YACN,SAAS;YACT,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACnB,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,yDAAyD;YACzD,yDAAyD;YACzD,2DAA2D;YAC3D,uBAAuB;YACvB,kBAAkB,EAAE,EAAE;YACtB,QAAQ,EAAE;gBACR;oBACE,eAAe,EAAE;wBACf,UAAU,EAAE,KAAK,CAAC,yBAAyB;wBAC3C,UAAU,EAAE,KAAK,CAAC,kBAAkB;wBACpC,MAAM,EAAE,aAAa,CAAC,uBAAuB;wBAC7C,cAAc,EAAE,cAGf;qBACF;iBACF;aACF;SACF,EACD,IAAI,CAAC,IAAI,CAAC,GAAG,CACd,CAAC;QAEF,8DAA8D;QAC9D,yDAAyD;QACzD,8DAA8D;QAC9D,6DAA6D;QAC7D,uDAAuD;QACvD,yDAAyD;QACzD,IAAI,sBAAsB,GAAkB,IAAI,CAAC;QACjD,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACnD,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,iBAAiB,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;aAChC,CAAC,CAAC;YACH,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,CAAC,CAAC,YAAY,CAAC;gBAC/B,IACE,OAAO;oBACP,OAAO,CAAC,UAAU,CAAC,QAAQ,CACzB,uBAAuB,CAAC,mBAAmB,CAC5C,EACD,CAAC;oBACD,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;oBAC5C,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,4DAA4D;YAC5D,sDAAsD;YACtD,4DAA4D;YAC5D,2DAA2D;YAC3D,0CAA0C;QAC5C,CAAC;QAED,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,KAAK;YACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,sBAAsB;SACvB,CAAC;IACJ,CAAC;CACF;AAkBD;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAoC;IAEpC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC;QAC9B,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,KAAK,EAAE,MAAM,CAAC,gBAAgB;QAC9B,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,0CAA0C;QAC7E,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3E,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO;QACzB,CAAC,CAAC,IAAI,UAAU,CAAC;YACb,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtE,GAAG,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC3E,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAEvD,MAAM,GAAG,GACP,MAAM,CAAC,MAAM;QACb,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjE,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CACb,mDAAmD,CACpD,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAc,gBAAgB,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAc,eAAe,CAAC,UAAU,CAAC,CAAC;IACzD,MAAM,GAAG,GAAG,yBAAyB,CAAC;QACpC,UAAU;QACV,SAAS;QACT,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS;YAClC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE;YACrC,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CAAC;IAEH,OAAO,IAAI,kBAAkB,CAAC;QAC5B,MAAM,EAAE,QAAQ;QAChB,MAAM;QACN,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG;QACH,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,GAAG,CAAC,MAAM,CAAC,oBAAoB,KAAK,SAAS;YAC3C,CAAC,CAAC,EAAE,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,EAAE;YACvD,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CAAC;AACL,CAAC"}

package/dist/fetch.d.ts

@@ -0,0 +1,51 @@
+/**
+ * wrapFetchWithCantonPayment — automate the x402 v2 "detect 402 →
+ * pay → retry" flow against any Canton-aware facilitator.
+ *
+ * Usage:
+ *
+ *   const fetchWithPay = wrapFetchWithCantonPayment(globalThis.fetch, signer);
+ *   const res = await fetchWithPay("https://api.example.com/data");
+ *   const settle = readPaymentResponseHeader(res);
+ *
+ * Wire format: x402 v2 only. v1 fallback is tracked in BACKLOG.md
+ * and lands when an older facilitator demands it.
+ *
+ * Limitations:
+ * - The original request body must be replayable (e.g. JSON string,
+ *   Uint8Array, FormData). Streaming bodies will fail on retry.
+ * - Idempotency: callers should treat the wrapped fetch as
+ *   at-most-twice. If the second response is still 402 we throw —
+ *   no infinite-loop retries.
+ */
+import { type PaymentRequirements, type X402ResourceInfo, type CantonNetwork } from "@ftptech/x402-canton-core";
+import type { CantonSigner } from "./signer.js";
+export interface X402PaymentRequired {
+    x402Version: number;
+    error?: string;
+    resource: X402ResourceInfo;
+    accepts: PaymentRequirements[];
+    extensions?: Record<string, unknown>;
+}
+export interface WrapFetchOptions {
+    /** Restrict which Canton networks this client will pay on.
+     *  Default: any `canton:*`. */
+    networkFilter?: (network: CantonNetwork) => boolean;
+    /** Tiebreaker among multiple exact-canton accepts. Default: first
+     *  matching entry. */
+    selectRequirements?: (candidates: PaymentRequirements[]) => PaymentRequirements;
+}
+export declare class X402PaymentError extends Error {
+    readonly code: X402PaymentErrorCode;
+    constructor(message: string, code: X402PaymentErrorCode);
+}
+export type X402PaymentErrorCode = "MISSING_PAYMENT_REQUIRED_HEADER" | "MALFORMED_PAYMENT_REQUIRED" | "NO_ACCEPTABLE_SCHEME" | "PAYMENT_REJECTED";
+export declare function wrapFetchWithCantonPayment(fetch: typeof globalThis.fetch, signer: CantonSigner, options?: WrapFetchOptions): typeof globalThis.fetch;
+/**
+ * Decode the `PAYMENT-RESPONSE` header (x402 v2) attached to a
+ * response that came back through wrapFetchWithCantonPayment.
+ * Returns null when the header is absent (e.g. response unrelated to
+ * x402).
+ */
+export declare function readPaymentResponseHeader<T = unknown>(response: Response): T | null;
+//# sourceMappingURL=fetch.d.ts.map

package/dist/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAML,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAWhD,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,gBAAgB;IAC/B;mCAC+B;IAC/B,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC;IACpD;0BACsB;IACtB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAAE,mBAAmB,EAAE,KAAK,mBAAmB,CAAC;CACjF;AAED,qBAAa,gBAAiB,SAAQ,KAAK;aACI,IAAI,EAAE,oBAAoB;gBAA3D,OAAO,EAAE,MAAM,EAAkB,IAAI,EAAE,oBAAoB;CAIxE;AAED,MAAM,MAAM,oBAAoB,GAC5B,iCAAiC,GACjC,4BAA4B,GAC5B,sBAAsB,GACtB,kBAAkB,CAAC;AAEvB,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,EAC9B,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,UAAU,CAAC,KAAK,CAyFzB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,GAAG,OAAO,EACnD,QAAQ,EAAE,QAAQ,GACjB,CAAC,GAAG,IAAI,CAIV"}