@mento-protocol/mento-sdk 1.10.3 → 1.12.0

package/dist/esm/constants/tradablePairs.42220.js

@@ -1,5 +1,5 @@
 // This file is auto-generated. Do not edit manually.
-// Generated on 2025-07-11T11:11:56.576Z
+// Generated on 2025-09-12T16:06:28.873Z
 export const tradablePairs42220 = [
     {
         "id": "USDC-cUSD",

package/dist/esm/constants/tradablePairs.44787.js

@@ -1,5 +1,5 @@
 // This file is auto-generated. Do not edit manually.
-// Generated on 2025-07-11T11:12:19.594Z
+// Generated on 2025-09-12T16:07:04.390Z
 export const tradablePairs44787 = [
     {
         "id": "USDC-cUSD",

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,4 +1,5 @@
 export declare enum ChainId {
     CELO = 42220,
+    CELO_SEPOLIA = 11142220,
     ALFAJORES = 44787
 }

package/dist/esm/enums/chainId.js

@@ -1,5 +1,6 @@
 export var ChainId;
 (function (ChainId) {
     ChainId[ChainId["CELO"] = 42220] = "CELO";
+    ChainId[ChainId["CELO_SEPOLIA"] = 11142220] = "CELO_SEPOLIA";
     ChainId[ChainId["ALFAJORES"] = 44787] = "ALFAJORES";
 })(ChainId || (ChainId = {}));

package/dist/esm/mento.d.ts

@@ -1,6 +1,7 @@
 import { IBroker } from '@mento-protocol/mento-core-ts';
 import { BigNumber, BigNumberish, providers, Signer } from 'ethers';
 import { Address, TradingLimit, TradingLimitsConfig, TradingLimitsState } from './interfaces';
+import { Identifier } from './constants/addresses';
 import { TradablePairWithSpread } from './constants/tradablePairs';
 export interface Exchange {
     providerAddr: Address;
@@ -11,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;
@@ -26,6 +33,7 @@ export declare class Mento {
     private readonly broker;
     private readonly router;
     private exchanges;
+    private cachedChainId;
     /**
      * This constructor is private, use the static create or createWithParams methods
      * to create a new Mento instance
@@ -89,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.
@@ -235,4 +253,6 @@ export declare class Mento {
      * @returns the trading limits state
      */
     getTradingLimitState(exchangeId: string): Promise<TradingLimitsState[]>;
+    getAddress(identifier: Identifier): Promise<Address>;
+    chainId(): Promise<number>;
 }

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 { getBrokerAddressFromRegistry, 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';
@@ -25,6 +25,7 @@ export class Mento {
      * @param exchanges exchange data for the broker
      */
     constructor(signerOrProvider, brokerAddress, routerAddress, exchanges) {
+        this.cachedChainId = null;
         this.signerOrProvider = signerOrProvider;
         this.broker = IBroker__factory.connect(brokerAddress, signerOrProvider);
         this.router = IMentoRouter__factory.connect(routerAddress, signerOrProvider);
@@ -39,7 +40,7 @@ export class Mento {
     static create(signerOrProvider) {
         return __awaiter(this, void 0, void 0, function* () {
             validateSignerOrProvider(signerOrProvider);
-            return new Mento(signerOrProvider, yield getBrokerAddressFromRegistry(signerOrProvider), yield getAddress('MentoRouter', yield getChainId(signerOrProvider)));
+            return new Mento(signerOrProvider, getAddress('Broker', yield getChainId(signerOrProvider)), getAddress('MentoRouter', yield getChainId(signerOrProvider)));
         });
     }
     /**
@@ -156,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.
@@ -552,4 +583,17 @@ export class Mento {
             return yield Promise.all(configuredLimitCfgs.map((cfg) => __awaiter(this, void 0, void 0, function* () { return yield getLimitsState(broker, exchangeId, cfg.asset); })));
         });
     }
+    getAddress(identifier) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return getAddress(identifier, yield this.chainId());
+        });
+    }
+    chainId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.cachedChainId == null) {
+                this.cachedChainId = yield getChainId(this.signerOrProvider);
+            }
+            return this.cachedChainId;
+        });
+    }
 }

package/dist/esm/types/contractAddressMap.d.ts

@@ -1,4 +1,4 @@
 import { ContractAddresses } from '.';
 export type ContractAddressMap = {
-    [chainId: number]: ContractAddresses;
+    [chainId: number]: Partial<ContractAddresses>;
 };

package/dist/esm/utils.d.ts

@@ -19,12 +19,6 @@ export declare function validateSigner(signer: Signer): void;
  * @throws if signerOrProvider is invalid or not connected
  */
 export declare function validateSignerOrProvider(signerOrProvider: Signer | providers.Provider): void;
-/**
- * Returns the broker address from the Celo registry
- * @param signerOrProvider an ethers provider or signer
- * @returns the broker address
- */
-export declare function getBrokerAddressFromRegistry(signerOrProvider: Signer | providers.Provider): Promise<Address>;
 /**
  * Returns the symbol of an erc20 token
  * @param tokenAddr the address of the erc20 token
@@ -32,6 +26,20 @@ export declare function getBrokerAddressFromRegistry(signerOrProvider: Signer |
  * @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
@@ -48,3 +56,4 @@ export declare function increaseAllowance(tokenAddr: string, spender: string, am
  * @returns the token address if found, null otherwise
  */
 export declare function findTokenBySymbol(pairs: readonly TradablePair[], symbol: string): string | null;
+export declare function capitalize(str: string): string;

package/dist/esm/utils.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { constants, Contract, providers, Signer } from 'ethers';
+import { Contract, providers, Signer } from 'ethers';
 /**
  * Gets the chain ID from a signer or provider
  * @param signerOrProvider an ethers provider or signer
@@ -50,36 +50,42 @@ export function validateSignerOrProvider(signerOrProvider) {
     }
 }
 /**
- * Returns the broker address from the Celo registry
+ * Returns the symbol of an erc20 token
+ * @param tokenAddr the address of the erc20 token
  * @param signerOrProvider an ethers provider or signer
- * @returns the broker address
+ * @returns the symbol of the erc20 token
  */
-export function getBrokerAddressFromRegistry(signerOrProvider) {
+export function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
     return __awaiter(this, void 0, void 0, function* () {
-        const celoRegistryAddress = '0x000000000000000000000000000000000000ce10';
-        const brokerIdentifier = 'Broker';
-        const registryAbi = [
-            'function getAddressForString(string calldata identifier) external view returns (address)',
-        ];
-        const contract = new Contract(celoRegistryAddress, registryAbi, signerOrProvider);
-        const brokerAddress = yield contract.getAddressForString(brokerIdentifier);
-        if (brokerAddress === constants.AddressZero) {
-            throw Error('Broker address not found in the registry');
-        }
-        return brokerAddress;
+        const erc20Abi = ['function symbol() external view returns (string memory)'];
+        const contract = new Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.symbol();
     });
 }
 /**
- * Returns the symbol of an erc20 token
+ * Returns the name of an erc20 token
  * @param tokenAddr the address of the erc20 token
  * @param signerOrProvider an ethers provider or signer
- * @returns the symbol of the erc20 token
+ * @returns the name of the erc20 token
  */
-export function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
+export function getNameFromTokenAddress(tokenAddr, signerOrProvider) {
     return __awaiter(this, void 0, void 0, function* () {
-        const erc20Abi = ['function symbol() external view returns (string memory)'];
+        const erc20Abi = ['function name() external view returns (string memory)'];
         const contract = new Contract(tokenAddr, erc20Abi, signerOrProvider);
-        return contract.symbol();
+        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();
     });
 }
 /**
@@ -117,3 +123,6 @@ export function findTokenBySymbol(pairs, symbol) {
     }
     return null;
 }
+export function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.10.3",
+  "version": "1.12.0",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
@@ -22,12 +22,12 @@
   ],
   "scripts": {
     "analyze": "size-limit --why",
-    "build": "yarn build:cjs && yarn build:esm",
+    "build": "yarn build:cjs && yarn build:esm && yarn check:scripts",
     "build:cjs": "tsc --project ./tsconfig.json",
     "build:esm": "tsc --project ./tsconfig.esm.json",
     "clean": "rm -rf ./dist",
-    "lint": "eslint --config ./.eslintrc.json 'src/**/*.ts' 'scripts/**/*.ts'",
-    "type-check": "tsc --noEmit --project ./tsconfig.eslint.json",
+    "lint": "eslint --fix --config ./.eslintrc.json 'src/**/*.ts' 'scripts/**/*.ts'",
+    "check:scripts": "tsc --project ./tsconfig.scripts.json",
     "prettier": "prettier --config ./.prettierrc.json --write **/*.{json,md,js,ts,yml}",
     "size": "size-limit",
     "test": "jest --runInBand --verbose",
@@ -35,10 +35,14 @@
     "cacheTradablePairs": "ts-node scripts/cacheTradablePairs.ts",
     "printTradablePairs": "ts-node scripts/printTradablePairs.ts",
     "tradingLimits": "ts-node scripts/printTradingLimits.ts",
+    "limits": "yarn tradingLimits",
     "poolConfigs": "ts-node scripts/printPoolConfigs.ts",
+    "pools": "ts-node scripts/printPoolConfigs.ts",
     "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": {
@@ -54,6 +58,7 @@
   "engines": {
     "node": ">=22"
   },
+  "packageManager": "yarn@3",
   "size-limit": [
     {
       "path": "dist/sdk.cjs.production.min.js",
@@ -91,11 +96,10 @@
     "yargs-parser": "^21.1.1"
   },
   "dependencies": {
-    "@mento-protocol/mento-core-ts": "^0.2.0",
+    "@mento-protocol/mento-core-ts": "2.6.5-rc3",
     "mento-router-ts": "^0.2.0"
   },
   "peerDependencies": {
     "ethers": "^5.7"
-  },
-  "packageManager": "yarn@3.3.1"
+  }
 }