@klappay/types 3.0.1 → 3.1.0

package/dist/index.mjs

@@ -1,3 +1,15 @@
+import {
+  ALT_TOKEN_ADDRESSES,
+  ALT_TOKEN_DECIMALS,
+  CHAIN_IDS,
+  EVM_NETWORKS,
+  NETWORK_EXPLORERS,
+  NETWORK_LABELS,
+  OPERATIONAL_NETWORKS,
+  TOKEN_ADDRESSES,
+  TOKEN_DECIMALS
+} from "./chunk-KZ3646WX.mjs";
+
 // src/errors.ts
 import { z } from "zod";
 var ErrorPayloadSchema = z.object({
@@ -54,42 +66,6 @@ function findConflictingScopes(scopes) {
 // src/networks.ts
 import { z as z4 } from "zod";
 var NetworkSchema = z4.enum(["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]).describe("The blockchain a charge/payment is on.");
-var NETWORK_LABELS = {
-  base: "Base",
-  optimism: "Optimism",
-  polygon: "Polygon",
-  ethereum: "Ethereum",
-  arbitrum: "Arbitrum",
-  avalanche: "Avalanche",
-  bnb: "BNB Chain"
-};
-var NETWORK_EXPLORERS = {
-  base: "https://basescan.org",
-  optimism: "https://optimistic.etherscan.io",
-  polygon: "https://polygonscan.com",
-  ethereum: "https://etherscan.io",
-  arbitrum: "https://arbiscan.io",
-  avalanche: "https://snowtrace.io",
-  bnb: "https://bscscan.com"
-};
-var EVM_NETWORKS = [
-  "base",
-  "optimism",
-  "polygon",
-  "ethereum",
-  "arbitrum",
-  "avalanche",
-  "bnb"
-];
-var OPERATIONAL_NETWORKS = [
-  "base",
-  "arbitrum",
-  "optimism",
-  "polygon",
-  "ethereum",
-  "avalanche",
-  "bnb"
-];
 
 // src/pagination.ts
 import { z as z5 } from "zod";
@@ -117,66 +93,26 @@ import { z as z6 } from "zod";
 var TokenSchema = z6.enum(["USDC", "USDT"]).describe(
   `Which stablecoin the payer will send. Support depends on both \`network\` and \`environment\` \u2014 not every token/network/environment combination is deployed; today, both \`USDC\` and \`USDT\` are deployed on every operational network's \`live\` side except BNB Chain (\`${OPERATIONAL_NETWORKS.join(", ")}\`), but \`test\` coverage varies per network \u2014 Base, Optimism, and Ethereum each have a \`test\` environment (\`USDC\` only; none has an official Sepolia USDT), Arbitrum, Polygon, Avalanche, and BNB Chain have none yet (0xSplits hasn't deployed on Arbitrum Sepolia and has no Polygon, Avalanche Fuji, or BNB testnet support at all). An unconfigured combination is rejected with \`422 token_not_supported\`, not silently accepted. **BNB Chain's \`USDC\` address is Binance-Peg USDC, not an official Circle deployment** \u2014 Circle does not issue native USDC on BNB Chain at all; this is a Binance-custodied, 1:1-pegged BEP-20 token, a materially different trust model than every other \`TOKEN_ADDRESSES\` entry (all verified directly against their real issuer). Accepted at the payer's own risk \u2014 Klappay does not verify or guarantee Binance's collateral backing it. \`USDT\` on BNB Chain is Tether's own official issuance, same trust model as everywhere else. More tokens/networks are expected to be added over time \u2014 check \`TOKEN_ADDRESSES\` in \`@klappay/types\` (or a future \`GET /v1/networks\` capabilities endpoint) for the exact current matrix rather than assuming full coverage.`
 );
-var TOKEN_DECIMALS = 6;
-var TOKEN_ADDRESSES = {
-  USDC: {
-    base: {
-      live: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
-      test: "0x036CbD53842c5426634e7929541eC2318f3dCF7e"
-    },
-    optimism: {
-      live: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
-      test: "0x5fd84259d66Cd46123540766Be93DFE6D43130D7"
-    },
-    polygon: { live: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359" },
-    ethereum: {
-      live: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-      test: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238"
-    },
-    arbitrum: { live: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831" },
-    avalanche: { live: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E" },
-    bnb: { live: "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }
-  },
-  USDT: {
-    base: { live: "0xfde4C96c8593536E31F229EA8f37b2ADa2699bb2" },
-    optimism: { live: "0x94b008aA00579c1307B0EF2c499aD98a8ce58e58" },
-    polygon: { live: "0xc2132D05D31c914a87C6611C10748AEb04B58e8F" },
-    ethereum: { live: "0xdAC17F958D2ee523a2206206994597C13D831ec7" },
-    arbitrum: { live: "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9" },
-    avalanche: { live: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7" },
-    bnb: { live: "0x55d398326f99059fF775485246999027B3197955" }
-  }
-};
 
 // src/alt-tokens.ts
 import { z as z7 } from "zod";
 var AltTokenSchema = z7.enum(["ETH", "BNB", "MATIC", "AVAX", "BTC"]).describe(
   "A non-stablecoin cryptocurrency Klappay trusts as swap input for a charge, via the 0x Swap API \u2014 swapped to one of the charge's `acceptedPayments` tokens before it ever reaches the merchant, so the merchant always receives USDC/USDT regardless of what the payer sent. Only a network's own native currency, plus `BTC` (wrapped) on the networks with deep, reputably-custodied liquidity, is trusted today (see `ALT_TOKEN_ADDRESSES`) \u2014 never assume every value here is available on every network."
 );
-var ALT_TOKEN_DECIMALS = {
-  ETH: 18,
-  BNB: 18,
-  MATIC: 18,
-  AVAX: 18,
-  BTC: 8
-};
-var ALT_TOKEN_ADDRESSES = {
-  base: { ETH: "native", BTC: "0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf" },
-  optimism: { ETH: "native", BTC: "0x68f180fcCe6836688e9084f035309E29Bf0A2095" },
-  ethereum: { ETH: "native", BTC: "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599" },
-  arbitrum: { ETH: "native", BTC: "0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f" },
-  polygon: { MATIC: "native", BTC: "0x1BFD67037B42Cf73acF2047067bd4F2C47D9BfD6" },
-  avalanche: { AVAX: "native" },
-  bnb: { BNB: "native" }
-};
-function listAltTokensForNetworks(networks) {
-  const found = /* @__PURE__ */ new Set();
-  for (const network of networks) {
+var SwapAlternativeSchema = z7.object({
+  token: AltTokenSchema,
+  network: NetworkSchema.describe(
+    "Which network to send `token` on \u2014 pass both as `inputToken`/`inputNetwork` to `POST /v1/charges/{id}/quote`. The same token can appear more than once here, once per network that trusts it and that this charge accepts payment on."
+  )
+});
+function listSwapAlternatives(networks) {
+  const alternatives = [];
+  for (const network of new Set(networks)) {
     for (const token of Object.keys(ALT_TOKEN_ADDRESSES[network] ?? {})) {
-      found.add(token);
+      alternatives.push({ token, network });
     }
   }
-  return [...found];
+  return alternatives;
 }
 
 // src/charges.ts
@@ -317,8 +253,8 @@ var ChargeSchema = z9.object({
   paidWith: z9.array(AcceptedPaymentSchema).describe(
     "Every distinct `(token, network)` pair that has actually contributed a credited transfer so far \u2014 empty until the first one arrives. Can hold more than one entry: a charge accepting several pairs can be paid across a combination of them, and every entry here sums toward `amountReceived`."
   ),
-  swapAlternatives: z9.array(AltTokenSchema).describe(
-    "Non-stablecoin cryptocurrencies the payer can pay with instead, via `POST /v1/charges/{id}/quote` \u2014 derived from the networks in `acceptedPayments` (e.g. a charge accepting USDC on Base lists `ETH` here, since Base's native currency is trusted as swap input). Recomputed on every read against Klappay's current trusted list, not frozen at creation \u2014 empty if this charge's networks have no trusted alt-token, or if swap-to-pay isn't configured on this deployment."
+  swapAlternatives: z9.array(SwapAlternativeSchema).describe(
+    "Every `(token, network)` pair the payer can pay with instead, via `POST /v1/charges/{id}/quote` \u2014 derived from the networks in `acceptedPayments` (e.g. a charge accepting USDC on both Base and Optimism lists `ETH` on Base and `ETH` on Optimism separately, since they're different networks the payer has to choose between, not one merged option). Pass an entry's `token`/`network` straight through as `inputToken`/`inputNetwork`. Recomputed on every read against Klappay's current trusted list, not frozen at creation \u2014 empty if this charge's networks have no trusted alt-token, if swap-to-pay isn't configured on this deployment, or if `environment` is `test` (0x, who powers the swap, has no testnet support at all \u2014 `POST /v1/charges/{id}/quote` always rejects a test-environment charge with `422 swap_test_environment_unsupported`)."
   ),
   address: z9.string().describe(
     "The on-chain address the payer must send funds to \u2014 identical across every accepted network (0xSplits addresses are chain-agnostic). Unique per charge, predicted at creation time \u2014 funds sent here go directly to the merchant, Klappay never custodies them."
@@ -936,6 +872,7 @@ export {
   AcceptedPaymentSchema,
   AltTokenSchema,
   ApiKeyScopeSchema,
+  CHAIN_IDS,
   CHARGE_ACCEPTED_PAYMENTS_MAX,
   CHARGE_AMOUNT_MAX,
   CHARGE_EXPIRES_IN_MAX_SECONDS,
@@ -1003,6 +940,7 @@ export {
   SplitDistributionStatusSchema,
   SplitRecipientInputSchema,
   SplitRecipientSchema,
+  SwapAlternativeSchema,
   SwapQuoteSchema,
   TOKEN_ADDRESSES,
   TOKEN_DECIMALS,
@@ -1025,7 +963,7 @@ export {
   WebhookPayloadSchema,
   WebhookSchema,
   findConflictingScopes,
-  listAltTokensForNetworks,
+  listSwapAlternatives,
   paginatedSchema
 };
 //# sourceMappingURL=index.mjs.map