@x402/evm 2.2.0 → 2.3.0

package/dist/cjs/index.d.ts

@@ -1,36 +1,463 @@
-import { SchemeNetworkClient, PaymentRequirements, PaymentPayload } from '@x402/core/types';
-import { C as ClientEvmSigner } from './signer-5OVDxViv.js';
-export { F as FacilitatorEvmSigner, t as toClientEvmSigner, a as toFacilitatorEvmSigner } from './signer-5OVDxViv.js';
+export { E as ExactEvmScheme, P as Permit2AllowanceParams, c as createPermit2ApprovalTx, e as erc20AllowanceAbi, g as getPermit2AllowanceReadParams } from './permit2-BYv82va2.js';
+export { C as ClientEvmSigner, F as FacilitatorEvmSigner, t as toClientEvmSigner, a as toFacilitatorEvmSigner } from './signer-5OVDxViv.js';
+import '@x402/core/types';
 
 /**
- * EVM client implementation for the Exact payment scheme.
+ * Asset transfer methods for the exact EVM scheme.
+ * - eip3009: Uses transferWithAuthorization (USDC, etc.) - recommended for compatible tokens
+ * - permit2: Uses Permit2 + x402Permit2Proxy - universal fallback for any ERC-20
+ */
+type AssetTransferMethod = "eip3009" | "permit2";
+/**
+ * EIP-3009 payload for tokens with native transferWithAuthorization support.
+ */
+type ExactEIP3009Payload = {
+    signature?: `0x${string}`;
+    authorization: {
+        from: `0x${string}`;
+        to: `0x${string}`;
+        value: string;
+        validAfter: string;
+        validBefore: string;
+        nonce: `0x${string}`;
+    };
+};
+/**
+ * Permit2 witness data structure.
+ * Matches the Witness struct in x402Permit2Proxy contract.
+ * Note: Upper time bound is enforced by Permit2's `deadline` field, not a witness field.
+ */
+type Permit2Witness = {
+    to: `0x${string}`;
+    validAfter: string;
+    extra: `0x${string}`;
+};
+/**
+ * Permit2 authorization parameters.
+ * Used to reconstruct the signed message for verification.
+ */
+type Permit2Authorization = {
+    permitted: {
+        token: `0x${string}`;
+        amount: string;
+    };
+    spender: `0x${string}`;
+    nonce: string;
+    deadline: string;
+    witness: Permit2Witness;
+};
+/**
+ * Permit2 payload for tokens using the Permit2 + x402Permit2Proxy flow.
+ */
+type ExactPermit2Payload = {
+    signature: `0x${string}`;
+    permit2Authorization: Permit2Authorization & {
+        from: `0x${string}`;
+    };
+};
+type ExactEvmPayloadV1 = ExactEIP3009Payload;
+type ExactEvmPayloadV2 = ExactEIP3009Payload | ExactPermit2Payload;
+/**
+ * Type guard to check if a payload is a Permit2 payload.
+ * Permit2 payloads have a `permit2Authorization` field.
+ *
+ * @param payload - The payload to check.
+ * @returns True if the payload is a Permit2 payload, false otherwise.
+ */
+declare function isPermit2Payload(payload: ExactEvmPayloadV2): payload is ExactPermit2Payload;
+/**
+ * Type guard to check if a payload is an EIP-3009 payload.
+ * EIP-3009 payloads have an `authorization` field.
  *
+ * @param payload - The payload to check.
+ * @returns True if the payload is an EIP-3009 payload, false otherwise.
+ */
+declare function isEIP3009Payload(payload: ExactEvmPayloadV2): payload is ExactEIP3009Payload;
+
+declare const authorizationTypes: {
+    readonly TransferWithAuthorization: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validAfter";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validBefore";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }];
+};
+/**
+ * Permit2 EIP-712 types for signing PermitWitnessTransferFrom.
+ * Must match the exact format expected by the Permit2 contract.
+ * Note: Types must be in ALPHABETICAL order after the primary type (TokenPermissions < Witness).
+ */
+declare const permit2WitnessTypes: {
+    readonly PermitWitnessTransferFrom: readonly [{
+        readonly name: "permitted";
+        readonly type: "TokenPermissions";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "witness";
+        readonly type: "Witness";
+    }];
+    readonly TokenPermissions: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly Witness: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "validAfter";
+        readonly type: "uint256";
+    }, {
+        readonly name: "extra";
+        readonly type: "bytes";
+    }];
+};
+declare const eip3009ABI: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validAfter";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validBefore";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "v";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly type: "bytes32";
+    }];
+    readonly name: "transferWithAuthorization";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validAfter";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validBefore";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "signature";
+        readonly type: "bytes";
+    }];
+    readonly name: "transferWithAuthorization";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "version";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+/**
+ * Canonical Permit2 contract address.
+ * Same address on all EVM chains via CREATE2 deployment.
+ *
+ * @see https://github.com/Uniswap/permit2
+ */
+declare const PERMIT2_ADDRESS: "0x000000000022D473030F116dDEE9F6B43aC78BA3";
+/**
+ * x402ExactPermit2Proxy contract address.
+ * Vanity address: 0x4020...0001 for easy recognition.
+ * This address is deterministic based on:
+ * - Arachnid's deterministic deployer (0x4e59b44847b379578588920cA78FbF26c0B4956C)
+ * - Vanity-mined salt for prefix 0x4020 and suffix 0001
+ * - Contract bytecode + constructor args (PERMIT2_ADDRESS)
+ */
+declare const x402ExactPermit2ProxyAddress: "0x4020615294c913F045dc10f0a5cdEbd86c280001";
+/**
+ * x402UptoPermit2Proxy contract address.
+ * Vanity address: 0x4020...0002 for easy recognition.
+ * This address is deterministic based on:
+ * - Arachnid's deterministic deployer (0x4e59b44847b379578588920cA78FbF26c0B4956C)
+ * - Vanity-mined salt for prefix 0x4020 and suffix 0002
+ * - Contract bytecode + constructor args (PERMIT2_ADDRESS)
+ */
+declare const x402UptoPermit2ProxyAddress: "0x4020633461b2895a48930Ff97eE8fCdE8E520002";
+/**
+ * x402ExactPermit2Proxy ABI - settle function for exact payment scheme.
  */
-declare class ExactEvmScheme implements SchemeNetworkClient {
-    private readonly signer;
-    readonly scheme = "exact";
-    /**
-     * Creates a new ExactEvmClient instance.
-     *
-     * @param signer - The EVM signer for client operations
-     */
-    constructor(signer: ClientEvmSigner);
-    /**
-     * Creates a payment payload for the Exact scheme.
-     *
-     * @param x402Version - The x402 protocol version
-     * @param paymentRequirements - The payment requirements
-     * @returns Promise resolving to a payment payload
-     */
-    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements): Promise<Pick<PaymentPayload, "x402Version" | "payload">>;
-    /**
-     * Sign the EIP-3009 authorization using EIP-712
-     *
-     * @param authorization - The authorization to sign
-     * @param requirements - The payment requirements
-     * @returns Promise resolving to the signature
-     */
-    private signAuthorization;
-}
+declare const x402ExactPermit2ProxyABI: readonly [{
+    readonly type: "function";
+    readonly name: "PERMIT2";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "contract ISignatureTransfer";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "WITNESS_TYPEHASH";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "WITNESS_TYPE_STRING";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "initialize";
+    readonly inputs: readonly [{
+        readonly name: "_permit2";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "settle";
+    readonly inputs: readonly [{
+        readonly name: "permit";
+        readonly type: "tuple";
+        readonly internalType: "struct ISignatureTransfer.PermitTransferFrom";
+        readonly components: readonly [{
+            readonly name: "permitted";
+            readonly type: "tuple";
+            readonly internalType: "struct ISignatureTransfer.TokenPermissions";
+            readonly components: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "deadline";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }];
+    }, {
+        readonly name: "owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "witness";
+        readonly type: "tuple";
+        readonly internalType: "struct x402BasePermit2Proxy.Witness";
+        readonly components: readonly [{
+            readonly name: "to";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "validAfter";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "extra";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "signature";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "settleWithPermit";
+    readonly inputs: readonly [{
+        readonly name: "permit2612";
+        readonly type: "tuple";
+        readonly internalType: "struct x402BasePermit2Proxy.EIP2612Permit";
+        readonly components: readonly [{
+            readonly name: "value";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "deadline";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "r";
+            readonly type: "bytes32";
+            readonly internalType: "bytes32";
+        }, {
+            readonly name: "s";
+            readonly type: "bytes32";
+            readonly internalType: "bytes32";
+        }, {
+            readonly name: "v";
+            readonly type: "uint8";
+            readonly internalType: "uint8";
+        }];
+    }, {
+        readonly name: "permit";
+        readonly type: "tuple";
+        readonly internalType: "struct ISignatureTransfer.PermitTransferFrom";
+        readonly components: readonly [{
+            readonly name: "permitted";
+            readonly type: "tuple";
+            readonly internalType: "struct ISignatureTransfer.TokenPermissions";
+            readonly components: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "deadline";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }];
+    }, {
+        readonly name: "owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "witness";
+        readonly type: "tuple";
+        readonly internalType: "struct x402BasePermit2Proxy.Witness";
+        readonly components: readonly [{
+            readonly name: "to";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "validAfter";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "extra";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "signature";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "event";
+    readonly name: "Settled";
+    readonly inputs: readonly [];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SettledWithPermit";
+    readonly inputs: readonly [];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "AlreadyInitialized";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidDestination";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidOwner";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidPermit2Address";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "PaymentTooEarly";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ReentrancyGuardReentrantCall";
+    readonly inputs: readonly [];
+}];
 
-export { ClientEvmSigner, ExactEvmScheme };
+export { type AssetTransferMethod, type ExactEIP3009Payload, type ExactEvmPayloadV1, type ExactEvmPayloadV2, type ExactPermit2Payload, PERMIT2_ADDRESS, type Permit2Authorization, type Permit2Witness, authorizationTypes, eip3009ABI, isEIP3009Payload, isPermit2Payload, permit2WitnessTypes, x402ExactPermit2ProxyABI, x402ExactPermit2ProxyAddress, x402UptoPermit2ProxyAddress };