@mento-protocol/mento-sdk 1.15.5 → 1.16.1-beta.0

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

@@ -1,2 +1,3 @@
-export * from './proposalState';
 export * from './chainId';
+export * from './proposalState';
+export * from './tradingMode';

package/dist/cjs/enums/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./proposalState"), exports);
 __exportStar(require("./chainId"), exports);
+__exportStar(require("./proposalState"), exports);
+__exportStar(require("./tradingMode"), exports);

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

@@ -0,0 +1,17 @@
+/**
+ * Trading modes for rate feeds in the BreakerBox
+ */
+export declare enum TradingMode {
+    /**
+     * Bidirectional trading is enabled
+     */
+    BIDIRECTIONAL = 0,
+    /**
+     * Trading is temporarily halted (circuit breaker tripped)
+     */
+    HALTED = 1,
+    /**
+     * Trading is permanently disabled
+     */
+    DISABLED = 2
+}

package/dist/cjs/enums/tradingMode.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradingMode = void 0;
+/**
+ * Trading modes for rate feeds in the BreakerBox
+ */
+var TradingMode;
+(function (TradingMode) {
+    /**
+     * Bidirectional trading is enabled
+     */
+    TradingMode[TradingMode["BIDIRECTIONAL"] = 0] = "BIDIRECTIONAL";
+    /**
+     * Trading is temporarily halted (circuit breaker tripped)
+     */
+    TradingMode[TradingMode["HALTED"] = 1] = "HALTED";
+    /**
+     * Trading is permanently disabled
+     */
+    TradingMode[TradingMode["DISABLED"] = 2] = "DISABLED";
+})(TradingMode = exports.TradingMode || (exports.TradingMode = {}));

package/dist/cjs/index.d.ts

@@ -1,4 +1,5 @@
 export * from './constants';
+export * from './enums';
 export * from './governance';
 export * from './mento';
 export * from './routeUtils';

package/dist/cjs/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants"), exports);
+__exportStar(require("./enums"), exports);
 __exportStar(require("./governance"), exports);
 __exportStar(require("./mento"), exports);
 __exportStar(require("./routeUtils"), exports);

package/dist/cjs/mento.d.ts

@@ -4,6 +4,7 @@ import { Address, TradingLimit, TradingLimitsConfig, TradingLimitsState } from '
 import { Identifier } from './constants/addresses';
 import { TokenSymbol } from './constants/tokens';
 import { TradablePairWithSpread } from './constants/tradablePairs';
+import { TradingMode } from './enums';
 export { TokenSymbol } from './constants/tokens';
 export interface Exchange {
     providerAddr: Address;
@@ -245,6 +246,20 @@ export declare class Mento {
      * @returns true if trading is enabled in the given mode, false otherwise
      */
     isTradingEnabled(exchangeId: string): Promise<boolean>;
+    /**
+     * Returns the current trading mode for a given rate feed
+     * @param rateFeedId the address of the rate feed
+     * @returns the current trading mode (BIDIRECTIONAL, HALTED, or DISABLED)
+     */
+    getRateFeedTradingMode(rateFeedId: Address): Promise<TradingMode>;
+    /**
+     * Checks if a trading pair is currently tradable (i.e., all rate feeds in the path are in BIDIRECTIONAL mode)
+     * For multi-hop routes (e.g., CELO → cUSD → USDT), checks that all intermediate rate feeds are tradable
+     * @param tokenIn the address of the token to sell
+     * @param tokenOut the address of the token to buy
+     * @returns true if the pair is tradable (all rate feeds in BIDIRECTIONAL mode), false otherwise
+     */
+    isPairTradable(tokenIn: Address, tokenOut: Address): Promise<boolean>;
     /**
      * Return the trading limits for a given exchange id. Each limit is an object with the following fields:
      * asset: the address of the asset with the limit

package/dist/cjs/mento.js

@@ -41,6 +41,7 @@ const assert_1 = require("assert");
 const mento_router_ts_1 = require("mento-router-ts");
 const addresses_1 = require("./constants/addresses");
 const tradablePairs_1 = require("./constants/tradablePairs");
+const enums_1 = require("./enums");
 const routeUtils_1 = require("./routeUtils");
 // Re-export TokenSymbol for use in auto-generated files and consuming packages
 var tokens_1 = require("./constants/tokens");
@@ -594,6 +595,43 @@ class Mento {
             return currentMode == BI_DIRECTIONAL_TRADING_MODE;
         });
     }
+    /**
+     * Returns the current trading mode for a given rate feed
+     * @param rateFeedId the address of the rate feed
+     * @returns the current trading mode (BIDIRECTIONAL, HALTED, or DISABLED)
+     */
+    getRateFeedTradingMode(rateFeedId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const breakerBoxAddr = yield this.getAddress('BreakerBox');
+            const breakerBox = mento_core_ts_1.IBreakerBox__factory.connect(breakerBoxAddr, this.signerOrProvider);
+            const currentMode = yield breakerBox.getRateFeedTradingMode(rateFeedId);
+            return currentMode;
+        });
+    }
+    /**
+     * Checks if a trading pair is currently tradable (i.e., all rate feeds in the path are in BIDIRECTIONAL mode)
+     * For multi-hop routes (e.g., CELO → cUSD → USDT), checks that all intermediate rate feeds are tradable
+     * @param tokenIn the address of the token to sell
+     * @param tokenOut the address of the token to buy
+     * @returns true if the pair is tradable (all rate feeds in BIDIRECTIONAL mode), false otherwise
+     */
+    isPairTradable(tokenIn, tokenOut) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Find the tradable pair (which includes the routing path)
+            const pair = yield this.findPairForTokens(tokenIn, tokenOut);
+            // For each hop in the path, check if the rate feed is tradable
+            const biPoolManager = mento_core_ts_1.BiPoolManager__factory.connect(pair.path[0].providerAddr, this.signerOrProvider);
+            // Get all rate feed IDs for each hop in the path
+            const rateFeedChecks = yield Promise.all(pair.path.map((hop) => __awaiter(this, void 0, void 0, function* () {
+                const exchangeConfig = yield biPoolManager.getPoolExchange(hop.id);
+                const rateFeedId = exchangeConfig.config.referenceRateFeedID;
+                const tradingMode = yield this.getRateFeedTradingMode(rateFeedId);
+                return tradingMode === enums_1.TradingMode.BIDIRECTIONAL;
+            })));
+            // All rate feeds must be in BIDIRECTIONAL mode for the pair to be tradable
+            return rateFeedChecks.every((isTradable) => isTradable);
+        });
+    }
     /**
      * Return the trading limits for a given exchange id. Each limit is an object with the following fields:
      * asset: the address of the asset with the limit

package/dist/cjs/utils.d.ts

@@ -71,3 +71,10 @@ export declare function getTokenAddress(symbol: TokenSymbol, chainId: number): s
  * @returns The token object or undefined if not found
  */
 export declare function findTokenBySymbol(symbol: string, chainId: number): Token | undefined;
+/**
+ * Computes the rate feed ID from a rate feed identifier string.
+ * This follows the Solidity formula: address(uint160(uint256(keccak256(abi.encodePacked(rateFeed)))))
+ * @param rateFeed the rate feed identifier string (e.g., "EURUSD", "relayed:COPUSD")
+ * @returns the computed rate feed address
+ */
+export declare function toRateFeedId(rateFeed: string): Address;

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.getTokenAddress = exports.capitalize = exports.findTokenAddressBySymbolInTradablePairs = exports.increaseAllowance = exports.getDecimalsFromTokenAddress = exports.getNameFromTokenAddress = exports.getSymbolFromTokenAddress = exports.validateSignerOrProvider = exports.validateSigner = exports.getChainId = void 0;
+exports.toRateFeedId = exports.findTokenBySymbol = exports.getTokenAddress = exports.capitalize = exports.findTokenAddressBySymbolInTradablePairs = exports.increaseAllowance = exports.getDecimalsFromTokenAddress = exports.getNameFromTokenAddress = exports.getSymbolFromTokenAddress = exports.validateSignerOrProvider = exports.validateSigner = exports.getChainId = void 0;
 const ethers_1 = require("ethers");
 const tokens_1 = require("./constants/tokens");
 /**
@@ -156,3 +156,22 @@ function findTokenBySymbol(symbol, chainId) {
     return tokens.find((token) => token.symbol === symbol);
 }
 exports.findTokenBySymbol = findTokenBySymbol;
+/**
+ * Computes the rate feed ID from a rate feed identifier string.
+ * This follows the Solidity formula: address(uint160(uint256(keccak256(abi.encodePacked(rateFeed)))))
+ * @param rateFeed the rate feed identifier string (e.g., "EURUSD", "relayed:COPUSD")
+ * @returns the computed rate feed address
+ */
+function toRateFeedId(rateFeed) {
+    // 1. Calculate keccak256 hash
+    const hashedBytes = ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(rateFeed));
+    // 2. Convert to BigInt (equivalent to uint256)
+    const hashAsBigInt = BigInt(hashedBytes);
+    // 3. Mask to 160 bits (equivalent to uint160)
+    const maskedToUint160 = hashAsBigInt & ((BigInt(1) << BigInt(160)) - BigInt(1));
+    // 4. Convert to address (hex string)
+    const addressHex = '0x' + maskedToUint160.toString(16).padStart(40, '0');
+    // 5. Return calculated rate feed ID
+    return addressHex;
+}
+exports.toRateFeedId = toRateFeedId;

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

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

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

@@ -0,0 +1,125 @@
+// This file is auto-generated. Do not edit manually.
+// Generated on 2025-10-06T16:08:33.900Z
+import { TokenSymbol } from '../mento';
+export const tokens44787 = [
+    {
+        address: '0x6e673502c5b55F3169657C004e5797fFE5be6653',
+        symbol: TokenSymbol.BridgedEUROC,
+        name: 'mockBridgedEUROC',
+        decimals: 6,
+    },
+    {
+        address: '0x87D61dA3d668797786D73BC674F053f87111570d',
+        symbol: TokenSymbol.BridgedUSDC,
+        name: 'mockBridgedUSDC',
+        decimals: 6,
+    },
+    {
+        address: '0x84CBD49F5aE07632B6B88094E81Cce8236125Fe0',
+        symbol: TokenSymbol.cAUD,
+        name: 'Celo Australian Dollar',
+        decimals: 18,
+    },
+    {
+        address: '0x02EC9E0D2Fd73e89168C1709e542a48f58d7B133',
+        symbol: TokenSymbol.cCAD,
+        name: 'Celo Canadian Dollar',
+        decimals: 18,
+    },
+    {
+        address: '0xADC57C2C34aD021Df4421230a6532F4e2E1dCE4F',
+        symbol: TokenSymbol.cCHF,
+        name: 'Celo Swiss Franc',
+        decimals: 18,
+    },
+    {
+        address: '0xe6A57340f0df6E020c1c0a80bC6E13048601f0d4',
+        symbol: TokenSymbol.cCOP,
+        name: 'Celo Colombian Peso',
+        decimals: 18,
+    },
+    {
+        address: '0xF194afDf50B03e69Bd7D057c1Aa9e10c9954E4C9',
+        symbol: TokenSymbol.CELO,
+        name: 'Celo native asset',
+        decimals: 18,
+    },
+    {
+        address: '0x10c892A6EC43a53E45D0B916B4b7D383B1b78C0F',
+        symbol: TokenSymbol.cEUR,
+        name: 'Celo Euro',
+        decimals: 18,
+    },
+    {
+        address: '0x47f2Fb88105155a18c390641C8a73f1402B2BB12',
+        symbol: TokenSymbol.cGBP,
+        name: 'Celo British Pound',
+        decimals: 18,
+    },
+    {
+        address: '0x295B66bE7714458Af45E6A6Ea142A5358A6cA375',
+        symbol: TokenSymbol.cGHS,
+        name: 'cGHS',
+        decimals: 18,
+    },
+    {
+        address: '0x2E51F41238cA36a421C9B8b3e189e8Cc7653FE67',
+        symbol: TokenSymbol.cJPY,
+        name: 'Celo Japanese Yen',
+        decimals: 18,
+    },
+    {
+        address: '0x1E0433C1769271ECcF4CFF9FDdD515eefE6CdF92',
+        symbol: TokenSymbol.cKES,
+        name: 'Celo Kenyan Shilling',
+        decimals: 18,
+    },
+    {
+        address: '0x4a5b03B8b16122D330306c65e4CA4BC5Dd6511d0',
+        symbol: TokenSymbol.cNGN,
+        name: 'Celo Nigerian Naira',
+        decimals: 18,
+    },
+    {
+        address: '0xE4D517785D091D3c54818832dB6094bcc2744545',
+        symbol: TokenSymbol.cREAL,
+        name: 'Celo Brazilian Real',
+        decimals: 18,
+    },
+    {
+        address: '0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1',
+        symbol: TokenSymbol.cUSD,
+        name: 'Celo Dollar',
+        decimals: 18,
+    },
+    {
+        address: '0x1e5b44015Ff90610b54000DAad31C89b3284df4d',
+        symbol: TokenSymbol.cZAR,
+        name: 'Celo South African Rand',
+        decimals: 18,
+    },
+    {
+        address: '0xB0FA15e002516d0301884059c0aaC0F0C72b019D',
+        symbol: TokenSymbol.eXOF,
+        name: 'ECO CFA',
+        decimals: 18,
+    },
+    {
+        address: '0x5E0E3c9419C42a1B04e2525991FB1A2C467AB8bF',
+        symbol: TokenSymbol.PUSO,
+        name: 'PUSO',
+        decimals: 18,
+    },
+    {
+        address: '0x2F25deB3848C207fc8E0c34035B3Ba7fC157602B',
+        symbol: TokenSymbol.USDC,
+        name: 'USDC',
+        decimals: 6,
+    },
+    {
+        address: '0xBba91F588d031469ABCCA566FE80fB1Ad8Ee3287',
+        symbol: TokenSymbol.USDT,
+        name: 'mockNativeUSDT',
+        decimals: 6,
+    },
+];

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

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