@mento-protocol/mento-sdk 1.12.0 → 1.13.0

package/README.md

@@ -16,19 +16,16 @@ yarn add @mento-protocol/mento-sdk
 
 You can find example usages of the SDK in the [mento-sdk-examples](https://github.com/mento-protocol/mento-sdk-examples) repository. For in-depth documentation and walk through explanations please see the [SDK section](https://docs.mento.org/mento/developers/mento-sdk) of the Mento docs.
 
-## Tradable Pairs Cache
+## Tokens & Tradable Pairs Cache
 
-Anytime we launch a new stable token, we need to update the tradable pairs cache.
+Anytime we launch a new stable token, we need to update the tokens & tradable pairs caches.
 
-The `yarn cacheTradablePairs` script generates a TypeScript file containing a list of all tradable pairs on the Mento protocol. This file is used to cache the tradable pairs in the SDK and avoid costly re-fetching from the network.
-
-```sh
-yarn cacheTradablePairs
-```
+- The `yarn cacheTokens` script generates a TypeScript file containing a list of all tradable Tokens on the Mento protocol. This cache can be used by UIs to avoid costly async token data lookups.
+- The `yarn cacheTradablePairs` script generates a TypeScript file containing a list of all tradable pairs on the Mento protocol. This file is used to cache the tradable pairs in the SDK and avoid costly re-fetching from the network.
 
 ## Token Graph Visualization
 
-Current token connectivity on Celo Mainnet (last updated: 2025-09-19):
+Current token connectivity on Celo Mainnet (last updated: 2025-10-02):
 
 ```mermaid
 graph TD
@@ -52,7 +49,6 @@ graph TD
     cNGN --- cUSD
     cKES --- cUSD
     cUSD --- eXOF
-
 ```
 
 **Network Stats:** 20 tokens, 19 direct trading pairs

package/dist/cjs/constants/index.d.ts

@@ -1,3 +1,4 @@
 export * from './addresses';
 export * from './currencies';
+export * from './tokens';
 export * from './tradablePairs';

package/dist/cjs/constants/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./addresses"), exports);
 __exportStar(require("./currencies"), exports);
+__exportStar(require("./tokens"), exports);
 __exportStar(require("./tradablePairs"), exports);

package/dist/cjs/constants/tokens.11142220.d.ts

@@ -0,0 +1,2 @@
+import { Token } from '../mento';
+export declare const tokens11142220: readonly Token[];

package/dist/cjs/constants/tokens.11142220.js

@@ -0,0 +1,127 @@
+"use strict";
+// This file is auto-generated. Do not edit manually.
+// Generated on 2025-10-02T13:52:20.427Z
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokens11142220 = void 0;
+exports.tokens11142220 = [
+    {
+        "address": "0x9883d788d40F1C7595a780ed881Ea833C7743B4B",
+        "symbol": "axlEUROC",
+        "name": "Mento Mock axlEUROC",
+        "decimals": 18
+    },
+    {
+        "address": "0x6285De9DA7C1d329C0451628638908915002d9d1",
+        "symbol": "axlUSDC",
+        "name": "Mento Mock axlUSDC",
+        "decimals": 18
+    },
+    {
+        "address": "0x5873Faeb42F3563dcD77F0fbbdA818E6d6DA3139",
+        "symbol": "cAUD",
+        "name": "Celo Australian Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0xF151c9a13b78C84f93f50B8b3bC689fedc134F60",
+        "symbol": "cCAD",
+        "name": "Celo Canadian Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0x284E9b7B623eAE866914b7FA0eB720C2Bb3C2980",
+        "symbol": "cCHF",
+        "name": "Celo Swiss Franc",
+        "decimals": 18
+    },
+    {
+        "address": "0x5F8d55c3627d2dc0a2B4afa798f877242F382F67",
+        "symbol": "cCOP",
+        "name": "Celo Colombian Peso",
+        "decimals": 18
+    },
+    {
+        "address": "0x471EcE3750Da237f93B8E339c536989b8978a438",
+        "symbol": "CELO",
+        "name": "Celo native asset",
+        "decimals": 18
+    },
+    {
+        "address": "0xA99dC247d6b7B2E3ab48a1fEE101b83cD6aCd82a",
+        "symbol": "cEUR",
+        "name": "Celo Euro",
+        "decimals": 18
+    },
+    {
+        "address": "0x85F5181Abdbf0e1814Fc4358582Ae07b8eBA3aF3",
+        "symbol": "cGBP",
+        "name": "Celo British Pound",
+        "decimals": 18
+    },
+    {
+        "address": "0x5e94B8C872bD47BC4255E60ECBF44D5E66e7401C",
+        "symbol": "cGHS",
+        "name": "Celo Ghanaian Cedi",
+        "decimals": 18
+    },
+    {
+        "address": "0x85Bee67D435A39f7467a8a9DE34a5B73D25Df426",
+        "symbol": "cJPY",
+        "name": "Celo Japanese Yen",
+        "decimals": 18
+    },
+    {
+        "address": "0xC7e4635651E3e3Af82b61d3E23c159438daE3BbF",
+        "symbol": "cKES",
+        "name": "Celo Kenyan Shilling",
+        "decimals": 18
+    },
+    {
+        "address": "0x3d5ae86F34E2a82771496D140daFAEf3789dF888",
+        "symbol": "cNGN",
+        "name": "Celo Nigerian Naira",
+        "decimals": 18
+    },
+    {
+        "address": "0x2294298942fdc79417DE9E0D740A4957E0e7783a",
+        "symbol": "cREAL",
+        "name": "Celo Brazilian Real",
+        "decimals": 18
+    },
+    {
+        "address": "0xdE9e4C3ce781b4bA68120d6261cbad65ce0aB00b",
+        "symbol": "cUSD",
+        "name": "Celo Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0x10CCfB235b0E1Ed394bACE4560C3ed016697687e",
+        "symbol": "cZAR",
+        "name": "Celo South African Rand",
+        "decimals": 18
+    },
+    {
+        "address": "0x5505b70207aE3B826c1A7607F19F3Bf73444A082",
+        "symbol": "eXOF",
+        "name": "ECO CFA",
+        "decimals": 18
+    },
+    {
+        "address": "0x0352976d940a2C3FBa0C3623198947Ee1d17869E",
+        "symbol": "PUSO",
+        "name": "PUSO",
+        "decimals": 18
+    },
+    {
+        "address": "0xBD63e46Be8eF8D89dFde3054E7b9ECAEb8Ad83e9",
+        "symbol": "USDC",
+        "name": "Mento Mock USDC",
+        "decimals": 18
+    },
+    {
+        "address": "0xCA53d9b72646B254d29EBeEb4c5cde7BB4bb59e0",
+        "symbol": "USDT",
+        "name": "Mento Mock USDT",
+        "decimals": 18
+    }
+];

package/dist/cjs/constants/tokens.42220.d.ts

@@ -0,0 +1,2 @@
+import { Token } from '../mento';
+export declare const tokens42220: readonly Token[];

package/dist/cjs/constants/tokens.42220.js

@@ -0,0 +1,127 @@
+"use strict";
+// This file is auto-generated. Do not edit manually.
+// Generated on 2025-10-02T13:54:27.948Z
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokens42220 = void 0;
+exports.tokens42220 = [
+    {
+        "address": "0x061cc5a2C863E0C1Cb404006D559dB18A34C762d",
+        "symbol": "axlEUROC",
+        "name": "Axelar Wrapped EUROC",
+        "decimals": 6
+    },
+    {
+        "address": "0xEB466342C4d449BC9f53A865D5Cb90586f405215",
+        "symbol": "axlUSDC",
+        "name": "Axelar Wrapped USDC",
+        "decimals": 6
+    },
+    {
+        "address": "0x7175504C455076F15c04A2F90a8e352281F492F9",
+        "symbol": "cAUD",
+        "name": "Celo Australian Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0xff4Ab19391af240c311c54200a492233052B6325",
+        "symbol": "cCAD",
+        "name": "Celo Canadian Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0xb55a79F398E759E43C95b979163f30eC87Ee131D",
+        "symbol": "cCHF",
+        "name": "Celo Swiss Franc",
+        "decimals": 18
+    },
+    {
+        "address": "0x8A567e2aE79CA692Bd748aB832081C45de4041eA",
+        "symbol": "cCOP",
+        "name": "Celo Colombian Peso",
+        "decimals": 18
+    },
+    {
+        "address": "0x471EcE3750Da237f93B8E339c536989b8978a438",
+        "symbol": "CELO",
+        "name": "Celo native asset",
+        "decimals": 18
+    },
+    {
+        "address": "0xD8763CBa276a3738E6DE85b4b3bF5FDed6D6cA73",
+        "symbol": "cEUR",
+        "name": "Celo Euro",
+        "decimals": 18
+    },
+    {
+        "address": "0xCCF663b1fF11028f0b19058d0f7B674004a40746",
+        "symbol": "cGBP",
+        "name": "Celo British Pound",
+        "decimals": 18
+    },
+    {
+        "address": "0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313",
+        "symbol": "cGHS",
+        "name": "Celo Ghanaian Cedi",
+        "decimals": 18
+    },
+    {
+        "address": "0xc45eCF20f3CD864B32D9794d6f76814aE8892e20",
+        "symbol": "cJPY",
+        "name": "Celo Japanese Yen",
+        "decimals": 18
+    },
+    {
+        "address": "0x456a3D042C0DbD3db53D5489e98dFb038553B0d0",
+        "symbol": "cKES",
+        "name": "Celo Kenyan Shilling",
+        "decimals": 18
+    },
+    {
+        "address": "0xE2702Bd97ee33c88c8f6f92DA3B733608aa76F71",
+        "symbol": "cNGN",
+        "name": "Celo Nigerian Naira",
+        "decimals": 18
+    },
+    {
+        "address": "0xe8537a3d056DA446677B9E9d6c5dB704EaAb4787",
+        "symbol": "cREAL",
+        "name": "Celo Brazilian Real",
+        "decimals": 18
+    },
+    {
+        "address": "0x765DE816845861e75A25fCA122bb6898B8B1282a",
+        "symbol": "cUSD",
+        "name": "Celo Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0x4c35853A3B4e647fD266f4de678dCc8fEC410BF6",
+        "symbol": "cZAR",
+        "name": "Celo South African Rand",
+        "decimals": 18
+    },
+    {
+        "address": "0x73F93dcc49cB8A239e2032663e9475dd5ef29A08",
+        "symbol": "eXOF",
+        "name": "ECO CFA",
+        "decimals": 18
+    },
+    {
+        "address": "0x105d4A9306D2E55a71d2Eb95B81553AE1dC20d7B",
+        "symbol": "PUSO",
+        "name": "PUSO",
+        "decimals": 18
+    },
+    {
+        "address": "0x48065fbBE25f71C9282ddf5e1cD6D6A887483D5e",
+        "symbol": "USD₮",
+        "name": "Tether USD",
+        "decimals": 6
+    },
+    {
+        "address": "0xcebA9300f2b948710d2653dD7B07f33A8B32118C",
+        "symbol": "USDC",
+        "name": "USDC",
+        "decimals": 6
+    }
+];

package/dist/cjs/constants/tokens.44787.d.ts

@@ -0,0 +1,2 @@
+import { Token } from '../mento';
+export declare const tokens44787: readonly Token[];

package/dist/cjs/constants/tokens.44787.js

@@ -0,0 +1,127 @@
+"use strict";
+// This file is auto-generated. Do not edit manually.
+// Generated on 2025-10-02T13:54:36.998Z
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokens44787 = void 0;
+exports.tokens44787 = [
+    {
+        "address": "0x6e673502c5b55F3169657C004e5797fFE5be6653",
+        "symbol": "BridgedEUROC",
+        "name": "mockBridgedEUROC",
+        "decimals": 6
+    },
+    {
+        "address": "0x87D61dA3d668797786D73BC674F053f87111570d",
+        "symbol": "BridgedUSDC",
+        "name": "mockBridgedUSDC",
+        "decimals": 6
+    },
+    {
+        "address": "0x84CBD49F5aE07632B6B88094E81Cce8236125Fe0",
+        "symbol": "cAUD",
+        "name": "Celo Australian Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0x02EC9E0D2Fd73e89168C1709e542a48f58d7B133",
+        "symbol": "cCAD",
+        "name": "Celo Canadian Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0xADC57C2C34aD021Df4421230a6532F4e2E1dCE4F",
+        "symbol": "cCHF",
+        "name": "Celo Swiss Franc",
+        "decimals": 18
+    },
+    {
+        "address": "0xe6A57340f0df6E020c1c0a80bC6E13048601f0d4",
+        "symbol": "cCOP",
+        "name": "Celo Colombian Peso",
+        "decimals": 18
+    },
+    {
+        "address": "0xF194afDf50B03e69Bd7D057c1Aa9e10c9954E4C9",
+        "symbol": "CELO",
+        "name": "Celo native asset",
+        "decimals": 18
+    },
+    {
+        "address": "0x10c892A6EC43a53E45D0B916B4b7D383B1b78C0F",
+        "symbol": "cEUR",
+        "name": "Celo Euro",
+        "decimals": 18
+    },
+    {
+        "address": "0x47f2Fb88105155a18c390641C8a73f1402B2BB12",
+        "symbol": "cGBP",
+        "name": "Celo British Pound",
+        "decimals": 18
+    },
+    {
+        "address": "0x295B66bE7714458Af45E6A6Ea142A5358A6cA375",
+        "symbol": "cGHS",
+        "name": "cGHS",
+        "decimals": 18
+    },
+    {
+        "address": "0x2E51F41238cA36a421C9B8b3e189e8Cc7653FE67",
+        "symbol": "cJPY",
+        "name": "Celo Japanese Yen",
+        "decimals": 18
+    },
+    {
+        "address": "0x1E0433C1769271ECcF4CFF9FDdD515eefE6CdF92",
+        "symbol": "cKES",
+        "name": "Celo Kenyan Shilling",
+        "decimals": 18
+    },
+    {
+        "address": "0x4a5b03B8b16122D330306c65e4CA4BC5Dd6511d0",
+        "symbol": "cNGN",
+        "name": "Celo Nigerian Naira",
+        "decimals": 18
+    },
+    {
+        "address": "0xE4D517785D091D3c54818832dB6094bcc2744545",
+        "symbol": "cREAL",
+        "name": "Celo Brazilian Real",
+        "decimals": 18
+    },
+    {
+        "address": "0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1",
+        "symbol": "cUSD",
+        "name": "Celo Dollar",
+        "decimals": 18
+    },
+    {
+        "address": "0x1e5b44015Ff90610b54000DAad31C89b3284df4d",
+        "symbol": "cZAR",
+        "name": "Celo South African Rand",
+        "decimals": 18
+    },
+    {
+        "address": "0xB0FA15e002516d0301884059c0aaC0F0C72b019D",
+        "symbol": "eXOF",
+        "name": "ECO CFA",
+        "decimals": 18
+    },
+    {
+        "address": "0x5E0E3c9419C42a1B04e2525991FB1A2C467AB8bF",
+        "symbol": "PUSO",
+        "name": "PUSO",
+        "decimals": 18
+    },
+    {
+        "address": "0x2F25deB3848C207fc8E0c34035B3Ba7fC157602B",
+        "symbol": "USDC",
+        "name": "USDC",
+        "decimals": 6
+    },
+    {
+        "address": "0xBba91F588d031469ABCCA566FE80fB1Ad8Ee3287",
+        "symbol": "USDT",
+        "name": "mockNativeUSDT",
+        "decimals": 6
+    }
+];

package/dist/cjs/constants/tokens.d.ts

@@ -0,0 +1,67 @@
+import { Token } from '../mento';
+/**
+ * Gets cached tokens for a specific chain ID
+ * @param chainId - The chain ID to get cached tokens for
+ * @returns Promise resolving to the cached tokens or undefined if not available
+ */
+export declare function getCachedTokens(chainId: number): Promise<readonly Token[] | undefined>;
+/**
+ * Synchronously gets cached tokens for a specific chain ID
+ * Note: This function throws if no cached tokens are available.
+ * Use getCachedTokens() for async loading or when you want to handle missing cache gracefully.
+ *
+ * @param chainId - The chain ID to get cached tokens for
+ * @returns The cached tokens
+ * @throws Error if no cached tokens are available for the chain
+ */
+export declare function getCachedTokensSync(chainId: number): readonly Token[];
+/**
+ * Type-safe token symbols available across all chains
+ * Note: Not all tokens are available on all chains - check TOKEN_ADDRESSES_BY_CHAIN
+ */
+export declare enum TokenSymbol {
+    BridgedEUROC = "BridgedEUROC",
+    BridgedUSDC = "BridgedUSDC",
+    CELO = "CELO",
+    PUSO = "PUSO",
+    USDC = "USDC",
+    USDT = "USDT",
+    USD_ = "USD\u20AE",
+    axlEUROC = "axlEUROC",
+    axlUSDC = "axlUSDC",
+    cAUD = "cAUD",
+    cCAD = "cCAD",
+    cCHF = "cCHF",
+    cCOP = "cCOP",
+    cEUR = "cEUR",
+    cGBP = "cGBP",
+    cGHS = "cGHS",
+    cJPY = "cJPY",
+    cKES = "cKES",
+    cNGN = "cNGN",
+    cREAL = "cREAL",
+    cUSD = "cUSD",
+    cZAR = "cZAR",
+    eXOF = "eXOF"
+}
+/**
+ * Token addresses mapped by chain ID and symbol
+ * Use this for type-safe token address lookups
+ */
+export declare const TOKEN_ADDRESSES_BY_CHAIN: {
+    [chainId: number]: Partial<Record<TokenSymbol, string>>;
+};
+/**
+ * Helper function to get token address by symbol for a specific chain
+ * @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;
+/**
+ * Helper function to find a token by symbol in the cached tokens
+ * @param chainId - The chain ID
+ * @param symbol - The token symbol to search for
+ * @returns The token object or undefined if not found
+ */
+export declare function findTokenBySymbol(chainId: number, symbol: string): Token | undefined;