@usdctofiat/offramp 4.0.0 → 4.2.0

package/dist/index.cjs

@@ -31,9 +31,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   CURRENCIES: () => CURRENCIES,
+  DEFAULT_EXTENSION_INSTALL_URL: () => DEFAULT_EXTENSION_INSTALL_URL,
   ESCROW_ADDRESS: () => ESCROW_ADDRESS,
   MakersCreateError: () => MakersCreateError,
+  OFFRAMP_DEVELOPER_RESOURCES: () => OFFRAMP_DEVELOPER_RESOURCES,
   OFFRAMP_ERROR_CODES: () => OFFRAMP_ERROR_CODES,
+  OFFRAMP_INTEGRATION_PLAYBOOKS: () => OFFRAMP_INTEGRATION_PLAYBOOKS,
+  OFFRAMP_RESOURCE_LINKS: () => OFFRAMP_RESOURCE_LINKS,
   Offramp: () => Offramp,
   OfframpError: () => OfframpError,
   PEER_EXTENSION_CHROME_URL: () => import_sdk7.PEER_EXTENSION_CHROME_URL,
@@ -49,6 +53,7 @@ __export(index_exports, {
   disableOtc: () => disableOtc,
   emitEvent: () => emitEvent,
   enableOtc: () => enableOtc,
+  getOfframpDeveloperResources: () => getOfframpDeveloperResources,
   getOtcLink: () => getOtcLink,
   getPeerExtensionRegistrationAuthParams: () => getPeerExtensionRegistrationAuthParams,
   getPeerExtensionRegistrationInfo: () => getPeerExtensionRegistrationInfo,
@@ -75,7 +80,7 @@ var import_sdk5 = require("@zkp2p/sdk");
 
 // src/config.ts
 var import_sdk = require("@zkp2p/sdk");
-var SDK_VERSION = "4.0.0";
+var SDK_VERSION = "4.2.0";
 var BASE_CHAIN_ID = 8453;
 var RUNTIME_ENV = "production";
 var API_BASE_URL = "https://api.zkp2p.xyz";
@@ -322,8 +327,7 @@ var BLUEPRINTS = {
     extensionRegistration: {
       providerId: "wise",
       requiredPrompt: "This Wisetag is not registered yet. Register it with PeerAuth, then retry with the same Wisetag.",
-      ctaLabel: "Register Wisetag",
-      minExtensionVersion: "0.5.0"
+      ctaLabel: "Register Wisetag"
     }
   },
   mercadopago: {
@@ -361,8 +365,7 @@ var BLUEPRINTS = {
       providerId: "paypal",
       requiredPrompt: "This PayPal username is not registered yet. Register it with PeerAuth, then retry with the same PayPal username.",
       ctaLabel: "Register PayPal Username",
-      ctaSubtext: "PayPal Business accounts are not supported at this time.",
-      minExtensionVersion: "0.5.0"
+      ctaSubtext: "PayPal Business accounts are not supported at this time."
     }
   },
   monzo: {
@@ -1666,6 +1669,7 @@ var OFFRAMP_ERROR_CODES = {
 
 // 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;
@@ -1706,7 +1710,8 @@ var openPeerExtensionInstallPage = (options) => {
   if (!resolvedWindow) {
     throw new Error("Peer extension SDK requires a browser window.");
   }
-  resolvedWindow.open(import_sdk7.PEER_EXTENSION_CHROME_URL, "_blank", "noopener,noreferrer");
+  const installUrl = options?.installUrl ?? DEFAULT_EXTENSION_INSTALL_URL;
+  resolvedWindow.open(installUrl, "_blank", "noopener,noreferrer");
 };
 var getPeerExtensionState = async (options) => {
   if (!isPeerExtensionAvailable(options)) {
@@ -1728,17 +1733,300 @@ 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()
   };
 };
 var peerExtensionSdk = createPeerExtensionSdk();
+
+// 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;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   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,
@@ -1754,6 +2042,7 @@ var peerExtensionSdk = createPeerExtensionSdk();
   disableOtc,
   emitEvent,
   enableOtc,
+  getOfframpDeveloperResources,
   getOtcLink,
   getPeerExtensionRegistrationAuthParams,
   getPeerExtensionRegistrationInfo,