@usdctofiat/offramp 1.1.3 → 1.3.0

package/dist/index.d.ts

@@ -1,15 +1,48 @@
 import { WalletClient } from 'viem';
-import { O as OfframpParams, a as OnProgress, b as OfframpResult, D as DepositInfo } from './errors-Dtzrl98J.js';
-export { C as CURRENCIES, c as CurrencyEntry, d as DepositStatus, e as OfframpError, f as OfframpErrorCode, g as OfframpProgress, h as OfframpStep, P as PLATFORMS, i as PlatformEntry } from './errors-Dtzrl98J.js';
+import { O as OfframpParams, a as OnProgress, b as OfframpResult, c as OfframpCreateOptions, d as OfframpQuoteInput, e as OfframpQuote, f as OfframpVaultStatus, P as PlatformEntry, C as CurrencyEntry, D as DepositInfo } from './errors-CfZrDly0.js';
+export { g as CURRENCIES, h as DepositStatus, i as OFFRAMP_ERROR_CODES, j as OfframpError, k as OfframpErrorCode, l as OfframpProgress, m as OfframpState, n as OfframpStep, o as PLATFORMS } from './errors-CfZrDly0.js';
 import '@zkp2p/sdk';
 
+type TelemetryEventName = "sdk.init" | "sdk.createDeposit.start" | "sdk.createDeposit.progress" | "sdk.createDeposit.success" | "sdk.createDeposit.error";
+interface TelemetryContext {
+    readonly enabled: boolean;
+    readonly sdkVersion: string;
+    readonly integratorId?: string;
+    readonly referralId?: string;
+    emit: (name: TelemetryEventName, payload?: Record<string, unknown>) => void;
+}
+interface CreateTelemetryContextOptions {
+    sdkVersion: string;
+    telemetry?: boolean;
+    integratorId?: string;
+    referralId?: string;
+}
+declare function sanitizeAttributionId(raw: unknown): string | undefined;
+declare function emitEvent(name: TelemetryEventName, payload?: Record<string, unknown>): void;
+declare function sendTelemetryEvent(name: TelemetryEventName, payload?: Record<string, unknown>): void;
+declare function createTelemetryContext(options: CreateTelemetryContextOptions): TelemetryContext;
+
 /**
  * Create a USDC-to-fiat offramp deposit and delegate it to the vault.
  *
  * **Resumable**: if an existing undelegated deposit is found for this wallet,
  * the flow skips directly to delegation instead of creating a new deposit.
  */
-declare function offramp(walletClient: WalletClient, params: OfframpParams, onProgress?: OnProgress): Promise<OfframpResult>;
+declare function offramp(walletClient: WalletClient, params: OfframpParams, onProgress?: OnProgress, telemetryContext?: TelemetryContext): Promise<OfframpResult>;
+
+interface OfframpConstructorOptions extends OfframpCreateOptions {
+    walletClient: WalletClient;
+}
+declare class Offramp {
+    private readonly walletClient;
+    private readonly telemetry;
+    constructor(options: OfframpConstructorOptions);
+    createDeposit(params: OfframpParams, onProgress?: OnProgress): Promise<OfframpResult>;
+    getQuote(input: OfframpQuoteInput): OfframpQuote;
+    getVaultStatus(): OfframpVaultStatus;
+    listCurrencies(): Record<PlatformEntry["id"], CurrencyEntry[]>;
+}
+declare function createOfframp(options: OfframpConstructorOptions): Offramp;
 
 /**
  * List all deposits for a wallet address. Read-only, no wallet needed.
@@ -23,6 +56,22 @@ declare function deposits(walletAddress: string): Promise<DepositInfo[]>;
  * @param depositId - The numeric deposit ID (from `DepositInfo.depositId`)
  */
 declare function close(walletClient: WalletClient, depositId: string, escrowAddress?: string): Promise<string>;
+/**
+ * Delegate a deposit to the configured Delegate vault.
+ *
+ * @param walletClient - viem WalletClient with the deposit owner's account
+ * @param depositId - The numeric deposit ID (from `DepositInfo.depositId`)
+ */
+declare function delegate(walletClient: WalletClient, depositId: string, escrowAddress?: string): Promise<string>;
+/**
+ * Remove Delegate rate management from a deposit.
+ *
+ * @param walletClient - viem WalletClient with the deposit owner's account
+ * @param depositId - The numeric deposit ID (from `DepositInfo.depositId`)
+ */
+declare function undelegate(walletClient: WalletClient, depositId: string, escrowAddress?: string): Promise<string>;
+
+declare const ESCROW_ADDRESS: `0x${string}`;
 
 interface EnableOtcResult {
     depositId: string;
@@ -57,4 +106,4 @@ declare function disableOtc(walletClient: WalletClient, depositId: string, escro
  */
 declare function getOtcLink(depositId: string, escrowAddress?: string): string;
 
-export { DepositInfo, type EnableOtcResult, OfframpParams, OfframpResult, OnProgress, close, deposits, disableOtc, enableOtc, getOtcLink, offramp };
+export { CurrencyEntry, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, Offramp, OfframpCreateOptions, OfframpParams, OfframpQuote, OfframpQuoteInput, OfframpResult, OfframpVaultStatus, OnProgress, PlatformEntry, close, createOfframp, createTelemetryContext, delegate, deposits, disableOtc, emitEvent, enableOtc, getOtcLink, offramp, sanitizeAttributionId, sendTelemetryEvent, undelegate };

package/dist/index.js

@@ -1,40 +1,54 @@
 import {
+  CURRENCIES,
+  ESCROW_ADDRESS,
+  Offramp,
   OfframpError,
   PLATFORMS,
   close,
+  createOfframp,
+  createTelemetryContext,
+  delegate,
   deposits,
   disableOtc,
+  emitEvent,
   enableOtc,
   getOtcLink,
-  offramp
-} from "./chunk-QELK2M73.js";
+  offramp,
+  sanitizeAttributionId,
+  sendTelemetryEvent,
+  undelegate
+} from "./chunk-JQBKGGI2.js";
 
-// src/currencies.ts
-import { currencyInfo } from "@zkp2p/sdk";
-function buildCurrencies() {
-  const entries = {};
-  for (const [code, info] of Object.entries(
-    currencyInfo
-  )) {
-    entries[code] = {
-      code: info.currencyCode ?? code,
-      name: info.currencyName ?? code,
-      symbol: info.currencySymbol ?? code,
-      countryCode: info.countryCode ?? ""
-    };
-  }
-  return entries;
-}
-var CURRENCIES = buildCurrencies();
+// src/types.ts
+var OFFRAMP_ERROR_CODES = {
+  VALIDATION: "VALIDATION",
+  APPROVAL_FAILED: "APPROVAL_FAILED",
+  REGISTRATION_FAILED: "REGISTRATION_FAILED",
+  DEPOSIT_FAILED: "DEPOSIT_FAILED",
+  CONFIRMATION_FAILED: "CONFIRMATION_FAILED",
+  DELEGATION_FAILED: "DELEGATION_FAILED",
+  USER_CANCELLED: "USER_CANCELLED",
+  UNSUPPORTED: "UNSUPPORTED"
+};
 export {
   CURRENCIES,
+  ESCROW_ADDRESS,
+  OFFRAMP_ERROR_CODES,
+  Offramp,
   OfframpError,
   PLATFORMS,
   close,
+  createOfframp,
+  createTelemetryContext,
+  delegate,
   deposits,
   disableOtc,
+  emitEvent,
   enableOtc,
   getOtcLink,
-  offramp
+  offramp,
+  sanitizeAttributionId,
+  sendTelemetryEvent,
+  undelegate
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/currencies.ts"],"sourcesContent":["import { currencyInfo } from \"@zkp2p/sdk\";\n\nexport interface CurrencyEntry {\n  readonly code: string;\n  readonly name: string;\n  readonly symbol: string;\n  readonly countryCode: string;\n}\n\ntype CurrencyMap = { readonly [K in keyof typeof currencyInfo]: CurrencyEntry };\n\nfunction buildCurrencies(): CurrencyMap {\n  const entries: Record<string, CurrencyEntry> = {};\n  for (const [code, info] of Object.entries(\n    currencyInfo as Record<\n      string,\n      {\n        currencyCode?: string;\n        currencyName?: string;\n        currencySymbol?: string;\n        countryCode?: string;\n      }\n    >,\n  )) {\n    entries[code] = {\n      code: info.currencyCode ?? code,\n      name: info.currencyName ?? code,\n      symbol: info.currencySymbol ?? code,\n      countryCode: info.countryCode ?? \"\",\n    };\n  }\n  return entries as CurrencyMap;\n}\n\n/** All supported currencies with metadata. Access via `CURRENCIES.EUR.symbol` etc. */\nexport const CURRENCIES = buildCurrencies();\n"],"mappings":";;;;;;;;;;;;AAAA,SAAS,oBAAoB;AAW7B,SAAS,kBAA+B;AACtC,QAAM,UAAyC,CAAC;AAChD,aAAW,CAAC,MAAM,IAAI,KAAK,OAAO;AAAA,IAChC;AAAA,EASF,GAAG;AACD,YAAQ,IAAI,IAAI;AAAA,MACd,MAAM,KAAK,gBAAgB;AAAA,MAC3B,MAAM,KAAK,gBAAgB;AAAA,MAC3B,QAAQ,KAAK,kBAAkB;AAAA,MAC/B,aAAa,KAAK,eAAe;AAAA,IACnC;AAAA,EACF;AACA,SAAO;AACT;AAGO,IAAM,aAAa,gBAAgB;","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  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  /** Optional per-wallet key to replay the first successful result for 10 minutes. */\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  feeRateBps: number;\n  escrow: string;\n  isActive: boolean;\n}\n\nexport interface OfframpCreateOptions {\n  integratorId?: string;\n  referralId?: string;\n  telemetry?: boolean;\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,EACrB,gBAAgB;AAAA,EAChB,qBAAqB;AAAA,EACrB,mBAAmB;AAAA,EACnB,gBAAgB;AAAA,EAChB,aAAa;AACf;","names":[]}