@klappay/types 4.1.0 → 5.0.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export { A as ALT_TOKEN_ADDRESSES, a as ALT_TOKEN_DECIMALS, b as AltToken, c as AltTokenSchema, C as CHAIN_IDS, E as EVM_NETWORKS, d as Environment, e as EnvironmentSchema, f as EvmNetwork, N as NETWORK_EXPLORERS, g as NETWORK_LABELS, h as Network, i as NetworkSchema, O as OPERATIONAL_NETWORKS, j as OperationalNetwork, S as SwapAlternative, k as SwapAlternativeSchema, T as TOKEN_ADDRESSES, l as TOKEN_DECIMALS, m as TOKEN_DEPLOYMENTS, n as Token, o as TokenDeployment, p as TokenSchema, q as getTokenDeployment, r as isPaymentDeploymentEnabled, s as listSwapAlternatives } from './constants-021Ybu31.js';
+export { A as ALT_TOKEN_ADDRESSES, a as ALT_TOKEN_DECIMALS, b as AltToken, c as AltTokenSchema, C as CHAIN_IDS, E as EVM_NETWORKS, d as Environment, e as EnvironmentSchema, f as EvmNetwork, N as NETWORK_EXPLORERS, g as NETWORK_LABELS, h as Network, i as NetworkSchema, O as OPERATIONAL_NETWORKS, j as OperationalNetwork, S as SwapAlternative, k as SwapAlternativeSchema, T as TOKEN_ADDRESSES, l as TOKEN_DECIMALS, m as TOKEN_DEPLOYMENTS, n as Token, o as TokenDeployment, p as TokenSchema, q as getTokenDeployment, r as isPaymentDeploymentEnabled, s as listSwapAlternatives } from './constants-Di4Qr6af.js';
 
 declare const ErrorPayloadSchema: z.ZodObject<{
     error: z.ZodObject<{
@@ -390,13 +390,13 @@ declare const ChargeSchema: z.ZodObject<{
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }>, "many">;
     swapAlternatives: z.ZodArray<z.ZodObject<{
-        token: z.ZodEnum<["ETH", "BNB", "MATIC", "AVAX", "BTC"]>;
+        token: z.ZodEnum<["ETH", "BNB", "POL", "AVAX", "BTC", "LINK", "ARB", "OP", "CBETH"]>;
         network: z.ZodEnum<["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]>;
     }, "strip", z.ZodTypeAny, {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }, {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }>, "many">;
     address: z.ZodString;
@@ -588,7 +588,7 @@ declare const ChargeSchema: z.ZodObject<{
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     swapAlternatives: {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     settlementStatus: "pending" | "completed" | "failed" | null;
@@ -667,7 +667,7 @@ declare const ChargeSchema: z.ZodObject<{
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     swapAlternatives: {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     settlementStatus: "pending" | "completed" | "failed" | null;
@@ -751,13 +751,13 @@ declare const PaginatedChargesSchema: z.ZodObject<{
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }>, "many">;
         swapAlternatives: z.ZodArray<z.ZodObject<{
-            token: z.ZodEnum<["ETH", "BNB", "MATIC", "AVAX", "BTC"]>;
+            token: z.ZodEnum<["ETH", "BNB", "POL", "AVAX", "BTC", "LINK", "ARB", "OP", "CBETH"]>;
             network: z.ZodEnum<["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]>;
         }, "strip", z.ZodTypeAny, {
-            token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+            token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }, {
-            token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+            token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }>, "many">;
         address: z.ZodString;
@@ -949,7 +949,7 @@ declare const PaginatedChargesSchema: z.ZodObject<{
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         swapAlternatives: {
-            token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+            token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         settlementStatus: "pending" | "completed" | "failed" | null;
@@ -1028,7 +1028,7 @@ declare const PaginatedChargesSchema: z.ZodObject<{
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         swapAlternatives: {
-            token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+            token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         settlementStatus: "pending" | "completed" | "failed" | null;
@@ -1111,7 +1111,7 @@ declare const PaginatedChargesSchema: z.ZodObject<{
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         swapAlternatives: {
-            token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+            token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         settlementStatus: "pending" | "completed" | "failed" | null;
@@ -1194,7 +1194,7 @@ declare const PaginatedChargesSchema: z.ZodObject<{
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         swapAlternatives: {
-            token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+            token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
             network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
         }[];
         settlementStatus: "pending" | "completed" | "failed" | null;
@@ -1279,13 +1279,13 @@ declare const CheckChargeResponseSchema: z.ZodObject<{
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }>, "many">;
     swapAlternatives: z.ZodArray<z.ZodObject<{
-        token: z.ZodEnum<["ETH", "BNB", "MATIC", "AVAX", "BTC"]>;
+        token: z.ZodEnum<["ETH", "BNB", "POL", "AVAX", "BTC", "LINK", "ARB", "OP", "CBETH"]>;
         network: z.ZodEnum<["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]>;
     }, "strip", z.ZodTypeAny, {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }, {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }>, "many">;
     address: z.ZodString;
@@ -1495,7 +1495,7 @@ declare const CheckChargeResponseSchema: z.ZodObject<{
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     swapAlternatives: {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     settlementStatus: "pending" | "completed" | "failed" | null;
@@ -1581,7 +1581,7 @@ declare const CheckChargeResponseSchema: z.ZodObject<{
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     swapAlternatives: {
-        token: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+        token: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
         network: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     }[];
     settlementStatus: "pending" | "completed" | "failed" | null;
@@ -3095,21 +3095,21 @@ declare const CapabilitiesSchema: z.ZodObject<{
 type Capabilities = z.infer<typeof CapabilitiesSchema>;
 
 declare const CreateSwapQuoteSchema: z.ZodObject<{
-    inputToken: z.ZodEnum<["ETH", "BNB", "MATIC", "AVAX", "BTC"]>;
+    inputToken: z.ZodEnum<["ETH", "BNB", "POL", "AVAX", "BTC", "LINK", "ARB", "OP", "CBETH"]>;
     inputNetwork: z.ZodEnum<["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]>;
     takerAddress: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    inputToken: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+    inputToken: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
     inputNetwork: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     takerAddress: string;
 }, {
-    inputToken: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+    inputToken: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
     inputNetwork: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     takerAddress: string;
 }>;
 type CreateSwapQuoteInput = z.infer<typeof CreateSwapQuoteSchema>;
 declare const SwapQuoteSchema: z.ZodObject<{
-    inputToken: z.ZodEnum<["ETH", "BNB", "MATIC", "AVAX", "BTC"]>;
+    inputToken: z.ZodEnum<["ETH", "BNB", "POL", "AVAX", "BTC", "LINK", "ARB", "OP", "CBETH"]>;
     inputNetwork: z.ZodEnum<["base", "optimism", "polygon", "ethereum", "arbitrum", "avalanche", "bnb"]>;
     inputAmount: z.ZodNumber;
     inputAmountExact: z.ZodOptional<z.ZodString>;
@@ -3156,7 +3156,7 @@ declare const SwapQuoteSchema: z.ZodObject<{
     }>>>;
 }, "strip", z.ZodTypeAny, {
     expiresAt: string;
-    inputToken: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+    inputToken: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
     inputNetwork: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     inputAmount: number;
     outputToken: "USDC" | "USDT";
@@ -3180,7 +3180,7 @@ declare const SwapQuoteSchema: z.ZodObject<{
     } | null | undefined;
 }, {
     expiresAt: string;
-    inputToken: "ETH" | "BNB" | "MATIC" | "AVAX" | "BTC";
+    inputToken: "ETH" | "BNB" | "POL" | "AVAX" | "BTC" | "LINK" | "ARB" | "OP" | "CBETH";
     inputNetwork: "base" | "optimism" | "polygon" | "ethereum" | "arbitrum" | "avalanche" | "bnb";
     inputAmount: number;
     outputToken: "USDC" | "USDT";

package/dist/index.js

@@ -331,23 +331,54 @@ var import_zod7 = require("zod");
 var ALT_TOKEN_DECIMALS = {
   ETH: 18,
   BNB: 18,
-  MATIC: 18,
+  POL: 18,
   AVAX: 18,
-  BTC: 8
+  BTC: 8,
+  LINK: 18,
+  ARB: 18,
+  OP: 18,
+  CBETH: 18
 };
 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" },
+  base: {
+    ETH: "native",
+    BTC: "0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf",
+    LINK: "0x88Fb150BDc53A65fe94Dea0c9BA0a6dAf8C6e196",
+    CBETH: "0x2Ae3F1Ec7F1F5012CFEab0185bfc7aa3cf0DEc22"
+  },
+  optimism: {
+    ETH: "native",
+    BTC: "0x68f180fcCe6836688e9084f035309E29Bf0A2095",
+    LINK: "0x350a791Bfc2C21F9Ed5d10980Dad2e2638ffa7f6",
+    OP: "0x4200000000000000000000000000000000000042"
+  },
+  ethereum: {
+    ETH: "native",
+    BTC: "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599",
+    LINK: "0x514910771AF9Ca656af840dff83E8264EcF986CA"
+  },
+  arbitrum: {
+    ETH: "native",
+    BTC: "0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f",
+    LINK: "0xf97f4df75117a78c1A5a0DBb814Af92458539FB4",
+    ARB: "0x912CE59144191C1204E64559FE8253a0e49E6548"
+  },
+  polygon: {
+    POL: "native",
+    BTC: "0x1BFD67037B42Cf73acF2047067bd4F2C47D9BfD6",
+    LINK: "0xb0897686c545045aFc77CF20eC7A532E3120E0F1"
+  },
+  avalanche: {
+    AVAX: "native",
+    BTC: "0x2297aebd383787a160dd0d9f71508148769342e3",
+    LINK: "0x5947BB275c521040051D82396192181b413227A3"
+  },
   bnb: { BNB: "native" }
 };
 
 // src/alt-tokens.ts
-var AltTokenSchema = import_zod7.z.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 AltTokenSchema = import_zod7.z.enum(["ETH", "BNB", "POL", "AVAX", "BTC", "LINK", "ARB", "OP", "CBETH"]).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. Trusted on a given network only when it has deep, reputably-issued/custodied liquidity there: each network's own native currency, `BTC` (wrapped) on the networks with a trusted deployment, `LINK` (Chainlink's own official per-chain deployment, except Avalanche's bridged `LINK.e`), and a small set of chain-specific blue chips (`ARB` on Arbitrum, `OP` on Optimism, `CBETH` on Base) \u2014 see `ALT_TOKEN_ADDRESSES` for the authoritative per-network list, never assume every value here is available on every network. `POL` replaced `MATIC` as Polygon's native currency name (Polygon's own token migration, 2024) \u2014 this schema tracks the network's current native asset, not the deprecated ticker."
 );
 var SwapAlternativeSchema = import_zod7.z.object({
   token: AltTokenSchema,
@@ -1232,13 +1263,13 @@ var SwapQuoteSchema = import_zod23.z.object({
     to: import_zod23.z.string().describe("Contract address the payer's wallet must send this transaction to."),
     data: import_zod23.z.string().describe("Calldata \u2014 opaque, must be sent unmodified."),
     value: import_zod23.z.string().describe(
-      "Native currency (ETH/BNB/MATIC/AVAX) to attach, in wei \u2014 `\"0\"` when `inputToken` isn't this network's native currency."
+      "Native currency (ETH/BNB/POL/AVAX) to attach, in wei \u2014 `\"0\"` when `inputToken` isn't this network's native currency."
     )
   }).describe(
     "Pass this directly to the payer's wallet (e.g. viem/ethers `sendTransaction`) \u2014 Klappay never touches the payer's private key or submits anything on their behalf. If `permit2` is present on this response, sign that first and append the signature to this `data` before sending; if `permit2` is absent, send `transaction` as-is with no extra step."
   ),
   permit2: import_zod23.z.object({ eip712: import_zod23.z.record(import_zod23.z.unknown()) }).nullish().describe(
-    "Present only when `inputToken` is an ERC-20 (today, only `BTC`) \u2014 the payer's wallet must sign this EIP-712 message and append the signature to `transaction.data` before sending, since an ERC-20 sell needs a Permit2 allowance signature that a native-currency sell doesn't. `null` (never omitted, in a genuine 0x-backed quote) when `inputToken` is a network's own native currency (ETH/BNB/MATIC/AVAX) \u2014 `transaction` is then ready to sign and send directly, no extra step."
+    "Present only when `inputToken` is an ERC-20 (BTC, LINK, or a chain-specific blue chip like ARB/OP/CBETH) \u2014 the payer's wallet must sign this EIP-712 message and append the signature to `transaction.data` before sending, since an ERC-20 sell needs a Permit2 allowance signature that a native-currency sell doesn't. `null` (never omitted, in a genuine 0x-backed quote) when `inputToken` is a network's own native currency (ETH/BNB/POL/AVAX) \u2014 `transaction` is then ready to sign and send directly, no extra step."
   )
 });
 // Annotate the CommonJS export names for ESM import in node: