@bankofai/x402-evm 1.0.0-beta.0

package/dist/cjs/types-DIt9uAUy.d.ts

@@ -0,0 +1,180 @@
+import { TypedData } from 'viem';
+
+interface AuthorizerSigner {
+    address: `0x${string}`;
+    signTypedData(params: {
+        domain: Record<string, unknown>;
+        types: TypedData;
+        primaryType: string;
+        message: Record<string, unknown>;
+    }): Promise<`0x${string}`>;
+}
+type ChannelState = {
+    balance: bigint;
+    totalClaimed: bigint;
+    withdrawRequestedAt: number;
+    refundNonce: bigint;
+};
+type ChannelConfig = {
+    payer: `0x${string}`;
+    payerAuthorizer: `0x${string}`;
+    receiver: `0x${string}`;
+    receiverAuthorizer: `0x${string}`;
+    token: `0x${string}`;
+    withdrawDelay: number;
+    salt: `0x${string}`;
+};
+type BatchSettlementErc3009Authorization = {
+    validAfter: string;
+    validBefore: string;
+    salt: `0x${string}`;
+    signature: `0x${string}`;
+};
+type BatchSettlementPermit2Authorization = {
+    from: `0x${string}`;
+    permitted: {
+        token: `0x${string}`;
+        amount: string;
+    };
+    spender: `0x${string}`;
+    nonce: string;
+    deadline: string;
+    witness: {
+        channelId: `0x${string}`;
+    };
+    signature: `0x${string}`;
+};
+type BatchSettlementAssetTransferMethod = "eip3009" | "permit2";
+type BatchSettlementDepositAuthorization = {
+    erc3009Authorization: BatchSettlementErc3009Authorization;
+    permit2Authorization?: never;
+} | {
+    erc3009Authorization?: never;
+    permit2Authorization: BatchSettlementPermit2Authorization;
+};
+type BatchSettlementDepositPayload = {
+    type: "deposit";
+    channelConfig: ChannelConfig;
+    voucher: BatchSettlementVoucherFields;
+    deposit: {
+        amount: string;
+        authorization: BatchSettlementDepositAuthorization;
+    };
+};
+type BatchSettlementVoucherPayload = {
+    type: "voucher";
+    channelConfig: ChannelConfig;
+    voucher: BatchSettlementVoucherFields;
+};
+type BatchSettlementRefundPayload = {
+    type: "refund";
+    channelConfig: ChannelConfig;
+    voucher: BatchSettlementVoucherFields;
+    amount?: string;
+};
+type BatchSettlementVoucherFields = {
+    channelId: `0x${string}`;
+    maxClaimableAmount: string;
+    signature: `0x${string}`;
+};
+type BatchSettlementVoucherClaim = {
+    voucher: {
+        channel: ChannelConfig;
+        maxClaimableAmount: string;
+    };
+    signature: `0x${string}`;
+    totalClaimed: string;
+};
+type BatchSettlementChannelStateExtra = {
+    channelId: `0x${string}`;
+    balance: string;
+    totalClaimed: string;
+    withdrawRequestedAt: number;
+    refundNonce: string;
+    chargedCumulativeAmount?: string;
+};
+type BatchSettlementVoucherStateExtra = {
+    signedMaxClaimable?: string;
+    signature?: `0x${string}`;
+};
+type BatchSettlementPaymentRequirementsExtra = {
+    receiverAuthorizer: `0x${string}`;
+    withdrawDelay: number;
+    name: string;
+    version: string;
+    assetTransferMethod?: BatchSettlementAssetTransferMethod;
+    channelState?: BatchSettlementChannelStateExtra;
+    voucherState?: BatchSettlementVoucherStateExtra;
+};
+type FileChannelStorageOptions = {
+    /** Root directory; channels are stored under `{directory}/{client|server}/{channelId}.json`. */
+    directory: string;
+};
+type BatchSettlementPaymentResponseExtra = {
+    chargedAmount?: string;
+    channelState?: BatchSettlementChannelStateExtra;
+    voucherState?: BatchSettlementVoucherStateExtra;
+};
+type BatchSettlementClaimPayload = {
+    type: "claim";
+    claims: BatchSettlementVoucherClaim[];
+    claimAuthorizerSignature?: `0x${string}`;
+};
+type BatchSettlementSettlePayload = {
+    type: "settle";
+    receiver: `0x${string}`;
+    token: `0x${string}`;
+};
+type BatchSettlementEnrichedRefundPayload = BatchSettlementRefundPayload & {
+    amount: string;
+    refundNonce: string;
+    claims: BatchSettlementVoucherClaim[];
+    refundAuthorizerSignature?: `0x${string}`;
+    claimAuthorizerSignature?: `0x${string}`;
+};
+type BatchSettlementPayload = BatchSettlementDepositPayload | BatchSettlementVoucherPayload | BatchSettlementRefundPayload;
+type BatchSettlementFacilitatorSettlePayload = BatchSettlementDepositPayload | BatchSettlementClaimPayload | BatchSettlementSettlePayload | BatchSettlementEnrichedRefundPayload;
+/**
+ * Type guard for {@link BatchSettlementDepositPayload}.
+ *
+ * @param payload - Unknown payload to check.
+ * @returns True if `payload` is a deposit payload (carries `deposit` and `voucher`).
+ */
+declare function isBatchSettlementDepositPayload(payload: unknown): payload is BatchSettlementDepositPayload;
+/**
+ * Type guard for {@link BatchSettlementVoucherPayload}.
+ *
+ * @param payload - Unknown payload to check.
+ * @returns True if `payload` is a voucher payload with channel and signature fields.
+ */
+declare function isBatchSettlementVoucherPayload(payload: unknown): payload is BatchSettlementVoucherPayload;
+/**
+ * Type guard for {@link BatchSettlementRefundPayload}.
+ *
+ * @param payload - Unknown payload to check.
+ * @returns True if `payload` is a refund payload with channel config and voucher fields.
+ */
+declare function isBatchSettlementRefundPayload(payload: unknown): payload is BatchSettlementRefundPayload;
+/**
+ * Type guard for {@link BatchSettlementClaimPayload}.
+ *
+ * @param payload - Unknown payload to check.
+ * @returns True if `payload` is a settle-action `claimWithSignature` payload.
+ */
+declare function isBatchSettlementClaimPayload(payload: unknown): payload is BatchSettlementClaimPayload;
+/**
+ * Type guard for {@link BatchSettlementSettlePayload}.
+ *
+ * @param payload - Unknown payload to check.
+ * @returns True if `payload` is a settle-action `settle` payload.
+ */
+declare function isBatchSettlementSettlePayload(payload: unknown): payload is BatchSettlementSettlePayload;
+/**
+ * Type guard for {@link BatchSettlementEnrichedRefundPayload}.
+ *
+ * @param payload - Unknown payload to check.
+ * @returns True if `payload` is a settle-action `refundWithSignature` payload.
+ */
+declare function isBatchSettlementEnrichedRefundPayload(payload: unknown): payload is BatchSettlementEnrichedRefundPayload;
+
+export { type AuthorizerSigner as A, type BatchSettlementVoucherClaim as B, type ChannelConfig as C, type FileChannelStorageOptions as F, type BatchSettlementVoucherFields as a, type BatchSettlementChannelStateExtra as b, type BatchSettlementVoucherStateExtra as c, type ChannelState as d, type BatchSettlementDepositPayload as e, type BatchSettlementVoucherPayload as f, type BatchSettlementRefundPayload as g, type BatchSettlementErc3009Authorization as h, type BatchSettlementClaimPayload as i, type BatchSettlementEnrichedRefundPayload as j, type BatchSettlementPayload as k, type BatchSettlementSettlePayload as l, type BatchSettlementFacilitatorSettlePayload as m, type BatchSettlementPaymentRequirementsExtra as n, type BatchSettlementPaymentResponseExtra as o, isBatchSettlementDepositPayload as p, isBatchSettlementVoucherPayload as q, isBatchSettlementRefundPayload as r, isBatchSettlementClaimPayload as s, isBatchSettlementSettlePayload as t, isBatchSettlementEnrichedRefundPayload as u };

package/dist/cjs/upto/client/index.d.ts

@@ -0,0 +1,34 @@
+import { SchemeNetworkClient, PaymentRequirements, PaymentPayloadContext, PaymentPayloadResult } from '@bankofai/x402-core/types';
+import { C as ClientEvmSigner } from '../../signer-BFelv8DL.js';
+import { c as EvmSchemeOptions } from '../../rpc-DULZzRne.js';
+export { d as UptoEvmSchemeConfig, e as UptoEvmSchemeConfigByChainId } from '../../rpc-DULZzRne.js';
+export { P as Permit2AllowanceParams, c as createPermit2ApprovalTx, e as erc20AllowanceAbi, g as getPermit2AllowanceReadParams } from '../../permit2-DhJRUcgY.js';
+import 'viem';
+
+/**
+ * EVM client implementation for the Upto payment scheme.
+ * Handles Permit2-based payment payload creation and gas-sponsoring extensions.
+ */
+declare class UptoEvmScheme implements SchemeNetworkClient {
+    private readonly signer;
+    private readonly options?;
+    readonly scheme = "upto";
+    /**
+     * Creates a new UptoEvmScheme instance.
+     *
+     * @param signer - The EVM signer for client operations
+     * @param options - Optional RPC configuration
+     */
+    constructor(signer: ClientEvmSigner, options?: EvmSchemeOptions | undefined);
+    /**
+     * Creates a payment payload for the Upto scheme using Permit2.
+     *
+     * @param x402Version - The x402 protocol version
+     * @param paymentRequirements - The payment requirements
+     * @param context - Optional context with server-declared extensions
+     * @returns Promise resolving to a payment payload result
+     */
+    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements, context?: PaymentPayloadContext): Promise<PaymentPayloadResult>;
+}
+
+export { UptoEvmScheme, EvmSchemeOptions as UptoEvmSchemeOptions };