@okxweb3/app-x402-core 0.1.2 → 0.2.0

package/dist/esm/index-DKbqlTu_.d.mts

@@ -0,0 +1,713 @@
+import { u as Subscription, v as SubscriptionCapability, w as ChargeResult, C as CancelAuth, a as PaymentRequirements, P as PaymentPayload, A as AccessProof, x as CancelInitiator, y as PlanInitialCharge, z as AccessRouteRequirements, m as FacilitatorCancelData, o as FacilitatorCancelPendingData, l as FacilitatorChangeData, p as FacilitatorChargeData, B as FacilitatorChargeRow, j as FacilitatorEnvelope, q as FacilitatorFinalizeExpiredData, r as FacilitatorGetChargesData, t as FacilitatorGetSubscriptionData, s as FacilitatorPendingChangeRow, k as FacilitatorSubscribeData, O as OnBeforeAccessContext, D as OnBeforeAccessHook, E as OnBeforeAccessResult, n as PendingChangeCancelAuth, G as PendingPlanChange, I as PlanCatalog, J as PlanCatalogEntry, K as SettleCancelOk, L as SettleCancelPendingChangeOk, M as SettleCancelPendingChangeResult, Q as SettleCancelResult, R as SettleChangeOk, T as SettleChangeResult, U as SettleResultFail, W as SettleSubscribeOk, X as SettleSubscribeResult, Y as SubscriptionFacilitatorClient, Z as SubscriptionState, _ as VerifyAccessOk, $ as VerifyAccessResult, a0 as VerifyChangeOk, a1 as VerifyChangeResult, a2 as VerifyOwnershipOk, a3 as VerifyOwnershipResult, a4 as VerifyResult, a5 as VerifyResultFail, a6 as VerifyResultOk, a7 as hasSubscriptionCapability, a8 as supportsSubscription } from './mechanisms-LhI9qkRo.mjs';
+import { Hex, TypedDataDomain } from 'viem';
+
+/**
+ * Canonical facilitator error reasons. The SDK uses these literal strings
+ * verbatim in verify / settle / charge return values so seller code can
+ * switch on a single set of codes regardless of whether the rejection
+ * originated in the SDK pre-check or in the facilitator response.
+ */
+declare const ErrorCode: {
+    readonly TermsBindingInvalid: "terms_binding_invalid";
+    readonly AllowanceInsufficient: "allowance_insufficient";
+    readonly AllowanceExpired: "allowance_expired";
+    readonly PeriodNotDue: "period_not_due";
+    readonly InsufficientBalance: "insufficient_balance";
+    readonly SubscriptionNotActive: "subscription_not_active";
+    /**
+     * SDK-local code. Surfaced by `verifyAccess` when local period math
+     * yields `currentCalculatePeriod === 0` — subscription exists but
+     * `nowSec < startAt`, i.e. has not yet entered its first chargeable
+     * period.
+     */
+    readonly SubscriptionNotYetActive: "subscription_not_yet_active";
+    readonly UnauthorizedCaller: "unauthorized_caller";
+    readonly CancelSignatureInvalid: "cancel_signature_invalid";
+    readonly CancelNonceUsed: "cancel_nonce_used";
+    readonly TierSame: "tier_same";
+    readonly ChangeEffectiveAtMismatch: "change_effective_at_mismatch";
+    readonly MerchantMismatch: "merchant_mismatch";
+    readonly PayerMismatch: "payer_mismatch";
+    readonly PendingChangeExists: "pending_change_exists";
+    readonly SubNotActiveForChange: "sub_not_active_for_change";
+    readonly NoPendingChange: "no_pending_change";
+    readonly ConfirmationTimeout: "confirmation_timeout";
+};
+type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+/**
+ * Charge-flow subset of ErrorCode. Seller scheduler switches on these 6
+ * codes.
+ */
+declare const ChargeErrorCode: {
+    readonly PeriodNotDue: "period_not_due";
+    readonly SubscriptionNotActive: "subscription_not_active";
+    readonly InsufficientBalance: "insufficient_balance";
+    readonly AllowanceExpired: "allowance_expired";
+    readonly UnauthorizedCaller: "unauthorized_caller";
+    readonly ConfirmationTimeout: "confirmation_timeout";
+};
+type ChargeErrorCode = (typeof ChargeErrorCode)[keyof typeof ChargeErrorCode];
+declare class ChargeError extends Error {
+    readonly code: ChargeErrorCode;
+    readonly subId: string;
+    readonly txHash?: string;
+    constructor(code: ChargeErrorCode, subId: string, txHash?: string);
+}
+
+/**
+ * Persistence abstraction for subscription state.
+ *
+ * Intentionally minimal — every state transition is performed by `put`-ing
+ * the full Subscription object, and every lookup is by `subId`. Address /
+ * payer-indexed queries are deliberately NOT part of this contract: the
+ * seller's own data model should own that (e.g. by mapping wallet →
+ * subId(s) in its user table), keeping the SDK store free of any secondary
+ * index requirement.
+ */
+interface SubscriptionStore {
+    get(subId: string): Promise<Subscription | null>;
+    put(sub: Subscription): Promise<void>;
+    delete(subId: string): Promise<void>;
+}
+/**
+ * In-memory reference implementation. Suitable for development / unit tests /
+ * single-process demos only — multi-process deployments must replace this
+ * with a shared persistent backend.
+ */
+declare class InMemoryStore implements SubscriptionStore {
+    private readonly data;
+    get(subId: string): Promise<Subscription | null>;
+    put(sub: Subscription): Promise<void>;
+    delete(subId: string): Promise<void>;
+    /**
+     * Return all subscriptions, ordered by `startAt` ascending. Not part of
+     * the SubscriptionStore interface — admin/debug helper, not used by the
+     * scheme. Production backends should expose paginated equivalents.
+     */
+    list(): Promise<Subscription[]>;
+}
+
+interface SubscriptionClientConfig {
+    /**
+     * The scheme instance to delegate facilitator-touching operations to.
+     * Typically the same `PermitSubscriptionScheme` instance that is registered
+     * to `x402ResourceServer`, so HTTP main-line state and out-of-band charge
+     * state share one source of truth.
+     */
+    scheme: SubscriptionCapability;
+    /**
+     * The store the scheme writes to. Required here because `getSubscription`
+     * reads from the store (fast path) while `syncFromChain` writes to it after
+     * re-fetching from chain.
+     */
+    store: SubscriptionStore;
+}
+/**
+ * Out-of-band primitives for Seller scheduler / business code. SDK ships the
+ * per-call atoms (charge / cancelBySeller / syncFromChain / etc.) but NOT a
+ * scheduler — cron, due index, retry policy, distributed locks are all
+ * Seller infrastructure.
+ *
+ * All methods are thin wrappers:
+ *   - `charge`           delegates to scheme.charge (throws ChargeError on fail)
+ *   - `cancelBySeller`   delegates to scheme.settleCancel with a Seller-built
+ *                        CancelAuth
+ *   - `syncFromChain`    re-pulls Subscription via scheme.getSubscription and
+ *                        repairs the store; connects with the `state==="changed"`
+ *                        chain to also sync the downstream new sub
+ *   - `getSubscription`  direct store read (does NOT touch the chain)
+ */
+declare class SubscriptionClient {
+    protected readonly scheme: SubscriptionCapability;
+    protected readonly store: SubscriptionStore;
+    constructor(config: SubscriptionClientConfig);
+    /**
+     * Run one charge period for a subscription. Throws `ChargeError` (one of 6
+     * codes) on facilitator-side failure. Internally `scheme.charge` already
+     * updates the store on success (and on `planChangeTriggered`); the client is
+     * a pass-through.
+     */
+    charge(subId: string): Promise<ChargeResult>;
+    /**
+     * Seller-initiated cancel (e.g. ToS violation, fraud, business reason).
+     *
+     * The SDK does NOT hold the Seller's merchant private key; the Seller must
+     * construct + sign a `CancelAuth` with `by=1 (MERCHANT)` outside and pass
+     * it in. SDK runs verifyCancel (sanity check on the auth) then settleCancel
+     * (facilitator + store mark canceled).
+     *
+     * Throws on either verify or settle failure.
+     */
+    cancelBySeller(subId: string, auth: CancelAuth, _reason?: string): Promise<void>;
+    /**
+     * Re-sync a subscription from chain and repair the store. Use when:
+     *   - `charge` threw `SubscriptionNotActive` (buyer may have cancelled
+     *     directly via the facilitator or contract)
+     *   - `charge` threw `ConfirmationTimeout` (network-level failure; chain
+     *     may or may not have written)
+     *   - periodic reconciliation
+     *
+     * If the synced sub is in `"changed"` state, the downstream `changedToSubId`
+     * is also fetched and persisted, so the Seller's `dueIndex` can switch over
+     * to the new sub without manual intervention.
+     */
+    syncFromChain(subId: string): Promise<Subscription | null>;
+    /**
+     * Direct store read. Cheap; does NOT touch the chain. Use this for hot-path
+     * lookups (e.g. resolving subId to plan/tier for business logic). For chain
+     * state of record, use `syncFromChain`.
+     */
+    getSubscription(subId: string): Promise<Subscription | null>;
+}
+
+/**
+ * Permit2 PermitSingle (AllowanceTransfer) — what the buyer signs to authorize
+ * the subscription contract to pull tokens on every charge.
+ *
+ *   PermitSingle(PermitDetails details, address spender, uint256 sigDeadline)
+ *   PermitDetails(address token, uint160 amount, uint48 expiration, uint48 nonce)
+ */
+interface PermitSingleData {
+    details: {
+        token: string;
+        /** uint160 as decimal string — covers entire remaining commitment. */
+        amount: string;
+        /** uint48 unix seconds — Permit2 allowance expiration. */
+        expiration: number;
+        /** uint48 — Permit2 nonce (current value from allowance-status, NOT +1). */
+        nonce: number;
+    };
+    /** Subscription contract address. */
+    spender: string;
+    /** uint256 as decimal string — outer signature expiry. */
+    sigDeadline: string;
+}
+/**
+ * SubscriptionTerms — what the buyer's EIP-712 signature commits to. 17
+ * fields. Field ORDER MATTERS because it determines the EIP-712 TypeHash:
+ *   0xa5223de56e7694cf776c7d4f74c0323f42bf9e65655fe49affefbdfd40ec97ae
+ */
+interface SubscriptionTerms {
+    payer: string;
+    merchant: string;
+    facilitator: string;
+    token: string;
+    /** uint160 (atomic units). */
+    amountPerPeriod: string;
+    /** uint64 seconds; MUST be 0 when periodMode=1 (calendar_month). */
+    periodSec: number;
+    /** uint32. */
+    maxPeriods: number;
+    /** uint64 unix seconds; 0 means "use block.timestamp on-chain". */
+    startAt: number;
+    /** uint32; 0 = no separate initial charge. */
+    initialChargePeriods: number;
+    /** uint160; atomic units. */
+    initialChargeAmount: string;
+    /** uint64 unix seconds — terms signature validity window. */
+    termsDeadline: number;
+    /** bytes32 — keccak256 of the PermitSingle EIP-712 struct hash, binds terms to permit. */
+    permitHash: Hex;
+    /** bytes32 — buyer-generated random anti-replay value. */
+    salt: Hex;
+    /** uint8 (>0) — plan tier for upgrade/downgrade comparison. */
+    planTier: number;
+    /** bytes32 — old subId on change, zero on create. */
+    changeFromSubId: Hex;
+    /** uint8 — 0 none(create) / 1 immediate(upgrade) / 2 period_end(downgrade). */
+    changeEffectiveAt: number;
+    /** uint8 — 0 fixed_seconds / 1 calendar_month. */
+    periodMode: number;
+    /**
+     * bytes32 — keccak256(utf8(plan.id)). Buyer SDKs sign it as a terms field
+     * and the facilitator persists it as the on-chain `planId`. Seller verify
+     * MUST cross-check this hash equals `keccak256(utf8(accepted.extra.plan.id))`
+     * to defeat plan-spoof attacks.
+     */
+    planId?: Hex;
+}
+/**
+ * Concrete payload nested inside `PaymentPayload.payload` for the `period`
+ * scheme.
+ */
+interface SubscriptionPaymentInner {
+    permitSingle: PermitSingleData;
+    permitSingleSignature: Hex;
+    terms: SubscriptionTerms;
+    termsSignature: Hex;
+}
+interface EncodePaymentPayloadInput {
+    selected: PaymentRequirements;
+    permitSingle: PermitSingleData;
+    permitSingleSignature: Hex;
+    terms: SubscriptionTerms;
+    termsSignature: Hex;
+}
+/**
+ * Decode the `APP-PAYMENT-REQUIRED` header into the underlying
+ * `PaymentRequired.accepts` array. Throws on invalid base64 / JSON.
+ */
+declare function parsePaymentRequired(headerValue: string): PaymentRequirements[];
+/**
+ * Build the `PAYMENT-SIGNATURE` header value (base64-encoded JSON). Buyer side.
+ */
+declare function encodePaymentPayload(input: EncodePaymentPayloadInput): string;
+/**
+ * Decode the `PAYMENT-SIGNATURE` header value back into a typed PaymentPayload.
+ * Throws on invalid base64 / JSON; does not validate field shapes (that is the
+ * responsibility of the scheme verify step).
+ */
+declare function decodePaymentPayload(headerValue: string): PaymentPayload;
+/**
+ * Narrow a generic PaymentPayload's `.payload` to the subscription inner.
+ * Throws if required fields are missing — single chokepoint between base64
+ * decode and verify.
+ */
+declare function asSubscriptionPaymentInner(payload: PaymentPayload): SubscriptionPaymentInner;
+
+/**
+ * Verify that buyer-signed `terms` bind to the server-advertised
+ * PaymentRequirements. Without this field-by-field check a buyer could sign
+ * a basic-tier accepted but submit terms claiming enterprise-tier access at
+ * basic price. The contract verifies the signature but cannot see what the
+ * seller offered in 402 — only the SDK can enforce this binding.
+ *
+ * All mismatches collapse to `terms_binding_invalid` so the caller's switch
+ * statement stays compact.
+ *
+ * Returns `null` on match, an `ErrorCode` on first mismatch.
+ */
+declare function verifyTermsBindRequirements(terms: SubscriptionTerms, requirements: PaymentRequirements): ErrorCode | null;
+
+/**
+ * Local mirror of the facilitator's elapsed-period math. Used by
+ * `verifyAccess` to decide whether `lastChargedPeriod` is current without
+ * hitting the facilitator on every request — only when the local
+ * computation says we're behind does the SDK fall through to a GET /detail
+ * refresh.
+ *
+ * MUST stay bit-for-bit equivalent to the backend implementation. Returns
+ * `0` when the subscription has not yet started — caller treats this as a
+ * special "pre-start" state.
+ */
+/**
+ * Compute the real elapsed period count at `nowSec`, NOT clamped to
+ * `maxPeriods`. Period 1 is the first chargeable period; `0` means
+ * pre-start (subscription not yet effective).
+ */
+declare function computeElapsedPeriods(periodMode: number, startAt: number, billingAnchorAt: number, periodSec: number, nowSec: number): number;
+/**
+ * Number of calendar-month boundaries crossed between `anchorSec` (exclusive)
+ * and `tsSec` (inclusive). Each boundary is `addCalendarMonths(anchor, n)`
+ * for n=1,2,…, with month-end truncation (1/31 + 1m → 2/28/29).
+ */
+declare function elapsedCalendarMonths(anchorSec: number, tsSec: number): number;
+/**
+ * Add `n` calendar months to `anchorSec`, keeping the anchor's day-of-month
+ * but truncating to month-end when overflowing (1/31 + 1m → 2/28 or 2/29).
+ * Returned timestamp preserves the anchor's hour / minute / second / ms in UTC.
+ */
+declare function addCalendarMonths(anchorSec: number, n: number): number;
+
+/**
+ * Isomorphic UTF-8 ↔ base64 helpers.
+ *
+ * Buyers may run this code in a browser; Buffer is preferred on Node so the
+ * built CJS bundle stays free of `globalThis.atob` polyfills, but we fall back
+ * to atob/btoa when Buffer is unavailable.
+ */
+declare function base64EncodeUtf8(value: string): string;
+declare function base64DecodeUtf8(value: string): string;
+
+interface AccessProofMessageInput {
+    subId: Hex;
+    payer: Hex;
+    timestamp: number;
+}
+/**
+ * Returns the inner 32-byte hash that wallets sign via EIP-191 personal_sign.
+ *
+ * Layout:
+ *   inner = keccak256(abi.encodePacked(bytes32 subId, address payer, uint256 timestamp))
+ *
+ * `timestamp` is encoded as `uint256` (32 bytes). Switching to anything
+ * narrower yields a different digest and silently produces
+ * `signature_invalid` on every access call.
+ *
+ * IMPORTANT: callers must NOT prepend the EIP-191 envelope themselves —
+ * `wallet.signMessage(buildAccessProofMessage(...))` will add the
+ * `\x19Ethereum Signed Message:\n32` prefix automatically. The recover step on
+ * the server must mirror this (verify EIP-191 signature, not raw keccak).
+ */
+declare function buildAccessProofMessage(input: AccessProofMessageInput): Hex;
+declare function encodeAccessProof(proof: AccessProof): string;
+declare function decodeAccessProof(headerValue: string): AccessProof;
+
+/** 32-byte zero hash, used as the sentinel for empty bytes32 fields. */
+declare const ZERO_BYTES32: Hex;
+/**
+ * Permit2 PermitSingle (AllowanceTransfer) EIP-712 schema. Used for the
+ * continuous-pull authorization signed by the buyer. The Permit2 domain has
+ * NO `version` field — only `name="Permit2"`, `chainId`, `verifyingContract`.
+ */
+declare const PERMIT2_TYPES: {
+    readonly PermitSingle: readonly [{
+        readonly name: "details";
+        readonly type: "PermitDetails";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "sigDeadline";
+        readonly type: "uint256";
+    }];
+    readonly PermitDetails: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint160";
+    }, {
+        readonly name: "expiration";
+        readonly type: "uint48";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint48";
+    }];
+};
+/**
+ * SubscriptionTerms EIP-712 schema. 17 fields; field ORDER + integer widths
+ * must mirror the contract. TypeHash:
+ *   0xa5223de56e7694cf776c7d4f74c0323f42bf9e65655fe49affefbdfd40ec97ae
+ * (verify against contract `SUBSCRIPTION_TERMS_TYPEHASH()`)
+ */
+declare const SUBSCRIPTION_TERMS_TYPES: {
+    readonly SubscriptionTerms: readonly [{
+        readonly name: "payer";
+        readonly type: "address";
+    }, {
+        readonly name: "merchant";
+        readonly type: "address";
+    }, {
+        readonly name: "facilitator";
+        readonly type: "address";
+    }, {
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "amountPerPeriod";
+        readonly type: "uint160";
+    }, {
+        readonly name: "periodSec";
+        readonly type: "uint64";
+    }, {
+        readonly name: "maxPeriods";
+        readonly type: "uint32";
+    }, {
+        readonly name: "startAt";
+        readonly type: "uint64";
+    }, {
+        readonly name: "initialChargePeriods";
+        readonly type: "uint32";
+    }, {
+        readonly name: "initialChargeAmount";
+        readonly type: "uint160";
+    }, {
+        readonly name: "termsDeadline";
+        readonly type: "uint64";
+    }, {
+        readonly name: "permitHash";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "salt";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "planTier";
+        readonly type: "uint8";
+    }, {
+        readonly name: "changeFromSubId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "changeEffectiveAt";
+        readonly type: "uint8";
+    }, {
+        readonly name: "periodMode";
+        readonly type: "uint8";
+    }];
+};
+/**
+ * CancelAuth EIP-712 schema (subscription contract domain):
+ *   `CancelAuth(uint8 action, bytes32 subId, uint8 initiator, bytes32 nonce, uint64 deadline)`
+ */
+declare const CANCEL_AUTH_TYPES: {
+    readonly CancelAuth: readonly [{
+        readonly name: "action";
+        readonly type: "uint8";
+    }, {
+        readonly name: "subId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "initiator";
+        readonly type: "uint8";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint64";
+    }];
+};
+/**
+ * PendingChangeCancelAuth EIP-712 schema (subscription contract domain):
+ *   `PendingChangeCancelAuth(bytes32 subId, bytes32 newSubId, bytes32 nonce, uint64 deadline)`
+ */
+declare const PENDING_CHANGE_CANCEL_AUTH_TYPES: {
+    readonly PendingChangeCancelAuth: readonly [{
+        readonly name: "subId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "newSubId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint64";
+    }];
+};
+interface SubscriptionPlanExtra {
+    id: string;
+    tier: number;
+    name?: string;
+}
+/**
+ * Buyer's intent to switch from `fromSubId` to a new plan. Present on
+ * PaymentRequirements.extra ONLY when the requirements are a change offer
+ * for an upgrade/downgrade.
+ */
+interface ChangeFromExtra {
+    fromSubId: Hex;
+    fromPlanId: Hex;
+    fromPlanTier: number;
+    direction: "upgrade" | "downgrade";
+    effectiveAt: "immediate" | "period_end";
+}
+interface SubscriptionContractAddresses {
+    subscription: string;
+    permit2: string;
+}
+/**
+ * Typed view of the `extra` field on subscription PaymentRequirements. The
+ * evm scheme is responsible for producing PaymentRequirements whose `extra`
+ * matches this shape; codec helpers consume it via this type rather than
+ * Record<string, unknown> to keep field access type-safe.
+ *
+ * Index signature lets this be assigned directly to
+ * `PaymentRequirements.extra: Record<string, unknown>` without a cast.
+ */
+interface SubscriptionRequirementsExtra {
+    contracts: SubscriptionContractAddresses;
+    facilitator: string;
+    amountPerPeriod: string;
+    periodSec: number;
+    /** uint8 — 0 fixed_seconds (default) / 1 calendar_month. */
+    periodMode?: number;
+    maxPeriods: number;
+    startAt?: number;
+    initialCharge?: PlanInitialCharge | null;
+    plan: SubscriptionPlanExtra;
+    changeFrom?: ChangeFromExtra;
+    domain: TypedDataDomain;
+    [key: string]: unknown;
+}
+interface TypedDataEnvelope<TPrimary extends string, TMessage> {
+    domain: TypedDataDomain;
+    types: Record<string, ReadonlyArray<{
+        name: string;
+        type: string;
+    }>>;
+    primaryType: TPrimary;
+    message: TMessage;
+}
+interface BuildPermit2TypedDataInput {
+    /** PaymentRequirements with subscription `extra`. */
+    selected: PaymentRequirements;
+    /** uint48 — current nonce from allowance-status (NOT +1). */
+    nonce: number;
+    /** uint48 unix seconds — Permit2 allowance expiration. */
+    expiration: number;
+    /** uint256 decimal — outer signature expiry. */
+    sigDeadline: string;
+    /** Override amount; default = initialChargeAmount + (maxPeriods - initialChargePeriods) * amountPerPeriod. */
+    amount?: string;
+}
+interface BuildSubscriptionTermsTypedDataInput {
+    selected: PaymentRequirements;
+    payer: string;
+    startAt: number;
+    /** uint64 unix seconds — terms signature validity. */
+    termsDeadline: number;
+    /** bytes32 — random anti-replay; reuse the same hex string ≤ once. */
+    salt: Hex;
+    /** bytes32 — keccak256 of the PermitSingle struct hash; bind permit. */
+    permitHash: Hex;
+    changeFrom?: ChangeFromExtra;
+    /** Override domain for special cases; defaults to `selected.extra.domain`. */
+    domain?: TypedDataDomain;
+}
+interface BuildCancelAuthTypedDataInput {
+    subId: Hex;
+    initiator: CancelInitiator;
+    /** uint64 unix seconds. */
+    deadline: number;
+    /** bytes32. */
+    nonce: Hex;
+    domain: TypedDataDomain;
+}
+interface BuildPendingChangeCancelAuthTypedDataInput {
+    subId: Hex;
+    /** The pending change's target newSubId — must match `pendingPlanChange.newSubId`. */
+    newSubId: Hex;
+    deadline: number;
+    nonce: Hex;
+    domain: TypedDataDomain;
+}
+/**
+ * Build the Permit2 PermitSingle (AllowanceTransfer) typed data the wallet
+ * signs. `spender = subscription contract`; `amount` covers the entire
+ * remaining commitment (default), so the subscription contract can pull from
+ * the same Permit2 allowance on every charge without re-signing.
+ *
+ * Permit2's EIP-712 domain has NO `version` field.
+ */
+declare function buildPermit2TypedData(input: BuildPermit2TypedDataInput): TypedDataEnvelope<"PermitSingle", Record<string, unknown>>;
+/**
+ * Compute the EIP-712 struct hash of a PermitSingle message — what
+ * `terms.permitHash` must equal byte-for-byte. The facilitator verifies this
+ * via `permit_hash_mismatch`.
+ *
+ *   permitDetailsHash = keccak256(
+ *     PERMIT_DETAILS_TYPEHASH ‖ token ‖ amount ‖ expiration ‖ nonce
+ *   )
+ *   permitSingleHash  = keccak256(
+ *     PERMIT_SINGLE_TYPEHASH ‖ permitDetailsHash ‖ spender ‖ sigDeadline
+ *   )
+ */
+declare function computePermitSingleStructHash(permit: PermitSingleData): Hex;
+/**
+ * Build the EIP-712 typed-data object the wallet signs to commit to the
+ * subscription terms (17 fields). `permitHash` MUST be the struct hash of
+ * the PermitSingle the buyer signed for permit2 (compute it via
+ * `computePermitSingleStructHash`) — the contract verifies this binding to
+ * defeat detached-signature swap attacks.
+ */
+declare function buildSubscriptionTermsTypedData(input: BuildSubscriptionTermsTypedDataInput): TypedDataEnvelope<"SubscriptionTerms", SubscriptionTerms>;
+declare function buildCancelAuthTypedData(input: BuildCancelAuthTypedDataInput): TypedDataEnvelope<"CancelAuth", Record<string, unknown>>;
+declare function buildPendingChangeCancelAuthTypedData(input: BuildPendingChangeCancelAuthTypedDataInput): TypedDataEnvelope<"PendingChangeCancelAuth", Record<string, unknown>>;
+/**
+ * Parse the chainId from a CAIP-2 network identifier (`eip155:<chainId>`).
+ * Throws if not an EVM CAIP — the subscription scheme is EVM-only.
+ */
+declare function parseChainIdFromNetwork(network: string): number;
+
+declare const ___subscription_AccessProof: typeof AccessProof;
+type ___subscription_AccessProofMessageInput = AccessProofMessageInput;
+declare const ___subscription_AccessRouteRequirements: typeof AccessRouteRequirements;
+type ___subscription_BuildCancelAuthTypedDataInput = BuildCancelAuthTypedDataInput;
+type ___subscription_BuildPermit2TypedDataInput = BuildPermit2TypedDataInput;
+type ___subscription_BuildSubscriptionTermsTypedDataInput = BuildSubscriptionTermsTypedDataInput;
+declare const ___subscription_CANCEL_AUTH_TYPES: typeof CANCEL_AUTH_TYPES;
+declare const ___subscription_CancelAuth: typeof CancelAuth;
+declare const ___subscription_CancelInitiator: typeof CancelInitiator;
+type ___subscription_ChangeFromExtra = ChangeFromExtra;
+type ___subscription_ChargeError = ChargeError;
+declare const ___subscription_ChargeError: typeof ChargeError;
+type ___subscription_ChargeErrorCode = ChargeErrorCode;
+declare const ___subscription_ChargeResult: typeof ChargeResult;
+type ___subscription_EncodePaymentPayloadInput = EncodePaymentPayloadInput;
+type ___subscription_ErrorCode = ErrorCode;
+declare const ___subscription_FacilitatorCancelData: typeof FacilitatorCancelData;
+declare const ___subscription_FacilitatorCancelPendingData: typeof FacilitatorCancelPendingData;
+declare const ___subscription_FacilitatorChangeData: typeof FacilitatorChangeData;
+declare const ___subscription_FacilitatorChargeData: typeof FacilitatorChargeData;
+declare const ___subscription_FacilitatorChargeRow: typeof FacilitatorChargeRow;
+declare const ___subscription_FacilitatorEnvelope: typeof FacilitatorEnvelope;
+declare const ___subscription_FacilitatorFinalizeExpiredData: typeof FacilitatorFinalizeExpiredData;
+declare const ___subscription_FacilitatorGetChargesData: typeof FacilitatorGetChargesData;
+declare const ___subscription_FacilitatorGetSubscriptionData: typeof FacilitatorGetSubscriptionData;
+declare const ___subscription_FacilitatorPendingChangeRow: typeof FacilitatorPendingChangeRow;
+declare const ___subscription_FacilitatorSubscribeData: typeof FacilitatorSubscribeData;
+type ___subscription_InMemoryStore = InMemoryStore;
+declare const ___subscription_InMemoryStore: typeof InMemoryStore;
+declare const ___subscription_OnBeforeAccessContext: typeof OnBeforeAccessContext;
+declare const ___subscription_OnBeforeAccessHook: typeof OnBeforeAccessHook;
+declare const ___subscription_OnBeforeAccessResult: typeof OnBeforeAccessResult;
+declare const ___subscription_PENDING_CHANGE_CANCEL_AUTH_TYPES: typeof PENDING_CHANGE_CANCEL_AUTH_TYPES;
+declare const ___subscription_PERMIT2_TYPES: typeof PERMIT2_TYPES;
+declare const ___subscription_PendingChangeCancelAuth: typeof PendingChangeCancelAuth;
+declare const ___subscription_PendingPlanChange: typeof PendingPlanChange;
+type ___subscription_PermitSingleData = PermitSingleData;
+declare const ___subscription_PlanCatalog: typeof PlanCatalog;
+declare const ___subscription_PlanCatalogEntry: typeof PlanCatalogEntry;
+declare const ___subscription_PlanInitialCharge: typeof PlanInitialCharge;
+declare const ___subscription_SUBSCRIPTION_TERMS_TYPES: typeof SUBSCRIPTION_TERMS_TYPES;
+declare const ___subscription_SettleCancelOk: typeof SettleCancelOk;
+declare const ___subscription_SettleCancelPendingChangeOk: typeof SettleCancelPendingChangeOk;
+declare const ___subscription_SettleCancelPendingChangeResult: typeof SettleCancelPendingChangeResult;
+declare const ___subscription_SettleCancelResult: typeof SettleCancelResult;
+declare const ___subscription_SettleChangeOk: typeof SettleChangeOk;
+declare const ___subscription_SettleChangeResult: typeof SettleChangeResult;
+declare const ___subscription_SettleResultFail: typeof SettleResultFail;
+declare const ___subscription_SettleSubscribeOk: typeof SettleSubscribeOk;
+declare const ___subscription_SettleSubscribeResult: typeof SettleSubscribeResult;
+declare const ___subscription_Subscription: typeof Subscription;
+declare const ___subscription_SubscriptionCapability: typeof SubscriptionCapability;
+type ___subscription_SubscriptionClient = SubscriptionClient;
+declare const ___subscription_SubscriptionClient: typeof SubscriptionClient;
+type ___subscription_SubscriptionClientConfig = SubscriptionClientConfig;
+type ___subscription_SubscriptionContractAddresses = SubscriptionContractAddresses;
+declare const ___subscription_SubscriptionFacilitatorClient: typeof SubscriptionFacilitatorClient;
+type ___subscription_SubscriptionPaymentInner = SubscriptionPaymentInner;
+type ___subscription_SubscriptionPlanExtra = SubscriptionPlanExtra;
+type ___subscription_SubscriptionRequirementsExtra = SubscriptionRequirementsExtra;
+declare const ___subscription_SubscriptionState: typeof SubscriptionState;
+type ___subscription_SubscriptionStore = SubscriptionStore;
+type ___subscription_SubscriptionTerms = SubscriptionTerms;
+type ___subscription_TypedDataEnvelope<TPrimary extends string, TMessage> = TypedDataEnvelope<TPrimary, TMessage>;
+declare const ___subscription_VerifyAccessOk: typeof VerifyAccessOk;
+declare const ___subscription_VerifyAccessResult: typeof VerifyAccessResult;
+declare const ___subscription_VerifyChangeOk: typeof VerifyChangeOk;
+declare const ___subscription_VerifyChangeResult: typeof VerifyChangeResult;
+declare const ___subscription_VerifyOwnershipOk: typeof VerifyOwnershipOk;
+declare const ___subscription_VerifyOwnershipResult: typeof VerifyOwnershipResult;
+declare const ___subscription_VerifyResult: typeof VerifyResult;
+declare const ___subscription_VerifyResultFail: typeof VerifyResultFail;
+declare const ___subscription_VerifyResultOk: typeof VerifyResultOk;
+declare const ___subscription_ZERO_BYTES32: typeof ZERO_BYTES32;
+declare const ___subscription_addCalendarMonths: typeof addCalendarMonths;
+declare const ___subscription_asSubscriptionPaymentInner: typeof asSubscriptionPaymentInner;
+declare const ___subscription_base64DecodeUtf8: typeof base64DecodeUtf8;
+declare const ___subscription_base64EncodeUtf8: typeof base64EncodeUtf8;
+declare const ___subscription_buildAccessProofMessage: typeof buildAccessProofMessage;
+declare const ___subscription_buildCancelAuthTypedData: typeof buildCancelAuthTypedData;
+declare const ___subscription_buildPendingChangeCancelAuthTypedData: typeof buildPendingChangeCancelAuthTypedData;
+declare const ___subscription_buildPermit2TypedData: typeof buildPermit2TypedData;
+declare const ___subscription_buildSubscriptionTermsTypedData: typeof buildSubscriptionTermsTypedData;
+declare const ___subscription_computeElapsedPeriods: typeof computeElapsedPeriods;
+declare const ___subscription_computePermitSingleStructHash: typeof computePermitSingleStructHash;
+declare const ___subscription_decodeAccessProof: typeof decodeAccessProof;
+declare const ___subscription_decodePaymentPayload: typeof decodePaymentPayload;
+declare const ___subscription_elapsedCalendarMonths: typeof elapsedCalendarMonths;
+declare const ___subscription_encodeAccessProof: typeof encodeAccessProof;
+declare const ___subscription_encodePaymentPayload: typeof encodePaymentPayload;
+declare const ___subscription_hasSubscriptionCapability: typeof hasSubscriptionCapability;
+declare const ___subscription_parseChainIdFromNetwork: typeof parseChainIdFromNetwork;
+declare const ___subscription_parsePaymentRequired: typeof parsePaymentRequired;
+declare const ___subscription_supportsSubscription: typeof supportsSubscription;
+declare const ___subscription_verifyTermsBindRequirements: typeof verifyTermsBindRequirements;
+declare namespace ___subscription {
+  export { ___subscription_AccessProof as AccessProof, type ___subscription_AccessProofMessageInput as AccessProofMessageInput, ___subscription_AccessRouteRequirements as AccessRouteRequirements, type ___subscription_BuildCancelAuthTypedDataInput as BuildCancelAuthTypedDataInput, type ___subscription_BuildPermit2TypedDataInput as BuildPermit2TypedDataInput, type ___subscription_BuildSubscriptionTermsTypedDataInput as BuildSubscriptionTermsTypedDataInput, ___subscription_CANCEL_AUTH_TYPES as CANCEL_AUTH_TYPES, ___subscription_CancelAuth as CancelAuth, ___subscription_CancelInitiator as CancelInitiator, type ___subscription_ChangeFromExtra as ChangeFromExtra, ___subscription_ChargeError as ChargeError, type ___subscription_ChargeErrorCode as ChargeErrorCode, ___subscription_ChargeResult as ChargeResult, type ___subscription_EncodePaymentPayloadInput as EncodePaymentPayloadInput, type ___subscription_ErrorCode as ErrorCode, ___subscription_FacilitatorCancelData as FacilitatorCancelData, ___subscription_FacilitatorCancelPendingData as FacilitatorCancelPendingData, ___subscription_FacilitatorChangeData as FacilitatorChangeData, ___subscription_FacilitatorChargeData as FacilitatorChargeData, ___subscription_FacilitatorChargeRow as FacilitatorChargeRow, ___subscription_FacilitatorEnvelope as FacilitatorEnvelope, ___subscription_FacilitatorFinalizeExpiredData as FacilitatorFinalizeExpiredData, ___subscription_FacilitatorGetChargesData as FacilitatorGetChargesData, ___subscription_FacilitatorGetSubscriptionData as FacilitatorGetSubscriptionData, ___subscription_FacilitatorPendingChangeRow as FacilitatorPendingChangeRow, ___subscription_FacilitatorSubscribeData as FacilitatorSubscribeData, ___subscription_InMemoryStore as InMemoryStore, ___subscription_OnBeforeAccessContext as OnBeforeAccessContext, ___subscription_OnBeforeAccessHook as OnBeforeAccessHook, ___subscription_OnBeforeAccessResult as OnBeforeAccessResult, ___subscription_PENDING_CHANGE_CANCEL_AUTH_TYPES as PENDING_CHANGE_CANCEL_AUTH_TYPES, ___subscription_PERMIT2_TYPES as PERMIT2_TYPES, ___subscription_PendingChangeCancelAuth as PendingChangeCancelAuth, ___subscription_PendingPlanChange as PendingPlanChange, type ___subscription_PermitSingleData as PermitSingleData, ___subscription_PlanCatalog as PlanCatalog, ___subscription_PlanCatalogEntry as PlanCatalogEntry, ___subscription_PlanInitialCharge as PlanInitialCharge, ___subscription_SUBSCRIPTION_TERMS_TYPES as SUBSCRIPTION_TERMS_TYPES, ___subscription_SettleCancelOk as SettleCancelOk, ___subscription_SettleCancelPendingChangeOk as SettleCancelPendingChangeOk, ___subscription_SettleCancelPendingChangeResult as SettleCancelPendingChangeResult, ___subscription_SettleCancelResult as SettleCancelResult, ___subscription_SettleChangeOk as SettleChangeOk, ___subscription_SettleChangeResult as SettleChangeResult, ___subscription_SettleResultFail as SettleResultFail, ___subscription_SettleSubscribeOk as SettleSubscribeOk, ___subscription_SettleSubscribeResult as SettleSubscribeResult, ___subscription_Subscription as Subscription, ___subscription_SubscriptionCapability as SubscriptionCapability, ___subscription_SubscriptionClient as SubscriptionClient, type ___subscription_SubscriptionClientConfig as SubscriptionClientConfig, type ___subscription_SubscriptionContractAddresses as SubscriptionContractAddresses, ___subscription_SubscriptionFacilitatorClient as SubscriptionFacilitatorClient, type ___subscription_SubscriptionPaymentInner as SubscriptionPaymentInner, type ___subscription_SubscriptionPlanExtra as SubscriptionPlanExtra, type ___subscription_SubscriptionRequirementsExtra as SubscriptionRequirementsExtra, ___subscription_SubscriptionState as SubscriptionState, type ___subscription_SubscriptionStore as SubscriptionStore, type ___subscription_SubscriptionTerms as SubscriptionTerms, type ___subscription_TypedDataEnvelope as TypedDataEnvelope, ___subscription_VerifyAccessOk as VerifyAccessOk, ___subscription_VerifyAccessResult as VerifyAccessResult, ___subscription_VerifyChangeOk as VerifyChangeOk, ___subscription_VerifyChangeResult as VerifyChangeResult, ___subscription_VerifyOwnershipOk as VerifyOwnershipOk, ___subscription_VerifyOwnershipResult as VerifyOwnershipResult, ___subscription_VerifyResult as VerifyResult, ___subscription_VerifyResultFail as VerifyResultFail, ___subscription_VerifyResultOk as VerifyResultOk, ___subscription_ZERO_BYTES32 as ZERO_BYTES32, ___subscription_addCalendarMonths as addCalendarMonths, ___subscription_asSubscriptionPaymentInner as asSubscriptionPaymentInner, ___subscription_base64DecodeUtf8 as base64DecodeUtf8, ___subscription_base64EncodeUtf8 as base64EncodeUtf8, ___subscription_buildAccessProofMessage as buildAccessProofMessage, ___subscription_buildCancelAuthTypedData as buildCancelAuthTypedData, ___subscription_buildPendingChangeCancelAuthTypedData as buildPendingChangeCancelAuthTypedData, ___subscription_buildPermit2TypedData as buildPermit2TypedData, ___subscription_buildSubscriptionTermsTypedData as buildSubscriptionTermsTypedData, ___subscription_computeElapsedPeriods as computeElapsedPeriods, ___subscription_computePermitSingleStructHash as computePermitSingleStructHash, ___subscription_decodeAccessProof as decodeAccessProof, ___subscription_decodePaymentPayload as decodePaymentPayload, ___subscription_elapsedCalendarMonths as elapsedCalendarMonths, ___subscription_encodeAccessProof as encodeAccessProof, ___subscription_encodePaymentPayload as encodePaymentPayload, ___subscription_hasSubscriptionCapability as hasSubscriptionCapability, ___subscription_parseChainIdFromNetwork as parseChainIdFromNetwork, ___subscription_parsePaymentRequired as parsePaymentRequired, ___subscription_supportsSubscription as supportsSubscription, ___subscription_verifyTermsBindRequirements as verifyTermsBindRequirements };
+}
+
+export { type AccessProofMessageInput as A, type BuildCancelAuthTypedDataInput as B, CANCEL_AUTH_TYPES as C, computePermitSingleStructHash as D, type EncodePaymentPayloadInput as E, decodeAccessProof as F, decodePaymentPayload as G, elapsedCalendarMonths as H, InMemoryStore as I, encodeAccessProof as J, encodePaymentPayload as K, parseChainIdFromNetwork as L, parsePaymentRequired as M, verifyTermsBindRequirements as N, PENDING_CHANGE_CANCEL_AUTH_TYPES as P, SUBSCRIPTION_TERMS_TYPES as S, type TypedDataEnvelope as T, ZERO_BYTES32 as Z, ___subscription as _, type BuildPermit2TypedDataInput as a, type BuildSubscriptionTermsTypedDataInput as b, type ChangeFromExtra as c, ChargeError as d, ChargeErrorCode as e, ErrorCode as f, PERMIT2_TYPES as g, type PermitSingleData as h, SubscriptionClient as i, type SubscriptionClientConfig as j, type SubscriptionContractAddresses as k, type SubscriptionPaymentInner as l, type SubscriptionPlanExtra as m, type SubscriptionRequirementsExtra as n, type SubscriptionStore as o, type SubscriptionTerms as p, addCalendarMonths as q, asSubscriptionPaymentInner as r, base64DecodeUtf8 as s, base64EncodeUtf8 as t, buildAccessProofMessage as u, buildCancelAuthTypedData as v, buildPendingChangeCancelAuthTypedData as w, buildPermit2TypedData as x, buildSubscriptionTermsTypedData as y, computeElapsedPeriods as z };