@usdctofiat/offramp 4.0.0 → 4.2.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { WalletClient } from 'viem';
-import { h as OfframpParams, p as OnProgress, l as OfframpResult, e as OfframpCreateOptions, k as OfframpQuoteInput, j as OfframpQuote, o as OfframpVaultStatus, t as PlatformEntry, c as CurrencyEntry, D as DepositInfo } from './errors-DYCRKcnY.cjs';
-export { C as CURRENCIES, a as CompletePeerExtensionRegistrationInput, b as CompletePeerExtensionRegistrationResult, d as DepositStatus, M as MakersCreateError, O as OFFRAMP_ERROR_CODES, f as OfframpError, g as OfframpErrorCode, i as OfframpProgress, m as OfframpState, n as OfframpStep, P as PLATFORMS, q as PLATFORM_LIMITS, r as PayeeDepositData, s as PeerExtensionRegistrationInfo, u as PlatformKey, v as PlatformLimits, w as PlatformTier, x as completePeerExtensionRegistration, y as getPeerExtensionRegistrationAuthParams, z as getPeerExtensionRegistrationInfo, A as getPlatformLimits, B as isPeerExtensionRegistrationError, E as isValidIBAN, F as normalizePaypalMeUsername } from './errors-DYCRKcnY.cjs';
+import { h as OfframpParams, p as OnProgress, l as OfframpResult, e as OfframpCreateOptions, k as OfframpQuoteInput, j as OfframpQuote, o as OfframpVaultStatus, t as PlatformEntry, c as CurrencyEntry, D as DepositInfo } from './errors-Dva4Wriq.cjs';
+export { C as CURRENCIES, a as CompletePeerExtensionRegistrationInput, b as CompletePeerExtensionRegistrationResult, d as DepositStatus, M as MakersCreateError, O as OFFRAMP_ERROR_CODES, f as OfframpError, g as OfframpErrorCode, i as OfframpProgress, m as OfframpState, n as OfframpStep, P as PLATFORMS, q as PLATFORM_LIMITS, r as PayeeDepositData, s as PeerExtensionRegistrationInfo, u as PlatformKey, v as PlatformLimits, w as PlatformTier, x as completePeerExtensionRegistration, y as getPeerExtensionRegistrationAuthParams, z as getPeerExtensionRegistrationInfo, A as getPlatformLimits, B as isPeerExtensionRegistrationError, E as isValidIBAN, F as normalizePaypalMeUsername } from './errors-Dva4Wriq.cjs';
 import { PeerConnectionStatus, PeerAuthenticateParams, PeerMetadataMessageCallback, SellerCredentialBundle } from '@zkp2p/sdk';
 export { PEER_EXTENSION_CHROME_URL, PeerAuthenticateParams, PeerBuyerTeePaymentCapture, PeerBuyerTeePaymentParams, PeerConnectionStatus, PeerMetadataCaptureMode, PeerMetadataMessage, PeerMetadataMessageCallback, PeerMetadataProviderConfig, PeerMetadataRow, PeerSarCredentialCapture } from '@zkp2p/sdk';
 
@@ -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>;
@@ -134,6 +146,10 @@ declare function delegate(walletClient: WalletClient, depositId: string, escrowA
 declare function undelegate(walletClient: WalletClient, depositId: string, escrowAddress?: string): Promise<string>;
 
 declare const ESCROW_ADDRESS: `0x${string}`;
+declare const DELEGATE_RATE_MANAGER_ID: `0x${string}`;
+declare const RATE_MANAGER_REGISTRY_ADDRESS: `0x${string}`;
+declare const DELEGATE_MANAGER_FEE_BPS = 10;
+declare const REFERRER = "galleonlabs";
 
 interface EnableOtcResult {
     depositId: string;
@@ -171,4 +187,74 @@ 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 };
+type OfframpIntegratorProfile = "app" | "bot" | "agent" | "private-otc" | "webhooks" | "peerlytics";
+interface OfframpResourceLink {
+    label: string;
+    href: string;
+    description: string;
+}
+interface OfframpIntegrationStep {
+    title: string;
+    detail: string;
+}
+interface OfframpIntegrationPlaybook {
+    profile: OfframpIntegratorProfile;
+    title: string;
+    summary: string;
+    steps: OfframpIntegrationStep[];
+    resources: OfframpResourceLink[];
+}
+interface OfframpDeveloperResources {
+    packageName: "@usdctofiat/offramp";
+    sdkVersion: string;
+    chain: "base-mainnet";
+    chainId: 8453;
+    referrer: typeof REFERRER;
+    delegation: {
+        required: true;
+        rateManagerId: typeof DELEGATE_RATE_MANAGER_ID;
+        rateManagerAddress: typeof RATE_MANAGER_REGISTRY_ADDRESS;
+        feeRateBps: typeof DELEGATE_MANAGER_FEE_BPS;
+        escrow: typeof ESCROW_ADDRESS;
+    };
+    links: {
+        developerPortal: string;
+        sdkGuide: string;
+        appGuide: string;
+        botGuide: string;
+        agentGuide: string;
+        webhooksGuide: string;
+        privateOtcGuide: string;
+        peerlyticsGuide: string;
+        agentSkill: string;
+        shortMachineReference: string;
+        fullMachineReference: string;
+        starters: string;
+        peerlyticsDevelopers: string;
+        peerlyticsPricing: string;
+        npm: string;
+    };
+    playbooks: OfframpIntegrationPlaybook[];
+}
+declare const OFFRAMP_RESOURCE_LINKS: {
+    readonly developerPortal: "https://usdctofiat.xyz/developers/";
+    readonly sdkGuide: "https://usdctofiat.xyz/developers/offramp-sdk/";
+    readonly appGuide: "https://usdctofiat.xyz/developers/apps/";
+    readonly botGuide: "https://usdctofiat.xyz/developers/bots/";
+    readonly agentGuide: "https://usdctofiat.xyz/developers/agents/";
+    readonly webhooksGuide: "https://usdctofiat.xyz/developers/webhooks/";
+    readonly privateOtcGuide: "https://usdctofiat.xyz/developers/private-otc/";
+    readonly peerlyticsGuide: "https://usdctofiat.xyz/developers/peerlytics/";
+    readonly agentSkill: "https://usdctofiat.xyz/skills/usdctofiat.md";
+    readonly shortMachineReference: "https://usdctofiat.xyz/llms.txt";
+    readonly fullMachineReference: "https://usdctofiat.xyz/llms-full.txt";
+    readonly starters: "https://github.com/ADWilkinson/usdctofiat-peerlytics-starters";
+    readonly peerlyticsDevelopers: "https://peerlytics.xyz/developers";
+    readonly peerlyticsPricing: "https://peerlytics.xyz/pricing";
+    readonly npm: "https://www.npmjs.com/package/@usdctofiat/offramp";
+};
+declare const OFFRAMP_INTEGRATION_PLAYBOOKS: OfframpIntegrationPlaybook[];
+declare const OFFRAMP_DEVELOPER_RESOURCES: OfframpDeveloperResources;
+declare function getOfframpDeveloperResources(profile?: OfframpIntegratorProfile): OfframpDeveloperResources | OfframpIntegrationPlaybook;
+
+export { CurrencyEntry, DEFAULT_EXTENSION_INSTALL_URL, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, OFFRAMP_DEVELOPER_RESOURCES, OFFRAMP_INTEGRATION_PLAYBOOKS, OFFRAMP_RESOURCE_LINKS, Offramp, OfframpCreateOptions, type OfframpDeveloperResources, type OfframpIntegrationPlaybook, type OfframpIntegrationStep, type OfframpIntegratorProfile, OfframpParams, OfframpQuote, OfframpQuoteInput, type OfframpResourceLink, 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, getOfframpDeveloperResources, getOtcLink, getPeerExtensionState, isPeerExtensionAvailable, isPeerExtensionMetadataBridgeAvailable, offramp, openPeerExtensionInstallPage, peerExtensionSdk, sanitizeAttributionId, sendTelemetryEvent, undelegate };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { WalletClient } from 'viem';
-import { h as OfframpParams, p as OnProgress, l as OfframpResult, e as OfframpCreateOptions, k as OfframpQuoteInput, j as OfframpQuote, o as OfframpVaultStatus, t as PlatformEntry, c as CurrencyEntry, D as DepositInfo } from './errors-DYCRKcnY.js';
-export { C as CURRENCIES, a as CompletePeerExtensionRegistrationInput, b as CompletePeerExtensionRegistrationResult, d as DepositStatus, M as MakersCreateError, O as OFFRAMP_ERROR_CODES, f as OfframpError, g as OfframpErrorCode, i as OfframpProgress, m as OfframpState, n as OfframpStep, P as PLATFORMS, q as PLATFORM_LIMITS, r as PayeeDepositData, s as PeerExtensionRegistrationInfo, u as PlatformKey, v as PlatformLimits, w as PlatformTier, x as completePeerExtensionRegistration, y as getPeerExtensionRegistrationAuthParams, z as getPeerExtensionRegistrationInfo, A as getPlatformLimits, B as isPeerExtensionRegistrationError, E as isValidIBAN, F as normalizePaypalMeUsername } from './errors-DYCRKcnY.js';
+import { h as OfframpParams, p as OnProgress, l as OfframpResult, e as OfframpCreateOptions, k as OfframpQuoteInput, j as OfframpQuote, o as OfframpVaultStatus, t as PlatformEntry, c as CurrencyEntry, D as DepositInfo } from './errors-Dva4Wriq.js';
+export { C as CURRENCIES, a as CompletePeerExtensionRegistrationInput, b as CompletePeerExtensionRegistrationResult, d as DepositStatus, M as MakersCreateError, O as OFFRAMP_ERROR_CODES, f as OfframpError, g as OfframpErrorCode, i as OfframpProgress, m as OfframpState, n as OfframpStep, P as PLATFORMS, q as PLATFORM_LIMITS, r as PayeeDepositData, s as PeerExtensionRegistrationInfo, u as PlatformKey, v as PlatformLimits, w as PlatformTier, x as completePeerExtensionRegistration, y as getPeerExtensionRegistrationAuthParams, z as getPeerExtensionRegistrationInfo, A as getPlatformLimits, B as isPeerExtensionRegistrationError, E as isValidIBAN, F as normalizePaypalMeUsername } from './errors-Dva4Wriq.js';
 import { PeerConnectionStatus, PeerAuthenticateParams, PeerMetadataMessageCallback, SellerCredentialBundle } from '@zkp2p/sdk';
 export { PEER_EXTENSION_CHROME_URL, PeerAuthenticateParams, PeerBuyerTeePaymentCapture, PeerBuyerTeePaymentParams, PeerConnectionStatus, PeerMetadataCaptureMode, PeerMetadataMessage, PeerMetadataMessageCallback, PeerMetadataProviderConfig, PeerMetadataRow, PeerSarCredentialCapture } from '@zkp2p/sdk';
 
@@ -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>;
@@ -134,6 +146,10 @@ declare function delegate(walletClient: WalletClient, depositId: string, escrowA
 declare function undelegate(walletClient: WalletClient, depositId: string, escrowAddress?: string): Promise<string>;
 
 declare const ESCROW_ADDRESS: `0x${string}`;
+declare const DELEGATE_RATE_MANAGER_ID: `0x${string}`;
+declare const RATE_MANAGER_REGISTRY_ADDRESS: `0x${string}`;
+declare const DELEGATE_MANAGER_FEE_BPS = 10;
+declare const REFERRER = "galleonlabs";
 
 interface EnableOtcResult {
     depositId: string;
@@ -171,4 +187,74 @@ 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 };
+type OfframpIntegratorProfile = "app" | "bot" | "agent" | "private-otc" | "webhooks" | "peerlytics";
+interface OfframpResourceLink {
+    label: string;
+    href: string;
+    description: string;
+}
+interface OfframpIntegrationStep {
+    title: string;
+    detail: string;
+}
+interface OfframpIntegrationPlaybook {
+    profile: OfframpIntegratorProfile;
+    title: string;
+    summary: string;
+    steps: OfframpIntegrationStep[];
+    resources: OfframpResourceLink[];
+}
+interface OfframpDeveloperResources {
+    packageName: "@usdctofiat/offramp";
+    sdkVersion: string;
+    chain: "base-mainnet";
+    chainId: 8453;
+    referrer: typeof REFERRER;
+    delegation: {
+        required: true;
+        rateManagerId: typeof DELEGATE_RATE_MANAGER_ID;
+        rateManagerAddress: typeof RATE_MANAGER_REGISTRY_ADDRESS;
+        feeRateBps: typeof DELEGATE_MANAGER_FEE_BPS;
+        escrow: typeof ESCROW_ADDRESS;
+    };
+    links: {
+        developerPortal: string;
+        sdkGuide: string;
+        appGuide: string;
+        botGuide: string;
+        agentGuide: string;
+        webhooksGuide: string;
+        privateOtcGuide: string;
+        peerlyticsGuide: string;
+        agentSkill: string;
+        shortMachineReference: string;
+        fullMachineReference: string;
+        starters: string;
+        peerlyticsDevelopers: string;
+        peerlyticsPricing: string;
+        npm: string;
+    };
+    playbooks: OfframpIntegrationPlaybook[];
+}
+declare const OFFRAMP_RESOURCE_LINKS: {
+    readonly developerPortal: "https://usdctofiat.xyz/developers/";
+    readonly sdkGuide: "https://usdctofiat.xyz/developers/offramp-sdk/";
+    readonly appGuide: "https://usdctofiat.xyz/developers/apps/";
+    readonly botGuide: "https://usdctofiat.xyz/developers/bots/";
+    readonly agentGuide: "https://usdctofiat.xyz/developers/agents/";
+    readonly webhooksGuide: "https://usdctofiat.xyz/developers/webhooks/";
+    readonly privateOtcGuide: "https://usdctofiat.xyz/developers/private-otc/";
+    readonly peerlyticsGuide: "https://usdctofiat.xyz/developers/peerlytics/";
+    readonly agentSkill: "https://usdctofiat.xyz/skills/usdctofiat.md";
+    readonly shortMachineReference: "https://usdctofiat.xyz/llms.txt";
+    readonly fullMachineReference: "https://usdctofiat.xyz/llms-full.txt";
+    readonly starters: "https://github.com/ADWilkinson/usdctofiat-peerlytics-starters";
+    readonly peerlyticsDevelopers: "https://peerlytics.xyz/developers";
+    readonly peerlyticsPricing: "https://peerlytics.xyz/pricing";
+    readonly npm: "https://www.npmjs.com/package/@usdctofiat/offramp";
+};
+declare const OFFRAMP_INTEGRATION_PLAYBOOKS: OfframpIntegrationPlaybook[];
+declare const OFFRAMP_DEVELOPER_RESOURCES: OfframpDeveloperResources;
+declare function getOfframpDeveloperResources(profile?: OfframpIntegratorProfile): OfframpDeveloperResources | OfframpIntegrationPlaybook;
+
+export { CurrencyEntry, DEFAULT_EXTENSION_INSTALL_URL, DepositInfo, ESCROW_ADDRESS, type EnableOtcResult, OFFRAMP_DEVELOPER_RESOURCES, OFFRAMP_INTEGRATION_PLAYBOOKS, OFFRAMP_RESOURCE_LINKS, Offramp, OfframpCreateOptions, type OfframpDeveloperResources, type OfframpIntegrationPlaybook, type OfframpIntegrationStep, type OfframpIntegratorProfile, OfframpParams, OfframpQuote, OfframpQuoteInput, type OfframpResourceLink, 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, getOfframpDeveloperResources, getOtcLink, getPeerExtensionState, isPeerExtensionAvailable, isPeerExtensionMetadataBridgeAvailable, offramp, openPeerExtensionInstallPage, peerExtensionSdk, sanitizeAttributionId, sendTelemetryEvent, undelegate };

package/dist/index.js

@@ -1,5 +1,8 @@
 import {
   CURRENCIES,
+  DEFAULT_EXTENSION_INSTALL_URL,
+  DELEGATE_MANAGER_FEE_BPS,
+  DELEGATE_RATE_MANAGER_ID,
   ESCROW_ADDRESS,
   MakersCreateError,
   Offramp,
@@ -7,6 +10,9 @@ import {
   PEER_EXTENSION_CHROME_URL,
   PLATFORMS,
   PLATFORM_LIMITS,
+  RATE_MANAGER_REGISTRY_ADDRESS,
+  REFERRER,
+  SDK_VERSION,
   close,
   completePeerExtensionRegistration,
   createOfframp,
@@ -33,7 +39,7 @@ import {
   sanitizeAttributionId,
   sendTelemetryEvent,
   undelegate
-} from "./chunk-QMO7HTBZ.js";
+} from "./chunk-COG2VN74.js";
 
 // src/types.ts
 var OFFRAMP_ERROR_CODES = {
@@ -55,11 +61,294 @@ var OFFRAMP_ERROR_CODES = {
   USER_CANCELLED: "USER_CANCELLED",
   UNSUPPORTED: "UNSUPPORTED"
 };
+
+// src/resources.ts
+var OFFRAMP_RESOURCE_LINKS = {
+  developerPortal: "https://usdctofiat.xyz/developers/",
+  sdkGuide: "https://usdctofiat.xyz/developers/offramp-sdk/",
+  appGuide: "https://usdctofiat.xyz/developers/apps/",
+  botGuide: "https://usdctofiat.xyz/developers/bots/",
+  agentGuide: "https://usdctofiat.xyz/developers/agents/",
+  webhooksGuide: "https://usdctofiat.xyz/developers/webhooks/",
+  privateOtcGuide: "https://usdctofiat.xyz/developers/private-otc/",
+  peerlyticsGuide: "https://usdctofiat.xyz/developers/peerlytics/",
+  agentSkill: "https://usdctofiat.xyz/skills/usdctofiat.md",
+  shortMachineReference: "https://usdctofiat.xyz/llms.txt",
+  fullMachineReference: "https://usdctofiat.xyz/llms-full.txt",
+  starters: "https://github.com/ADWilkinson/usdctofiat-peerlytics-starters",
+  peerlyticsDevelopers: "https://peerlytics.xyz/developers",
+  peerlyticsPricing: "https://peerlytics.xyz/pricing",
+  npm: "https://www.npmjs.com/package/@usdctofiat/offramp"
+};
+var sharedResources = [
+  {
+    label: "Developer portal",
+    href: OFFRAMP_RESOURCE_LINKS.developerPortal,
+    description: "Human-readable hub for SDK, webhooks, OTC, bots, agents, and Peerlytics."
+  },
+  {
+    label: "Starter templates",
+    href: OFFRAMP_RESOURCE_LINKS.starters,
+    description: "Next.js, Vite, Telegram-bot, scripts, and HMAC webhook receivers."
+  },
+  {
+    label: "Agent skill",
+    href: OFFRAMP_RESOURCE_LINKS.agentSkill,
+    description: "Drop-in skill file for coding agents integrating the off-ramp."
+  }
+];
+var OFFRAMP_INTEGRATION_PLAYBOOKS = [
+  {
+    profile: "app",
+    title: "Wallet app",
+    summary: "Add a sell-USDC button to a user-facing web app.",
+    steps: [
+      {
+        title: "Collect route inputs",
+        detail: "Ask for amount, platform, currency, and the platform-specific payout identifier."
+      },
+      {
+        title: "Call useOfframp or createOfframp",
+        detail: "Pass the user's viem WalletClient so the user signs approval, deposit, and delegation."
+      },
+      {
+        title: "Handle PayPal and Wise registration",
+        detail: "Catch EXTENSION_REGISTRATION_REQUIRED and drive usePeerExtensionRegistration."
+      },
+      {
+        title: "Reconcile state",
+        detail: "Use deposits(address) and webhooks rather than assuming the browser stayed open."
+      }
+    ],
+    resources: [
+      ...sharedResources,
+      {
+        label: "App integration guide",
+        href: OFFRAMP_RESOURCE_LINKS.appGuide,
+        description: "User-facing app flow, React hooks, and wallet-state guidance."
+      },
+      {
+        label: "SDK guide",
+        href: OFFRAMP_RESOURCE_LINKS.sdkGuide,
+        description: "Core SDK exports, resumability, errors, and examples."
+      }
+    ]
+  },
+  {
+    profile: "bot",
+    title: "Bot or backend worker",
+    summary: "Create delegated deposits from a server wallet or automation wallet.",
+    steps: [
+      {
+        title: "Own duplicate prevention",
+        detail: "Before creating, call deposits(address) and reuse open inventory when possible."
+      },
+      {
+        title: "Pass stable attribution",
+        detail: "Use integratorId and referralId so telemetry can separate automated flows."
+      },
+      {
+        title: "Use OTC when a buyer is known",
+        detail: "Pass otcTaker to avoid exposing known-counterparty liquidity publicly."
+      },
+      {
+        title: "Subscribe to lifecycle state",
+        detail: "Register HMAC webhooks so fills and closes survive process restarts."
+      }
+    ],
+    resources: [
+      ...sharedResources,
+      {
+        label: "Bot guide",
+        href: OFFRAMP_RESOURCE_LINKS.botGuide,
+        description: "Server-wallet, retry, idempotency, and OTC patterns."
+      },
+      {
+        label: "Webhooks guide",
+        href: OFFRAMP_RESOURCE_LINKS.webhooksGuide,
+        description: "HMAC verification and lifecycle event names."
+      }
+    ]
+  },
+  {
+    profile: "agent",
+    title: "Coding agent",
+    summary: "Give an agent enough canonical context to build without guessing protocol details.",
+    steps: [
+      {
+        title: "Load the skill",
+        detail: "Point the agent at /skills/usdctofiat.md before it writes integration code."
+      },
+      {
+        title: "Use the machine references",
+        detail: "Feed llms.txt or llms-full.txt when the agent needs routes, contracts, and rules."
+      },
+      {
+        title: "Scaffold first",
+        detail: "Use create-offramp-app or starters before asking the agent to invent wiring."
+      },
+      {
+        title: "Verify delegation",
+        detail: "Check getVaultStatus() and the returned deposit state; SDK deposits must delegate."
+      }
+    ],
+    resources: [
+      ...sharedResources,
+      {
+        label: "Agent guide",
+        href: OFFRAMP_RESOURCE_LINKS.agentGuide,
+        description: "Context-pack and prompt sequence for AI-assisted integration."
+      },
+      {
+        label: "Full machine reference",
+        href: OFFRAMP_RESOURCE_LINKS.fullMachineReference,
+        description: "Canonical routes, contracts, fees, and extractable answers."
+      }
+    ]
+  },
+  {
+    profile: "private-otc",
+    title: "Private OTC flow",
+    summary: "Restrict a delegated deposit to one approved taker wallet.",
+    steps: [
+      {
+        title: "Create with otcTaker",
+        detail: "Pass the buyer wallet in the original offramp() call when the counterparty is known."
+      },
+      {
+        title: "Share the returned otcLink",
+        detail: "The link is convenience; the whitelist hook is the onchain enforcement."
+      },
+      {
+        title: "Rotate when needed",
+        detail: "Use enableOtc, disableOtc, and getOtcLink on existing deposits."
+      }
+    ],
+    resources: [
+      ...sharedResources,
+      {
+        label: "Private OTC guide",
+        href: OFFRAMP_RESOURCE_LINKS.privateOtcGuide,
+        description: "Whitelist hook model and helper exports."
+      }
+    ]
+  },
+  {
+    profile: "webhooks",
+    title: "Lifecycle webhooks",
+    summary: "Receive deposit and OTC lifecycle state with HMAC verification.",
+    steps: [
+      {
+        title: "Create a Peerlytics API key",
+        detail: "One key authenticates both Peerlytics and USDCtoFiat developer surfaces."
+      },
+      {
+        title: "Register an endpoint",
+        detail: "Point the console at an HTTPS endpoint that can read the raw request body."
+      },
+      {
+        title: "Verify before parsing",
+        detail: "Compute HMAC-SHA256 over timestamp.rawBody and compare to v1 in constant time."
+      },
+      {
+        title: "Reconcile important state",
+        detail: "Treat events as hints and call deposits(address) or your indexer for hard state."
+      }
+    ],
+    resources: [
+      ...sharedResources,
+      {
+        label: "Webhooks guide",
+        href: OFFRAMP_RESOURCE_LINKS.webhooksGuide,
+        description: "Event names, headers, and replay-window guidance."
+      },
+      {
+        label: "Peerlytics console",
+        href: OFFRAMP_RESOURCE_LINKS.peerlyticsDevelopers,
+        description: "API keys, credits, and endpoint management."
+      }
+    ]
+  },
+  {
+    profile: "peerlytics",
+    title: "Peerlytics expansion",
+    summary: "Add market data, explorer reads, analytics, and credit-backed API access.",
+    steps: [
+      {
+        title: "Start with deposits",
+        detail: "@usdctofiat/offramp creates delegated seller inventory without an API key."
+      },
+      {
+        title: "Add the paid API",
+        detail: "Use @peerlytics/sdk when the product needs orderbook, analytics, and webhooks."
+      },
+      {
+        title: "Buy credits as usage grows",
+        detail: "Peerlytics credits back deeper API calls and Pro webhook access."
+      }
+    ],
+    resources: [
+      ...sharedResources,
+      {
+        label: "Peerlytics expansion guide",
+        href: OFFRAMP_RESOURCE_LINKS.peerlyticsGuide,
+        description: "When to add the paid protocol API alongside the free deposit SDK."
+      },
+      {
+        label: "Peerlytics pricing",
+        href: OFFRAMP_RESOURCE_LINKS.peerlyticsPricing,
+        description: "Credit packs, Free and Pro plans, and API limits."
+      }
+    ]
+  }
+];
+var OFFRAMP_DEVELOPER_RESOURCES = {
+  packageName: "@usdctofiat/offramp",
+  sdkVersion: SDK_VERSION,
+  chain: "base-mainnet",
+  chainId: 8453,
+  referrer: REFERRER,
+  delegation: {
+    required: true,
+    rateManagerId: DELEGATE_RATE_MANAGER_ID,
+    rateManagerAddress: RATE_MANAGER_REGISTRY_ADDRESS,
+    feeRateBps: DELEGATE_MANAGER_FEE_BPS,
+    escrow: ESCROW_ADDRESS
+  },
+  links: {
+    developerPortal: OFFRAMP_RESOURCE_LINKS.developerPortal,
+    sdkGuide: OFFRAMP_RESOURCE_LINKS.sdkGuide,
+    appGuide: OFFRAMP_RESOURCE_LINKS.appGuide,
+    botGuide: OFFRAMP_RESOURCE_LINKS.botGuide,
+    agentGuide: OFFRAMP_RESOURCE_LINKS.agentGuide,
+    webhooksGuide: OFFRAMP_RESOURCE_LINKS.webhooksGuide,
+    privateOtcGuide: OFFRAMP_RESOURCE_LINKS.privateOtcGuide,
+    peerlyticsGuide: OFFRAMP_RESOURCE_LINKS.peerlyticsGuide,
+    agentSkill: OFFRAMP_RESOURCE_LINKS.agentSkill,
+    shortMachineReference: OFFRAMP_RESOURCE_LINKS.shortMachineReference,
+    fullMachineReference: OFFRAMP_RESOURCE_LINKS.fullMachineReference,
+    starters: OFFRAMP_RESOURCE_LINKS.starters,
+    peerlyticsDevelopers: OFFRAMP_RESOURCE_LINKS.peerlyticsDevelopers,
+    peerlyticsPricing: OFFRAMP_RESOURCE_LINKS.peerlyticsPricing,
+    npm: OFFRAMP_RESOURCE_LINKS.npm
+  },
+  playbooks: OFFRAMP_INTEGRATION_PLAYBOOKS
+};
+function getOfframpDeveloperResources(profile) {
+  if (!profile) return OFFRAMP_DEVELOPER_RESOURCES;
+  const playbook = OFFRAMP_INTEGRATION_PLAYBOOKS.find((entry) => entry.profile === profile);
+  if (!playbook) return OFFRAMP_DEVELOPER_RESOURCES;
+  return playbook;
+}
 export {
   CURRENCIES,
+  DEFAULT_EXTENSION_INSTALL_URL,
   ESCROW_ADDRESS,
   MakersCreateError,
+  OFFRAMP_DEVELOPER_RESOURCES,
   OFFRAMP_ERROR_CODES,
+  OFFRAMP_INTEGRATION_PLAYBOOKS,
+  OFFRAMP_RESOURCE_LINKS,
   Offramp,
   OfframpError,
   PEER_EXTENSION_CHROME_URL,
@@ -75,6 +364,7 @@ export {
   disableOtc,
   emitEvent,
   enableOtc,
+  getOfframpDeveloperResources,
   getOtcLink,
   getPeerExtensionRegistrationAuthParams,
   getPeerExtensionRegistrationInfo,

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","../src/resources.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","import {\n  DELEGATE_MANAGER_FEE_BPS,\n  DELEGATE_RATE_MANAGER_ID,\n  ESCROW_ADDRESS,\n  RATE_MANAGER_REGISTRY_ADDRESS,\n  REFERRER,\n  SDK_VERSION,\n} from \"./config\";\n\nexport type OfframpIntegratorProfile =\n  | \"app\"\n  | \"bot\"\n  | \"agent\"\n  | \"private-otc\"\n  | \"webhooks\"\n  | \"peerlytics\";\n\nexport interface OfframpResourceLink {\n  label: string;\n  href: string;\n  description: string;\n}\n\nexport interface OfframpIntegrationStep {\n  title: string;\n  detail: string;\n}\n\nexport interface OfframpIntegrationPlaybook {\n  profile: OfframpIntegratorProfile;\n  title: string;\n  summary: string;\n  steps: OfframpIntegrationStep[];\n  resources: OfframpResourceLink[];\n}\n\nexport interface OfframpDeveloperResources {\n  packageName: \"@usdctofiat/offramp\";\n  sdkVersion: string;\n  chain: \"base-mainnet\";\n  chainId: 8453;\n  referrer: typeof REFERRER;\n  delegation: {\n    required: true;\n    rateManagerId: typeof DELEGATE_RATE_MANAGER_ID;\n    rateManagerAddress: typeof RATE_MANAGER_REGISTRY_ADDRESS;\n    feeRateBps: typeof DELEGATE_MANAGER_FEE_BPS;\n    escrow: typeof ESCROW_ADDRESS;\n  };\n  links: {\n    developerPortal: string;\n    sdkGuide: string;\n    appGuide: string;\n    botGuide: string;\n    agentGuide: string;\n    webhooksGuide: string;\n    privateOtcGuide: string;\n    peerlyticsGuide: string;\n    agentSkill: string;\n    shortMachineReference: string;\n    fullMachineReference: string;\n    starters: string;\n    peerlyticsDevelopers: string;\n    peerlyticsPricing: string;\n    npm: string;\n  };\n  playbooks: OfframpIntegrationPlaybook[];\n}\n\nexport const OFFRAMP_RESOURCE_LINKS = {\n  developerPortal: \"https://usdctofiat.xyz/developers/\",\n  sdkGuide: \"https://usdctofiat.xyz/developers/offramp-sdk/\",\n  appGuide: \"https://usdctofiat.xyz/developers/apps/\",\n  botGuide: \"https://usdctofiat.xyz/developers/bots/\",\n  agentGuide: \"https://usdctofiat.xyz/developers/agents/\",\n  webhooksGuide: \"https://usdctofiat.xyz/developers/webhooks/\",\n  privateOtcGuide: \"https://usdctofiat.xyz/developers/private-otc/\",\n  peerlyticsGuide: \"https://usdctofiat.xyz/developers/peerlytics/\",\n  agentSkill: \"https://usdctofiat.xyz/skills/usdctofiat.md\",\n  shortMachineReference: \"https://usdctofiat.xyz/llms.txt\",\n  fullMachineReference: \"https://usdctofiat.xyz/llms-full.txt\",\n  starters: \"https://github.com/ADWilkinson/usdctofiat-peerlytics-starters\",\n  peerlyticsDevelopers: \"https://peerlytics.xyz/developers\",\n  peerlyticsPricing: \"https://peerlytics.xyz/pricing\",\n  npm: \"https://www.npmjs.com/package/@usdctofiat/offramp\",\n} as const;\n\nconst sharedResources: OfframpResourceLink[] = [\n  {\n    label: \"Developer portal\",\n    href: OFFRAMP_RESOURCE_LINKS.developerPortal,\n    description: \"Human-readable hub for SDK, webhooks, OTC, bots, agents, and Peerlytics.\",\n  },\n  {\n    label: \"Starter templates\",\n    href: OFFRAMP_RESOURCE_LINKS.starters,\n    description: \"Next.js, Vite, Telegram-bot, scripts, and HMAC webhook receivers.\",\n  },\n  {\n    label: \"Agent skill\",\n    href: OFFRAMP_RESOURCE_LINKS.agentSkill,\n    description: \"Drop-in skill file for coding agents integrating the off-ramp.\",\n  },\n];\n\nexport const OFFRAMP_INTEGRATION_PLAYBOOKS: OfframpIntegrationPlaybook[] = [\n  {\n    profile: \"app\",\n    title: \"Wallet app\",\n    summary: \"Add a sell-USDC button to a user-facing web app.\",\n    steps: [\n      {\n        title: \"Collect route inputs\",\n        detail: \"Ask for amount, platform, currency, and the platform-specific payout identifier.\",\n      },\n      {\n        title: \"Call useOfframp or createOfframp\",\n        detail:\n          \"Pass the user's viem WalletClient so the user signs approval, deposit, and delegation.\",\n      },\n      {\n        title: \"Handle PayPal and Wise registration\",\n        detail: \"Catch EXTENSION_REGISTRATION_REQUIRED and drive usePeerExtensionRegistration.\",\n      },\n      {\n        title: \"Reconcile state\",\n        detail: \"Use deposits(address) and webhooks rather than assuming the browser stayed open.\",\n      },\n    ],\n    resources: [\n      ...sharedResources,\n      {\n        label: \"App integration guide\",\n        href: OFFRAMP_RESOURCE_LINKS.appGuide,\n        description: \"User-facing app flow, React hooks, and wallet-state guidance.\",\n      },\n      {\n        label: \"SDK guide\",\n        href: OFFRAMP_RESOURCE_LINKS.sdkGuide,\n        description: \"Core SDK exports, resumability, errors, and examples.\",\n      },\n    ],\n  },\n  {\n    profile: \"bot\",\n    title: \"Bot or backend worker\",\n    summary: \"Create delegated deposits from a server wallet or automation wallet.\",\n    steps: [\n      {\n        title: \"Own duplicate prevention\",\n        detail: \"Before creating, call deposits(address) and reuse open inventory when possible.\",\n      },\n      {\n        title: \"Pass stable attribution\",\n        detail: \"Use integratorId and referralId so telemetry can separate automated flows.\",\n      },\n      {\n        title: \"Use OTC when a buyer is known\",\n        detail: \"Pass otcTaker to avoid exposing known-counterparty liquidity publicly.\",\n      },\n      {\n        title: \"Subscribe to lifecycle state\",\n        detail: \"Register HMAC webhooks so fills and closes survive process restarts.\",\n      },\n    ],\n    resources: [\n      ...sharedResources,\n      {\n        label: \"Bot guide\",\n        href: OFFRAMP_RESOURCE_LINKS.botGuide,\n        description: \"Server-wallet, retry, idempotency, and OTC patterns.\",\n      },\n      {\n        label: \"Webhooks guide\",\n        href: OFFRAMP_RESOURCE_LINKS.webhooksGuide,\n        description: \"HMAC verification and lifecycle event names.\",\n      },\n    ],\n  },\n  {\n    profile: \"agent\",\n    title: \"Coding agent\",\n    summary: \"Give an agent enough canonical context to build without guessing protocol details.\",\n    steps: [\n      {\n        title: \"Load the skill\",\n        detail: \"Point the agent at /skills/usdctofiat.md before it writes integration code.\",\n      },\n      {\n        title: \"Use the machine references\",\n        detail: \"Feed llms.txt or llms-full.txt when the agent needs routes, contracts, and rules.\",\n      },\n      {\n        title: \"Scaffold first\",\n        detail: \"Use create-offramp-app or starters before asking the agent to invent wiring.\",\n      },\n      {\n        title: \"Verify delegation\",\n        detail:\n          \"Check getVaultStatus() and the returned deposit state; SDK deposits must delegate.\",\n      },\n    ],\n    resources: [\n      ...sharedResources,\n      {\n        label: \"Agent guide\",\n        href: OFFRAMP_RESOURCE_LINKS.agentGuide,\n        description: \"Context-pack and prompt sequence for AI-assisted integration.\",\n      },\n      {\n        label: \"Full machine reference\",\n        href: OFFRAMP_RESOURCE_LINKS.fullMachineReference,\n        description: \"Canonical routes, contracts, fees, and extractable answers.\",\n      },\n    ],\n  },\n  {\n    profile: \"private-otc\",\n    title: \"Private OTC flow\",\n    summary: \"Restrict a delegated deposit to one approved taker wallet.\",\n    steps: [\n      {\n        title: \"Create with otcTaker\",\n        detail:\n          \"Pass the buyer wallet in the original offramp() call when the counterparty is known.\",\n      },\n      {\n        title: \"Share the returned otcLink\",\n        detail: \"The link is convenience; the whitelist hook is the onchain enforcement.\",\n      },\n      {\n        title: \"Rotate when needed\",\n        detail: \"Use enableOtc, disableOtc, and getOtcLink on existing deposits.\",\n      },\n    ],\n    resources: [\n      ...sharedResources,\n      {\n        label: \"Private OTC guide\",\n        href: OFFRAMP_RESOURCE_LINKS.privateOtcGuide,\n        description: \"Whitelist hook model and helper exports.\",\n      },\n    ],\n  },\n  {\n    profile: \"webhooks\",\n    title: \"Lifecycle webhooks\",\n    summary: \"Receive deposit and OTC lifecycle state with HMAC verification.\",\n    steps: [\n      {\n        title: \"Create a Peerlytics API key\",\n        detail: \"One key authenticates both Peerlytics and USDCtoFiat developer surfaces.\",\n      },\n      {\n        title: \"Register an endpoint\",\n        detail: \"Point the console at an HTTPS endpoint that can read the raw request body.\",\n      },\n      {\n        title: \"Verify before parsing\",\n        detail: \"Compute HMAC-SHA256 over timestamp.rawBody and compare to v1 in constant time.\",\n      },\n      {\n        title: \"Reconcile important state\",\n        detail: \"Treat events as hints and call deposits(address) or your indexer for hard state.\",\n      },\n    ],\n    resources: [\n      ...sharedResources,\n      {\n        label: \"Webhooks guide\",\n        href: OFFRAMP_RESOURCE_LINKS.webhooksGuide,\n        description: \"Event names, headers, and replay-window guidance.\",\n      },\n      {\n        label: \"Peerlytics console\",\n        href: OFFRAMP_RESOURCE_LINKS.peerlyticsDevelopers,\n        description: \"API keys, credits, and endpoint management.\",\n      },\n    ],\n  },\n  {\n    profile: \"peerlytics\",\n    title: \"Peerlytics expansion\",\n    summary: \"Add market data, explorer reads, analytics, and credit-backed API access.\",\n    steps: [\n      {\n        title: \"Start with deposits\",\n        detail: \"@usdctofiat/offramp creates delegated seller inventory without an API key.\",\n      },\n      {\n        title: \"Add the paid API\",\n        detail: \"Use @peerlytics/sdk when the product needs orderbook, analytics, and webhooks.\",\n      },\n      {\n        title: \"Buy credits as usage grows\",\n        detail: \"Peerlytics credits back deeper API calls and Pro webhook access.\",\n      },\n    ],\n    resources: [\n      ...sharedResources,\n      {\n        label: \"Peerlytics expansion guide\",\n        href: OFFRAMP_RESOURCE_LINKS.peerlyticsGuide,\n        description: \"When to add the paid protocol API alongside the free deposit SDK.\",\n      },\n      {\n        label: \"Peerlytics pricing\",\n        href: OFFRAMP_RESOURCE_LINKS.peerlyticsPricing,\n        description: \"Credit packs, Free and Pro plans, and API limits.\",\n      },\n    ],\n  },\n];\n\nexport const OFFRAMP_DEVELOPER_RESOURCES: OfframpDeveloperResources = {\n  packageName: \"@usdctofiat/offramp\",\n  sdkVersion: SDK_VERSION,\n  chain: \"base-mainnet\",\n  chainId: 8453,\n  referrer: REFERRER,\n  delegation: {\n    required: true,\n    rateManagerId: DELEGATE_RATE_MANAGER_ID,\n    rateManagerAddress: RATE_MANAGER_REGISTRY_ADDRESS,\n    feeRateBps: DELEGATE_MANAGER_FEE_BPS,\n    escrow: ESCROW_ADDRESS,\n  },\n  links: {\n    developerPortal: OFFRAMP_RESOURCE_LINKS.developerPortal,\n    sdkGuide: OFFRAMP_RESOURCE_LINKS.sdkGuide,\n    appGuide: OFFRAMP_RESOURCE_LINKS.appGuide,\n    botGuide: OFFRAMP_RESOURCE_LINKS.botGuide,\n    agentGuide: OFFRAMP_RESOURCE_LINKS.agentGuide,\n    webhooksGuide: OFFRAMP_RESOURCE_LINKS.webhooksGuide,\n    privateOtcGuide: OFFRAMP_RESOURCE_LINKS.privateOtcGuide,\n    peerlyticsGuide: OFFRAMP_RESOURCE_LINKS.peerlyticsGuide,\n    agentSkill: OFFRAMP_RESOURCE_LINKS.agentSkill,\n    shortMachineReference: OFFRAMP_RESOURCE_LINKS.shortMachineReference,\n    fullMachineReference: OFFRAMP_RESOURCE_LINKS.fullMachineReference,\n    starters: OFFRAMP_RESOURCE_LINKS.starters,\n    peerlyticsDevelopers: OFFRAMP_RESOURCE_LINKS.peerlyticsDevelopers,\n    peerlyticsPricing: OFFRAMP_RESOURCE_LINKS.peerlyticsPricing,\n    npm: OFFRAMP_RESOURCE_LINKS.npm,\n  },\n  playbooks: OFFRAMP_INTEGRATION_PLAYBOOKS,\n};\n\nexport function getOfframpDeveloperResources(\n  profile?: OfframpIntegratorProfile,\n): OfframpDeveloperResources | OfframpIntegrationPlaybook {\n  if (!profile) return OFFRAMP_DEVELOPER_RESOURCES;\n  const playbook = OFFRAMP_INTEGRATION_PLAYBOOKS.find((entry) => entry.profile === profile);\n  if (!playbook) return OFFRAMP_DEVELOPER_RESOURCES;\n  return playbook;\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;;;ACgDO,IAAM,yBAAyB;AAAA,EACpC,iBAAiB;AAAA,EACjB,UAAU;AAAA,EACV,UAAU;AAAA,EACV,UAAU;AAAA,EACV,YAAY;AAAA,EACZ,eAAe;AAAA,EACf,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,YAAY;AAAA,EACZ,uBAAuB;AAAA,EACvB,sBAAsB;AAAA,EACtB,UAAU;AAAA,EACV,sBAAsB;AAAA,EACtB,mBAAmB;AAAA,EACnB,KAAK;AACP;AAEA,IAAM,kBAAyC;AAAA,EAC7C;AAAA,IACE,OAAO;AAAA,IACP,MAAM,uBAAuB;AAAA,IAC7B,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,OAAO;AAAA,IACP,MAAM,uBAAuB;AAAA,IAC7B,aAAa;AAAA,EACf;AAAA,EACA;AAAA,IACE,OAAO;AAAA,IACP,MAAM,uBAAuB;AAAA,IAC7B,aAAa;AAAA,EACf;AACF;AAEO,IAAM,gCAA8D;AAAA,EACzE;AAAA,IACE,SAAS;AAAA,IACT,OAAO;AAAA,IACP,SAAS;AAAA,IACT,OAAO;AAAA,MACL;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QACE;AAAA,MACJ;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,WAAW;AAAA,MACT,GAAG;AAAA,MACH;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,SAAS;AAAA,IACT,OAAO;AAAA,IACP,SAAS;AAAA,IACT,OAAO;AAAA,MACL;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,WAAW;AAAA,MACT,GAAG;AAAA,MACH;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,SAAS;AAAA,IACT,OAAO;AAAA,IACP,SAAS;AAAA,IACT,OAAO;AAAA,MACL;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QACE;AAAA,MACJ;AAAA,IACF;AAAA,IACA,WAAW;AAAA,MACT,GAAG;AAAA,MACH;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,SAAS;AAAA,IACT,OAAO;AAAA,IACP,SAAS;AAAA,IACT,OAAO;AAAA,MACL;AAAA,QACE,OAAO;AAAA,QACP,QACE;AAAA,MACJ;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,WAAW;AAAA,MACT,GAAG;AAAA,MACH;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,SAAS;AAAA,IACT,OAAO;AAAA,IACP,SAAS;AAAA,IACT,OAAO;AAAA,MACL;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,WAAW;AAAA,MACT,GAAG;AAAA,MACH;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AAAA,EACA;AAAA,IACE,SAAS;AAAA,IACT,OAAO;AAAA,IACP,SAAS;AAAA,IACT,OAAO;AAAA,MACL;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,IACA,WAAW;AAAA,MACT,GAAG;AAAA,MACH;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,MAAM,uBAAuB;AAAA,QAC7B,aAAa;AAAA,MACf;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,8BAAyD;AAAA,EACpE,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,OAAO;AAAA,EACP,SAAS;AAAA,EACT,UAAU;AAAA,EACV,YAAY;AAAA,IACV,UAAU;AAAA,IACV,eAAe;AAAA,IACf,oBAAoB;AAAA,IACpB,YAAY;AAAA,IACZ,QAAQ;AAAA,EACV;AAAA,EACA,OAAO;AAAA,IACL,iBAAiB,uBAAuB;AAAA,IACxC,UAAU,uBAAuB;AAAA,IACjC,UAAU,uBAAuB;AAAA,IACjC,UAAU,uBAAuB;AAAA,IACjC,YAAY,uBAAuB;AAAA,IACnC,eAAe,uBAAuB;AAAA,IACtC,iBAAiB,uBAAuB;AAAA,IACxC,iBAAiB,uBAAuB;AAAA,IACxC,YAAY,uBAAuB;AAAA,IACnC,uBAAuB,uBAAuB;AAAA,IAC9C,sBAAsB,uBAAuB;AAAA,IAC7C,UAAU,uBAAuB;AAAA,IACjC,sBAAsB,uBAAuB;AAAA,IAC7C,mBAAmB,uBAAuB;AAAA,IAC1C,KAAK,uBAAuB;AAAA,EAC9B;AAAA,EACA,WAAW;AACb;AAEO,SAAS,6BACd,SACwD;AACxD,MAAI,CAAC,QAAS,QAAO;AACrB,QAAM,WAAW,8BAA8B,KAAK,CAAC,UAAU,MAAM,YAAY,OAAO;AACxF,MAAI,CAAC,SAAU,QAAO;AACtB,SAAO;AACT;","names":[]}