@zkp2p/sdk 0.3.0 → 0.3.1

package/dist/{vaultUtils-sodi4Xx-.d.mts → vaultUtils-DATqc35J.d.mts}

@@ -423,6 +423,7 @@ type IntentStatus = `${IntentStatus$1}`;
 type DepositEntity = WithOverrides<Deposit, {
     status: DepositStatus$1;
     retainOnEmpty?: boolean;
+    whitelistHookAddress?: string | null;
 }>;
 type DepositPaymentMethodEntity = DepositPaymentMethod;
 type MethodCurrencyEntity = MethodCurrency;
@@ -773,6 +774,16 @@ type ReferrerFeeConfig = {
     recipient: `0x${string}`;
     feeBps: number;
 };
+type CuratorPayeeData = {
+    offchainId: string;
+    telegramUsername: string | null;
+    metadata: Record<string, string> | null;
+};
+type CuratorPayeeDataInput = {
+    offchainId: string;
+    telegramUsername?: string | null;
+    metadata?: Record<string, string> | null;
+};
 /**
  * Parameters for fulfilling an intent with payment attestation
  */
@@ -836,10 +847,12 @@ type SignalIntentParams = {
  * Request structure for posting deposit details
  */
 type PostDepositDetailsRequest = {
-    /** Deposit data key-value pairs */
-    depositData: {
-        [key: string]: string;
-    };
+    /** Primary offchain payment identifier for the processor */
+    offchainId: string;
+    /** Optional Telegram username associated with the payee */
+    telegramUsername?: string | null;
+    /** Optional processor-specific metadata */
+    metadata?: Record<string, string> | null;
     /** Payment processor name */
     processorName: string;
 };
@@ -853,9 +866,9 @@ type PostDepositDetailsResponse = {
     responseObject: {
         id: number;
         processorName: string;
-        depositData: {
-            [key: string]: string;
-        };
+        offchainId: string;
+        telegramUsername: string | null;
+        metadata: Record<string, string> | null;
         hashedOnchainId: string;
         createdAt: string;
     };
@@ -887,6 +900,8 @@ type QuoteRequest = {
     nearbySearchRange?: number;
     /** Max suggestions per direction (1-10, default: 3) */
     nearbyQuotesCount?: number;
+    /** Include whitelist-gated private orderbook deposits scoped to the requesting user */
+    includePrivateOrderbooks?: boolean;
 };
 type QuotesBestByPlatformRequest = {
     fiatCurrency: string;
@@ -957,7 +972,7 @@ type QuoteSingleResponse = {
     conversionRate: string;
     takerConversionRate?: string;
     intent: QuoteIntentResponse;
-    payeeData?: Record<string, string>;
+    payeeData?: CuratorPayeeData;
 };
 type GetQuoteSingleResponse = QuoteSingleResponse & {
     referrerFeeAmount?: string;
@@ -1073,9 +1088,9 @@ type GetPayeeDetailsResponse = {
     responseObject: {
         id: number;
         processorName: string;
-        depositData: {
-            [key: string]: string;
-        };
+        offchainId: string;
+        telegramUsername: string | null;
+        metadata: Record<string, string> | null;
         hashedOnchainId: string;
         createdAt: string;
     };
@@ -1083,9 +1098,9 @@ type GetPayeeDetailsResponse = {
 };
 type ValidatePayeeDetailsRequest = {
     processorName: string;
-    depositData: {
-        [key: string]: string;
-    };
+    offchainId: string;
+    telegramUsername?: string | null;
+    metadata?: Record<string, string> | null;
 };
 type ValidatePayeeDetailsResponse = {
     success: boolean;
@@ -1125,9 +1140,13 @@ type CreateDepositParams = {
     intentAmountRange: Range;
     conversionRates: CreateDepositConversionRate[][];
     processorNames: string[];
-    depositData: {
-        [key: string]: string;
-    }[];
+    /**
+     * Required when the SDK needs to register payee details with the curator.
+     * Optional when reusing `payeeDetailsHashes` or supplying the full override arrays.
+     */
+    payeeData?: CuratorPayeeDataInput[];
+    /** @deprecated Use `payeeData` instead. */
+    depositData?: CuratorPayeeDataInput[];
     payeeDetailsHashes?: string[];
     paymentMethodsOverride?: `0x${string}`[];
     paymentMethodDataOverride?: DepositVerifierData[];
@@ -1553,7 +1572,7 @@ type OnchainCurrencyEntry = {
  * // Step 1: Register payee details (separate from deposit creation)
  * const { hashedOnchainIds } = await client.registerPayeeDetails({
  *   processorNames: ['wise'],
- *   depositData: [{ email: 'you@example.com' }],
+ *   payeeData: [{ offchainId: 'you@example.com' }],
  * });
  *
  * // Step 2: Create a 1000 USDC deposit accepting Wise payments
@@ -1562,7 +1581,7 @@ type OnchainCurrencyEntry = {
  *   amount: 1000_000000n,
  *   intentAmountRange: { min: 10_000000n, max: 500_000000n },
  *   processorNames: ['wise'],
- *   depositData: [{ email: 'you@example.com' }],
+ *   payeeData: [{ offchainId: 'you@example.com' }],
  *   conversionRates: [[
  *     { currency: 'USD', conversionRate: '1020000000000000000' },
  *     { currency: 'EUR', conversionRate: '1100000000000000000' },
@@ -2011,23 +2030,22 @@ declare class Zkp2pClient {
      * register maker payment details with the curator service.
      *
      * @param params.processorNames - Payment platforms (e.g., ['wise', 'revolut'])
-     * @param params.depositData - Payee details per processor (e.g., [{ email: '...' }])
+     * @param params.payeeData - Payee details per processor (e.g., [{ offchainId: 'you@example.com' }]). Required when the SDK needs to register payee details with the curator.
      * @returns The posted deposit details and their corresponding hashed on-chain IDs
      *
      * @example
      * ```typescript
      * const { hashedOnchainIds } = await client.registerPayeeDetails({
      *   processorNames: ['wise'],
-     *   depositData: [{ email: 'you@example.com' }],
+     *   payeeData: [{ offchainId: 'you@example.com' }],
      * });
      * // Then pass hashedOnchainIds to createDeposit
      * ```
      */
     registerPayeeDetails(params: {
         processorNames: string[];
-        depositData: {
-            [key: string]: string;
-        }[];
+        payeeData?: CuratorPayeeDataInput[];
+        depositData?: CuratorPayeeDataInput[];
     }): Promise<{
         depositDetails: PostDepositDetailsRequest[];
         hashedOnchainIds: string[];
@@ -2045,16 +2063,17 @@ declare class Zkp2pClient {
      * @param params.amount - Total deposit amount in token units (6 decimals for USDC)
      * @param params.intentAmountRange - Min/max amount per intent
      * @param params.processorNames - Payment platforms to accept (e.g., ['wise', 'revolut'])
-     * @param params.depositData - Payee details per processor (e.g., [{ email: '...' }])
+     * @param params.payeeData - Payee details per processor (e.g., [{ offchainId: 'you@example.com' }])
      * @param params.conversionRates - Conversion rates per processor, grouped by currency
      * @param params.payeeDetailsHashes - Pre-computed hashed on-chain IDs (from registerPayeeDetails). When provided, skips the curator API call entirely.
      * @param params.delegate - Optional delegate address that can manage the deposit
      * @param params.intentGuardian - Optional guardian for intent approval
      * @param params.retainOnEmpty - Keep deposit active when balance reaches zero
      * @param params.txOverrides - Optional viem transaction overrides
-     * @returns The deposit details posted to API and the transaction hash
+     * @returns The deposit details posted to API (empty when payee registration is skipped) and the transaction hash
      *
-     * @throws Error if processorNames, depositData, and conversionRates lengths don't match
+     * @throws Error if processorNames, payeeData, and conversionRates lengths don't match
+     * @throws Error if payeeData is missing and neither payeeDetailsHashes nor full payment method overrides are provided
      * @throws Error if a currency is not supported by the specified processor
      *
      * @example
@@ -2065,7 +2084,7 @@ declare class Zkp2pClient {
      *   amount: 1000_000000n,
      *   intentAmountRange: { min: 10_000000n, max: 500_000000n },
      *   processorNames: ['wise'],
-     *   depositData: [{ email: 'you@example.com' }],
+     *   payeeData: [{ offchainId: 'you@example.com' }],
      *   conversionRates: [[
      *     { currency: 'USD', conversionRate: '1020000000000000000' }, // 1.02
      *     { currency: 'EUR', conversionRate: '1100000000000000000' }, // 1.10
@@ -2082,9 +2101,8 @@ declare class Zkp2pClient {
             max: bigint;
         };
         processorNames: string[];
-        depositData: {
-            [key: string]: string;
-        }[];
+        payeeData?: CuratorPayeeDataInput[];
+        depositData?: CuratorPayeeDataInput[];
         conversionRates: {
             currency: string;
             conversionRate: string;
@@ -2120,9 +2138,8 @@ declare class Zkp2pClient {
             max: bigint;
         };
         processorNames: string[];
-        depositData: {
-            [key: string]: string;
-        }[];
+        payeeData?: CuratorPayeeDataInput[];
+        depositData?: CuratorPayeeDataInput[];
         conversionRates: {
             currency: string;
             conversionRate: string;
@@ -2588,7 +2605,7 @@ declare class Zkp2pClient {
      * sending fiat payment to the deposit's payee.
      *
      * If `gatingServiceSignature` is not provided, the SDK will automatically
-     * fetch one from curator `/v3/intent` when `apiKey` or `authorizationToken`
+     * fetch one from curator `/v3/intent/sign` when `apiKey` or `authorizationToken`
      * is available. Otherwise you must provide `gatingServiceSignature` and
      * `signatureExpiration` yourself.
      *

package/dist/{vaultUtils-sodi4Xx-.d.ts → vaultUtils-DATqc35J.d.ts}

@@ -423,6 +423,7 @@ type IntentStatus = `${IntentStatus$1}`;
 type DepositEntity = WithOverrides<Deposit, {
     status: DepositStatus$1;
     retainOnEmpty?: boolean;
+    whitelistHookAddress?: string | null;
 }>;
 type DepositPaymentMethodEntity = DepositPaymentMethod;
 type MethodCurrencyEntity = MethodCurrency;
@@ -773,6 +774,16 @@ type ReferrerFeeConfig = {
     recipient: `0x${string}`;
     feeBps: number;
 };
+type CuratorPayeeData = {
+    offchainId: string;
+    telegramUsername: string | null;
+    metadata: Record<string, string> | null;
+};
+type CuratorPayeeDataInput = {
+    offchainId: string;
+    telegramUsername?: string | null;
+    metadata?: Record<string, string> | null;
+};
 /**
  * Parameters for fulfilling an intent with payment attestation
  */
@@ -836,10 +847,12 @@ type SignalIntentParams = {
  * Request structure for posting deposit details
  */
 type PostDepositDetailsRequest = {
-    /** Deposit data key-value pairs */
-    depositData: {
-        [key: string]: string;
-    };
+    /** Primary offchain payment identifier for the processor */
+    offchainId: string;
+    /** Optional Telegram username associated with the payee */
+    telegramUsername?: string | null;
+    /** Optional processor-specific metadata */
+    metadata?: Record<string, string> | null;
     /** Payment processor name */
     processorName: string;
 };
@@ -853,9 +866,9 @@ type PostDepositDetailsResponse = {
     responseObject: {
         id: number;
         processorName: string;
-        depositData: {
-            [key: string]: string;
-        };
+        offchainId: string;
+        telegramUsername: string | null;
+        metadata: Record<string, string> | null;
         hashedOnchainId: string;
         createdAt: string;
     };
@@ -887,6 +900,8 @@ type QuoteRequest = {
     nearbySearchRange?: number;
     /** Max suggestions per direction (1-10, default: 3) */
     nearbyQuotesCount?: number;
+    /** Include whitelist-gated private orderbook deposits scoped to the requesting user */
+    includePrivateOrderbooks?: boolean;
 };
 type QuotesBestByPlatformRequest = {
     fiatCurrency: string;
@@ -957,7 +972,7 @@ type QuoteSingleResponse = {
     conversionRate: string;
     takerConversionRate?: string;
     intent: QuoteIntentResponse;
-    payeeData?: Record<string, string>;
+    payeeData?: CuratorPayeeData;
 };
 type GetQuoteSingleResponse = QuoteSingleResponse & {
     referrerFeeAmount?: string;
@@ -1073,9 +1088,9 @@ type GetPayeeDetailsResponse = {
     responseObject: {
         id: number;
         processorName: string;
-        depositData: {
-            [key: string]: string;
-        };
+        offchainId: string;
+        telegramUsername: string | null;
+        metadata: Record<string, string> | null;
         hashedOnchainId: string;
         createdAt: string;
     };
@@ -1083,9 +1098,9 @@ type GetPayeeDetailsResponse = {
 };
 type ValidatePayeeDetailsRequest = {
     processorName: string;
-    depositData: {
-        [key: string]: string;
-    };
+    offchainId: string;
+    telegramUsername?: string | null;
+    metadata?: Record<string, string> | null;
 };
 type ValidatePayeeDetailsResponse = {
     success: boolean;
@@ -1125,9 +1140,13 @@ type CreateDepositParams = {
     intentAmountRange: Range;
     conversionRates: CreateDepositConversionRate[][];
     processorNames: string[];
-    depositData: {
-        [key: string]: string;
-    }[];
+    /**
+     * Required when the SDK needs to register payee details with the curator.
+     * Optional when reusing `payeeDetailsHashes` or supplying the full override arrays.
+     */
+    payeeData?: CuratorPayeeDataInput[];
+    /** @deprecated Use `payeeData` instead. */
+    depositData?: CuratorPayeeDataInput[];
     payeeDetailsHashes?: string[];
     paymentMethodsOverride?: `0x${string}`[];
     paymentMethodDataOverride?: DepositVerifierData[];
@@ -1553,7 +1572,7 @@ type OnchainCurrencyEntry = {
  * // Step 1: Register payee details (separate from deposit creation)
  * const { hashedOnchainIds } = await client.registerPayeeDetails({
  *   processorNames: ['wise'],
- *   depositData: [{ email: 'you@example.com' }],
+ *   payeeData: [{ offchainId: 'you@example.com' }],
  * });
  *
  * // Step 2: Create a 1000 USDC deposit accepting Wise payments
@@ -1562,7 +1581,7 @@ type OnchainCurrencyEntry = {
  *   amount: 1000_000000n,
  *   intentAmountRange: { min: 10_000000n, max: 500_000000n },
  *   processorNames: ['wise'],
- *   depositData: [{ email: 'you@example.com' }],
+ *   payeeData: [{ offchainId: 'you@example.com' }],
  *   conversionRates: [[
  *     { currency: 'USD', conversionRate: '1020000000000000000' },
  *     { currency: 'EUR', conversionRate: '1100000000000000000' },
@@ -2011,23 +2030,22 @@ declare class Zkp2pClient {
      * register maker payment details with the curator service.
      *
      * @param params.processorNames - Payment platforms (e.g., ['wise', 'revolut'])
-     * @param params.depositData - Payee details per processor (e.g., [{ email: '...' }])
+     * @param params.payeeData - Payee details per processor (e.g., [{ offchainId: 'you@example.com' }]). Required when the SDK needs to register payee details with the curator.
      * @returns The posted deposit details and their corresponding hashed on-chain IDs
      *
      * @example
      * ```typescript
      * const { hashedOnchainIds } = await client.registerPayeeDetails({
      *   processorNames: ['wise'],
-     *   depositData: [{ email: 'you@example.com' }],
+     *   payeeData: [{ offchainId: 'you@example.com' }],
      * });
      * // Then pass hashedOnchainIds to createDeposit
      * ```
      */
     registerPayeeDetails(params: {
         processorNames: string[];
-        depositData: {
-            [key: string]: string;
-        }[];
+        payeeData?: CuratorPayeeDataInput[];
+        depositData?: CuratorPayeeDataInput[];
     }): Promise<{
         depositDetails: PostDepositDetailsRequest[];
         hashedOnchainIds: string[];
@@ -2045,16 +2063,17 @@ declare class Zkp2pClient {
      * @param params.amount - Total deposit amount in token units (6 decimals for USDC)
      * @param params.intentAmountRange - Min/max amount per intent
      * @param params.processorNames - Payment platforms to accept (e.g., ['wise', 'revolut'])
-     * @param params.depositData - Payee details per processor (e.g., [{ email: '...' }])
+     * @param params.payeeData - Payee details per processor (e.g., [{ offchainId: 'you@example.com' }])
      * @param params.conversionRates - Conversion rates per processor, grouped by currency
      * @param params.payeeDetailsHashes - Pre-computed hashed on-chain IDs (from registerPayeeDetails). When provided, skips the curator API call entirely.
      * @param params.delegate - Optional delegate address that can manage the deposit
      * @param params.intentGuardian - Optional guardian for intent approval
      * @param params.retainOnEmpty - Keep deposit active when balance reaches zero
      * @param params.txOverrides - Optional viem transaction overrides
-     * @returns The deposit details posted to API and the transaction hash
+     * @returns The deposit details posted to API (empty when payee registration is skipped) and the transaction hash
      *
-     * @throws Error if processorNames, depositData, and conversionRates lengths don't match
+     * @throws Error if processorNames, payeeData, and conversionRates lengths don't match
+     * @throws Error if payeeData is missing and neither payeeDetailsHashes nor full payment method overrides are provided
      * @throws Error if a currency is not supported by the specified processor
      *
      * @example
@@ -2065,7 +2084,7 @@ declare class Zkp2pClient {
      *   amount: 1000_000000n,
      *   intentAmountRange: { min: 10_000000n, max: 500_000000n },
      *   processorNames: ['wise'],
-     *   depositData: [{ email: 'you@example.com' }],
+     *   payeeData: [{ offchainId: 'you@example.com' }],
      *   conversionRates: [[
      *     { currency: 'USD', conversionRate: '1020000000000000000' }, // 1.02
      *     { currency: 'EUR', conversionRate: '1100000000000000000' }, // 1.10
@@ -2082,9 +2101,8 @@ declare class Zkp2pClient {
             max: bigint;
         };
         processorNames: string[];
-        depositData: {
-            [key: string]: string;
-        }[];
+        payeeData?: CuratorPayeeDataInput[];
+        depositData?: CuratorPayeeDataInput[];
         conversionRates: {
             currency: string;
             conversionRate: string;
@@ -2120,9 +2138,8 @@ declare class Zkp2pClient {
             max: bigint;
         };
         processorNames: string[];
-        depositData: {
-            [key: string]: string;
-        }[];
+        payeeData?: CuratorPayeeDataInput[];
+        depositData?: CuratorPayeeDataInput[];
         conversionRates: {
             currency: string;
             conversionRate: string;
@@ -2588,7 +2605,7 @@ declare class Zkp2pClient {
      * sending fiat payment to the deposit's payee.
      *
      * If `gatingServiceSignature` is not provided, the SDK will automatically
-     * fetch one from curator `/v3/intent` when `apiKey` or `authorizationToken`
+     * fetch one from curator `/v3/intent/sign` when `apiKey` or `authorizationToken`
      * is available. Otherwise you must provide `gatingServiceSignature` and
      * `signatureExpiration` yourself.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkp2p/sdk",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "ZKP2P Client SDK - TypeScript SDK for deposit management, liquidity provision, and onramping",
   "license": "MIT",
   "main": "dist/index.cjs",