@zkp2p/sdk 0.0.6 → 0.0.7

package/README.md

@@ -44,6 +44,70 @@ The SDK also includes supporting functionality for the broader ZKP2P ecosystem:
 - **Quote API**: `getQuote()` (used by frontends to display available liquidity)
 - **Indexer Queries**: Historical data, pagination, and advanced filtering via `client.indexer.*`
 
+## Peer Extension SDK
+
+If your app integrates with the Peer browser extension, you can use the SDK wrappers around `window.peer`:
+
+```typescript
+import { peerExtensionSdk } from '@zkp2p/sdk';
+
+const state = await peerExtensionSdk.getState();
+if (state === 'needs_install') {
+  peerExtensionSdk.openInstallPage();
+} else if (state === 'needs_connection') {
+  await peerExtensionSdk.requestConnection();
+} else {
+  const version = await peerExtensionSdk.getVersion();
+  peerExtensionSdk.openSidebar('/buy');
+  peerExtensionSdk.onramp({
+    referrer: 'Polymarket',
+    inputCurrency: 'USD',
+    inputAmount: 25,
+    paymentPlatform: 'venmo',
+    amountUsdc: '100000000',
+    recipientAddress: '0x1111111111111111111111111111111111111111',
+  });
+}
+```
+
+### Intent Hash Deeplink
+
+Open the extension directly to a specific intent (skips quote flow):
+
+```typescript
+peerExtensionSdk.onramp({
+  intentHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+});
+```
+
+### Proof Completion Callbacks
+
+Subscribe to proof completion events to know when a proof succeeds, fails, or is cancelled:
+
+```typescript
+const unsubscribe = peerExtensionSdk.onProofComplete((result) => {
+  switch (result.status) {
+    case 'success':
+      console.log('Proof completed!', result.proof);
+      // result.proof: { attestation, signature, timestamp, platform }
+      break;
+    case 'failure':
+      console.error('Proof failed:', result.error);
+      // result.error: { code, message }
+      break;
+    case 'cancelled':
+      console.log('User cancelled');
+      break;
+    case 'timeout':
+      console.log('Proof timed out');
+      break;
+  }
+});
+
+// Clean up when done
+unsubscribe();
+```
+
 ## Installation
 
 ```bash
@@ -392,7 +456,7 @@ const catalog = getPaymentMethodsCatalog(8453, 'production');
 - `setIntentRange(params)` - Set min/max intent amounts
 - `setCurrencyMinRate(params)` - Set minimum conversion rate
 - `setDelegate(params)` / `removeDelegate(params)` - Manage delegates
-- `addPaymentMethods(params)` - Add payment platforms
+- `addPaymentMethods(params)` - Add payment platforms (requires `currencies` array per method)
 - `setPaymentMethodActive(params)` - Enable/disable payment methods
 - `addCurrencies(params)` / `deactivateCurrency(params)` - Manage currencies
 
@@ -446,6 +510,21 @@ if (result.hadAllowance) {
 For methods that interact directly with on-chain data, parameters use bytes32 hex strings:
 
 ```typescript
+// addPaymentMethods - Add payment methods with required currency lists
+await client.addPaymentMethods({
+  depositId: 1n,
+  paymentMethods: ['0x...'], // bytes32 payment method hashes
+  paymentMethodData: [
+    { intentGatingService: '0x...', payeeDetails: '0x...', data: '0x' },
+  ],
+  // currencies is required and must align with paymentMethods by index
+  currencies: [
+    [
+      { code: '0x...', minConversionRate: 1020000000000000000n },
+    ],
+  ],
+});
+
 // addCurrencies - Add currencies to a payment method
 await client.addCurrencies({
   depositId: 1n,

package/dist/{Zkp2pClient-D-eU4dxy.d.mts → Zkp2pClient-w5Pzlea6.d.mts}

@@ -741,6 +741,8 @@ type TokenResponse = {
 type QuoteIntentResponse = {
     /** Deposit ID */
     depositId: string;
+    /** Escrow contract address */
+    escrowAddress: string;
     /** Payment processor name */
     processorName: string;
     /** Amount to transfer */
@@ -880,6 +882,12 @@ type CreateDepositParams = {
     depositData: {
         [key: string]: string;
     }[];
+    paymentMethodsOverride?: `0x${string}`[];
+    paymentMethodDataOverride?: DepositVerifierData[];
+    currenciesOverride?: {
+        code: `0x${string}`;
+        minConversionRate: bigint;
+    }[][];
     onSuccess?: ActionCallback;
     onError?: (error: Error) => void;
     onMined?: ActionCallback;
@@ -1071,7 +1079,7 @@ type GetTakerTierResponse = {
 };
 
 declare const PAYMENT_PLATFORMS: readonly ["wise", "venmo", "revolut", "cashapp", "mercadopago", "zelle", "paypal", "monzo"];
-type PaymentPlatformType = typeof PAYMENT_PLATFORMS[number];
+type PaymentPlatformType = (typeof PAYMENT_PLATFORMS)[number];
 
 /**
  * Configuration options for creating a Zkp2pClient instance.
@@ -1299,6 +1307,10 @@ declare class Zkp2pClient {
      * Used internally by prepareable methods after preparation.
      */
     private executePreparedTransaction;
+    private prepareEscrowTransaction;
+    private prepareOrchestratorTransaction;
+    private buildEscrowMethod;
+    private buildOrchestratorMethod;
     /**
      * Fetches all deposits owned by the connected wallet from on-chain.
      *
@@ -1584,6 +1596,16 @@ declare class Zkp2pClient {
             currency: string;
             conversionRate: string;
         }[][];
+        paymentMethodsOverride?: `0x${string}`[];
+        paymentMethodDataOverride?: {
+            intentGatingService: Address;
+            payeeDetails: string;
+            data: `0x${string}`;
+        }[];
+        currenciesOverride?: {
+            code: `0x${string}`;
+            minConversionRate: bigint;
+        }[][];
         delegate?: Address;
         intentGuardian?: Address;
         retainOnEmpty?: boolean;
@@ -1592,6 +1614,46 @@ declare class Zkp2pClient {
         depositDetails: PostDepositDetailsRequest[];
         hash: Hash;
     }>;
+    /**
+     * Prepares a createDeposit transaction without sending it.
+     *
+     * Returns both the prepared transaction calldata and the posted deposit details
+     * (including hashed on-chain IDs) needed for tracking.
+     */
+    prepareCreateDeposit(params: {
+        token: Address;
+        amount: bigint;
+        intentAmountRange: {
+            min: bigint;
+            max: bigint;
+        };
+        processorNames: string[];
+        depositData: {
+            [key: string]: string;
+        }[];
+        conversionRates: {
+            currency: string;
+            conversionRate: string;
+        }[][];
+        paymentMethodsOverride?: `0x${string}`[];
+        paymentMethodDataOverride?: {
+            intentGatingService: Address;
+            payeeDetails: string;
+            data: `0x${string}`;
+        }[];
+        currenciesOverride?: {
+            code: `0x${string}`;
+            minConversionRate: bigint;
+        }[][];
+        delegate?: Address;
+        intentGuardian?: Address;
+        retainOnEmpty?: boolean;
+        txOverrides?: TxOverrides;
+    }): Promise<{
+        depositDetails: PostDepositDetailsRequest[];
+        prepared: PreparedTransaction;
+    }>;
+    private prepareCreateDepositInternal;
     /**
      * Enables or disables a deposit from accepting new intents.
      *
@@ -1600,11 +1662,11 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    setAcceptingIntents(params: {
+    readonly setAcceptingIntents: PrepareableMethod<{
         depositId: bigint;
         accepting: boolean;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Updates the min/max intent amount range for a deposit.
      *
@@ -1614,12 +1676,12 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    setIntentRange(params: {
+    readonly setIntentRange: PrepareableMethod<{
         depositId: bigint;
         min: bigint;
         max: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Updates the minimum conversion rate for a specific currency on a payment method.
      *
@@ -1630,13 +1692,13 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    setCurrencyMinRate(params: {
+    readonly setCurrencyMinRate: PrepareableMethod<{
         depositId: bigint;
         paymentMethod: `0x${string}`;
         fiatCurrency: `0x${string}`;
         minConversionRate: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Adds additional funds to an existing deposit.
      * Requires prior approval of the token amount.
@@ -1646,11 +1708,11 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    addFunds(params: {
+    readonly addFunds: PrepareableMethod<{
         depositId: bigint;
         amount: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Removes funds from a deposit (partial withdrawal).
      * Can only withdraw available (non-locked) funds.
@@ -1660,11 +1722,11 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    removeFunds(params: {
+    readonly removeFunds: PrepareableMethod<{
         depositId: bigint;
         amount: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Fully withdraws a deposit, returning all available funds to the owner.
      * The deposit must have no active intents.
@@ -1673,10 +1735,10 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    withdrawDeposit(params: {
+    readonly withdrawDeposit: PrepareableMethod<{
         depositId: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Sets whether a deposit should remain active when its balance reaches zero.
      *
@@ -1685,11 +1747,11 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    setRetainOnEmpty(params: {
+    readonly setRetainOnEmpty: PrepareableMethod<{
         depositId: bigint;
         retain: boolean;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Assigns a delegate address that can manage the deposit on behalf of the owner.
      *
@@ -1698,11 +1760,11 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    setDelegate(params: {
+    readonly setDelegate: PrepareableMethod<{
         depositId: bigint;
         delegate: Address;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Removes the delegate from a deposit.
      *
@@ -1710,10 +1772,10 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    removeDelegate(params: {
+    readonly removeDelegate: PrepareableMethod<{
         depositId: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Adds new payment methods to an existing deposit.
      *
@@ -1723,7 +1785,7 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    addPaymentMethods(params: {
+    readonly addPaymentMethods: PrepareableMethod<{
         depositId: bigint;
         paymentMethods: `0x${string}`[];
         paymentMethodData: {
@@ -1731,8 +1793,12 @@ declare class Zkp2pClient {
             payeeDetails: string;
             data: `0x${string}`;
         }[];
+        currencies: {
+            code: `0x${string}`;
+            minConversionRate: bigint;
+        }[][];
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Activates or deactivates a payment method on a deposit.
      *
@@ -1742,12 +1808,12 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    setPaymentMethodActive(params: {
+    readonly setPaymentMethodActive: PrepareableMethod<{
         depositId: bigint;
         paymentMethod: `0x${string}`;
         isActive: boolean;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Deactivates a payment method on a deposit (convenience alias for setPaymentMethodActive).
      *
@@ -1756,11 +1822,11 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    removePaymentMethod(params: {
+    readonly removePaymentMethod: PrepareableMethod<{
         depositId: bigint;
         paymentMethod: `0x${string}`;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Adds new currencies to a payment method on a deposit.
      *
@@ -1770,7 +1836,7 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    addCurrencies(params: {
+    readonly addCurrencies: PrepareableMethod<{
         depositId: bigint;
         paymentMethod: `0x${string}`;
         currencies: {
@@ -1778,7 +1844,7 @@ declare class Zkp2pClient {
             minConversionRate: bigint;
         }[];
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Deactivates a currency for a payment method on a deposit.
      *
@@ -1788,12 +1854,12 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    deactivateCurrency(params: {
+    readonly deactivateCurrency: PrepareableMethod<{
         depositId: bigint;
         paymentMethod: `0x${string}`;
         currencyCode: `0x${string}`;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Removes (deactivates) a currency from a payment method.
      * Alias for deactivateCurrency.
@@ -1804,12 +1870,12 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    removeCurrency(params: {
+    readonly removeCurrency: PrepareableMethod<{
         depositId: bigint;
         paymentMethod: `0x${string}`;
         currencyCode: `0x${string}`;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * Removes expired intents from a deposit, freeing up locked funds.
      * Can be called by anyone (permissionless cleanup).
@@ -1818,10 +1884,10 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    pruneExpiredIntents(params: {
+    readonly pruneExpiredIntents: PrepareableMethod<{
         depositId: bigint;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * **Supporting Method** - Signals intent to use a deposit.
      *
@@ -1930,10 +1996,10 @@ declare class Zkp2pClient {
      * @param params.txOverrides - Optional viem transaction overrides
      * @returns Transaction hash
      */
-    releaseFundsToPayer(params: {
+    readonly releaseFundsToPayer: PrepareableMethod<{
         intentHash: `0x${string}`;
         txOverrides?: TxOverrides;
-    }): Promise<Hash>;
+    }, `0x${string}`>;
     /**
      * **Supporting Method** - Fulfills an intent by submitting a payment proof.
      *
@@ -2127,4 +2193,4 @@ declare class Zkp2pClient {
     }>;
 }
 
-export { type RegisterPayeeDetailsRequest as $, type ActionCallback as A, type GetOwnerDepositsRequest as B, type CancelIntentMethodParams as C, type DepositWithRelations as D, type GetOwnerDepositsResponse as E, type FulfillIntentMethodParams as F, type GetPayeeDetailsRequest as G, type GetDepositByIdRequest as H, type IntentEntity as I, type GetDepositByIdResponse as J, type Intent as K, type ApiIntentStatus as L, type GetOwnerIntentsRequest as M, type NearbyQuote as N, type GetOwnerIntentsResponse as O, type PostDepositDetailsRequest as P, type QuoteRequest as Q, type Range as R, type SignalIntentMethodParams as S, type TxOverrides as T, type GetIntentsByDepositRequest as U, type ValidatePayeeDetailsRequest as V, type WithdrawDepositParams as W, type GetIntentsByDepositResponse as X, type GetIntentByHashRequest as Y, Zkp2pClient as Z, type GetIntentByHashResponse as _, type ValidatePayeeDetailsResponse as a, type RegisterPayeeDetailsResponse as a0, type OnchainCurrency as a1, type DepositVerifierData as a2, type PreparedTransaction as a3, type OrderStats as a4, type DepositIntentStatistics as a5, type TakerTier as a6, type TakerTierStats as a7, type TakerTierLevel as a8, type PlatformLimit as a9, mapConversionRatesToOnchainMinRate as aA, type CurrencyType as aB, type CurrencyData as aC, getContracts as aD, getPaymentMethodsCatalog as aE, getGatingServiceAddress as aF, type RuntimeEnv as aG, parseDepositView as aH, parseIntentView as aI, enrichPvDepositView as aJ, enrichPvIntentView as aK, type PV_DepositView as aL, type PV_Deposit as aM, type PV_PaymentMethodData as aN, type PV_Currency as aO, type PV_IntentView as aP, type PV_Intent as aQ, type PlatformRiskLevel as aa, IndexerClient as ab, defaultIndexerEndpoint as ac, IndexerDepositService as ad, fetchFulfillmentAndPayment as ae, type DepositEntity as af, type IntentFulfilledEntity as ag, type DepositPaymentMethodEntity as ah, type MethodCurrencyEntity as ai, type IntentStatus as aj, type DepositFilter as ak, type PaginationOptions as al, type DepositOrderField as am, type OrderDirection as an, type DeploymentEnv as ao, type FulfillmentRecord as ap, type PaymentVerifiedRecord as aq, type FulfillmentAndPaymentResponse as ar, PAYMENT_PLATFORMS as as, type PaymentPlatformType as at, Currency as au, currencyInfo as av, getCurrencyInfoFromHash as aw, getCurrencyInfoFromCountryCode as ax, getCurrencyCodeFromHash as ay, isSupportedCurrencyHash as az, type PostDepositDetailsResponse as b, type GetPayeeDetailsResponse as c, type GetTakerTierRequest as d, type GetTakerTierResponse as e, type PaymentMethodCatalog as f, type Zkp2pClientOptions as g, type TimeoutConfig as h, type CreateDepositParams as i, type CreateDepositConversionRate as j, type SignalIntentParams as k, type FulfillIntentParams as l, type ReleaseFundsToPayerParams as m, type CancelIntentParams as n, type QuoteResponse as o, type QuoteResponseObject as p, type QuoteSingleResponse as q, type QuoteIntentResponse as r, type QuoteFeesResponse as s, type FiatResponse as t, type TokenResponse as u, type NearbySuggestions as v, type ApiDeposit as w, type DepositVerifier as x, type DepositVerifierCurrency as y, type DepositStatus as z };
+export { type RegisterPayeeDetailsRequest as $, type ActionCallback as A, type DepositVerifierCurrency as B, type CancelIntentMethodParams as C, type DepositWithRelations as D, type DepositStatus as E, type FulfillIntentMethodParams as F, type GetPayeeDetailsRequest as G, type GetDepositByIdRequest as H, type IntentEntity as I, type GetDepositByIdResponse as J, type Intent as K, type ApiIntentStatus as L, type GetOwnerIntentsRequest as M, type NearbyQuote as N, type GetOwnerIntentsResponse as O, type PostDepositDetailsRequest as P, type QuoteRequest as Q, type Range as R, type SignalIntentMethodParams as S, type TxOverrides as T, type GetIntentsByDepositRequest as U, type ValidatePayeeDetailsRequest as V, type WithdrawDepositParams as W, type GetIntentsByDepositResponse as X, type GetIntentByHashRequest as Y, Zkp2pClient as Z, type GetIntentByHashResponse as _, type ValidatePayeeDetailsResponse as a, type RegisterPayeeDetailsResponse as a0, type OnchainCurrency as a1, type DepositVerifierData as a2, type PreparedTransaction as a3, type OrderStats as a4, type DepositIntentStatistics as a5, type TakerTier as a6, type TakerTierStats as a7, type TakerTierLevel as a8, type PlatformLimit as a9, mapConversionRatesToOnchainMinRate as aA, type CurrencyType as aB, type CurrencyData as aC, getContracts as aD, getPaymentMethodsCatalog as aE, getGatingServiceAddress as aF, type RuntimeEnv as aG, parseDepositView as aH, parseIntentView as aI, enrichPvDepositView as aJ, enrichPvIntentView as aK, type PV_DepositView as aL, type PV_Deposit as aM, type PV_PaymentMethodData as aN, type PV_Currency as aO, type PV_IntentView as aP, type PV_Intent as aQ, type PlatformRiskLevel as aa, IndexerClient as ab, defaultIndexerEndpoint as ac, IndexerDepositService as ad, fetchFulfillmentAndPayment as ae, type DepositEntity as af, type IntentFulfilledEntity as ag, type DepositPaymentMethodEntity as ah, type MethodCurrencyEntity as ai, type IntentStatus as aj, type DepositFilter as ak, type PaginationOptions as al, type DepositOrderField as am, type OrderDirection as an, type DeploymentEnv as ao, type FulfillmentRecord as ap, type PaymentVerifiedRecord as aq, type FulfillmentAndPaymentResponse as ar, PAYMENT_PLATFORMS as as, type PaymentPlatformType as at, Currency as au, currencyInfo as av, getCurrencyInfoFromHash as aw, getCurrencyInfoFromCountryCode as ax, getCurrencyCodeFromHash as ay, isSupportedCurrencyHash as az, type PostDepositDetailsResponse as b, type GetPayeeDetailsResponse as c, type GetOwnerDepositsRequest as d, type GetOwnerDepositsResponse as e, type GetTakerTierRequest as f, type GetTakerTierResponse as g, type PaymentMethodCatalog as h, type Zkp2pClientOptions as i, type TimeoutConfig as j, type CreateDepositParams as k, type CreateDepositConversionRate as l, type SignalIntentParams as m, type FulfillIntentParams as n, type ReleaseFundsToPayerParams as o, type CancelIntentParams as p, type QuoteResponse as q, type QuoteResponseObject as r, type QuoteSingleResponse as s, type QuoteIntentResponse as t, type QuoteFeesResponse as u, type FiatResponse as v, type TokenResponse as w, type NearbySuggestions as x, type ApiDeposit as y, type DepositVerifier as z };