@usdctofiat/offramp 3.0.2 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { WalletClient } from 'viem';
2
- 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-DKQ2N_ih.cjs';
3
- export { g as CURRENCIES, h as DepositStatus, M as MakersCreateError, i as OFFRAMP_ERROR_CODES, j as OfframpError, k as OfframpErrorCode, l as OfframpProgress, m as OfframpState, n as OfframpStep, o as PLATFORMS, p as PayeeDepositData, q as PeerExtensionRegistrationInfo, r as PlatformKey, s as getPeerExtensionRegistrationInfo, t as isPeerExtensionRegistrationError, u as normalizePaypalMeUsername } from './errors-DKQ2N_ih.cjs';
2
+ import { f as OfframpParams, n as OnProgress, j as OfframpResult, c as OfframpCreateOptions, i as OfframpQuoteInput, h as OfframpQuote, m as OfframpVaultStatus, r as PlatformEntry, a as CurrencyEntry, D as DepositInfo } from './errors-D9bV_DWE.cjs';
3
+ export { C as CURRENCIES, b as DepositStatus, M as MakersCreateError, O as OFFRAMP_ERROR_CODES, d as OfframpError, e as OfframpErrorCode, g as OfframpProgress, k as OfframpState, l as OfframpStep, P as PLATFORMS, o as PLATFORM_LIMITS, p as PayeeDepositData, q as PeerExtensionRegistrationInfo, s as PlatformKey, t as PlatformLimits, u as PlatformTier, v as getPeerExtensionRegistrationInfo, w as getPlatformLimits, x as isPeerExtensionRegistrationError, y as isValidIBAN, z as normalizePaypalMeUsername } from './errors-D9bV_DWE.cjs';
4
4
  export { PEER_EXTENSION_CHROME_URL, PeerConnectionStatus, PeerExtensionApi, PeerExtensionOnrampParams, PeerExtensionSdk, PeerExtensionSdkOptions, PeerExtensionState, PeerExtensionWindow, PeerOnrampPreparedTransactionCallback, PeerOnrampPreparedTransactionResult, createPeerExtensionSdk, getPeerExtensionState, isPeerExtensionAvailable, openPeerExtensionInstallPage, peerExtensionSdk } from '@zkp2p/sdk';
5
5
 
6
6
  type TelemetryEventName = "sdk.init" | "sdk.createDeposit.start" | "sdk.createDeposit.progress" | "sdk.createDeposit.success" | "sdk.createDeposit.error";
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { WalletClient } from 'viem';
2
- 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-DKQ2N_ih.js';
3
- export { g as CURRENCIES, h as DepositStatus, M as MakersCreateError, i as OFFRAMP_ERROR_CODES, j as OfframpError, k as OfframpErrorCode, l as OfframpProgress, m as OfframpState, n as OfframpStep, o as PLATFORMS, p as PayeeDepositData, q as PeerExtensionRegistrationInfo, r as PlatformKey, s as getPeerExtensionRegistrationInfo, t as isPeerExtensionRegistrationError, u as normalizePaypalMeUsername } from './errors-DKQ2N_ih.js';
2
+ import { f as OfframpParams, n as OnProgress, j as OfframpResult, c as OfframpCreateOptions, i as OfframpQuoteInput, h as OfframpQuote, m as OfframpVaultStatus, r as PlatformEntry, a as CurrencyEntry, D as DepositInfo } from './errors-D9bV_DWE.js';
3
+ export { C as CURRENCIES, b as DepositStatus, M as MakersCreateError, O as OFFRAMP_ERROR_CODES, d as OfframpError, e as OfframpErrorCode, g as OfframpProgress, k as OfframpState, l as OfframpStep, P as PLATFORMS, o as PLATFORM_LIMITS, p as PayeeDepositData, q as PeerExtensionRegistrationInfo, s as PlatformKey, t as PlatformLimits, u as PlatformTier, v as getPeerExtensionRegistrationInfo, w as getPlatformLimits, x as isPeerExtensionRegistrationError, y as isValidIBAN, z as normalizePaypalMeUsername } from './errors-D9bV_DWE.js';
4
4
  export { PEER_EXTENSION_CHROME_URL, PeerConnectionStatus, PeerExtensionApi, PeerExtensionOnrampParams, PeerExtensionSdk, PeerExtensionSdkOptions, PeerExtensionState, PeerExtensionWindow, PeerOnrampPreparedTransactionCallback, PeerOnrampPreparedTransactionResult, createPeerExtensionSdk, getPeerExtensionState, isPeerExtensionAvailable, openPeerExtensionInstallPage, peerExtensionSdk } from '@zkp2p/sdk';
5
5
 
6
6
  type TelemetryEventName = "sdk.init" | "sdk.createDeposit.start" | "sdk.createDeposit.progress" | "sdk.createDeposit.success" | "sdk.createDeposit.error";
package/dist/index.js CHANGED
@@ -6,6 +6,7 @@ import {
6
6
  OfframpError,
7
7
  PEER_EXTENSION_CHROME_URL,
8
8
  PLATFORMS,
9
+ PLATFORM_LIMITS,
9
10
  close,
10
11
  createOfframp,
11
12
  createPeerExtensionSdk,
@@ -18,8 +19,10 @@ import {
18
19
  getOtcLink,
19
20
  getPeerExtensionRegistrationInfo,
20
21
  getPeerExtensionState,
22
+ getPlatformLimits,
21
23
  isPeerExtensionAvailable,
22
24
  isPeerExtensionRegistrationError,
25
+ isValidIBAN,
23
26
  normalizePaypalMeUsername,
24
27
  offramp,
25
28
  openPeerExtensionInstallPage,
@@ -27,7 +30,7 @@ import {
27
30
  sanitizeAttributionId,
28
31
  sendTelemetryEvent,
29
32
  undelegate
30
- } from "./chunk-F7DVUBMT.js";
33
+ } from "./chunk-4KKKDDES.js";
31
34
 
32
35
  // src/types.ts
33
36
  var OFFRAMP_ERROR_CODES = {
@@ -58,6 +61,7 @@ export {
58
61
  OfframpError,
59
62
  PEER_EXTENSION_CHROME_URL,
60
63
  PLATFORMS,
64
+ PLATFORM_LIMITS,
61
65
  close,
62
66
  createOfframp,
63
67
  createPeerExtensionSdk,
@@ -70,8 +74,10 @@ export {
70
74
  getOtcLink,
71
75
  getPeerExtensionRegistrationInfo,
72
76
  getPeerExtensionState,
77
+ getPlatformLimits,
73
78
  isPeerExtensionAvailable,
74
79
  isPeerExtensionRegistrationError,
80
+ isValidIBAN,
75
81
  normalizePaypalMeUsername,
76
82
  offramp,
77
83
  openPeerExtensionInstallPage,
package/dist/index.js.map CHANGED
@@ -1 +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 `peerExtensionSdk`\n * directly, then call `offramp()` again.\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 /** 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;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":[]}
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 `peerExtensionSdk`\n * directly, then call `offramp()` again.\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 /** 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;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":[]}