@mento-protocol/mento-sdk 1.10.3 → 1.12.0

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

@@ -1,6 +1,6 @@
 "use strict";
 // 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
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tradablePairs42220 = void 0;
 exports.tradablePairs42220 = [

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

@@ -1,6 +1,6 @@
 "use strict";
 // 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
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tradablePairs44787 = void 0;
 exports.tradablePairs44787 = [

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

package/dist/cjs/enums/chainId.js

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

package/dist/cjs/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/cjs/mento.js

@@ -28,6 +28,7 @@ class Mento {
      * @param exchanges exchange data for the broker
      */
     constructor(signerOrProvider, brokerAddress, routerAddress, exchanges) {
+        this.cachedChainId = null;
         this.signerOrProvider = signerOrProvider;
         this.broker = mento_core_ts_1.IBroker__factory.connect(brokerAddress, signerOrProvider);
         this.router = mento_router_ts_1.IMentoRouter__factory.connect(routerAddress, signerOrProvider);
@@ -42,7 +43,7 @@ class Mento {
     static create(signerOrProvider) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, utils_1.validateSignerOrProvider)(signerOrProvider);
-            return new Mento(signerOrProvider, yield (0, utils_1.getBrokerAddressFromRegistry)(signerOrProvider), yield (0, addresses_1.getAddress)('MentoRouter', yield (0, utils_1.getChainId)(signerOrProvider)));
+            return new Mento(signerOrProvider, (0, addresses_1.getAddress)('Broker', yield (0, utils_1.getChainId)(signerOrProvider)), (0, addresses_1.getAddress)('MentoRouter', yield (0, utils_1.getChainId)(signerOrProvider)));
         });
     }
     /**
@@ -159,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.
@@ -555,5 +586,18 @@ class Mento {
             return yield Promise.all(configuredLimitCfgs.map((cfg) => __awaiter(this, void 0, void 0, function* () { return yield (0, limits_1.getLimitsState)(broker, exchangeId, cfg.asset); })));
         });
     }
+    getAddress(identifier) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, addresses_1.getAddress)(identifier, yield this.chainId());
+        });
+    }
+    chainId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.cachedChainId == null) {
+                this.cachedChainId = yield (0, utils_1.getChainId)(this.signerOrProvider);
+            }
+            return this.cachedChainId;
+        });
+    }
 }
 exports.Mento = Mento;

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

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

package/dist/cjs/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/cjs/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findTokenBySymbol = exports.increaseAllowance = exports.getSymbolFromTokenAddress = exports.getBrokerAddressFromRegistry = 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
@@ -55,27 +55,6 @@ function validateSignerOrProvider(signerOrProvider) {
     }
 }
 exports.validateSignerOrProvider = validateSignerOrProvider;
-/**
- * Returns the broker address from the Celo registry
- * @param signerOrProvider an ethers provider or signer
- * @returns the broker address
- */
-function getBrokerAddressFromRegistry(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 ethers_1.Contract(celoRegistryAddress, registryAbi, signerOrProvider);
-        const brokerAddress = yield contract.getAddressForString(brokerIdentifier);
-        if (brokerAddress === ethers_1.constants.AddressZero) {
-            throw Error('Broker address not found in the registry');
-        }
-        return brokerAddress;
-    });
-}
-exports.getBrokerAddressFromRegistry = getBrokerAddressFromRegistry;
 /**
  * Returns the symbol of an erc20 token
  * @param tokenAddr the address of the erc20 token
@@ -90,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
@@ -127,3 +134,7 @@ function findTokenBySymbol(pairs, symbol) {
     return null;
 }
 exports.findTokenBySymbol = findTokenBySymbol;
+function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+exports.capitalize = capitalize;

package/dist/esm/constants/addresses.js

@@ -1,51 +1,67 @@
 import { ChainId } from './../enums';
 export const addresses = {
     [ChainId.CELO]: {
-        GovernanceFactory: '0xee6CE2dbe788dFC38b8F583Da86cB9caf2C8cF5A',
+        // Oracles & Breakers
+        BreakerBox: '0x303ED1df62Fa067659B586EbEe8De0EcE824Ab39',
+        MedianDeltaBreaker: '0x49349F92D2B17d491e42C8fdB02D19f072F9B5D9',
+        SortedOracles: '0xefB84935239dAcdecF7c5bA76d8dE40b077B7b33',
+        ValueDeltaBreaker: '0x4DBC33B3abA78475A5AA4BC7A5B11445d387BF68',
+        // DEX
+        BiPoolManager: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
+        Broker: '0x777A8255cA72412f0d706dc03C9D1987306B4CaD',
+        ConstantProductPricingModule: '0x0c07126d0CB30E66eF7553Cc7C37143B4f06DddB',
+        ConstantSumPricingModule: '0xDebED1F6f6ce9F6e73AA25F95acBFFE2397550Fb',
+        MentoRouter: '0xbe729350f8cdfc19db6866e8579841188ee57f67',
+        Reserve: '0x9380fA34Fd9e4Fd14c06305fd7B6199089eD4eb9',
+        // Governance
         Airgrab: '0x7D8E73deafDBAfc98fDBe7974168cFA6d8B9AE0C',
         Emission: '0x5C789592E2611df1873b46D394c69f75faB99778',
+        Locking: '0x001Bb66636dCd149A1A2bA8C50E408BdDd80279C',
         MentoGovernor: '0x47036d78bB3169b4F5560dD77BF93f4412A59852',
         MentoToken: '0x7FF62f59e3e89EA34163EA1458EEBCc81177Cfb6',
         TimelockController: '0x890DB8A597940165901372Dd7DB61C9f246e2147',
-        Locking: '0x001Bb66636dCd149A1A2bA8C50E408BdDd80279C',
-        MentoRouter: '0xbe729350f8cdfc19db6866e8579841188ee57f67',
-        Broker: '0x777A8255cA72412f0d706dc03C9D1987306B4CaD',
-        BiPoolManager: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-        BreakerBox: '0x303ED1df62Fa067659B586EbEe8De0EcE824Ab39',
-        Reserve: '0x9380fA34Fd9e4Fd14c06305fd7B6199089eD4eb9',
-        ConstantSumPricingModule: '0xDebED1F6f6ce9F6e73AA25F95acBFFE2397550Fb',
-        ConstantProductPricingModule: '0x0c07126d0CB30E66eF7553Cc7C37143B4f06DddB',
-        MedianDeltaBreaker: '0x49349F92D2B17d491e42C8fdB02D19f072F9B5D9',
-        ValueDeltaBreaker: '0x4DBC33B3abA78475A5AA4BC7A5B11445d387BF68',
-        StableToken: '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-        StableTokenEUR: '0xD8763CBa276a3738E6DE85b4b3bF5FDed6D6cA73',
-        StableTokenBRL: '0xe8537a3d056DA446677B9E9d6c5dB704EaAb4787',
-        StableTokenXOF: '0x73F93dcc49cB8A239e2032663e9475dd5ef29A08',
-        SortedOracles: '0xefB84935239dAcdecF7c5bA76d8dE40b077B7b33',
     },
     [ChainId.ALFAJORES]: {
-        GovernanceFactory: '0x96Fe03DBFEc1EB419885a01d2335bE7c1a45e33b',
+        // Oracles & Breakers
+        BreakerBox: '0xC76BDf0AFb654888728003683cf748A8B1b4f5fD',
+        MedianDeltaBreaker: '0x6B0a2076713fDAef4F9301fe8404a228e3682DE4',
+        SortedOracles: '0xFdd8bD58115FfBf04e47411c1d228eCC45E93075',
+        ValueDeltaBreaker: '0xfa6fFf746a5E74055e432f3bba26138956AEfbFe',
+        // DEX
+        BiPoolManager: '0x9B64E8EaBD1a035b148cE970d3319c5C3Ad53EC3',
+        Broker: '0xD3Dff18E465bCa6241A244144765b4421Ac14D09',
+        ConstantProductPricingModule: '0x99EDce8143FF8AeFA1fBB6C2103B349Add2B9519',
+        ConstantSumPricingModule: '0x474DBf1eDF845410bdaC6aeE97C3CC403651ba2E',
+        MentoRouter: '0xe6101a457a69b53e298e35a7f6e3dcb0390df02a',
+        Reserve: '0xa7ed835288Aa4524bB6C73DD23c0bF4315D9Fe3e',
+        // Governance
         Airgrab: '0x8dC9282F0a74A2a36F41440e009AA0EADFe490c5',
         Emission: '0xe62cc88ca2A5E7Dd3Fe5ce8511C874e610Ddb0b6',
+        Locking: '0x537CaE97C588C6DA64A385817F3D3563DDCf0591',
         MentoGovernor: '0x558e92236f85Bb4e8A63ec0D5Bf9d34087Eab744',
         MentoToken: '0x3eDd2f7c90e2E931c817a44302Af7112E84be6Cc',
         TimelockController: '0xa0Ad8DD40104556122c21dF50eD14bb1B53A3338',
-        Locking: '0x537CaE97C588C6DA64A385817F3D3563DDCf0591',
-        MentoRouter: '0xe6101a457a69b53e298e35a7f6e3dcb0390df02a',
-        Broker: '0xD3Dff18E465bCa6241A244144765b4421Ac14D09',
-        BiPoolManager: '0x9B64E8EaBD1a035b148cE970d3319c5C3Ad53EC3',
-        BreakerBox: '0xC76BDf0AFb654888728003683cf748A8B1b4f5fD',
-        Reserve: '0xa7ed835288Aa4524bB6C73DD23c0bF4315D9Fe3e',
-        ConstantSumPricingModule: '0x474DBf1eDF845410bdaC6aeE97C3CC403651ba2E',
-        ConstantProductPricingModule: '0x99EDce8143FF8AeFA1fBB6C2103B349Add2B9519',
-        MedianDeltaBreaker: '0x6B0a2076713fDAef4F9301fe8404a228e3682DE4',
-        ValueDeltaBreaker: '0xfa6fFf746a5E74055e432f3bba26138956AEfbFe',
-        StableToken: '0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1',
-        StableTokenEUR: '0x10c892A6EC43a53E45D0B916B4b7D383B1b78C0F',
-        StableTokenBRL: '0xE4D517785D091D3c54818832dB6094bcc2744545',
-        StableTokenXOF: '0xB0FA15e002516d0301884059c0aaC0F0C72b019D',
-        SortedOracles: '0xFdd8bD58115FfBf04e47411c1d228eCC45E93075',
     },
+    [ChainId.CELO_SEPOLIA]: {
+        // Oracles & Breakers
+        BreakerBox: '0x578bD46003B9D3fd4c3C3f47c98B329562a6a1dE',
+        MedianDeltaBreaker: '0xd29B4e743F7B84D63fBF9149B6D983DF2eF5C952',
+        SortedOracles: '0xfaa7Ca2B056E60F6733aE75AA0709140a6eAfD20',
+        ValueDeltaBreaker: '0x03CDf2966185Eb0b980f2481Ad386B8aFdAB4534',
+        // DEX
+        BiPoolManager: '0xeCB3C656C131fCd9bB8D1d80898716bD684feb78',
+        Broker: '0xB9Ae2065142EB79b6c5EB1E8778F883fad6B07Ba',
+        ConstantProductPricingModule: '0x2584a5835e3aE7E901e6462E1de06920c2C68028',
+        ConstantSumPricingModule: '0x3b199d9EbEbe509bb711BfFb455c2d79102A9602',
+        MentoRouter: '0x8e4Fb12D86D5DF911086a9153e79CA27e0c96156',
+        Reserve: '0x2bC2D48735842924C508468C5A02580aD4F6d99A',
+        // Governance
+        Emission: '0x3C1BEA0F35b5dcAc1065CA9b3b6877657dEa4A69',
+        Locking: '0xB72320fC501cb30E55bAF0DA48c20b11fAc9f79D',
+        MentoGovernor: '0x23173Ac37b8E4e5a60d787aC543B3F51e8f398b4',
+        MentoToken: '0x07867fd40EB56b4380bE39c88D0a7EA59Aa99A20',
+        TimelockController: '0x74c44Be99937815173A3C56274331e0A05611e0D',
+    }
 };
 export function getAddress(identifier, chainId) {
     const addressesForChain = addresses[chainId];

package/dist/esm/constants/currencies.d.ts

@@ -0,0 +1,5 @@
+/**
+ * List of supported currencies for rate feed generation and validation
+ */
+export declare const CURRENCIES: readonly ["AUD", "USD", "PHP", "ZAR", "CAD", "EUR", "BRL", "XOF", "COP", "GHS", "CHF", "NGN", "JPY", "GBP", "KES", "CELO", "ETH", "EURC", "EUROC", "USDC", "USDT"];
+export type Currency = typeof CURRENCIES[number];

package/dist/esm/constants/currencies.js

@@ -0,0 +1,26 @@
+/**
+ * List of supported currencies for rate feed generation and validation
+ */
+export const CURRENCIES = [
+    "AUD",
+    "USD",
+    "PHP",
+    "ZAR",
+    "CAD",
+    "EUR",
+    "BRL",
+    "XOF",
+    "COP",
+    "GHS",
+    "CHF",
+    "NGN",
+    "JPY",
+    "GBP",
+    "KES",
+    "CELO",
+    "ETH",
+    "EURC",
+    "EUROC",
+    "USDC",
+    "USDT"
+];

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

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

package/dist/esm/constants/index.js

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

package/dist/esm/constants/tradablePairs.11142220.d.ts

@@ -0,0 +1,2 @@
+import { TradablePairWithSpread } from './tradablePairs';
+export declare const tradablePairs11142220: TradablePairWithSpread[];