@mento-protocol/mento-sdk 2.0.0-beta.9 → 3.0.0-beta.10

package/README.md

@@ -31,7 +31,7 @@ const provider = createPublicClient({
 const mento = new Mento({ provider })
 
 // Use the SDK
-const stableTokens = await mento.stable.getStableTokens()
+const stableTokens = await mento.tokens.getStableTokens()
 console.log('Stable Tokens:', stableTokens)
 ```
 
@@ -84,6 +84,40 @@ pnpm build
 pnpm test
 ```
 
+#### Cache Generation Scripts
+
+The SDK includes scripts to generate and update cached route and token data:
+
+```bash
+# Generate route cache
+pnpm cacheRoutes
+
+# Generate token cache
+pnpm cacheTokens
+```
+
+**Environment Variables:**
+
+You can override the default RPC URLs used by cache generation scripts:
+
+```bash
+# Use custom RPC for Celo mainnet
+export CELO_RPC_URL=https://your-custom-rpc.example.com
+pnpm cacheRoutes
+
+# Use custom RPC for Celo Sepolia testnet
+export CELO_SEPOLIA_RPC_URL=https://your-sepolia-rpc.example.com
+pnpm cacheRoutes
+
+# Or set both
+CELO_RPC_URL=https://your-rpc.com CELO_SEPOLIA_RPC_URL=https://your-sepolia.com pnpm cacheRoutes
+```
+
+By default, scripts use the public Forno RPC endpoints:
+
+- Celo mainnet: `https://forno.celo.org`
+- Celo Sepolia: `https://forno.celo-sepolia.celo-testnet.org`
+
 ### Project Structure
 
 ```bash
@@ -102,200 +136,238 @@ pnpm test
 
 ## Features
 
-### Stable Tokens
+### Read Operations
+
+#### Stable Tokens
 
 Query Mento stable tokens:
 
 ```typescript
 // Get all stable tokens
-const tokens = await mento.getStableTokens()
+const tokens = await mento.tokens.getStableTokens()
 ```
 
-### Collateral Assets
+#### Collateral Assets
 
 Retrieve collateral assets:
 
 ```typescript
 // Get all collateral assets
-const assets = await mento.getCollateralAssets()
+const assets = await mento.collateral.getCollateralAssets()
 ```
 
-### Swap Functionality
-
-The SDK provides comprehensive swap functionality, supporting exchanges between collateral assets and stable tokens:
-
-#### Provider-Specific Setup for Write Operations
+#### Exchanges
 
-Before executing swaps, ensure your provider is set up with the appropriate signing capabilities:
+Query exchanges and tradable pairs:
 
-**With Ethers v6:**
 ```typescript
-import { JsonRpcProvider, Wallet } from 'ethers'
-import { Mento } from '@mento/sdk'
+// Get all exchanges
+const exchanges = await mento.exchanges.getExchanges()
 
-// Create a provider with a signer
-const provider = new JsonRpcProvider('YOUR_RPC_URL')
-const wallet = new Wallet('YOUR_PRIVATE_KEY', provider)
+// Get tradable pairs (includes multi-hop routes)
+const pairs = await mento.exchanges.getTradablePairs()
 
-// Initialize Mento SDK with the provider+signer
-const mento = await Mento.create({ provider: wallet })
+// Find specific pair
+const pair = await mento.exchanges.findPairForTokens(
+  tokenInAddress,
+  tokenOutAddress
+)
 ```
 
-**With Ethers v5:**
-```typescript
-import { providers, Wallet } from 'ethers-v5'
-import { Mento } from '@mento/sdk'
+### Write Operations
 
-// Create a provider with a signer
-const provider = new providers.JsonRpcProvider('YOUR_RPC_URL')
-const wallet = new Wallet('YOUR_PRIVATE_KEY', provider)
+The SDK supports write transactions for submitting state-changing operations to the blockchain. Write operations require a signer (Ethers) or wallet client (Viem).
 
-// Initialize Mento SDK with the provider+signer
-const mento = await Mento.create({ provider: wallet })
-```
+#### Setup for Write Operations
 
 **With Viem:**
+
 ```typescript
 import { createPublicClient, createWalletClient, http } from 'viem'
 import { privateKeyToAccount } from 'viem/accounts'
 import { celo } from 'viem/chains'
 import { Mento } from '@mento/sdk'
 
-// Create public client
+// Create account from private key
+const account = privateKeyToAccount('0x...')
+
+// Create public and wallet clients
 const publicClient = createPublicClient({
   chain: celo,
-  transport: http('YOUR_RPC_URL')
+  transport: http('https://forno.celo.org'),
 })
 
-// Create wallet client
-const account = privateKeyToAccount('0x' + 'YOUR_PRIVATE_KEY')
 const walletClient = createWalletClient({
   account,
   chain: celo,
-  transport: http('YOUR_RPC_URL')
+  transport: http('https://forno.celo.org'),
 })
 
-// Initialize Mento SDK
-const mento = await Mento.create({ 
+// Initialize SDK with write support
+const mento = await Mento.create({
   provider: publicClient,
-  viemAdapterConfig: { walletClient, account }
+  signer: walletClient, // Add wallet client for write operations
 })
 ```
 
-#### Swap In (Fixed Input)
-
-Exchange a specific amount of input token for at least a minimum amount of output token:
+**With Ethers v6:**
 
 ```typescript
-// Get estimated swap amounts
-const amountOut = await mento.getAmountOut(
-  celoAddress,
-  cUsdAddress,
-  '1000000000000000000' // 1 CELO with 18 decimals
-)
-console.log(`Expected amount out: ${amountOut}`)
-
-// Calculate slippage (0.5% in this example)
-const minAmountOut = (BigInt(amountOut) * BigInt(995)) / BigInt(1000)
-
-// Execute the swap
-const tx = await mento.swapIn(
-  celoAddress, // tokenIn (CELO)
-  cUsdAddress, // tokenOut (cUSD)
-  '1000000000000000000', // amountIn (fixed)
-  minAmountOut.toString(), // minimum acceptable output
-  { gasLimit: '300000' } // Optional gas settings
-)
+import { JsonRpcProvider, Wallet } from 'ethers'
+import { Mento } from '@mento/sdk'
 
-// Wait for confirmation
-const receipt = await tx.wait()
-console.log('Swap completed!', receipt)
+// Create provider and signer
+const provider = new JsonRpcProvider('https://forno.celo.org')
+const signer = new Wallet('0x...', provider)
+
+// Initialize SDK with write support
+const mento = await Mento.create({
+  provider,
+  signer, // Add signer for write operations
+})
 ```
 
-#### Swap Out (Fixed Output)
+#### Token Approval
 
-Get a specific amount of output token by spending at most a maximum amount of input token:
+Approve tokens for Mento protocol interactions:
 
 ```typescript
-// Get required input amount
-const amountIn = await mento.getAmountIn(
-  celoAddress,
-  cUsdAddress,
-  '1000000000000000000' // 1 cUSD with 18 decimals
-)
-console.log(`Required amount in: ${amountIn}`)
-
-// Calculate slippage (0.5% in this example)
-const maxAmountIn = (BigInt(amountIn) * BigInt(1005)) / BigInt(1000)
-
-// Execute the swap
-const tx = await mento.swapOut(
-  celoAddress, // tokenIn (CELO)
-  cUsdAddress, // tokenOut (cUSD)
-  '1000000000000000000', // amountOut (fixed)
-  maxAmountIn.toString(), // maximum acceptable input
-  { gasLimit: '350000' } // Optional gas settings
-)
+// Get the adapter (provider-agnostic)
+const adapter = mento.getAdapter()
+
+// Approve USDC for Mento Broker
+const tx = await adapter.writeContract({
+  address: '0x765DE816845861e75A25fCA122bb6898B8B1282a', // USDC on Celo
+  abi: ['function approve(address spender, uint256 amount) returns (bool)'],
+  functionName: 'approve',
+  args: [
+    '0x...', // Spender address (e.g., Mento Broker)
+    1000000n, // Amount (1 USDC with 6 decimals)
+  ],
+})
+
+console.log('Transaction hash:', tx.hash)
+console.log('From:', tx.from)
+console.log('To:', tx.to)
 
 // Wait for confirmation
 const receipt = await tx.wait()
-console.log('Swap completed!', receipt)
+console.log('Transaction confirmed in block:', receipt.blockNumber)
+console.log('Status:', receipt.status) // 'success' or 'failed'
+```
+
+#### Transaction Status Tracking
+
+Monitor transaction status and confirmations:
+
+```typescript
+// Submit transaction
+const tx = await adapter.writeContract({...})
+
+// Check if transaction is mined (returns null if pending)
+const receipt = await tx.getReceipt()
+if (receipt) {
+  console.log('Transaction mined!', receipt.blockNumber)
+}
+
+// Wait for specific number of confirmations
+const confirmedReceipt = await tx.wait(3)  // Wait for 3 confirmations
+console.log('Transaction confirmed after 3 blocks')
 ```
 
 #### Gas Estimation
 
-Estimate gas costs for a swap operation:
+Estimate gas before submitting transactions:
 
 ```typescript
-const estimatedGas = await mento.estimateGas(
-  'swapIn', // or 'swapOut'
-  [celoAddress, cUsdAddress, '1000000000000000000', minAmountOut.toString()]
-)
-console.log(`Estimated gas: ${estimatedGas}`)
-
-// Use the estimated gas in your transaction
-const tx = await mento.swapIn(
-  celoAddress,
-  cUsdAddress,
-  '1000000000000000000',
-  minAmountOut.toString(),
-  { gasLimit: estimatedGas }
-)
+// Estimate gas for an approval
+const estimatedGas = await adapter.estimateGas({
+  address: '0x765DE816845861e75A25fCA122bb6898B8B1282a',
+  abi: ['function approve(address spender, uint256 amount) returns (bool)'],
+  functionName: 'approve',
+  args: ['0x...', 1000000n],
+})
+
+console.log('Estimated gas:', estimatedGas) // Returns BigInt
+```
+
+#### Custom Gas Parameters
+
+Customize gas parameters for transactions:
+
+```typescript
+// Legacy gas price (Type 0/1 transactions)
+const tx = await adapter.writeContract({
+  address: '0x...',
+  abi: [...],
+  functionName: 'approve',
+  args: [...],
+  gasLimit: 100000n,       // Custom gas limit
+  gasPrice: 5000000000n,   // 5 gwei
+})
+
+// EIP-1559 (Type 2 transactions)
+const tx = await adapter.writeContract({
+  address: '0x...',
+  abi: [...],
+  functionName: 'approve',
+  args: [...],
+  gasLimit: 100000n,
+  maxFeePerGas: 10000000000n,        // 10 gwei max
+  maxPriorityFeePerGas: 2000000000n, // 2 gwei priority
+})
+
+// Custom nonce (for transaction ordering)
+const tx = await adapter.writeContract({
+  address: '0x...',
+  abi: [...],
+  functionName: 'approve',
+  args: [...],
+  nonce: 42n,  // Explicit nonce
+})
+```
+
+#### Error Handling
+
+The SDK provides detailed error information:
+
+```typescript
+import { ValidationError, ExecutionError, NetworkError } from '@mento/sdk'
+
+try {
+  const tx = await adapter.writeContract({...})
+  const receipt = await tx.wait()
+} catch (error) {
+  if (error instanceof ValidationError) {
+    // Pre-submission validation errors (no gas cost)
+    console.error('Invalid parameters:', error.message)
+  } else if (error instanceof ExecutionError) {
+    // Transaction reverted on-chain (gas was consumed)
+    console.error('Transaction failed:', error.message)
+    console.error('Revert reason:', error.revertReason)
+  } else if (error instanceof NetworkError) {
+    // RPC/network errors
+    console.error('Network error:', error.message)
+    if (error.retry) {
+      console.log('This error is retryable')
+    }
+  }
+}
 ```
 
-## Agentic Coding with Claude Code
-
-This project supports agentic coding practices using Claude Code to accelerate development and maintain high-quality standards. Follow these steps to get started:
-
-1.  **Prerequisites:**
-
-    - Ensure you have [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview) installed and configured globally.
-    - Familiarize yourself with the project's coding standards and architectural patterns documented in `ai_docs/project-patterns.md`.
-
-2.  **Workflow:**
-
-    - **Start Claude Code:** Launch your Claude Code interface.
-    - **Prime Context:**
-      - In Claude Code, type `/prime`.
-      - When prompted (or if your tool allows inline commands), execute the command defined in `.claude/commands/context_prime`. This will provide the AI with essential background information about the Mento SDK project.
-    - **Generate Feature Specification:**
-      - To create a new feature, first generate a detailed specification.
-      - In Claude Code, type `/spec` and select the "generate spec" command/prompt.
-      - Provide a clear description of the feature you want to implement. The AI will use the templates and examples in the `specs/` directory as a guide.
-      - **Review and Refine:** Carefully review the generated spec. Edit and refine it to ensure it accurately and comprehensively captures the feature requirements, edge cases, and acceptance criteria.
-    - **Implement Feature from Specification:**
-      - Once the spec is finalized, instruct the AI to write the code.
-      - In Claude Code, type `/spec` again, but this time select the "generate code from spec" command/prompt.
-      - Provide the filename of the spec you just created (e.g., `specs/my-new-feature.md`). You might be able to provide this inline with the command or when prompted by the AI.
-    - **Review Generated Code:**
-      - Thoroughly review the code generated by the AI. Check for correctness, adherence to coding standards (`ai_docs/project-patterns.md`), and completeness against the spec.
-      - Iterate with the AI if necessary, providing feedback for corrections or improvements.
-    - **Create a Pull Request (PR):**
-      - Once you are satisfied with the code, ask Claude Code to help you create a Pull Request.
-      - Ensure the PR description is clear and links to the relevant spec.
-      - The PR should then be reviewed by another team member before merging.
-
-By following this workflow, you can leverage AI to handle boilerplate, draft implementations, and ensure consistency, allowing you to focus on the more complex and strategic aspects of development.
+#### Utility Methods
+
+Additional helper methods for write operations:
+
+```typescript
+// Get signer/wallet address
+const address = await adapter.getSignerAddress()
+console.log('Wallet address:', address)
+
+// Get current nonce
+const nonce = await adapter.getTransactionCount(address)
+console.log('Next nonce:', nonce)
+```
 
 ## Contributing
 

package/dist/cache/routes.d.ts

@@ -0,0 +1,13 @@
+import type { RouteWithCost } from '../core/types';
+/**
+ * Cached routes indexed by chain ID
+ * Routes that don't exist for a chain will return an empty array
+ */
+export declare const cachedRoutes: Record<number, RouteWithCost[]>;
+/**
+ * Get cached routes for a specific chain
+ * @param chainId - The chain ID
+ * @returns The cached routes array, or empty array if not available
+ */
+export declare function getCachedRoutes(chainId: number): RouteWithCost[];
+//# sourceMappingURL=routes.d.ts.map

package/dist/cache/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../src/cache/routes.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAElD;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CA8GxD,CAAA;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,EAAE,CAEhE"}

package/dist/cache/routes.js

@@ -0,0 +1,130 @@
+"use strict";
+// This file is auto-generated. Do not edit manually.
+// Generated on 2026-01-21T20:27:37.682Z
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cachedRoutes = void 0;
+exports.getCachedRoutes = getCachedRoutes;
+/**
+ * Cached routes indexed by chain ID
+ * Routes that don't exist for a chain will return an empty array
+ */
+exports.cachedRoutes = {
+    // Chain 42220
+    42220: [
+        {
+            "id": "KESm-USDm",
+            "tokens": [
+                {
+                    "address": "0x456a3D042C0DbD3db53D5489e98dFb038553B0d0",
+                    "symbol": "KESm"
+                },
+                {
+                    "address": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+                    "symbol": "USDm"
+                }
+            ],
+            "path": [
+                {
+                    "factoryAddr": "0x65A67cb93a3e035C32f131e911A0d6b46a5f3Bd0",
+                    "poolAddr": "0x5c3919258a040D203260880401E3201a82d224c4",
+                    "token0": "0x456a3D042C0DbD3db53D5489e98dFb038553B0d0",
+                    "token1": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+                    "poolType": "FPMM"
+                }
+            ],
+            "costData": {
+                "totalCostPercent": 0.3,
+                "hops": [
+                    {
+                        "poolAddress": "0x5c3919258a040D203260880401E3201a82d224c4",
+                        "costPercent": 0.3
+                    }
+                ]
+            }
+        },
+        {
+            "id": "GHSm-USDm",
+            "tokens": [
+                {
+                    "address": "0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313",
+                    "symbol": "GHSm"
+                },
+                {
+                    "address": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+                    "symbol": "USDm"
+                }
+            ],
+            "path": [
+                {
+                    "factoryAddr": "0x6CE2dFC48b2688075A804835757a734e3316E0a2",
+                    "poolAddr": "0x21243E9F64815D86Eeb38d80a212295a39634e70",
+                    "token0": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+                    "token1": "0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313",
+                    "poolType": "Virtual",
+                    "exchangeId": "0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187"
+                }
+            ],
+            "costData": {
+                "totalCostPercent": 1,
+                "hops": [
+                    {
+                        "poolAddress": "0x21243E9F64815D86Eeb38d80a212295a39634e70",
+                        "costPercent": 1
+                    }
+                ]
+            }
+        },
+        {
+            "id": "GHSm-KESm",
+            "tokens": [
+                {
+                    "address": "0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313",
+                    "symbol": "GHSm"
+                },
+                {
+                    "address": "0x456a3D042C0DbD3db53D5489e98dFb038553B0d0",
+                    "symbol": "KESm"
+                }
+            ],
+            "path": [
+                {
+                    "factoryAddr": "0x65A67cb93a3e035C32f131e911A0d6b46a5f3Bd0",
+                    "poolAddr": "0x5c3919258a040D203260880401E3201a82d224c4",
+                    "token0": "0x456a3D042C0DbD3db53D5489e98dFb038553B0d0",
+                    "token1": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+                    "poolType": "FPMM"
+                },
+                {
+                    "factoryAddr": "0x6CE2dFC48b2688075A804835757a734e3316E0a2",
+                    "poolAddr": "0x21243E9F64815D86Eeb38d80a212295a39634e70",
+                    "token0": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+                    "token1": "0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313",
+                    "poolType": "Virtual",
+                    "exchangeId": "0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187"
+                }
+            ],
+            "costData": {
+                "totalCostPercent": 1.297,
+                "hops": [
+                    {
+                        "poolAddress": "0x5c3919258a040D203260880401E3201a82d224c4",
+                        "costPercent": 0.3
+                    },
+                    {
+                        "poolAddress": "0x21243E9F64815D86Eeb38d80a212295a39634e70",
+                        "costPercent": 1
+                    }
+                ]
+            }
+        }
+    ],
+};
+/**
+ * Get cached routes for a specific chain
+ * @param chainId - The chain ID
+ * @returns The cached routes array, or empty array if not available
+ */
+function getCachedRoutes(chainId) {
+    return exports.cachedRoutes[chainId] ?? [];
+}
+//# sourceMappingURL=routes.js.map

package/dist/cache/routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../../src/cache/routes.ts"],"names":[],"mappings":";AAAA,qDAAqD;AACrD,wCAAwC;;;AA6HxC,0CAEC;AA3HD;;;GAGG;AACU,QAAA,YAAY,GAAoC;IAC3D,cAAc;IACd,KAAK,EAAE;QACL;YACE,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE;gBACR;oBACE,SAAS,EAAE,4CAA4C;oBACvD,QAAQ,EAAE,MAAM;iBACjB;gBACD;oBACE,SAAS,EAAE,4CAA4C;oBACvD,QAAQ,EAAE,MAAM;iBACjB;aACF;YACD,MAAM,EAAE;gBACN;oBACE,aAAa,EAAE,4CAA4C;oBAC3D,UAAU,EAAE,4CAA4C;oBACxD,QAAQ,EAAE,4CAA4C;oBACtD,QAAQ,EAAE,4CAA4C;oBACtD,UAAU,EAAE,MAAM;iBACnB;aACF;YACD,UAAU,EAAE;gBACV,kBAAkB,EAAE,GAAG;gBACvB,MAAM,EAAE;oBACN;wBACE,aAAa,EAAE,4CAA4C;wBAC3D,aAAa,EAAE,GAAG;qBACnB;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE;gBACR;oBACE,SAAS,EAAE,4CAA4C;oBACvD,QAAQ,EAAE,MAAM;iBACjB;gBACD;oBACE,SAAS,EAAE,4CAA4C;oBACvD,QAAQ,EAAE,MAAM;iBACjB;aACF;YACD,MAAM,EAAE;gBACN;oBACE,aAAa,EAAE,4CAA4C;oBAC3D,UAAU,EAAE,4CAA4C;oBACxD,QAAQ,EAAE,4CAA4C;oBACtD,QAAQ,EAAE,4CAA4C;oBACtD,UAAU,EAAE,SAAS;oBACrB,YAAY,EAAE,oEAAoE;iBACnF;aACF;YACD,UAAU,EAAE;gBACV,kBAAkB,EAAE,CAAC;gBACrB,MAAM,EAAE;oBACN;wBACE,aAAa,EAAE,4CAA4C;wBAC3D,aAAa,EAAE,CAAC;qBACjB;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE;gBACR;oBACE,SAAS,EAAE,4CAA4C;oBACvD,QAAQ,EAAE,MAAM;iBACjB;gBACD;oBACE,SAAS,EAAE,4CAA4C;oBACvD,QAAQ,EAAE,MAAM;iBACjB;aACF;YACD,MAAM,EAAE;gBACN;oBACE,aAAa,EAAE,4CAA4C;oBAC3D,UAAU,EAAE,4CAA4C;oBACxD,QAAQ,EAAE,4CAA4C;oBACtD,QAAQ,EAAE,4CAA4C;oBACtD,UAAU,EAAE,MAAM;iBACnB;gBACD;oBACE,aAAa,EAAE,4CAA4C;oBAC3D,UAAU,EAAE,4CAA4C;oBACxD,QAAQ,EAAE,4CAA4C;oBACtD,QAAQ,EAAE,4CAA4C;oBACtD,UAAU,EAAE,SAAS;oBACrB,YAAY,EAAE,oEAAoE;iBACnF;aACF;YACD,UAAU,EAAE;gBACV,kBAAkB,EAAE,KAAK;gBACzB,MAAM,EAAE;oBACN;wBACE,aAAa,EAAE,4CAA4C;wBAC3D,aAAa,EAAE,GAAG;qBACnB;oBACD;wBACE,aAAa,EAAE,4CAA4C;wBAC3D,aAAa,EAAE,CAAC;qBACjB;iBACF;aACF;SACF;KACF;CACF,CAAA;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,OAAe;IAC7C,OAAO,oBAAY,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;AACpC,CAAC"}

package/dist/cache/tokens.d.ts

@@ -0,0 +1,67 @@
+import type { Token } from '../core/types';
+/**
+ * Enum of all token symbols across all supported chains
+ */
+export declare enum TokenSymbol {
+    AUDm = "AUDm",
+    BRLm = "BRLm",
+    CADm = "CADm",
+    CELO = "CELO",
+    CHFm = "CHFm",
+    COPm = "COPm",
+    EURm = "EURm",
+    GBPm = "GBPm",
+    GHSm = "GHSm",
+    JPYm = "JPYm",
+    KESm = "KESm",
+    NGNm = "NGNm",
+    PHPm = "PHPm",
+    USDC = "USDC",
+    USDm = "USDm",
+    USD_ = "USD\u20AE",
+    XOFm = "XOFm",
+    ZARm = "ZARm",
+    axlEUROC = "axlEUROC",
+    axlUSDC = "axlUSDC"
+}
+/**
+ * Cached tokens indexed by chain ID
+ */
+export declare const cachedTokens: Record<number, readonly Token[]>;
+/**
+ * Mapping of token addresses by chain ID and token symbol
+ * Useful for quickly looking up a token address by its symbol on a specific chain
+ */
+export declare const TOKEN_ADDRESSES_BY_CHAIN: {
+    [chainId: number]: {
+        [tokenSymbol in TokenSymbol]?: string;
+    };
+};
+/**
+ * Get cached tokens for a specific chain
+ * @param chainId - The chain ID
+ * @returns The cached tokens array, or empty array if not available
+ */
+export declare function getCachedTokens(chainId: number): readonly Token[];
+/**
+ * Get cached tokens synchronously for a specific chain
+ * @param chainId - The chain ID to get tokens for
+ * @returns The cached tokens array
+ * @throws Error if tokens are not available for the chain
+ */
+export declare function getCachedTokensSync(chainId: number): readonly Token[];
+/**
+ * Get token address by chain ID and symbol
+ * @param chainId - The chain ID
+ * @param symbol - The token symbol
+ * @returns The token address or undefined if not found
+ */
+export declare function getTokenAddress(chainId: number, symbol: TokenSymbol): string | undefined;
+/**
+ * Find a token by its symbol on a specific chain
+ * @param chainId - The chain ID
+ * @param symbol - The token symbol
+ * @returns The token object or undefined if not found
+ */
+export declare function findTokenBySymbol(chainId: number, symbol: TokenSymbol): Token | undefined;
+//# sourceMappingURL=tokens.d.ts.map

package/dist/cache/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/cache/tokens.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAE1C;;GAEG;AACH,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,cAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAuPzD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE;IACrC,CAAC,OAAO,EAAE,MAAM,GAAG;SAAG,WAAW,IAAI,WAAW,CAAC,CAAC,EAAE,MAAM;KAAE,CAAA;CA8C7D,CAAA;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,EAAE,CAEjE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,EAAE,CAMrE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,WAAW,GAClB,MAAM,GAAG,SAAS,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,WAAW,GAClB,KAAK,GAAG,SAAS,CAInB"}