@usdctofiat/offramp 4.0.0 → 4.1.0

package/dist/index.d.cts

@@ -64,7 +64,19 @@ type PeerExtensionWindow = Window & {
 };
 type PeerExtensionSdkOptions = {
     window?: PeerExtensionWindow;
+    /**
+     * Chrome Web Store listing opened by `openInstallPage()`. Defaults to the
+     * USDCtoFiat Verify listing; pass `PEER_EXTENSION_CHROME_URL` (re-exported
+     * from `@zkp2p/sdk`) to target the legacy PeerAuth listing, or any custom
+     * branded-extension listing.
+     */
+    installUrl?: string;
 };
+/**
+ * Default install target: the USDCtoFiat Verify extension (branded fork of
+ * PeerAuth implementing the same window.peer interface).
+ */
+declare const DEFAULT_EXTENSION_INSTALL_URL = "https://chromewebstore.google.com/detail/usdctofiat-verify/lfkmdfifolhcfjmhklmckigfngghmpdf";
 type PeerExtensionSdk = {
     requestConnection(): Promise<boolean>;
     checkConnectionStatus(): Promise<PeerConnectionStatus>;
@@ -171,4 +183,4 @@ declare function disableOtc(walletClient: WalletClient, depositId: string, escro
  */
 declare function getOtcLink(depositId: string, escrowAddress?: string): string;
 
-export { CurrencyEntry, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, Offramp, OfframpCreateOptions, OfframpParams, OfframpQuote, OfframpQuoteInput, OfframpResult, OfframpVaultStatus, OnProgress, type PeerExtensionApi, type PeerExtensionSdk, type PeerExtensionSdkOptions, type PeerExtensionState, type PeerExtensionWindow, type PeerSarCredentialBundle, PlatformEntry, close, createOfframp, createPeerExtensionSdk, createTelemetryContext, delegate, deposits, disableOtc, emitEvent, enableOtc, getOtcLink, getPeerExtensionState, isPeerExtensionAvailable, isPeerExtensionMetadataBridgeAvailable, offramp, openPeerExtensionInstallPage, peerExtensionSdk, sanitizeAttributionId, sendTelemetryEvent, undelegate };
+export { CurrencyEntry, DEFAULT_EXTENSION_INSTALL_URL, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, Offramp, OfframpCreateOptions, OfframpParams, OfframpQuote, OfframpQuoteInput, OfframpResult, OfframpVaultStatus, OnProgress, type PeerExtensionApi, type PeerExtensionSdk, type PeerExtensionSdkOptions, type PeerExtensionState, type PeerExtensionWindow, type PeerSarCredentialBundle, PlatformEntry, close, createOfframp, createPeerExtensionSdk, createTelemetryContext, delegate, deposits, disableOtc, emitEvent, enableOtc, getOtcLink, getPeerExtensionState, isPeerExtensionAvailable, isPeerExtensionMetadataBridgeAvailable, offramp, openPeerExtensionInstallPage, peerExtensionSdk, sanitizeAttributionId, sendTelemetryEvent, undelegate };

package/dist/index.d.ts

@@ -64,7 +64,19 @@ type PeerExtensionWindow = Window & {
 };
 type PeerExtensionSdkOptions = {
     window?: PeerExtensionWindow;
+    /**
+     * Chrome Web Store listing opened by `openInstallPage()`. Defaults to the
+     * USDCtoFiat Verify listing; pass `PEER_EXTENSION_CHROME_URL` (re-exported
+     * from `@zkp2p/sdk`) to target the legacy PeerAuth listing, or any custom
+     * branded-extension listing.
+     */
+    installUrl?: string;
 };
+/**
+ * Default install target: the USDCtoFiat Verify extension (branded fork of
+ * PeerAuth implementing the same window.peer interface).
+ */
+declare const DEFAULT_EXTENSION_INSTALL_URL = "https://chromewebstore.google.com/detail/usdctofiat-verify/lfkmdfifolhcfjmhklmckigfngghmpdf";
 type PeerExtensionSdk = {
     requestConnection(): Promise<boolean>;
     checkConnectionStatus(): Promise<PeerConnectionStatus>;
@@ -171,4 +183,4 @@ declare function disableOtc(walletClient: WalletClient, depositId: string, escro
  */
 declare function getOtcLink(depositId: string, escrowAddress?: string): string;
 
-export { CurrencyEntry, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, Offramp, OfframpCreateOptions, OfframpParams, OfframpQuote, OfframpQuoteInput, OfframpResult, OfframpVaultStatus, OnProgress, type PeerExtensionApi, type PeerExtensionSdk, type PeerExtensionSdkOptions, type PeerExtensionState, type PeerExtensionWindow, type PeerSarCredentialBundle, PlatformEntry, close, createOfframp, createPeerExtensionSdk, createTelemetryContext, delegate, deposits, disableOtc, emitEvent, enableOtc, getOtcLink, getPeerExtensionState, isPeerExtensionAvailable, isPeerExtensionMetadataBridgeAvailable, offramp, openPeerExtensionInstallPage, peerExtensionSdk, sanitizeAttributionId, sendTelemetryEvent, undelegate };
+export { CurrencyEntry, DEFAULT_EXTENSION_INSTALL_URL, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, Offramp, OfframpCreateOptions, OfframpParams, OfframpQuote, OfframpQuoteInput, OfframpResult, OfframpVaultStatus, OnProgress, type PeerExtensionApi, type PeerExtensionSdk, type PeerExtensionSdkOptions, type PeerExtensionState, type PeerExtensionWindow, type PeerSarCredentialBundle, PlatformEntry, close, createOfframp, createPeerExtensionSdk, createTelemetryContext, delegate, deposits, disableOtc, emitEvent, enableOtc, getOtcLink, getPeerExtensionState, isPeerExtensionAvailable, isPeerExtensionMetadataBridgeAvailable, offramp, openPeerExtensionInstallPage, peerExtensionSdk, sanitizeAttributionId, sendTelemetryEvent, undelegate };

package/dist/index.js

@@ -1,5 +1,6 @@
 import {
   CURRENCIES,
+  DEFAULT_EXTENSION_INSTALL_URL,
   ESCROW_ADDRESS,
   MakersCreateError,
   Offramp,
@@ -33,7 +34,7 @@ import {
   sanitizeAttributionId,
   sendTelemetryEvent,
   undelegate
-} from "./chunk-QMO7HTBZ.js";
+} from "./chunk-PL7GZI4K.js";
 
 // src/types.ts
 var OFFRAMP_ERROR_CODES = {
@@ -57,6 +58,7 @@ var OFFRAMP_ERROR_CODES = {
 };
 export {
   CURRENCIES,
+  DEFAULT_EXTENSION_INSTALL_URL,
   ESCROW_ADDRESS,
   MakersCreateError,
   OFFRAMP_ERROR_CODES,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { PlatformEntry } from \"./platforms\";\nimport type { CurrencyEntry } from \"./currencies\";\n\nexport const OFFRAMP_ERROR_CODES = {\n  VALIDATION: \"VALIDATION\",\n  APPROVAL_FAILED: \"APPROVAL_FAILED\",\n  REGISTRATION_FAILED: \"REGISTRATION_FAILED\",\n  /**\n   * Curator rejected the maker because the user has not registered this\n   * handle in the Peer extension yet. Thrown from `offramp()` for PayPal\n   * and Wise when `/v2/makers/create` returns 400 or a \"creating the maker\"\n   * message. Recover by prompting the user through the Peer extension via\n   * `usePeerExtensionRegistration(platform)` (React) or\n   * `completePeerExtensionRegistration(...)`, then retrying `offramp()`.\n   */\n  EXTENSION_REGISTRATION_REQUIRED: \"EXTENSION_REGISTRATION_REQUIRED\",\n  DEPOSIT_FAILED: \"DEPOSIT_FAILED\",\n  CONFIRMATION_FAILED: \"CONFIRMATION_FAILED\",\n  DELEGATION_FAILED: \"DELEGATION_FAILED\",\n  USER_CANCELLED: \"USER_CANCELLED\",\n  UNSUPPORTED: \"UNSUPPORTED\",\n} as const;\n\nexport type OfframpErrorCode = (typeof OFFRAMP_ERROR_CODES)[keyof typeof OFFRAMP_ERROR_CODES];\n\nexport interface OfframpParams {\n  /** USDC amount as decimal string, min 1. */\n  amount: string;\n  /** Payment platform — use `PLATFORMS.REVOLUT` etc. */\n  platform: PlatformEntry;\n  /** Fiat currency — use `CURRENCIES.EUR` etc. */\n  currency: CurrencyEntry;\n  /** Platform-specific identifier (username, email, IBAN). */\n  identifier: string;\n  /** Optional: restrict the deposit to this taker wallet (OTC private order). */\n  otcTaker?: string;\n  /** Optional SDK-only referral metadata for telemetry attribution. */\n  referralId?: string;\n  /** Optional SDK-only integrator metadata for telemetry attribution. */\n  integratorId?: string;\n  /**\n   * Optional per-wallet key to replay the first successful result for 10 minutes.\n   *\n   * Browser-only: the replay cache is backed by `sessionStorage` and is a no-op\n   * in Node/worker runtimes (no duplicate protection there). It is honored only\n   * by the `Offramp` class (`createDeposit`) / the `useOfframp` hook — the\n   * standalone `offramp()` function ignores it. For server-side dedup, call\n   * `deposits(walletAddress)` and reuse an existing open deposit before creating\n   * a new one (the SDK's own resume behavior does this for the delegation step).\n   */\n  idempotencyKey?: string;\n}\n\nexport interface OfframpResult {\n  depositId: string;\n  txHash: string;\n  /** Whether an existing undelegated deposit was resumed. */\n  resumed: boolean;\n  /** OTC link for the taker, present when `otcTaker` was provided. */\n  otcLink?: string;\n}\n\nexport type OfframpStep =\n  | \"approving\"\n  | \"registering\"\n  | \"depositing\"\n  | \"confirming\"\n  | \"delegating\"\n  | \"restricting\"\n  | \"resuming\"\n  | \"done\";\n\nexport type OfframpState =\n  | \"idle\"\n  | \"approving\"\n  | \"registering\"\n  | \"depositing\"\n  | \"confirming\"\n  | \"delegating\"\n  | \"done\"\n  | \"error\";\n\nexport interface OfframpProgress {\n  step: OfframpStep;\n  txHash?: string;\n  depositId?: string;\n}\n\nexport type OnProgress = (progress: OfframpProgress) => void;\n\nexport type DepositStatus = \"active\" | \"empty\" | \"closed\";\n\nexport interface OfframpQuoteInput {\n  amount: string;\n  currency: CurrencyEntry;\n  platform: PlatformEntry;\n}\n\nexport interface OfframpQuote {\n  amountUsdc: number;\n  expectedFiat: number;\n  effectiveRate: number;\n  vaultSpreadBps: number;\n}\n\nexport interface OfframpVaultStatus {\n  rateManagerId: string;\n  rateManagerAddress: string;\n  /**\n   * Delegate vault manager fee in basis points (currently 10 = 0.10%). Charged\n   * by the vault's rate manager on each fill and deducted from the USDC released\n   * to the buyer; not added to the maker's deposit cost. See the README \"Fees\".\n   */\n  feeRateBps: number;\n  escrow: string;\n  isActive: boolean;\n}\n\nexport interface OfframpCreateOptions {\n  integratorId?: string;\n  referralId?: string;\n  telemetry?: boolean;\n  /**\n   * Override the curator REST base URL (default `https://api.zkp2p.xyz`) used\n   * for maker registration/validation and the SDK's REST calls. For\n   * testing/proxying/mocking only — the indexer and Base RPC always target\n   * mainnet. Honored by the `Offramp` class (`createDeposit`); absent ⇒ default\n   * behavior is unchanged.\n   */\n  apiBaseUrl?: string;\n}\n\nexport interface DepositInfo {\n  /** Numeric deposit ID. Pass this to `close()`. */\n  depositId: string;\n  /** Composite ID (escrowAddress_depositId). */\n  compositeId: string;\n  /** Creation transaction hash. */\n  txHash?: string;\n  status: DepositStatus;\n  remainingUsdc: number;\n  outstandingUsdc: number;\n  totalTakenUsdc: number;\n  fulfilledIntents: number;\n  paymentMethods: string[];\n  currencies: string[];\n  rateSource: string;\n  delegated: boolean;\n  escrowAddress: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGO,IAAM,sBAAsB;AAAA,EACjC,YAAY;AAAA,EACZ,iBAAiB;AAAA,EACjB,qBAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASrB,iCAAiC;AAAA,EACjC,gBAAgB;AAAA,EAChB,qBAAqB;AAAA,EACrB,mBAAmB;AAAA,EACnB,gBAAgB;AAAA,EAChB,aAAa;AACf;","names":[]}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { PlatformEntry } from \"./platforms\";\nimport type { CurrencyEntry } from \"./currencies\";\n\nexport const OFFRAMP_ERROR_CODES = {\n  VALIDATION: \"VALIDATION\",\n  APPROVAL_FAILED: \"APPROVAL_FAILED\",\n  REGISTRATION_FAILED: \"REGISTRATION_FAILED\",\n  /**\n   * Curator rejected the maker because the user has not registered this\n   * handle in the Peer extension yet. Thrown from `offramp()` for PayPal\n   * and Wise when `/v2/makers/create` returns 400 or a \"creating the maker\"\n   * message. Recover by prompting the user through the Peer extension via\n   * `usePeerExtensionRegistration(platform)` (React) or\n   * `completePeerExtensionRegistration(...)`, then retrying `offramp()`.\n   */\n  EXTENSION_REGISTRATION_REQUIRED: \"EXTENSION_REGISTRATION_REQUIRED\",\n  DEPOSIT_FAILED: \"DEPOSIT_FAILED\",\n  CONFIRMATION_FAILED: \"CONFIRMATION_FAILED\",\n  DELEGATION_FAILED: \"DELEGATION_FAILED\",\n  USER_CANCELLED: \"USER_CANCELLED\",\n  UNSUPPORTED: \"UNSUPPORTED\",\n} as const;\n\nexport type OfframpErrorCode = (typeof OFFRAMP_ERROR_CODES)[keyof typeof OFFRAMP_ERROR_CODES];\n\nexport interface OfframpParams {\n  /** USDC amount as decimal string, min 1. */\n  amount: string;\n  /** Payment platform — use `PLATFORMS.REVOLUT` etc. */\n  platform: PlatformEntry;\n  /** Fiat currency — use `CURRENCIES.EUR` etc. */\n  currency: CurrencyEntry;\n  /** Platform-specific identifier (username, email, IBAN). */\n  identifier: string;\n  /** Optional: restrict the deposit to this taker wallet (OTC private order). */\n  otcTaker?: string;\n  /** Optional SDK-only referral metadata for telemetry attribution. */\n  referralId?: string;\n  /** Optional SDK-only integrator metadata for telemetry attribution. */\n  integratorId?: string;\n  /**\n   * Optional per-wallet key to replay the first successful result for 10 minutes.\n   *\n   * Browser-only: the replay cache is backed by `sessionStorage` and is a no-op\n   * in Node/worker runtimes (no duplicate protection there). It is honored only\n   * by the `Offramp` class (`createDeposit`) / the `useOfframp` hook — the\n   * standalone `offramp()` function ignores it. For server-side dedup, call\n   * `deposits(walletAddress)` and reuse an existing open deposit before creating\n   * a new one (the SDK's own resume behavior does this for the delegation step).\n   */\n  idempotencyKey?: string;\n}\n\nexport interface OfframpResult {\n  depositId: string;\n  txHash: string;\n  /** Whether an existing undelegated deposit was resumed. */\n  resumed: boolean;\n  /** OTC link for the taker, present when `otcTaker` was provided. */\n  otcLink?: string;\n}\n\nexport type OfframpStep =\n  | \"approving\"\n  | \"registering\"\n  | \"depositing\"\n  | \"confirming\"\n  | \"delegating\"\n  | \"restricting\"\n  | \"resuming\"\n  | \"done\";\n\nexport type OfframpState =\n  | \"idle\"\n  | \"approving\"\n  | \"registering\"\n  | \"depositing\"\n  | \"confirming\"\n  | \"delegating\"\n  | \"done\"\n  | \"error\";\n\nexport interface OfframpProgress {\n  step: OfframpStep;\n  txHash?: string;\n  depositId?: string;\n}\n\nexport type OnProgress = (progress: OfframpProgress) => void;\n\nexport type DepositStatus = \"active\" | \"empty\" | \"closed\";\n\nexport interface OfframpQuoteInput {\n  amount: string;\n  currency: CurrencyEntry;\n  platform: PlatformEntry;\n}\n\nexport interface OfframpQuote {\n  amountUsdc: number;\n  expectedFiat: number;\n  effectiveRate: number;\n  vaultSpreadBps: number;\n}\n\nexport interface OfframpVaultStatus {\n  rateManagerId: string;\n  rateManagerAddress: string;\n  /**\n   * Delegate vault manager fee in basis points (currently 10 = 0.10%). Charged\n   * by the vault's rate manager on each fill and deducted from the USDC released\n   * to the buyer; not added to the maker's deposit cost. See the README \"Fees\".\n   */\n  feeRateBps: number;\n  escrow: string;\n  isActive: boolean;\n}\n\nexport interface OfframpCreateOptions {\n  integratorId?: string;\n  referralId?: string;\n  telemetry?: boolean;\n  /**\n   * Override the curator REST base URL (default `https://api.zkp2p.xyz`) used\n   * for maker registration/validation and the SDK's REST calls. For\n   * testing/proxying/mocking only — the indexer and Base RPC always target\n   * mainnet. Honored by the `Offramp` class (`createDeposit`); absent ⇒ default\n   * behavior is unchanged.\n   */\n  apiBaseUrl?: string;\n}\n\nexport interface DepositInfo {\n  /** Numeric deposit ID. Pass this to `close()`. */\n  depositId: string;\n  /** Composite ID (escrowAddress_depositId). */\n  compositeId: string;\n  /** Creation transaction hash. */\n  txHash?: string;\n  status: DepositStatus;\n  remainingUsdc: number;\n  outstandingUsdc: number;\n  totalTakenUsdc: number;\n  fulfilledIntents: number;\n  paymentMethods: string[];\n  currencies: string[];\n  rateSource: string;\n  delegated: boolean;\n  escrowAddress: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGO,IAAM,sBAAsB;AAAA,EACjC,YAAY;AAAA,EACZ,iBAAiB;AAAA,EACjB,qBAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASrB,iCAAiC;AAAA,EACjC,gBAAgB;AAAA,EAChB,qBAAqB;AAAA,EACrB,mBAAmB;AAAA,EACnB,gBAAgB;AAAA,EAChB,aAAa;AACf;","names":[]}

package/dist/react.cjs

@@ -40,7 +40,7 @@ var import_react = require("react");
 
 // src/config.ts
 var import_sdk = require("@zkp2p/sdk");
-var SDK_VERSION = "4.0.0";
+var SDK_VERSION = "4.1.0";
 var BASE_CHAIN_ID = 8453;
 var RUNTIME_ENV = "production";
 var API_BASE_URL = "https://api.zkp2p.xyz";
@@ -1602,6 +1602,7 @@ var import_react2 = require("react");
 
 // src/extension.ts
 var import_sdk7 = require("@zkp2p/sdk");
+var DEFAULT_EXTENSION_INSTALL_URL = "https://chromewebstore.google.com/detail/usdctofiat-verify/lfkmdfifolhcfjmhklmckigfngghmpdf";
 var resolveWindow = (options) => {
   if (options?.window) {
     return options.window;
@@ -1637,6 +1638,14 @@ var isPeerExtensionMetadataBridgeAvailable = (options) => {
   const resolvedWindow = resolveWindow(options);
   return Boolean(resolvedWindow?.peer && hasHeadlessMetadataBridge(resolvedWindow.peer));
 };
+var openPeerExtensionInstallPage = (options) => {
+  const resolvedWindow = resolveWindow(options);
+  if (!resolvedWindow) {
+    throw new Error("Peer extension SDK requires a browser window.");
+  }
+  const installUrl = options?.installUrl ?? DEFAULT_EXTENSION_INSTALL_URL;
+  resolvedWindow.open(installUrl, "_blank", "noopener,noreferrer");
+};
 var createPeerExtensionSdk = (options = {}) => {
   const sdk = (0, import_sdk7.createPeerExtensionSdk)(options);
   return {
@@ -1646,7 +1655,7 @@ var createPeerExtensionSdk = (options = {}) => {
     getVersion: () => requirePeer(options).getVersion(),
     authenticate: (params) => requirePeerMetadataBridge(options).authenticate(params),
     onMetadataMessage: (callback) => requirePeerMetadataBridge(options).onMetadataMessage(callback),
-    openInstallPage: () => sdk.openInstallPage(),
+    openInstallPage: () => openPeerExtensionInstallPage(options),
     getState: () => sdk.getState()
   };
 };
@@ -1723,7 +1732,7 @@ function usePeerExtensionRegistration(platform) {
       peerExtensionSdk.openInstallPage();
     } catch {
       if (typeof window !== "undefined") {
-        window.open(import_sdk7.PEER_EXTENSION_CHROME_URL, "_blank", "noopener,noreferrer");
+        window.open(DEFAULT_EXTENSION_INSTALL_URL, "_blank", "noopener,noreferrer");
       }
     }
   }, []);