@zkp2p/cash 0.1.0-dev.0 → 0.1.2

package/dist/{createCashClient-DpAx9A1A.d.ts → createCashClient-iHuGgjH_.d.ts}

@@ -1,5 +1,6 @@
 import { Address, WalletClient, Hash, Transport } from 'viem';
-import { IndexerIntentStatus, Zkp2pClient, IndexerIntent, CurrencyType, RuntimeEnv, PreparedTransaction } from '@zkp2p/sdk';
+import { IndexerIntentStatus, Zkp2pClient, IndexerIntent, CurrencyType, PreparedTransaction, RuntimeEnv } from '@zkp2p/sdk';
+import { Execute, RelayClient, RelayChain, ProgressData } from '@relayprotocol/relay-sdk';
 
 /**
  * Name-mapping shim over the published `@zkp2p/sdk` (^0.8).
@@ -201,6 +202,78 @@ interface CashDepositInput {
     };
 }
 
+interface CashAsset {
+    chainId: number;
+    address: string;
+    symbol: string;
+    decimals: number;
+    name?: string;
+    isNative?: boolean;
+}
+interface CashChain {
+    id: number;
+    name: string;
+    displayName: string;
+    disabled: boolean;
+    depositEnabled: boolean;
+    blockProductionLagging: boolean;
+    vmType?: string;
+    tokens: CashAsset[];
+}
+interface CashSourceCapabilities {
+    destination: CashAsset;
+    chains: CashChain[];
+    source: 'relay-sdk';
+    asOf: number;
+}
+interface RelayOptions {
+    apiUrl?: string;
+    apiKey?: string;
+    source?: string;
+    client?: RelayClient;
+    chains?: RelayChain[];
+}
+interface RelaySourceInput {
+    chainId: number;
+    currency: string;
+}
+interface RelayQuoteInput {
+    user: string;
+    amount: bigint;
+    source: RelaySourceInput;
+    recipient?: string;
+    tradeType?: 'EXACT_INPUT' | 'EXACT_OUTPUT' | 'EXPECTED_OUTPUT';
+}
+interface RelayQuote {
+    requestId?: string;
+    source: CashAsset;
+    destination: CashAsset;
+    inputAmount: bigint;
+    outputAmount: bigint;
+    rate?: number;
+    timeEstimateSeconds?: number;
+    fees?: unknown;
+    txs: PreparedTransaction[];
+    raw: Execute;
+}
+interface RelayExecutionResult {
+    requestId?: string;
+    txHashes: string[];
+    quote: Execute;
+}
+interface RelayStatus {
+    requestId: string;
+    status: 'refund' | 'waiting' | 'depositing' | 'failure' | 'pending' | 'submitted' | 'success';
+    details?: string;
+    inTxHashes: string[];
+    txHashes: string[];
+    updatedAt?: number;
+    originChainId?: number;
+    destinationChainId?: number;
+    quoteCreatedAt?: number;
+    raw: unknown;
+}
+
 /** Hard floor: below one cent a deposit is dust and can never fill. */
 declare const MIN_CASHOUT_AMOUNT = 10000n;
 /** Recommended floor: sub-1-USDC deposits force min==max fills and starve matching. */
@@ -228,6 +301,30 @@ interface CashCapabilities {
         decimals: number;
     };
     environment: RuntimeEnv;
+    /** Destination asset for every Peer Cash order. */
+    destination: {
+        chainId: number;
+        token: {
+            address: string;
+            symbol: 'USDC';
+            decimals: number;
+        };
+    };
+    /**
+     * Source discovery. The sync default is Base USDC only; pass
+     * `{ includeRelaySources: true }` to `capabilities()` for live Relay EVM sources.
+     */
+    source: {
+        default: {
+            chainId: number;
+            token: {
+                address: string;
+                symbol: 'USDC';
+                decimals: number;
+            };
+        };
+        relay?: CashSourceCapabilities;
+    };
     /** Every payout corridor: platform × oracle-priced currencies. */
     platforms: CashPlatformCapability[];
     /** All oracle-priced (market-rate) currencies across platforms. */
@@ -246,6 +343,13 @@ interface CashCapabilities {
 }
 declare function buildCapabilities(environment: RuntimeEnv): CashCapabilities;
 
+interface CashFillEta {
+    /** Simple headline ETA from recent deposits. Undefined when no recent sample exists. */
+    seconds?: number;
+    /** Display-ready copy. Historical, not a guarantee. */
+    label: string;
+}
+
 /**
  * Estimate - currency + amount only. No payee, no side effects, no expiry,
  * idempotent, cacheable. "≈ at whatever the oracle says when a buyer fills."
@@ -256,16 +360,26 @@ declare function buildCapabilities(environment: RuntimeEnv): CashCapabilities;
  */
 
 interface EstimateInput {
-    /** Amount to cash out, USDC base units (6 decimals). Use `usdc()` to build it. */
+    /** Amount to cash out. Defaults to Base USDC base units; when `source` is set it is source-token base units. */
     amount: bigint;
     /** Target fiat currency. */
     currency: CurrencyType;
+    /** Optional payout platform for platform-specific fill ETA sampling. */
+    platform?: string;
+    /** Optional Relay EVM source asset. Omit for the current Base USDC default path. */
+    source?: RelaySourceInput & {
+        /** Source wallet that will submit Relay's origin transaction. Required by Relay quote. */
+        user: string;
+        /** Base recipient for bridged USDC; defaults to `user`. */
+        recipient?: string;
+        tradeType?: 'EXACT_INPUT' | 'EXACT_OUTPUT' | 'EXPECTED_OUTPUT';
+    };
 }
 interface CashEstimate {
     /** Always `'oracle-estimate'` - there is no committed quote in Peer Cash. */
     kind: 'oracle-estimate';
     currency: CurrencyType;
-    /** The input amount, USDC base units. */
+    /** Base USDC amount that Peer Cash would deposit after any source routing. */
     amount: bigint;
     /** Target-currency units per 1 USDC at the time of the read. */
     rate: number;
@@ -277,6 +391,15 @@ interface CashEstimate {
     oracleUpdatedAt?: number;
     /** True when the feed reading is older than a day - treat the rate with caution. */
     stale?: boolean;
+    /** Optional source asset route. Absent means same-chain Base USDC. */
+    source?: {
+        kind: 'relay';
+        asset: CashAsset;
+        inputAmount: bigint;
+        relayQuote: RelayQuote;
+    };
+    /** Simple recent-fill ETA from indexer history. */
+    eta?: CashFillEta;
 }
 
 /**
@@ -310,6 +433,8 @@ interface CashClientOptions {
     curatorUrl?: string;
     /** Optional ZKP2P API key. */
     apiKey?: string;
+    /** Relay API configuration for source assets outside Base USDC. */
+    relay?: RelayOptions;
     /**
      * Your own ERC-8021 attribution code(s), appended after
      * {@link CASH_ATTRIBUTION_CODE} on every transaction (e.g. `'acme-app'`).
@@ -326,8 +451,17 @@ interface CashLeg {
     payee: CuratorPayeeDataInput;
 }
 interface CashoutInput {
-    /** Amount to cash out, USDC base units. Use `usdc()` to build it. */
+    /**
+     * Amount to cash out. Defaults to Base USDC base units. When `source` is set,
+     * this is source-token base units and Relay routes it into Base USDC first.
+     */
     amount: bigint;
+    /** Optional Relay source asset. Omit for the Base USDC default path. */
+    source?: RelaySourceInput & {
+        /** Base recipient for bridged USDC; defaults to the signer address. */
+        recipient?: string;
+        tradeType?: 'EXACT_INPUT' | 'EXACT_OUTPUT' | 'EXPECTED_OUTPUT';
+    };
     /** Where the fiat should arrive. Multi-payout is a deliberate v1 cut. */
     receive: CashLeg;
     /** Per-order min/max override (USDC base units). */
@@ -340,6 +474,14 @@ interface SignerOptions {
     /** A viem WalletClient with an account, on Base. */
     signer: WalletClient;
 }
+interface CashoutOptions extends SignerOptions {
+    /** Source-chain signer for Relay. Required when `input.source.chainId` is not Base. */
+    sourceSigner?: WalletClient;
+    /** Relay execution progress callback when `input.source` is present. */
+    onSourceProgress?: (data: ProgressData) => void;
+    /** Forwarded to Relay SDK for wallets with broken EIP-5792 capability calls. */
+    disableSourceCapabilitiesCheck?: boolean;
+}
 interface WithdrawOptions extends SignerOptions {
     /**
      * Partial amount to withdraw (USDC base units). Only unlocked funds are
@@ -367,6 +509,12 @@ interface CashoutResult {
     onchainDepositId: bigint;
     /** Optimistic snapshot (`awaiting-buyer`); poll `order(depositId)` for live state. */
     order: CashOrder;
+    /** Present when `cashout()` first routed a source asset through Relay. */
+    source?: {
+        amount: bigint;
+        requestId?: string;
+        txHashes: string[];
+    };
 }
 interface PrepareResult {
     /**
@@ -402,10 +550,25 @@ interface OrdersOptions {
 interface CashClient {
     /** 0 - Discovery: sync, static. */
     capabilities(): CashCapabilities;
+    /** 0b - Discovery with live Relay-supported EVM source chains/tokens. */
+    capabilities(options: {
+        includeRelaySources: true;
+    }): Promise<CashCapabilities>;
+    /** Relay-only source discovery helper. */
+    sourceCapabilities(): Promise<CashSourceCapabilities>;
+    /** Quote any Relay-supported EVM source asset into Base USDC. */
+    quoteSource(input: RelayQuoteInput): Promise<RelayQuote>;
+    /** Execute a Relay SDK quote into Base USDC before starting the Peer Cash order. */
+    executeSourceQuote(quote: Execute, opts: SignerOptions & {
+        onProgress?: (data: ProgressData) => void;
+        disableCapabilitiesCheck?: boolean;
+    }): Promise<RelayExecutionResult>;
+    /** Track Relay execution status by quote/request id. */
+    relayStatus(requestId: string): Promise<RelayStatus>;
     /** 1 - Estimate: currency + amount only. No payee, no side effects, no expiry. */
     estimate(input: EstimateInput): Promise<CashEstimate>;
     /** 2 - Cash out: payee registration + deposit params + submission happen here. */
-    cashout(input: CashoutInput, opts: SignerOptions): Promise<CashoutResult>;
+    cashout(input: CashoutInput, opts: CashoutOptions): Promise<CashoutResult>;
     /** 2b - Unsigned path: `txs[]` for agent wallets, AA, server keys, policy layers. */
     prepare(input: CashoutInput): Promise<PrepareResult>;
     /** 3 - Observe: resumable from `depositId` alone; no session state anywhere. */
@@ -446,4 +609,4 @@ interface CashClient {
 }
 declare function createCashClient(options: CashClientOptions): CashClient;
 
-export { type CashPayoutInfo as C, type EstimateInput as E, type IntentStatus as I, MIN_CASHOUT_AMOUNT as M, type OrdersOptions as O, type PrepareResult as P, RECOMMENDED_MIN_CASHOUT_AMOUNT as R, type SignerOptions as S, type TopUpResult as T, type WithdrawResult as W, type IntentEntity as a, type CashBuyerProfile as b, type CashDepositInput as c, type CreateDepositParamsArg as d, type CashOrder as e, type CashFill as f, type CashCapabilities as g, type CashoutResult as h, type CashEstimate as i, type CashPreparedStep as j, CASH_ATTRIBUTION_CODE as k, type CashClient as l, type CashClientOptions as m, type CashLeg as n, type CashNextAction as o, type CashOrderState as p, type CashPayout as q, type CashPayoutPricing as r, type CashPlatformCapability as s, type CashPreparedStepKind as t, type CashoutInput as u, type CuratorPayeeDataInput as v, type WatchOptions as w, type WithdrawOptions as x, buildCapabilities as y, createCashClient as z };
+export { type CuratorPayeeDataInput as A, type RelayExecutionResult as B, type CashPayoutInfo as C, type RelayOptions as D, type EstimateInput as E, type RelayQuote as F, type RelayQuoteInput as G, type RelaySourceInput as H, type IntentStatus as I, type RelayStatus as J, type WatchOptions as K, type WithdrawOptions as L, MIN_CASHOUT_AMOUNT as M, buildCapabilities as N, type OrdersOptions as O, type PrepareResult as P, createCashClient as Q, RECOMMENDED_MIN_CASHOUT_AMOUNT as R, type SignerOptions as S, type TopUpResult as T, type WithdrawResult as W, type IntentEntity as a, type CashBuyerProfile as b, type CashDepositInput as c, type CreateDepositParamsArg as d, type CashOrder as e, type CashFill as f, type CashCapabilities as g, type CashoutResult as h, type CashEstimate as i, type CashPreparedStep as j, CASH_ATTRIBUTION_CODE as k, type CashAsset as l, type CashChain as m, type CashClient as n, type CashClientOptions as o, type CashFillEta as p, type CashLeg as q, type CashNextAction as r, type CashOrderState as s, type CashPayout as t, type CashPayoutPricing as u, type CashPlatformCapability as v, type CashPreparedStepKind as w, type CashSourceCapabilities as x, type CashoutInput as y, type CashoutOptions as z };