@mento-protocol/mento-sdk 3.2.2-beta1 → 3.2.3

package/dist/{utils → cjs}/routeUtils.js

@@ -1,13 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildConnectivityStructures = buildConnectivityStructures;
-exports.generateAllRoutes = generateAllRoutes;
-exports.createTwoHopRoute = createTwoHopRoute;
-exports.selectOptimalRoutes = selectOptimalRoutes;
-exports.selectBestRoute = selectBestRoute;
-exports.getIntermediateToken = getIntermediateToken;
-exports.hasCostData = hasCostData;
-const sortUtils_1 = require("./sortUtils");
+exports.hasSpreadData = exports.getIntermediateToken = exports.selectBestRoute = exports.selectOptimalRoutes = exports.createTwoHopPair = exports.generateAllRoutes = exports.buildConnectivityStructures = void 0;
 /**
  * Builds the connectivity data structures needed for route generation.
  *
@@ -18,23 +11,23 @@ const sortUtils_1 = require("./sortUtils");
  *
  * ```
  * Input: TradablePairs = [
- *   { id: 'USDm-CELO', assets: [USDm, CELO], path: [exchange1_CELO_USDm] },
- *   { id: 'CELO-EURm', assets: [CELO, EURm], path: [exchange2_CELO_EURm] }
+ *   { id: 'cUSD-CELO', assets: [cUSD, CELO], path: [exchange1_CELO_cUSD] },
+ *   { id: 'CELO-cEUR', assets: [CELO, cEUR], path: [exchange2_CELO_cEUR] }
  * ]
  *
  * Step 1 - Build addrToSymbol map:
- *   USDm.address → 'USDm'
+ *   cUSD.address → 'cUSD'
  *   CELO.address → 'CELO'
- *   EURm.address → 'EURm'
+ *   cEUR.address → 'cEUR'
  *
  * Step 2 - Build directPathMap (sorted alphabetically for consistency):
- *   'CELO_addr-EURm_addr' → exchange2_CELO_EURm
- *   'CELO_addr-USDm_addr' → exchange1_CELO_USDm
+ *   'CELO_addr-cEUR_addr' → exchange2_CELO_cEUR
+ *   'CELO_addr-cUSD_addr' → exchange1_CELO_cUSD
  *
  * Step 3 - Build bidirectional tokenGraph:
- *   USDm.address → Set([CELO.address])
- *   CELO.address → Set([USDm.address, EURm.address])
- *   EURm.address → Set([CELO.address])
+ *   cUSD.address → Set([CELO.address])
+ *   CELO.address → Set([cUSD.address, cEUR.address])
+ *   cEUR.address → Set([CELO.address])
  * ```
  *
  * **Result**: We can now efficiently answer:
@@ -42,57 +35,60 @@ const sortUtils_1 = require("./sortUtils");
  * - "What exchange connects tokens X and Y?" → directPathMap.get(sortedAddressPairKey)
  * - "What tokens can I reach from token X?" → tokenGraph.get(X)
  *
- * @param directRoutes - Array of direct trading pairs
+ * @param directPairs - Array of direct trading pairs
  * @returns Connectivity data structure for efficient route generation
  *
  * @example
  * ```typescript
  * const directPairs = [
- *   { id: 'USDm-CELO', assets: [USDm, CELO], path: [exchange1] },
- *   { id: 'CELO-EURm', assets: [CELO, EURm], path: [exchange2] }
+ *   { id: 'cUSD-CELO', assets: [cUSD, CELO], path: [exchange1] },
+ *   { id: 'CELO-cEUR', assets: [CELO, cEUR], path: [exchange2] }
  * ]
  *
  * const connectivityData = buildConnectivityStructures(directPairs)
  *
  * // Now we can efficiently find routes:
- * // 1. Check if USDm connects to anything: connectivityData.tokenGraph.get(USDm.address) → [CELO.address]
- * // 2. Check if CELO connects to EURm: connectivityData.tokenGraph.get(CELO.address) → [USDm.address, EURm.address] ✓
- * // 3. Get exchange details: connectivityData.directPathMap.get('CELO_addr-EURm_addr') → exchange2_CELO_EURm
- * // Result: Found route USDm → CELO → EURm with exchange details
+ * // 1. Check if cUSD connects to anything: connectivityData.tokenGraph.get(cUSD.address) → [CELO.address]
+ * // 2. Check if CELO connects to cEUR: connectivityData.tokenGraph.get(CELO.address) → [cUSD.address, cEUR.address] ✓
+ * // 3. Get exchange details: connectivityData.directPathMap.get('CELO_addr-cEUR_addr') → exchange2_CELO_cEUR
+ * // Result: Found route cUSD → CELO → cEUR with exchange details
  * ```
  */
-function buildConnectivityStructures(directRoutes) {
+function buildConnectivityStructures(directPairs) {
     const addrToSymbol = new Map();
-    const directRouteMap = new Map();
+    const directPathMap = new Map();
     const tokenGraph = new Map();
-    for (const route of directRoutes) {
-        const [tokenA, tokenB] = route.tokens;
+    for (const pair of directPairs) {
+        const [assetA, assetB] = pair.assets;
         // Build address-to-symbol map for quick symbol lookups
-        addrToSymbol.set(tokenA.address, tokenA.symbol);
-        addrToSymbol.set(tokenB.address, tokenB.symbol);
+        addrToSymbol.set(assetA.address, assetA.symbol);
+        addrToSymbol.set(assetB.address, assetB.symbol);
         // Build direct path map (sorted addresses as key for consistency)
         // for quick lookup of exchange details for any token pair
-        const routeId = (0, sortUtils_1.canonicalSymbolKey)(tokenA.symbol, tokenB.symbol);
-        if (!directRouteMap.has(routeId)) {
-            directRouteMap.set(routeId, route.path[0]);
+        const sortedAddresses = [assetA.address, assetB.address]
+            .sort()
+            .join('-');
+        if (!directPathMap.has(sortedAddresses)) {
+            directPathMap.set(sortedAddresses, pair.path[0]);
         }
         // Build bidirectional connectivity graph for route traversal
         // Each token can reach its directly connected tokens
-        if (!tokenGraph.has(tokenA.address))
-            tokenGraph.set(tokenA.address, new Set());
-        if (!tokenGraph.has(tokenB.address))
-            tokenGraph.set(tokenB.address, new Set());
-        tokenGraph.get(tokenA.address).add(tokenB.address);
-        tokenGraph.get(tokenB.address).add(tokenA.address);
+        if (!tokenGraph.has(assetA.address))
+            tokenGraph.set(assetA.address, new Set());
+        if (!tokenGraph.has(assetB.address))
+            tokenGraph.set(assetB.address, new Set());
+        tokenGraph.get(assetA.address).add(assetB.address);
+        tokenGraph.get(assetB.address).add(assetA.address);
     }
-    return { addrToSymbol, directRouteMap, tokenGraph, directRoutes };
+    return { addrToSymbol, directPathMap, tokenGraph, directPairs };
 }
+exports.buildConnectivityStructures = buildConnectivityStructures;
 /**
  * Generates all possible routes (direct + two-hop) using connectivity data.
  *
  * This function implements a route discovery algorithm that:
  *
- * 1. **Adds all direct routes** (single-hop routes)
+ * 1. **Adds all direct pairs** (single-hop routes)
  * 2. **Discovers two-hop routes** using graph traversal:
  *    - For each token A, find its neighbors (tokens directly connected)
  *    - For each neighbor B, find B's neighbors
@@ -100,70 +96,71 @@ function buildConnectivityStructures(directRoutes) {
  *
  * **Route Deduplication**: Multiple routes between the same token pair
  * are collected in arrays, allowing the selection algorithm to choose
- * the best one based on cost data or heuristics.
+ * the best one based on spread data or heuristics.
  *
- * **Canonical Route IDs**: All routes use alphabetically sorted symbols
- * (e.g., 'EURm-USDm' not 'USDm-EURm') for consistent identification.
+ * **Canonical Pair IDs**: All pairs use alphabetically sorted symbols
+ * (e.g., 'cEUR-cUSD' not 'cUSD-cEUR') for consistent identification.
  *
  * @param connectivityData - The connectivity data from buildConnectivityStructures()
- * @returns Map of route ID -> array of possible routes for that token pair
+ * @returns Map of pair ID -> array of possible routes for that pair
  *
  * @example
  * ```typescript
- * // Given direct routes: USDm-CELO, CELO-EURm, USDm-USDC
+ * // Given direct pairs: cUSD-CELO, CELO-cEUR, cUSD-USDC
  * const allRoutes = generateAllRoutes(connectivityData)
  *
  * // Results might include:
- * // 'USDm-CELO' -> [{ path: [USDm->CELO] }] // direct route
- * // 'EURm-USDm' -> [
- * //   { path: [USDm->USDC, USDC->EURm] } // two-hop via USDC
- * //   { path: [USDm->CELO, CELO->EURm] } // two-hop via CELO
+ * // 'cUSD-CELO' -> [{ path: [cUSD->CELO] }] // direct route
+ * // 'cEUR-cUSD' -> [
+ * //   { path: [cUSD->USDC, USDC->cEUR] } // two-hop via USDC
+ * //   { path: [cUSD->CELO, CELO->cEUR] } // two-hop via CELO
  * // ]
  * ```
  */
 function generateAllRoutes(connectivityData) {
-    const { addrToSymbol, directRouteMap, tokenGraph, directRoutes } = connectivityData;
+    const { addrToSymbol, directPathMap, tokenGraph, directPairs } = connectivityData;
     const allRoutes = new Map();
     // Step 1: Add all direct pairs (single-hop routes)
-    for (const route of directRoutes) {
-        if (!allRoutes.has(route.id)) {
-            allRoutes.set(route.id, []);
+    for (const pair of directPairs) {
+        if (!allRoutes.has(pair.id)) {
+            allRoutes.set(pair.id, []);
         }
-        allRoutes.get(route.id).push(route);
+        allRoutes.get(pair.id).push(pair);
     }
-    // Step 2: Generate two-hop routes using graph traversal
+    // Step 2: Generate two-hop pairs using graph traversal
     // Algorithm: For each token, explore all paths of length 2
-    // OUTER LOOP: "For each starting token..." (e.g., USDm, CELO, EURm, etc.)
+    // OUTER LOOP: "For each starting token..." (e.g., cUSD, CELO, cEUR, etc.)
     for (const [start, neighbors] of tokenGraph.entries()) {
         // MIDDLE LOOP: "Where can I go from the starting token?" (first hop)
-        // Example: If start = USDm, neighbors might be [CELO, USDC, KESm]
+        // Example: If start = cUSD, neighbors might be [CELO, USDC, cKES]
         for (const intermediate of neighbors) {
             // Get all tokens reachable from this intermediate token (second hop destinations)
             const secondHopNeighbors = tokenGraph.get(intermediate);
             if (!secondHopNeighbors)
                 continue;
             // INNER LOOP: "From the intermediate token, where can I go?" (second hop)
-            // Example: If intermediate = CELO, secondHopNeighbors might be [USDm, EURm, BRLm]
+            // Example: If intermediate = CELO, secondHopNeighbors might be [cUSD, cEUR, cBRL]
             for (const end of secondHopNeighbors) {
-                // Skip circular routes like USDm → CELO → USDm (pointless)
+                // Skip circular routes like cUSD → CELO → cUSD (pointless)
                 if (end === start)
                     continue;
                 // At this point we have a potential route: start → intermediate → end
-                // Example: USDm → CELO → EURm
+                // Example: cUSD → CELO → cEUR
                 // Try to create a valid two-hop trading pair from this route
-                const twoHopRoute = createTwoHopRoute(start, intermediate, end, addrToSymbol, directRouteMap);
+                const twoHopPair = createTwoHopPair(start, intermediate, end, addrToSymbol, directPathMap);
                 // If we successfully created the pair, add it to our collection
-                if (twoHopRoute) {
-                    if (!allRoutes.has(twoHopRoute.id)) {
-                        allRoutes.set(twoHopRoute.id, []);
+                if (twoHopPair) {
+                    if (!allRoutes.has(twoHopPair.id)) {
+                        allRoutes.set(twoHopPair.id, []);
                     }
-                    allRoutes.get(twoHopRoute.id).push(twoHopRoute);
+                    allRoutes.get(twoHopPair.id).push(twoHopPair);
                 }
             }
         }
     }
     return allRoutes;
 }
+exports.generateAllRoutes = generateAllRoutes;
 /**
  * Creates a two-hop tradable pair if valid exchange hops exist.
  *
@@ -187,55 +184,56 @@ function generateAllRoutes(connectivityData) {
  *
  * @example
  * ```typescript
- * // Create route: USDm -> CELO -> EURm
+ * // Create route: cUSD -> CELO -> cEUR
  * const pair = createTwoHopPair(
- *   '0x765D...', // USDm address
+ *   '0x765D...', // cUSD address
  *   '0x471E...', // CELO address
- *   '0xD876...', // EURm address
+ *   '0xD876...', // cEUR address
  *   addrToSymbol,
  *   directPathMap
  * )
  *
  * // Result:
  * // {
- * //   id: 'EURm-USDm',           // alphabetical order
- * //   assets: [EURm, USDm],     // alphabetical order
+ * //   id: 'cEUR-cUSD',           // alphabetical order
+ * //   assets: [cEUR, cUSD],     // alphabetical order
  * //   path: [                   // actual routing path
- * //     { USDm->CELO exchange },
- * //     { CELO->EURm exchange }
+ * //     { cUSD->CELO exchange },
+ * //     { CELO->cEUR exchange }
  * //   ]
  * // }
  * ```
  */
-function createTwoHopRoute(startAddr, intermediateAddr, endAddr, addrToSymbol, directRouteMap) {
-    // Validate that both all tokens exist in our address-to-symbol map
-    const startSymbol = addrToSymbol.get(startAddr);
-    const intermediateSymbol = addrToSymbol.get(intermediateAddr);
-    const endSymbol = addrToSymbol.get(endAddr);
-    if (!startSymbol || !intermediateSymbol || !endSymbol)
+function createTwoHopPair(startToken, intermediateToken, endToken, addrToSymbol, directPathMap) {
+    // Validate that both start and end tokens exist in our address-to-symbol map
+    const startSymbol = addrToSymbol.get(startToken);
+    const endSymbol = addrToSymbol.get(endToken);
+    if (!startSymbol || !endSymbol)
         return null;
+    // Create Asset objects from address and symbol
+    const startAsset = { address: startToken, symbol: startSymbol };
+    const endAsset = { address: endToken, symbol: endSymbol };
     // Find exchange hops for both segments of the two-hop route
     // Keys are sorted token addresses for consistent lookup
-    const hop1Key = (0, sortUtils_1.canonicalSymbolKey)(startSymbol, intermediateSymbol);
-    const hop2Key = (0, sortUtils_1.canonicalSymbolKey)(intermediateSymbol, endSymbol);
-    const hop1 = directRouteMap.get(hop1Key);
-    const hop2 = directRouteMap.get(hop2Key);
+    const hop1Key = [startToken, intermediateToken].sort().join('-');
+    const hop2Key = [intermediateToken, endToken].sort().join('-');
+    const hop1 = directPathMap.get(hop1Key);
+    const hop2 = directPathMap.get(hop2Key);
     // If either hop doesn't exist, this route is invalid
     if (!hop1 || !hop2)
         return null;
     // Create canonical pair structure (alphabetical symbol ordering)
-    const routeId = (0, sortUtils_1.canonicalSymbolKey)(startSymbol, endSymbol);
-    // Create Token objects from address and symbol
-    const startToken = { address: startAddr, symbol: startSymbol };
-    const endToken = { address: endAddr, symbol: endSymbol };
-    // Token array follows alphabetical ordering for consistency
-    const tokens = startSymbol <= endSymbol ? [startToken, endToken] : [endToken, startToken];
+    const sortedSymbols = [startSymbol, endSymbol].sort();
+    const pairId = `${sortedSymbols[0]}-${sortedSymbols[1]}`;
+    // Assets array follows alphabetical ordering for consistency
+    const assets = startSymbol <= endSymbol ? [startAsset, endAsset] : [endAsset, startAsset];
     return {
-        id: routeId,
-        tokens,
+        id: pairId,
+        assets,
         path: [hop1, hop2], // Preserves actual routing path for execution
     };
 }
+exports.createTwoHopPair = createTwoHopPair;
 /**
  * Selects optimal routes from all candidates based on spread data or heuristics.
  *
@@ -257,58 +255,59 @@ function createTwoHopRoute(startAddr, intermediateAddr, endAddr, addrToSymbol, d
  *
  * @example
  * ```typescript
- * // Multiple routes for USDm-EURm pair
+ * // Multiple routes for cUSD-cEUR pair
  * const candidates = new Map([
- *   ['EURm-USDm', [
- *     { path: [USDm->CELO->EURm], costData: { totalCostPercent: 0.5 } },
- *     { path: [USDm->BRLm->EURm], costData: { totalCostPercent: 0.3 } },
- *     { path: [USDm->EURm] } // direct route, no cost data
+ *   ['cEUR-cUSD', [
+ *     { path: [cUSD->CELO->cEUR], spreadData: { totalSpreadPercent: 0.5 } },
+ *     { path: [cUSD->cREAL->cEUR], spreadData: { totalSpreadPercent: 0.3 } },
+ *     { path: [cUSD->cEUR] } // direct route, no spread data
  *   ]]
  * ])
  *
  * const optimal = selectOptimalRoutes(candidates, false, assetMap)
- * // Returns the USDm->BRLm->EURm route (lowest cost: 0.3%)
+ * // Returns the cUSD->cREAL->cEUR route (lowest spread: 0.3%)
  * ```
  */
 function selectOptimalRoutes(allRoutes, returnAllRoutes, addrToSymbol) {
     const result = new Map();
-    for (const [routeId, routes] of allRoutes) {
+    for (const [pairId, routes] of allRoutes) {
         if (routes.length === 1) {
             // Only one route available - use it directly
-            result.set(routeId, routes[0]);
+            result.set(pairId, routes[0]);
         }
         else if (returnAllRoutes) {
             // Return all routes with unique keys (used for cache generation)
             routes.forEach((route, index) => {
-                result.set(`${routeId}_${index}`, route);
+                result.set(`${pairId}_${index}`, route);
             });
         }
         else {
             // Multiple routes - select the best one using optimization logic
             const bestRoute = selectBestRoute(routes, addrToSymbol);
-            result.set(routeId, bestRoute);
+            result.set(pairId, bestRoute);
         }
     }
     return Array.from(result.values());
 }
+exports.selectOptimalRoutes = selectOptimalRoutes;
 /**
- * Selects the best route from candidates using cost data or fallback heuristics.
+ * Selects the best route from candidates using spread data or fallback heuristics.
  *
  * This function implements a sophisticated route selection algorithm with
  * multiple optimization tiers:
  *
- * **Tier 1 - Cost-Based Optimization** (Preferred):
- * - Use routes with cost data (actual cost information)
- * - Select route with lowest `totalCostPercent`
+ * **Tier 1 - Spread-Based Optimization** (Preferred):
+ * - Use routes with spread data (actual cost information)
+ * - Select route with lowest `totalSpreadPercent`
  * - This provides the most cost-efficient trading
  *
  * **Tier 2 - Direct Route Preference** (Fallback):
- * - If no cost data available, prefer direct (single-hop) routes
+ * - If no spread data available, prefer direct (single-hop) routes
  * - Direct routes have lower execution risk and gas costs
  *
  * **Tier 3 - Major Stablecoin Preference** (Final Fallback):
  * - For two-hop routes, prefer those going through major stablecoins
- * - Major FX currencies like USDm and EURm typically have better liquidity
+ * - Major FX currencies like cUSD and cEUR typically have better liquidity
  *
  * **Tier 4 - First Available** (Last Resort):
  * - If no other heuristics apply, use the first route found
@@ -320,27 +319,29 @@ function selectOptimalRoutes(allRoutes, returnAllRoutes, addrToSymbol) {
  * @example
  * ```typescript
  * const candidates = [
- *   { path: [A->B->C], costData: { totalCostPercent: 0.8 } },
- *   { path: [A->D->C], costData: { totalCostPercent: 0.4 } }, // Winner: lowest cost
- *   { path: [A->C] }, // direct route, no cost data
+ *   { path: [A->B->C], spreadData: { totalSpreadPercent: 0.8 } },
+ *   { path: [A->D->C], spreadData: { totalSpreadPercent: 0.4 } }, // Winner: lowest spread
+ *   { path: [A->C] }, // direct route, no spread data
  * ]
  *
  * const best = selectBestRoute(candidates, assetMap)
- * // Returns the A->D->C route (0.4% cost)
+ * // Returns the A->D->C route (0.4% spread)
  * ```
  */
 function selectBestRoute(candidates, addrToSymbol) {
-    // Tier 1: Prefer routes with cost data (lowest cost wins)
-    const candidatesWithCost = candidates.filter(hasCostData);
-    if (candidatesWithCost.length > 0) {
-        return candidatesWithCost.reduce((best, current) => current.costData.totalCostPercent < best.costData.totalCostPercent ? current : best);
+    // Tier 1: Prefer routes with spread data (lowest spread wins)
+    const candidatesWithSpread = candidates.filter(hasSpreadData);
+    if (candidatesWithSpread.length > 0) {
+        return candidatesWithSpread.reduce((best, current) => current.spreadData.totalSpreadPercent < best.spreadData.totalSpreadPercent
+            ? current
+            : best);
     }
     // Tier 2: Prefer direct routes (single-hop, lower risk)
     const directRoute = candidates.find((c) => c.path.length === 1);
     if (directRoute)
         return directRoute;
     // Tier 3: Prefer routes through major stablecoins (better liquidity)
-    const stablecoins = ['USDm', 'EURm', 'USDC', 'USDT'];
+    const stablecoins = ['cUSD', 'cEUR', 'USDC', 'USDT'];
     const routeWithStablecoin = candidates.find((candidate) => {
         const intermediateToken = getIntermediateToken(candidate);
         if (!intermediateToken)
@@ -351,6 +352,7 @@ function selectBestRoute(candidates, addrToSymbol) {
     // Tier 4: Use first available route as last resort
     return routeWithStablecoin || candidates[0];
 }
+exports.selectBestRoute = selectBestRoute;
 /**
  * Extracts the intermediate token address from a two-hop route.
  * In a two-hop route A->B->C, this function finds token B (the intermediate).
@@ -358,14 +360,13 @@ function selectBestRoute(candidates, addrToSymbol) {
 function getIntermediateToken(route) {
     // Find the common token between the two hops
     const [hop1, hop2] = route.path;
-    const hop1Tokens = [hop1.token0, hop1.token1];
-    const hop2Tokens = [hop2.token0, hop2.token1];
-    return hop1Tokens.find((addr) => hop2Tokens.includes(addr));
+    return hop1.assets.find((addr) => hop2.assets.includes(addr));
 }
+exports.getIntermediateToken = getIntermediateToken;
 /**
- * Type guard to check if a Route has cost data.
+ * Type guard to check if a Route has spread data.
  */
-function hasCostData(pair) {
-    return 'costData' in pair && pair.costData !== undefined;
+function hasSpreadData(pair) {
+    return 'spreadData' in pair && pair.spreadData !== undefined;
 }
-//# sourceMappingURL=routeUtils.js.map
+exports.hasSpreadData = hasSpreadData;

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

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

package/dist/cjs/types/contractAddressMap.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,23 @@
+export type ContractAddresses = {
+    GovernanceFactory: string;
+    Airgrab: string;
+    Emission: string;
+    MentoGovernor: string;
+    MentoToken: string;
+    TimelockController: string;
+    Locking: string;
+    MentoRouter: string;
+    Broker: string;
+    BiPoolManager: string;
+    BreakerBox: string;
+    Reserve: string;
+    ConstantSumPricingModule: string;
+    ConstantProductPricingModule: string;
+    MedianDeltaBreaker: string;
+    ValueDeltaBreaker: string;
+    StableToken: string;
+    StableTokenEUR: string;
+    StableTokenBRL: string;
+    StableTokenXOF: string;
+    SortedOracles: string;
+};

package/dist/cjs/types/contractAddresses.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,2 @@
+export * from './contractAddresses';
+export * from './contractAddressMap';

package/dist/{services/pools → cjs/types}/index.js

@@ -14,5 +14,5 @@ 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("./PoolService"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./contractAddresses"), exports);
+__exportStar(require("./contractAddressMap"), exports);

package/dist/cjs/utils.d.ts

@@ -0,0 +1,80 @@
+import { BigNumberish, providers, Signer } from 'ethers';
+import { TokenSymbol } from './constants';
+import { Address } from './interfaces';
+import { Token, TradablePair } from './mento';
+/**
+ * Gets the chain ID from a signer or provider
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the chain ID
+ */
+export declare function getChainId(signerOrProvider: Signer | providers.Provider): Promise<number>;
+/**
+ * Ensures that given signer is truly a a connected signer
+ * @param signer an ethers signer
+ * @throws if signer is invalid or not connected
+ */
+export declare function validateSigner(signer: Signer): void;
+/**
+ * Ensures that given signerOrProvider is truly a provider or a connected signer
+ * @param signerOrProvider an ethers provider or signer
+ * @throws if signerOrProvider is invalid or not connected
+ */
+export declare function validateSignerOrProvider(signerOrProvider: Signer | providers.Provider): void;
+/**
+ * Returns the symbol 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
+ */
+export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<TokenSymbol>;
+/**
+ * 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
+ * @param spender the address of the spender
+ * @param amount the amount to increase the allowance by
+ * @param signerOrProvider an ethers signer or provider
+ * @returns the populated TransactionRequest object
+ */
+export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>;
+/**
+ * Find a token address by its symbol from tradable pairs
+ * @param pairs array of tradable pairs to search through
+ * @param symbol the token symbol to find (case-insensitive)
+ * @returns the token address if found, null otherwise
+ */
+export declare function findTokenAddressBySymbolInTradablePairs(symbol: TokenSymbol, pairs: readonly TradablePair[]): Address | null;
+export declare function capitalize(str: string): string; /**
+ * Helper function to get token address by symbol for a specific chain
+ * @param symbol - The token symbol
+ * @param chainId - The chain ID
+ * @returns The token address or undefined if not found
+ */
+export declare function getTokenAddress(symbol: TokenSymbol, chainId: number): string | undefined;
+/**
+ * Helper function to find a token by symbol in the cached tokens
+ * @param symbol - The token symbol to search for
+ * @param chainId - The chain ID
+ * @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;