@lunora/x402 0.0.0 → 1.0.0-alpha.10

package/dist/packem_shared/config.d-B-NYmHgG.d.mts

@@ -0,0 +1,404 @@
+import { ClientEvmSigner } from '@x402/evm';
+import { ClientSvmSigner } from '@x402/svm';
+import { ProcessSettleSuccessResponse } from '@x402/core/http';
+import { BeforePaymentCreationHook, PaymentPolicy, OnPaymentCreationFailureHook } from '@x402/core/client';
+import { PaymentRequirements } from '@x402/core/types';
+/**
+ * A normalised record of one settled x402 payment. The settled `amount` is kept
+ * as its exact on-chain atomic-unit string (USDC has 6 decimals) — never coerced
+ * to a fractional-dollar number — so no precision is lost crossing the reporting
+ * seam.
+ * @experimental
+ */
+interface X402Receipt {
+  /** Settled amount in the asset's atomic base units (USDC: 6 decimals), as an exact string. */
+  readonly amount: string;
+  /** The settled asset's contract / mint address (e.g. Base USDC). */
+  readonly asset: string;
+  /** The payer's wallet address, when the facilitator reports it. */
+  readonly from: string | undefined;
+  /** The settlement network as a CAIP-2 id (e.g. `eip155:8453`). */
+  readonly network: string;
+  /** The gated resource this payment bought (a URL, or a procedure's `file:function` id). */
+  readonly resource: string;
+  /** The payout wallet the funds settled to (the merchant recipient). */
+  readonly to: string;
+  /** When the receipt was produced (epoch milliseconds). */
+  readonly ts: number;
+  /** On-chain settlement transaction id / hash. */
+  readonly tx: string;
+}
+/**
+ * A one-way, opt-in sink for settled-payment receipts. Wire it via
+ * `config.onReceipt`. It is best-effort telemetry — the middleware fires it after
+ * settlement, does not block the paid response on it, and swallows any error it
+ * throws — so a sink must never rely on being awaited or on its failures
+ * surfacing.
+ * @experimental
+ */
+type X402ReceiptSink = (receipt: X402Receipt) => Promise<void> | void;
+/**
+ * Normalise a successful facilitator settlement into an {@link X402Receipt}.
+ * `resource` (the gated URL or procedure id) and `ts` are supplied by the caller —
+ * the settlement result carries neither. Prefers the actual settled `amount`
+ * (present for `upto`-scheme partial settlements) and falls back to the route's
+ * required amount for `exact`.
+ * @experimental
+ */
+declare const toReceipt: (settlement: ProcessSettleSuccessResponse, context: {
+  readonly resource: string;
+  readonly ts: number;
+}) => X402Receipt;
+/**
+ * A row for `@lunora/payment`'s durable `events` table. Deliberately a plain
+ * structural type — building one imports nothing from `@lunora/payment`, so the
+ * rails stay decoupled.
+ * @experimental
+ */
+interface PaymentEventRow {
+  /** Epoch milliseconds the settlement was recorded. */
+  readonly processedAt: number;
+  /** The rail that produced the event. */
+  readonly provider: "x402";
+  /** The settlement tx hash — the natural unique event id (the table is unique on `(provider, providerEventId)`). */
+  readonly providerEventId: string;
+  /** The event kind, namespaced to the x402 rail. */
+  readonly type: "x402.settled";
+}
+/**
+ * Shape a receipt as a row for `@lunora/payment`'s durable `events` table, so a
+ * settled x402 payment shows in Studio's Payments panel (its recent-events card)
+ * with ZERO coupling: this returns a plain object matching that table's
+ * documented column contract (`provider` / `providerEventId` / `type` /
+ * `processedAt`, unique on `(provider, providerEventId)`) and imports nothing
+ * from `@lunora/payment`. Insert it from a mutation ctx:
+ *
+ * ```ts
+ * onReceipt: (receipt) => ctx.db.insert("events", toPaymentEventRow(receipt)),
+ * ```
+ *
+ * The source of truth for the column contract is `@lunora/payment`'s `events`
+ * table (`packages/payment/src/schema.ts`). Amount / from / to / resource are
+ * intentionally not on this row — that card renders none of them; read them off
+ * the {@link X402Receipt} (e.g. into your own revenue table) if you need them.
+ * @experimental
+ */
+declare const toPaymentEventRow: (receipt: X402Receipt) => PaymentEventRow;
+/**
+ * Network identity for `@lunora/x402`.
+ *
+ * `@x402/core` v2 speaks **CAIP-2** chain ids (`eip155:8453` for Base,
+ * `solana:5eyk…` for Solana mainnet) — `type Network = ` `${string}:${string}` ``.
+ * Lunora keeps ergonomic **friendly** names (`"base"`, `"base-sepolia"`) as the
+ * public surface and maps them to CAIP-2 here, at the single seam where we hand a
+ * network to the SDK. A raw CAIP-2 string is also accepted as a power-user escape
+ * hatch (e.g. a chain we don't yet have a friendly alias for).
+ *
+ * The friendly set is intentionally scoped to chains `@x402/evm` / `@x402/svm`
+ * can settle the ergonomic `price:"$0.01"` path on out of the box (i.e. chains in
+ * their `DEFAULT_STABLECOINS` registry). Notably that excludes Optimism and
+ * Avalanche today — advertising them would 500 at settlement — so they are not
+ * friendly aliases; a caller who needs them can still pass a raw CAIP-2 id with an
+ * explicit asset.
+ */
+/**
+ * A CAIP-2 chain identifier, e.g. `"eip155:8453"` (Base) or `"solana:5eyk…"`.
+ * @experimental
+ */
+type Caip2 = `${string}:${string}`;
+/**
+ * Friendly network names Lunora maps to CAIP-2 for `@x402/core`.
+ * @experimental
+ */
+type FriendlyNetwork = "arbitrum" | "arbitrum-sepolia" | "base" | "base-sepolia" | "ethereum" | "polygon" | "solana" | "solana-devnet";
+/**
+ * A network Lunora can settle on: a {@link FriendlyNetwork} alias (mapped to
+ * CAIP-2 internally) or a raw {@link Caip2} id for chains without a friendly name.
+ * @experimental
+ */
+type X402Network = Caip2 | FriendlyNetwork;
+/**
+ * Friendly name → CAIP-2 id. Values verified against `@x402/evm` and `@x402/svm`
+ * `DEFAULT_STABLECOINS` at 2.17.0. `base` / `base-sepolia` are the primary
+ * prod / test pair.
+ * @experimental
+ */
+declare const NETWORK_TO_CAIP2: {
+  readonly arbitrum: "eip155:42161";
+  readonly "arbitrum-sepolia": "eip155:421614";
+  readonly base: "eip155:8453";
+  readonly "base-sepolia": "eip155:84532";
+  readonly ethereum: "eip155:1";
+  readonly polygon: "eip155:137";
+  readonly solana: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
+  readonly "solana-devnet": "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1";
+};
+/**
+ * EVM friendly networks (signed via `@x402/evm` + viem).
+ * @experimental
+ */
+declare const EVM_NETWORKS: readonly ["arbitrum", "arbitrum-sepolia", "base", "base-sepolia", "ethereum", "polygon"];
+/**
+ * Solana friendly networks (signed via `@x402/svm`).
+ * @experimental
+ */
+declare const SVM_NETWORKS: readonly ["solana", "solana-devnet"];
+/**
+ * Resolve a network to its CAIP-2 id. Friendly aliases are looked up; a value
+ * that already looks like CAIP-2 (`namespace:reference`) passes through.
+ * @experimental
+ */
+declare const toCaip2: (network: X402Network) => Caip2;
+/**
+ * True when `network` settles on an EVM chain (viem signer path).
+ * @experimental
+ */
+declare const isEvmNetwork: (network: X402Network) => boolean;
+/**
+ * True when `network` settles on Solana (`@x402/svm` signer path).
+ * @experimental
+ */
+declare const isSvmNetwork: (network: X402Network) => boolean;
+/**
+ * USDC — and every asset in `@x402/evm` / `@x402/svm`'s `DEFAULT_STABLECOINS` —
+ * uses 6 decimals, so a USD price converts to atomic base units at `10 ** 6`.
+ * Override per {@link SpendPolicy.decimals} only for a custom, non-6-decimal asset.
+ * @experimental
+ */
+declare const DEFAULT_STABLECOIN_DECIMALS = 6;
+/**
+ * Spend limits and approval gates for an agent wallet. At least one bound must be
+ * set — see {@link assertBoundedPolicy} — or the pay rail refuses to build.
+ *
+ * Caps are denominated in USD (the stablecoin's dollar value); addresses and
+ * networks are matched against the requirement the server offers.
+ * @experimental
+ */
+interface SpendPolicy {
+  /** Network allowlist. When set, only these networks may be paid on. */
+  readonly allowedNetworks?: ReadonlyArray<X402Network>;
+  /** Recipient allowlist. When set, only these `payTo` addresses may be paid. */
+  readonly allowedRecipients?: ReadonlyArray<string>;
+  /** Stablecoin decimals for USD→atomic conversion (default {@link DEFAULT_STABLECOIN_DECIMALS}). */
+  readonly decimals?: number;
+  /** Hard ceiling on a single payment, in USD. */
+  readonly maxPerCall?: X402Price;
+  /** Hard ceiling on cumulative spend across this wallet's lifetime, in USD. */
+  readonly maxPerRun?: X402Price;
+  /**
+   * Approval gate. Called with the selected requirement before signing; return
+   * `false` (or reject) to refuse the payment. Use for human-in-the-loop or any
+   * dynamic rule the static caps can't express.
+   */
+  readonly onPaymentRequired?: (requirement: PaymentRequirements) => Promise<boolean> | boolean;
+}
+/**
+ * A running spend ledger the per-run cap is measured (and reserved) against.
+ * @experimental
+ */
+interface SpendState {
+  /** Reserve a payment (atomic base units) against the running total, before it is signed. */
+  readonly add: (amount: bigint) => void;
+  /** Release a previously reserved amount (atomic base units) — e.g. a declined or failed payment. Clamps at 0. */
+  readonly release: (amount: bigint) => void;
+  /** Cumulative spend so far, in atomic base units. */
+  readonly spentAtomic: bigint;
+}
+/**
+ * A fresh spend ledger. One per wallet instance; the guard reserves into it and
+ * releases from it.
+ * @experimental
+ */
+declare const createSpendState: () => SpendState;
+/**
+ * Convert a USD amount (`0.01`, `"0.01"`, or the `"$0.01"` shorthand) to atomic
+ * stablecoin base units, exactly — parsed digit-by-digit so no binary-float drift
+ * can round a cap the wrong way. Throws on a malformed amount (including
+ * exponential notation like `"1e-7"`, which a decimal string never needs).
+ * @experimental
+ */
+declare const usdToAtomic: (usd: X402Price, decimals?: number) => bigint;
+/**
+ * A `PaymentPolicy` that narrows the server's offered requirements to those a
+ * bounded wallet may pay: within the per-call cap, to an allowed recipient, on an
+ * allowed network. An empty result means the client cannot pay — fail-closed.
+ * @experimental
+ */
+declare const buildSpendPolicy: (policy: SpendPolicy) => PaymentPolicy;
+/**
+ * A `BeforePaymentCreationHook` enforcing the stateful bounds the stateless
+ * {@link buildSpendPolicy} filter can't: the cumulative per-run cap and the async
+ * confirmation gate. Aborts (no signature) when either would be violated.
+ *
+ * The per-run cap is *reserved* into `state` as soon as the check passes — before
+ * the `await policy.onPaymentRequired` below, and before `@x402/core` ever attempts
+ * to sign — not recorded afterwards. This closes a check-then-act race: without an
+ * atomic reserve, N concurrent payments could each read the same `spentAtomic`,
+ * all pass the cap check, and all record, overspending the cap by up to
+ * (N−1)×maxPerCall. A declined confirmation releases the reservation before this
+ * hook returns; {@link releaseSpendOnFailure} releases it if the signature itself
+ * later fails. The reservation is intentionally *not* released on success — a
+ * committed payment stays counted.
+ * @experimental
+ */
+declare const buildPaymentGuard: (policy: SpendPolicy, state: SpendState) => BeforePaymentCreationHook;
+/**
+ * An `OnPaymentCreationFailureHook` that releases a reservation
+ * {@link buildPaymentGuard} made when the scheme's signature creation itself
+ * throws (network error, wallet error, …) after the guard already approved and
+ * reserved the amount. Without this, a failed signature would permanently
+ * over-count against the per-run cap for the rest of the run — fail-closed, but
+ * needlessly so when the client (`wrapFetchWithPayment`) may retry.
+ * @experimental
+ */
+declare const releaseSpendOnFailure: (state: SpendState) => OnPaymentCreationFailureHook;
+/**
+ * Guard at wallet-build time: refuse a policy with no bound whatsoever. Signing
+ * money on an agent's behalf with unlimited spend authority is never the intent,
+ * so this fails loudly rather than defaulting to unbounded.
+ *
+ * `allowedNetworks` / `allowedRecipients` narrow *where* a payment can go, but
+ * neither caps *how much* — a policy with only an allowlist still authorises
+ * unlimited spend to any recipient it permits. Only `maxPerCall`, `maxPerRun`, or
+ * a dynamic `onPaymentRequired` gate actually bound spend, so only those count here.
+ * @experimental
+ */
+declare const assertBoundedPolicy: (policy: SpendPolicy) => void;
+/**
+ * The public, Coinbase-operated facilitator (verify + settle). It needs no API
+ * key. Override with a self-hosted or CDP facilitator via {@link FacilitatorConfig}.
+ * @experimental
+ */
+declare const DEFAULT_FACILITATOR_URL = "https://x402.org/facilitator";
+/**
+ * How to reach a facilitator's `/verify` + `/settle` endpoints.
+ * @experimental
+ */
+interface FacilitatorConfig {
+  /** Extra headers for a private facilitator (e.g. a CDP bearer token). */
+  readonly headers?: Record<string, string>;
+  /** Base URL. Defaults to {@link DEFAULT_FACILITATOR_URL}. */
+  readonly url?: string;
+}
+/**
+ * A resource's price, as a USD-denominated decimal string (`"0.01"`, or the
+ * `"$0.01"` shorthand) or a number of dollars (`0.01`). The scheme resolves it
+ * to the network's stablecoin base units (USDC has 6 decimals) at challenge
+ * time. (Kept `number | string` rather than a `` `$${string}` `` template
+ * member — the template is subsumed by `string`, so it only adds noise.)
+ * @experimental
+ */
+type X402Price = number | string;
+/**
+ * An EVM recipient address (the merchant wallet that receives settlement).
+ * @experimental
+ */
+type EvmAddress = `0x${string}`;
+/**
+ * Recipient wallet the facilitator settles payments to, per network family.
+ * @experimental
+ */
+interface X402Recipient {
+  /** EVM payout address (required for EVM networks). */
+  readonly evm?: EvmAddress;
+  /** Solana payout address, base58 (required for SVM networks). */
+  readonly svm?: string;
+}
+/**
+ * Server-side (charge rail) config. The server needs only a **recipient
+ * address** — no private key — because the facilitator performs settlement.
+ * @experimental
+ */
+interface X402ChargeConfig {
+  readonly facilitator?: FacilitatorConfig;
+  /** Network this resource settles on. */
+  readonly network: X402Network;
+  /**
+   * Opt-in, one-way telemetry sink fired once per settled payment. Best-effort:
+   * it runs after settlement, never blocks the paid response, and its errors are
+   * swallowed. Use it to mirror x402 revenue into a durable table / `@lunora/payment`'s
+   * `events` table (see `toPaymentEventRow`) so it surfaces in Studio.
+   */
+  readonly onReceipt?: X402ReceiptSink;
+  /** Default price for a gated resource; per-resource overrides win. */
+  readonly price: X402Price;
+  /** Payout wallet(s). */
+  readonly recipient: X402Recipient;
+}
+/**
+ * Client-side (pay rail) config. The signer holds spending authority, so the
+ * pay rail is ActionCtx-only and MUST be paired with a spend `policy` — the pay
+ * rail refuses to build if the policy is unbounded.
+ * @experimental
+ */
+interface X402PayConfig {
+  /** Network to transact on. Determines the signer family (EVM vs SVM). */
+  readonly network: X402Network;
+  /** Mandatory spend limits + approval gates. An unbounded policy is refused. */
+  readonly policy: SpendPolicy;
+  /** How the agent wallet is custodied (raw key, a user-supplied signer, or CDP-managed). */
+  readonly signer: X402SignerConfig;
+}
+/**
+ * CDP-managed wallet custody via `@coinbase/cdp-sdk` (an optional peer). The SDK
+ * gets-or-creates a named server account and signs the x402 EIP-712 payment
+ * authorization with it — no private key ever leaves Coinbase. Needs three CDP
+ * credentials, read from `ctx.secrets` under names that default to the SDK's own
+ * env-var names; override them if your secrets are named differently. (Note
+ * `@coinbase/x402` is a facilitator-auth helper, not a signer provider — CDP
+ * custody is `@coinbase/cdp-sdk`.) EVM only today; for CDP on Solana, build a
+ * `@solana/kit` signer around your CDP account and pass it via the `"signer"`
+ * escape hatch.
+ * @experimental
+ */
+interface X402CdpSignerConfig {
+  /** CDP account name to get-or-create and sign with. */
+  readonly account: string;
+  /** `ctx.secrets` name for the CDP API key id. Default `"CDP_API_KEY_ID"`. */
+  readonly apiKeyIdSecretName?: string;
+  /** `ctx.secrets` name for the CDP API key secret. Default `"CDP_API_KEY_SECRET"`. */
+  readonly apiKeySecretName?: string;
+  readonly type: "cdp";
+  /** `ctx.secrets` name for the CDP wallet secret. Default `"CDP_WALLET_SECRET"`. */
+  readonly walletSecretName?: string;
+}
+/**
+ * Wallet custody for the pay rail — three shapes.
+ *
+ * `"raw-key"` resolves a private key from `ctx.secrets` (viem for EVM, a
+ * `@solana/kit` keypair for Solana) — simplest, self-custodied.
+ *
+ * `"signer"` is the escape hatch: hand in a signer you already built — any
+ * `@x402/evm` `ClientEvmSigner` (a viem account from Turnkey, Privy, an AWS/GCP
+ * KMS `toAccount`, CDP's viem adapter, …) on an EVM network, or an `@x402/svm`
+ * `ClientSvmSigner` (a `@solana/kit` `TransactionSigner`) on Solana. Adapt any
+ * custody provider to the structural signer and pass it here; `@lunora/x402`
+ * takes no dependency on the provider's SDK.
+ *
+ * `"cdp"` is a Coinbase-managed wallet via `@coinbase/cdp-sdk`
+ * ({@link X402CdpSignerConfig}).
+ *
+ * Wired today: raw-key (EVM + SVM), the user-supplied signer (both families),
+ * and CDP-managed EVM custody. CDP on Solana is not yet wired — use the escape
+ * hatch.
+ * @experimental
+ */
+type X402SignerConfig = X402CdpSignerConfig | {
+  /** Name of the `ctx.secrets` entry holding the private key. */
+  readonly secretName: string;
+  readonly type: "raw-key";
+} | {
+  /**
+   * A pre-built signer you own: an EVM `ClientEvmSigner` (viem account) on
+   * an EVM network, or an SVM `ClientSvmSigner` (`@solana/kit`
+   * `TransactionSigner`) on Solana. Must match the config `network`'s family.
+   */
+  readonly signer: ClientEvmSigner | ClientSvmSigner;
+  readonly type: "signer";
+};
+/**
+ * Resolve a facilitator's base URL, applying the public default.
+ * @experimental
+ */
+declare const resolveFacilitatorUrl: (facilitator?: FacilitatorConfig) => string;
+export { Caip2 as C, DEFAULT_FACILITATOR_URL as D, EVM_NETWORKS as E, FacilitatorConfig as F, NETWORK_TO_CAIP2 as N, PaymentEventRow as P, SVM_NETWORKS as S, X402CdpSignerConfig as X, EvmAddress as a, FriendlyNetwork as b, X402ChargeConfig as c, X402Network as d, X402PayConfig as e, X402Price as f, X402Receipt as g, X402ReceiptSink as h, X402Recipient as i, X402SignerConfig as j, isEvmNetwork as k, isSvmNetwork as l, DEFAULT_STABLECOIN_DECIMALS as m, SpendPolicy as n, SpendState as o, assertBoundedPolicy as p, buildPaymentGuard as q, resolveFacilitatorUrl as r, buildSpendPolicy as s, toCaip2 as t, createSpendState as u, releaseSpendOnFailure as v, usdToAtomic as w, toPaymentEventRow as x, toReceipt as y };