@usdctofiat/offramp 4.2.1 → 4.3.1

package/dist/index.cjs

@@ -36,6 +36,7 @@ __export(index_exports, {
   MakersCreateError: () => MakersCreateError,
   OFFRAMP_DEVELOPER_RESOURCES: () => OFFRAMP_DEVELOPER_RESOURCES,
   OFFRAMP_ERROR_CODES: () => OFFRAMP_ERROR_CODES,
+  OFFRAMP_INTEGRATION_CHECKLIST: () => OFFRAMP_INTEGRATION_CHECKLIST,
   OFFRAMP_INTEGRATION_PLAYBOOKS: () => OFFRAMP_INTEGRATION_PLAYBOOKS,
   OFFRAMP_RESOURCE_LINKS: () => OFFRAMP_RESOURCE_LINKS,
   Offramp: () => Offramp,
@@ -53,6 +54,7 @@ __export(index_exports, {
   disableOtc: () => disableOtc,
   emitEvent: () => emitEvent,
   enableOtc: () => enableOtc,
+  getOfframpAgentPrompt: () => getOfframpAgentPrompt,
   getOfframpDeveloperResources: () => getOfframpDeveloperResources,
   getOtcLink: () => getOtcLink,
   getPeerExtensionRegistrationAuthParams: () => getPeerExtensionRegistrationAuthParams,
@@ -62,7 +64,6 @@ __export(index_exports, {
   isPeerExtensionAvailable: () => isPeerExtensionAvailable,
   isPeerExtensionMetadataBridgeAvailable: () => isPeerExtensionMetadataBridgeAvailable,
   isPeerExtensionRegistrationError: () => isPeerExtensionRegistrationError,
-  isValidIBAN: () => isValidIBAN,
   normalizePaypalMeUsername: () => normalizePaypalMeUsername,
   offramp: () => offramp,
   openPeerExtensionInstallPage: () => openPeerExtensionInstallPage,
@@ -80,7 +81,7 @@ var import_sdk5 = require("@zkp2p/sdk");
 
 // src/config.ts
 var import_sdk = require("@zkp2p/sdk");
-var SDK_VERSION = "4.2.1";
+var SDK_VERSION = "4.3.0";
 var BASE_CHAIN_ID = 8453;
 var RUNTIME_ENV = "production";
 var API_BASE_URL = "https://api.zkp2p.xyz";
@@ -216,9 +217,7 @@ var FALLBACK_CURRENCIES = {
   mercadopago: ["ARS"],
   zelle: ["USD"],
   paypal: ["USD", "EUR", "GBP", "SGD", "NZD", "AUD", "CAD"],
-  monzo: ["GBP"],
-  n26: ["EUR"],
-  luxon: ["USD", "EUR", "GBP"]
+  monzo: ["GBP"]
 };
 function gatherCatalogHashes(platform) {
   if (platform === "zelle") {
@@ -261,21 +260,6 @@ function normalizePaypalMeUsername(value) {
   }
   return trimmed.replace(/^@+/, "").toLowerCase();
 }
-function isValidIBAN(iban) {
-  const upper = iban.toUpperCase();
-  if (!/^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/.test(upper)) return false;
-  const rearranged = upper.slice(4) + upper.slice(0, 4);
-  const numeric = rearranged.split("").map((ch) => {
-    const code = ch.charCodeAt(0);
-    return code >= 65 && code <= 90 ? (code - 55).toString() : ch;
-  }).join("");
-  let remainder = numeric;
-  while (remainder.length > 2) {
-    const block = remainder.slice(0, 9);
-    remainder = (parseInt(block, 10) % 97).toString() + remainder.slice(block.length);
-  }
-  return parseInt(remainder, 10) % 97 === 1;
-}
 var BLUEPRINTS = {
   venmo: {
     id: "venmo",
@@ -375,27 +359,6 @@ var BLUEPRINTS = {
     placeholder: "monzo.me username",
     helperText: "Your Monzo.me username",
     validation: import_zod.z.string().min(1).regex(/^[a-zA-Z0-9_-]+$/)
-  },
-  n26: {
-    id: "n26",
-    name: "N26",
-    identifierLabel: "IBAN",
-    placeholder: "IBAN (e.g. DE89...)",
-    helperText: "Your IBAN (spaces will be removed)",
-    // transform runs before validation, so the schema sees a spaceless,
-    // uppercased IBAN. The MOD-97 refine mirrors curator's N26Processor so a
-    // typo'd-but-well-formed IBAN fails here, not after USDC approval + gas.
-    validation: import_zod.z.string().regex(/^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/, "Enter a valid IBAN").refine(isValidIBAN, "That IBAN looks wrong \u2014 its checksum doesn't match"),
-    transform: (v) => v.replace(/\s/g, "").toUpperCase()
-  },
-  luxon: {
-    id: "luxon",
-    name: "Luxon",
-    identifierLabel: "Email",
-    placeholder: "your-luxon-email@example.com",
-    helperText: "Email address registered with Luxon",
-    validation: import_zod.z.string().email(),
-    transform: (v) => v.trim()
   }
 };
 function buildPlatformEntry(bp) {
@@ -433,13 +396,10 @@ var PLATFORMS = {
   MERCADO_PAGO: buildPlatformEntry(BLUEPRINTS.mercadopago),
   ZELLE: buildPlatformEntry(BLUEPRINTS.zelle),
   PAYPAL: buildPlatformEntry(BLUEPRINTS.paypal),
-  MONZO: buildPlatformEntry(BLUEPRINTS.monzo),
-  N26: buildPlatformEntry(BLUEPRINTS.n26),
-  LUXON: buildPlatformEntry(BLUEPRINTS.luxon)
+  MONZO: buildPlatformEntry(BLUEPRINTS.monzo)
 };
 var PLATFORM_LIMITS = {
   venmo: { platformCapUsd: 5e3 },
-  n26: { platformCapUsd: 1e4 },
   paypal: { minTier: "PLUS" }
 };
 function getPlatformLimits(platform) {
@@ -458,20 +418,26 @@ function normalizePaymentMethodLookupName(platform) {
   const ids = Object.values(PLATFORMS).map((p) => p.id);
   return ids.includes(normalized) ? normalized : null;
 }
-function resolveCanonicalZelleHash() {
-  const direct = PAYMENT_CATALOG.zelle?.paymentMethodHash;
-  if (direct) return direct;
-  const variant = Object.entries(PAYMENT_CATALOG).find(
-    ([name, entry]) => name.startsWith("zelle") && Boolean(entry.paymentMethodHash)
-  );
-  return variant?.[1]?.paymentMethodHash ?? null;
+var ZELLE_CREATE_LOOKUP_NAMES = ["zelle-chase", "zelle-bofa", "zelle-citi"];
+var GENERIC_ZELLE_METHOD_HASH = (0, import_sdk2.resolvePaymentMethodHash)("zelle") ?? null;
+function resolveGenericZelleHash() {
+  return GENERIC_ZELLE_METHOD_HASH;
+}
+function getZelleCreateEntries() {
+  const entries = [];
+  for (const name of ZELLE_CREATE_LOOKUP_NAMES) {
+    const hash = getPaymentMethodHash(name);
+    if (hash) entries.push({ name, hash });
+  }
+  return entries;
 }
 function getPaymentMethodHash(platform) {
   const name = normalizePaymentMethodLookupName(platform);
   if (!name) return null;
   const catalogEntry = PAYMENT_CATALOG[name];
   if (catalogEntry?.paymentMethodHash) return catalogEntry.paymentMethodHash;
-  if (name === "zelle" || name.startsWith("zelle-")) return resolveCanonicalZelleHash();
+  if (name === "zelle") return resolveGenericZelleHash();
+  if (name.startsWith("zelle-")) return (0, import_sdk2.resolvePaymentMethodHash)(name);
   const sdkHash = (0, import_sdk2.resolvePaymentMethodHash)(name);
   return sdkHash ? sdkHash : null;
 }
@@ -480,24 +446,16 @@ function getPaymentMethodHashes(platform) {
     const hash = getPaymentMethodHash(platform);
     return hash ? [hash] : [];
   }
-  const hashes = /* @__PURE__ */ new Set();
-  const generic = (0, import_sdk2.resolvePaymentMethodHash)("zelle");
-  if (generic) hashes.add(generic);
-  const canonical = resolveCanonicalZelleHash();
-  if (canonical) hashes.add(canonical);
-  for (const [name, entry] of Object.entries(PAYMENT_CATALOG)) {
-    if (name.startsWith("zelle") && entry.paymentMethodHash) {
-      hashes.add(entry.paymentMethodHash);
-    }
-  }
-  return Array.from(hashes);
+  const hashes = getZelleCreateEntries().map((entry) => entry.hash);
+  const generic = resolveGenericZelleHash();
+  return generic ? [...hashes, generic] : hashes;
 }
 function getPaymentMethodCreateEntries(platform) {
   if (platform !== "zelle") {
     const hash = getPaymentMethodHash(platform);
     return hash ? [{ name: platform, hash }] : [];
   }
-  return Object.entries(PAYMENT_CATALOG).filter(([name, entry]) => name.startsWith("zelle") && Boolean(entry.paymentMethodHash)).sort(([a], [b]) => a.localeCompare(b)).map(([name, entry]) => ({ name, hash: entry.paymentMethodHash }));
+  return getZelleCreateEntries();
 }
 function buildDepositData(platform, identifier, telegramUsername = "") {
   const offchainId = platform === "chime" ? identifier.toLowerCase() : identifier;
@@ -1952,15 +1910,15 @@ var OFFRAMP_INTEGRATION_PLAYBOOKS = [
   },
   {
     profile: "peerlytics",
-    title: "Peerlytics expansion",
-    summary: "Add market data, explorer reads, analytics, and credit-backed API access.",
+    title: "Peerlytics API",
+    summary: "Add market data, explorer reads, analytics, and API-credit-backed access.",
     steps: [
       {
         title: "Start with deposits",
         detail: "@usdctofiat/offramp creates delegated seller inventory without an API key."
       },
       {
-        title: "Add the paid API",
+        title: "Add the Peerlytics API",
         detail: "Use @peerlytics/sdk when the product needs orderbook, analytics, and webhooks."
       },
       {
@@ -1971,7 +1929,7 @@ var OFFRAMP_INTEGRATION_PLAYBOOKS = [
     resources: [
       ...sharedResources,
       {
-        label: "Peerlytics expansion guide",
+        label: "Peerlytics API guide",
         href: OFFRAMP_RESOURCE_LINKS.peerlyticsGuide,
         description: "When to add the paid protocol API alongside the free deposit SDK."
       },
@@ -1983,6 +1941,33 @@ var OFFRAMP_INTEGRATION_PLAYBOOKS = [
     ]
   }
 ];
+var OFFRAMP_INTEGRATION_CHECKLIST = [
+  {
+    title: "Base mainnet wallet client",
+    detail: "Use a viem WalletClient on chain 8453. The SDK has no public sandbox mode.",
+    required: true
+  },
+  {
+    title: "Delegate-vault pricing",
+    detail: "Every SDK-created deposit must delegate pricing to the managed Delegate vault.",
+    required: true
+  },
+  {
+    title: "PayPal/Wise recovery path",
+    detail: "Catch EXTENSION_REGISTRATION_REQUIRED and drive Peer extension seller registration.",
+    required: true
+  },
+  {
+    title: "Server-side duplicate prevention",
+    detail: "Bots and workers must call deposits(address) and use their own order database; idempotencyKey is browser-session scoped and the standalone offramp() helper ignores it.",
+    required: true
+  },
+  {
+    title: "Raw-body webhook verification",
+    detail: "Verify timestamp.rawBody with HMAC-SHA256 before parsing JSON.",
+    required: true
+  }
+];
 var OFFRAMP_DEVELOPER_RESOURCES = {
   packageName: "@usdctofiat/offramp",
   sdkVersion: SDK_VERSION,
@@ -2013,7 +1998,8 @@ var OFFRAMP_DEVELOPER_RESOURCES = {
     peerlyticsPricing: OFFRAMP_RESOURCE_LINKS.peerlyticsPricing,
     npm: OFFRAMP_RESOURCE_LINKS.npm
   },
-  playbooks: OFFRAMP_INTEGRATION_PLAYBOOKS
+  playbooks: OFFRAMP_INTEGRATION_PLAYBOOKS,
+  checklist: OFFRAMP_INTEGRATION_CHECKLIST
 };
 function getOfframpDeveloperResources(profile) {
   if (!profile) return OFFRAMP_DEVELOPER_RESOURCES;
@@ -2021,6 +2007,22 @@ function getOfframpDeveloperResources(profile) {
   if (!playbook) return OFFRAMP_DEVELOPER_RESOURCES;
   return playbook;
 }
+function getOfframpAgentPrompt(profile = "app") {
+  const playbook = getOfframpDeveloperResources(profile);
+  const resource = "profile" in playbook ? playbook : OFFRAMP_INTEGRATION_PLAYBOOKS.find((entry) => entry.profile === "app");
+  const steps = resource?.steps.map((step, index) => `${index + 1}. ${step.title}: ${step.detail}`);
+  return [
+    "Build a USDC-to-fiat integration with @usdctofiat/offramp.",
+    `Profile: ${profile}.`,
+    "Before coding, read https://usdctofiat.xyz/skills/usdctofiat.md and https://usdctofiat.xyz/llms.txt.",
+    "Use Base mainnet chainId 8453 and a viem WalletClient; do not invent a sandbox.",
+    "Do not add manual rate controls; SDK-created deposits must delegate to the Delegate vault.",
+    "For PayPal and Wise, recover EXTENSION_REGISTRATION_REQUIRED through the Peer extension registration flow.",
+    "For bots/workers, deduplicate with deposits(address) plus your own order database; do not rely on idempotencyKey.",
+    "For webhooks, verify the raw request body before parsing JSON.",
+    ...steps ?? []
+  ].join("\n");
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CURRENCIES,
@@ -2029,6 +2031,7 @@ function getOfframpDeveloperResources(profile) {
   MakersCreateError,
   OFFRAMP_DEVELOPER_RESOURCES,
   OFFRAMP_ERROR_CODES,
+  OFFRAMP_INTEGRATION_CHECKLIST,
   OFFRAMP_INTEGRATION_PLAYBOOKS,
   OFFRAMP_RESOURCE_LINKS,
   Offramp,
@@ -2046,6 +2049,7 @@ function getOfframpDeveloperResources(profile) {
   disableOtc,
   emitEvent,
   enableOtc,
+  getOfframpAgentPrompt,
   getOfframpDeveloperResources,
   getOtcLink,
   getPeerExtensionRegistrationAuthParams,
@@ -2055,7 +2059,6 @@ function getOfframpDeveloperResources(profile) {
   isPeerExtensionAvailable,
   isPeerExtensionMetadataBridgeAvailable,
   isPeerExtensionRegistrationError,
-  isValidIBAN,
   normalizePaypalMeUsername,
   offramp,
   openPeerExtensionInstallPage,