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

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

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

package/dist/esm/enums/index.js

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

package/dist/esm/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/esm/enums/tradingMode.js

@@ -0,0 +1,18 @@
+/**
+ * Trading modes for rate feeds in the BreakerBox
+ */
+export 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 || (TradingMode = {}));

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 /* istanbul ignore file */
 export * from './constants';
+export * from './enums';
 export * from './governance';
 export * from './mento';
 export * from './routeUtils';

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

@@ -15,6 +15,7 @@ import { strict as assert } from 'assert';
 import { IMentoRouter__factory } from 'mento-router-ts';
 import { getAddress } from './constants/addresses';
 import { getCachedTradablePairs, } from './constants/tradablePairs';
+import { TradingMode } from './enums';
 import { buildConnectivityStructures, generateAllRoutes, selectOptimalRoutes, } from './routeUtils';
 // Re-export TokenSymbol for use in auto-generated files and consuming packages
 export { TokenSymbol } from './constants/tokens';
@@ -567,6 +568,43 @@ export 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 = 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 = 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 === 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/esm/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/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 { Contract, providers, Signer } from 'ethers';
+import { Contract, ethers, providers, Signer } from 'ethers';
 import { getCachedTokensSync, TOKEN_ADDRESSES_BY_CHAIN } from './constants/tokens';
 /**
  * Gets the chain ID from a signer or provider
@@ -142,3 +142,21 @@ export function findTokenBySymbol(symbol, chainId) {
     const tokens = getCachedTokensSync(chainId);
     return tokens.find((token) => token.symbol === symbol);
 }
+/**
+ * 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 function toRateFeedId(rateFeed) {
+    // 1. Calculate keccak256 hash
+    const hashedBytes = ethers.utils.keccak256(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;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.15.5",
+  "version": "1.16.1-beta.0",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [