@mento-protocol/mento-sdk 1.11.0 → 1.12.0

package/README.md

@@ -26,7 +26,6 @@ The `yarn cacheTradablePairs` script generates a TypeScript file containing a li
 yarn cacheTradablePairs
 ```
 
-
 ## Token Graph Visualization
 
 Current token connectivity on Celo Mainnet (last updated: 2025-09-19):
@@ -59,7 +58,5 @@ graph TD
 **Network Stats:** 20 tokens, 19 direct trading pairs
 
 > 💡 This graph shows direct trading pairs only. The SDK automatically finds optimal routes including multi-hop paths.
-> 
+>
 > To regenerate: `yarn getTokenGraph`
-
-

package/dist/cjs/constants/tradablePairs.js

@@ -45,6 +45,8 @@ function getCachedTradablePairs(chainId) {
                 return yield Promise.resolve().then(() => __importStar(require('./tradablePairs.42220'))).then((module) => module.tradablePairs42220);
             case 44787:
                 return yield Promise.resolve().then(() => __importStar(require('./tradablePairs.44787'))).then((module) => module.tradablePairs44787);
+            case 11142220:
+                return yield Promise.resolve().then(() => __importStar(require('./tradablePairs.11142220'))).then((module) => module.tradablePairs11142220);
             default:
                 return undefined;
         }

package/dist/cjs/enums/chainId.d.ts

@@ -1,6 +1,5 @@
 export declare enum ChainId {
     CELO = 42220,
     CELO_SEPOLIA = 11142220,
-    ALFAJORES = 44787,
-    BASE = 8453
+    ALFAJORES = 44787
 }

package/dist/cjs/enums/chainId.js

@@ -6,5 +6,4 @@ var ChainId;
     ChainId[ChainId["CELO"] = 42220] = "CELO";
     ChainId[ChainId["CELO_SEPOLIA"] = 11142220] = "CELO_SEPOLIA";
     ChainId[ChainId["ALFAJORES"] = 44787] = "ALFAJORES";
-    ChainId[ChainId["BASE"] = 8453] = "BASE";
 })(ChainId = exports.ChainId || (exports.ChainId = {}));

package/dist/cjs/mento.d.ts

@@ -12,6 +12,12 @@ export interface Asset {
     address: Address;
     symbol: string;
 }
+export interface Token {
+    address: Address;
+    symbol: string;
+    name: string;
+    decimals: number;
+}
 export type TradablePairID = `${Address}-${Address}`;
 export interface TradablePair {
     id: TradablePairID;
@@ -91,6 +97,16 @@ export declare class Mento {
      * Attempts to get cached tradable pairs for the current chain
      */
     private getCachedTradablePairs;
+    /**
+     * Returns a list of all unique tokens available on the current chain.
+     * Each token includes its address, symbol, name, and decimals.
+     * @param options - Optional parameters
+     * @param options.cached - Whether to use cached data (default: true)
+     * @returns An array of unique Token objects.
+     */
+    getTokens({ cached, }?: {
+        cached?: boolean;
+    }): Promise<Token[]>;
     /**
      * Returns the amount of tokenIn to be sold to buy amountOut of tokenOut.
      * If the provided tradablePair has a single (direct) pricing path, then direct pricing is used.

package/dist/cjs/mento.js

@@ -160,6 +160,36 @@ class Mento {
             return yield (0, tradablePairs_1.getCachedTradablePairs)(chainId);
         });
     }
+    /**
+     * Returns a list of all unique tokens available on the current chain.
+     * Each token includes its address, symbol, name, and decimals.
+     * @param options - Optional parameters
+     * @param options.cached - Whether to use cached data (default: true)
+     * @returns An array of unique Token objects.
+     */
+    getTokens({ cached = true, } = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tradablePairs = yield this.getTradablePairsWithPath({ cached });
+            // Collect unique token addresses
+            const uniqueAddresses = new Set(tradablePairs.flatMap(pair => pair.assets.map(asset => asset.address)));
+            // Fetch token metadata for each unique address
+            const tokens = yield Promise.all(Array.from(uniqueAddresses).map((address) => __awaiter(this, void 0, void 0, function* () {
+                const [symbol, name, decimals] = yield Promise.all([
+                    (0, utils_1.getSymbolFromTokenAddress)(address, this.signerOrProvider),
+                    (0, utils_1.getNameFromTokenAddress)(address, this.signerOrProvider),
+                    (0, utils_1.getDecimalsFromTokenAddress)(address, this.signerOrProvider),
+                ]);
+                return {
+                    address,
+                    symbol,
+                    name,
+                    decimals,
+                };
+            })));
+            // Sort by symbol
+            return tokens.sort((a, b) => a.symbol.localeCompare(b.symbol));
+        });
+    }
     /**
      * Returns the amount of tokenIn to be sold to buy amountOut of tokenOut.
      * If the provided tradablePair has a single (direct) pricing path, then direct pricing is used.

package/dist/cjs/utils.d.ts

@@ -26,6 +26,20 @@ export declare function validateSignerOrProvider(signerOrProvider: Signer | prov
  * @returns the symbol of the erc20 token
  */
 export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
+/**
+ * Returns the name of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the name of the erc20 token
+ */
+export declare function getNameFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
+/**
+ * Returns the decimals of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the decimals of the erc20 token
+ */
+export declare function getDecimalsFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<number>;
 /**
  * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
  * @param tokenAddr the address of the erc20 token

package/dist/cjs/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalize = exports.findTokenBySymbol = exports.increaseAllowance = exports.getSymbolFromTokenAddress = exports.validateSignerOrProvider = exports.validateSigner = exports.getChainId = void 0;
+exports.capitalize = exports.findTokenBySymbol = exports.increaseAllowance = exports.getDecimalsFromTokenAddress = exports.getNameFromTokenAddress = exports.getSymbolFromTokenAddress = exports.validateSignerOrProvider = exports.validateSigner = exports.getChainId = void 0;
 const ethers_1 = require("ethers");
 /**
  * Gets the chain ID from a signer or provider
@@ -69,6 +69,34 @@ function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
     });
 }
 exports.getSymbolFromTokenAddress = getSymbolFromTokenAddress;
+/**
+ * Returns the name of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the name of the erc20 token
+ */
+function getNameFromTokenAddress(tokenAddr, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const erc20Abi = ['function name() external view returns (string memory)'];
+        const contract = new ethers_1.Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.name();
+    });
+}
+exports.getNameFromTokenAddress = getNameFromTokenAddress;
+/**
+ * Returns the decimals of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the decimals of the erc20 token
+ */
+function getDecimalsFromTokenAddress(tokenAddr, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const erc20Abi = ['function decimals() external view returns (uint8)'];
+        const contract = new ethers_1.Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.decimals();
+    });
+}
+exports.getDecimalsFromTokenAddress = getDecimalsFromTokenAddress;
 /**
  * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
  * @param tokenAddr the address of the erc20 token

package/dist/esm/constants/tradablePairs.js

@@ -19,6 +19,8 @@ export function getCachedTradablePairs(chainId) {
                 return yield import('./tradablePairs.42220').then((module) => module.tradablePairs42220);
             case 44787:
                 return yield import('./tradablePairs.44787').then((module) => module.tradablePairs44787);
+            case 11142220:
+                return yield import('./tradablePairs.11142220').then((module) => module.tradablePairs11142220);
             default:
                 return undefined;
         }

package/dist/esm/enums/chainId.d.ts

@@ -1,6 +1,5 @@
 export declare enum ChainId {
     CELO = 42220,
     CELO_SEPOLIA = 11142220,
-    ALFAJORES = 44787,
-    BASE = 8453
+    ALFAJORES = 44787
 }

package/dist/esm/enums/chainId.js

@@ -3,5 +3,4 @@ export var ChainId;
     ChainId[ChainId["CELO"] = 42220] = "CELO";
     ChainId[ChainId["CELO_SEPOLIA"] = 11142220] = "CELO_SEPOLIA";
     ChainId[ChainId["ALFAJORES"] = 44787] = "ALFAJORES";
-    ChainId[ChainId["BASE"] = 8453] = "BASE";
 })(ChainId || (ChainId = {}));

package/dist/esm/mento.d.ts

@@ -12,6 +12,12 @@ export interface Asset {
     address: Address;
     symbol: string;
 }
+export interface Token {
+    address: Address;
+    symbol: string;
+    name: string;
+    decimals: number;
+}
 export type TradablePairID = `${Address}-${Address}`;
 export interface TradablePair {
     id: TradablePairID;
@@ -91,6 +97,16 @@ export declare class Mento {
      * Attempts to get cached tradable pairs for the current chain
      */
     private getCachedTradablePairs;
+    /**
+     * Returns a list of all unique tokens available on the current chain.
+     * Each token includes its address, symbol, name, and decimals.
+     * @param options - Optional parameters
+     * @param options.cached - Whether to use cached data (default: true)
+     * @returns An array of unique Token objects.
+     */
+    getTokens({ cached, }?: {
+        cached?: boolean;
+    }): Promise<Token[]>;
     /**
      * Returns the amount of tokenIn to be sold to buy amountOut of tokenOut.
      * If the provided tradablePair has a single (direct) pricing path, then direct pricing is used.

package/dist/esm/mento.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BiPoolManager__factory, Broker__factory, IBreakerBox__factory, IBroker__factory, IExchangeProvider__factory, } from '@mento-protocol/mento-core-ts';
 import { Signer } from 'ethers';
 import { getLimits, getLimitsConfig, getLimitsState } from './limits';
-import { getChainId, getSymbolFromTokenAddress, increaseAllowance, validateSigner, validateSignerOrProvider, } from './utils';
+import { getChainId, getDecimalsFromTokenAddress, getNameFromTokenAddress, getSymbolFromTokenAddress, increaseAllowance, validateSigner, validateSignerOrProvider, } from './utils';
 import { strict as assert } from 'assert';
 import { IMentoRouter__factory } from 'mento-router-ts';
 import { getAddress } from './constants/addresses';
@@ -157,6 +157,36 @@ export class Mento {
             return yield getCachedTradablePairs(chainId);
         });
     }
+    /**
+     * Returns a list of all unique tokens available on the current chain.
+     * Each token includes its address, symbol, name, and decimals.
+     * @param options - Optional parameters
+     * @param options.cached - Whether to use cached data (default: true)
+     * @returns An array of unique Token objects.
+     */
+    getTokens({ cached = true, } = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tradablePairs = yield this.getTradablePairsWithPath({ cached });
+            // Collect unique token addresses
+            const uniqueAddresses = new Set(tradablePairs.flatMap(pair => pair.assets.map(asset => asset.address)));
+            // Fetch token metadata for each unique address
+            const tokens = yield Promise.all(Array.from(uniqueAddresses).map((address) => __awaiter(this, void 0, void 0, function* () {
+                const [symbol, name, decimals] = yield Promise.all([
+                    getSymbolFromTokenAddress(address, this.signerOrProvider),
+                    getNameFromTokenAddress(address, this.signerOrProvider),
+                    getDecimalsFromTokenAddress(address, this.signerOrProvider),
+                ]);
+                return {
+                    address,
+                    symbol,
+                    name,
+                    decimals,
+                };
+            })));
+            // Sort by symbol
+            return tokens.sort((a, b) => a.symbol.localeCompare(b.symbol));
+        });
+    }
     /**
      * Returns the amount of tokenIn to be sold to buy amountOut of tokenOut.
      * If the provided tradablePair has a single (direct) pricing path, then direct pricing is used.

package/dist/esm/utils.d.ts

@@ -26,6 +26,20 @@ export declare function validateSignerOrProvider(signerOrProvider: Signer | prov
  * @returns the symbol of the erc20 token
  */
 export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
+/**
+ * Returns the name of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the name of the erc20 token
+ */
+export declare function getNameFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
+/**
+ * Returns the decimals of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the decimals of the erc20 token
+ */
+export declare function getDecimalsFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<number>;
 /**
  * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
  * @param tokenAddr the address of the erc20 token

package/dist/esm/utils.js

@@ -62,6 +62,32 @@ export function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
         return contract.symbol();
     });
 }
+/**
+ * Returns the name of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the name of the erc20 token
+ */
+export function getNameFromTokenAddress(tokenAddr, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const erc20Abi = ['function name() external view returns (string memory)'];
+        const contract = new Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.name();
+    });
+}
+/**
+ * Returns the decimals of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the decimals of the erc20 token
+ */
+export function getDecimalsFromTokenAddress(tokenAddr, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const erc20Abi = ['function decimals() external view returns (uint8)'];
+        const contract = new Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.decimals();
+    });
+}
 /**
  * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
  * @param tokenAddr the address of the erc20 token

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
@@ -41,7 +41,8 @@
     "breakerBox": "ts-node scripts/printBreakerBox.ts",
     "breakers": "yarn breakerBox",
     "quote": "ts-node scripts/quotes/index.ts",
-    "getTokenGraph": "ts-node scripts/visualizeTokenGraph.ts"
+    "getTokenGraph": "ts-node scripts/visualizeTokenGraph.ts",
+    "tokens": "ts-node scripts/printTokens.ts"
   },
   "husky": {
     "hooks": {