@mento-protocol/mento-sdk 1.0.9 → 1.10.1

package/dist/esm/routeUtils.js

@@ -0,0 +1,362 @@
+/**
+ * Builds the connectivity data structures needed for route generation.
+ *
+ * Transforms a list of direct trading pairs into our ConnectivityData
+ * that allow us to quickly find trading routes.
+ *
+ * **Construction Process:**
+ *
+ * ```
+ * Input: TradablePairs = [
+ *   { 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:
+ *   cUSD.address → 'cUSD'
+ *   CELO.address → 'CELO'
+ *   cEUR.address → 'cEUR'
+ *
+ * Step 2 - Build directPathMap (sorted alphabetically for consistency):
+ *   'CELO_addr-cEUR_addr' → exchange2_CELO_cEUR
+ *   'CELO_addr-cUSD_addr' → exchange1_CELO_cUSD
+ *
+ * Step 3 - Build bidirectional tokenGraph:
+ *   cUSD.address → Set([CELO.address])
+ *   CELO.address → Set([cUSD.address, cEUR.address])
+ *   cEUR.address → Set([CELO.address])
+ * ```
+ *
+ * **Result**: We can now efficiently answer:
+ * - "What's the symbol for address X?" → addrToSymbol.get(addr)
+ * - "What exchange connects tokens X and Y?" → directPathMap.get(sortedAddressPairKey)
+ * - "What tokens can I reach from token X?" → tokenGraph.get(X)
+ *
+ * @param directPairs - Array of direct trading pairs
+ * @returns Connectivity data structure for efficient route generation
+ *
+ * @example
+ * ```typescript
+ * const directPairs = [
+ *   { 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 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
+ * ```
+ */
+export function buildConnectivityStructures(directPairs) {
+    const addrToSymbol = new Map();
+    const directPathMap = new Map();
+    const tokenGraph = new Map();
+    for (const pair of directPairs) {
+        const [assetA, assetB] = pair.assets;
+        // Build address-to-symbol map for quick symbol lookups
+        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 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(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, directPathMap, tokenGraph, directPairs };
+}
+/**
+ * Generates all possible routes (direct + two-hop) using connectivity data.
+ *
+ * This function implements a route discovery algorithm that:
+ *
+ * 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
+ *    - If B connects to token C (C ≠ A), then A->B->C is a valid route
+ *
+ * **Route Deduplication**: Multiple routes between the same token pair
+ * are collected in arrays, allowing the selection algorithm to choose
+ * the best one based on spread data or heuristics.
+ *
+ * **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 pair ID -> array of possible routes for that pair
+ *
+ * @example
+ * ```typescript
+ * // Given direct pairs: cUSD-CELO, CELO-cEUR, cUSD-USDC
+ * const allRoutes = generateAllRoutes(connectivityData)
+ *
+ * // Results might include:
+ * // '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
+ * // ]
+ * ```
+ */
+export function generateAllRoutes(connectivityData) {
+    const { addrToSymbol, directPathMap, tokenGraph, directPairs } = connectivityData;
+    const allRoutes = new Map();
+    // Step 1: Add all direct pairs (single-hop routes)
+    for (const pair of directPairs) {
+        if (!allRoutes.has(pair.id)) {
+            allRoutes.set(pair.id, []);
+        }
+        allRoutes.get(pair.id).push(pair);
+    }
+    // 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., 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 = 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 [cUSD, cEUR, cBRL]
+            for (const end of secondHopNeighbors) {
+                // Skip circular routes like cUSD → CELO → cUSD (pointless)
+                if (end === start)
+                    continue;
+                // At this point we have a potential route: start → intermediate → end
+                // Example: cUSD → CELO → cEUR
+                // Try to create a valid two-hop trading pair from this route
+                const twoHopPair = createTwoHopPair(start, intermediate, end, addrToSymbol, directPathMap);
+                // If we successfully created the pair, add it to our collection
+                if (twoHopPair) {
+                    if (!allRoutes.has(twoHopPair.id)) {
+                        allRoutes.set(twoHopPair.id, []);
+                    }
+                    allRoutes.get(twoHopPair.id).push(twoHopPair);
+                }
+            }
+        }
+    }
+    return allRoutes;
+}
+/**
+ * Creates a two-hop tradable pair if valid exchange hops exist.
+ *
+ * 1. **Validates tokens exist** in the asset map
+ * 2. **Finds exchange hops** for both segments of the route
+ * 3. **Creates canonical pair structure** with sorted symbols
+ *
+ * **Route Structure**: The resulting pair represents trading from start->end
+ * via intermediate token, but the assets are ordered alphabetically by symbol
+ * for consistency (canonical form).
+ *
+ * **Path Representation**: The path array contains the actual exchange hops
+ * needed to execute the trade, preserving the routing information.
+ *
+ * @param startToken - Starting token address
+ * @param intermediate - Intermediate token address for routing
+ * @param end - Destination token address
+ * @param assetMap - Map of token address -> Asset details
+ * @param directPathMap - Map of token pairs -> exchange hop details
+ * @returns Route if valid route exists, null otherwise
+ *
+ * @example
+ * ```typescript
+ * // Create route: cUSD -> CELO -> cEUR
+ * const pair = createTwoHopPair(
+ *   '0x765D...', // cUSD address
+ *   '0x471E...', // CELO address
+ *   '0xD876...', // cEUR address
+ *   addrToSymbol,
+ *   directPathMap
+ * )
+ *
+ * // Result:
+ * // {
+ * //   id: 'cEUR-cUSD',           // alphabetical order
+ * //   assets: [cEUR, cUSD],     // alphabetical order
+ * //   path: [                   // actual routing path
+ * //     { cUSD->CELO exchange },
+ * //     { CELO->cEUR exchange }
+ * //   ]
+ * // }
+ * ```
+ */
+export 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 = [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 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: pairId,
+        assets,
+        path: [hop1, hop2], // Preserves actual routing path for execution
+    };
+}
+/**
+ * Selects optimal routes from all candidates based on spread data or heuristics.
+ *
+ * This is the route optimization engine that implements the following logic:
+ *
+ * **For Single Route**: Use it directly (no optimization needed)
+ *
+ * **For Multiple Routes**:
+ * - If `returnAllRoutes=true`: Return all routes (used for cache generation)
+ * - If `returnAllRoutes=false`: Apply optimization to select the best route
+ *
+ * **Route Selection Strategy**: Delegates to `selectBestRoute()` which uses
+ * a multi-tier approach prioritizing cost efficiency and reliability.
+ *
+ * @param allRoutes - Map of pair ID -> array of possible routes
+ * @param returnAllRoutes - Whether to return all routes or optimize selection
+ * @param assetMap - Asset map for token symbol lookups during optimization
+ * @returns Array of selected optimal routes
+ *
+ * @example
+ * ```typescript
+ * // Multiple routes for cUSD-cEUR pair
+ * const candidates = new Map([
+ *   ['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 cUSD->cREAL->cEUR route (lowest spread: 0.3%)
+ * ```
+ */
+export function selectOptimalRoutes(allRoutes, returnAllRoutes, addrToSymbol) {
+    const result = new Map();
+    for (const [pairId, routes] of allRoutes) {
+        if (routes.length === 1) {
+            // Only one route available - use it directly
+            result.set(pairId, routes[0]);
+        }
+        else if (returnAllRoutes) {
+            // Return all routes with unique keys (used for cache generation)
+            routes.forEach((route, index) => {
+                result.set(`${pairId}_${index}`, route);
+            });
+        }
+        else {
+            // Multiple routes - select the best one using optimization logic
+            const bestRoute = selectBestRoute(routes, addrToSymbol);
+            result.set(pairId, bestRoute);
+        }
+    }
+    return Array.from(result.values());
+}
+/**
+ * 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 - 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 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 cUSD and cEUR typically have better liquidity
+ *
+ * **Tier 4 - First Available** (Last Resort):
+ * - If no other heuristics apply, use the first route found
+ *
+ * @param candidates - Array of possible routes for the same token pair
+ * @param assetMap - Asset map for token symbol lookups
+ * @returns The optimal route selected using the tier system
+ *
+ * @example
+ * ```typescript
+ * const candidates = [
+ *   { 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% spread)
+ * ```
+ */
+export function selectBestRoute(candidates, addrToSymbol) {
+    // 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 = ['cUSD', 'cEUR', 'USDC', 'USDT'];
+    const routeWithStablecoin = candidates.find((candidate) => {
+        const intermediateToken = getIntermediateToken(candidate);
+        if (!intermediateToken)
+            return false;
+        const symbol = addrToSymbol.get(intermediateToken);
+        return symbol && stablecoins.includes(symbol);
+    });
+    // Tier 4: Use first available route as last resort
+    return routeWithStablecoin || candidates[0];
+}
+/**
+ * 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).
+ */
+export function getIntermediateToken(route) {
+    // Find the common token between the two hops
+    const [hop1, hop2] = route.path;
+    return hop1.assets.find((addr) => hop2.assets.includes(addr));
+}
+/**
+ * Type guard to check if a Route has spread data.
+ */
+export function hasSpreadData(pair) {
+    return 'spreadData' in pair && pair.spreadData !== undefined;
+}

package/dist/esm/utils.d.ts

@@ -1,5 +1,6 @@
 import { BigNumberish, providers, Signer } from 'ethers';
 import { Address } from './interfaces';
+import { TradablePair } from './mento';
 /**
  * Gets the chain ID from a signer or provider
  * @param signerOrProvider an ethers provider or signer
@@ -40,3 +41,10 @@ export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrPr
  * @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 findTokenBySymbol(pairs: readonly TradablePair[], symbol: string): string | null;

package/dist/esm/utils.js

@@ -101,3 +101,19 @@ export function increaseAllowance(tokenAddr, spender, amount, signerOrProvider)
         return yield contract.populateTransaction.increaseAllowance(spender, amount);
     });
 }
+/**
+ * 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 function findTokenBySymbol(pairs, symbol) {
+    for (const pair of pairs) {
+        for (const asset of pair.assets) {
+            if (asset.symbol.toLowerCase() === symbol.toLowerCase()) {
+                return asset.address;
+            }
+        }
+    }
+    return null;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.0.9",
+  "version": "1.10.1",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
@@ -26,13 +26,19 @@
     "build:cjs": "tsc --project ./tsconfig.json",
     "build:esm": "tsc --project ./tsconfig.esm.json",
     "clean": "rm -rf ./dist",
-    "lint": "eslint --config ./.eslintrc.json src/**/*.ts",
+    "lint": "eslint --config ./.eslintrc.json 'src/**/*.ts' 'scripts/**/*.ts'",
+    "type-check": "tsc --noEmit --project ./tsconfig.eslint.json",
     "prettier": "prettier --config ./.prettierrc.json --write **/*.{json,md,js,ts,yml}",
     "size": "size-limit",
     "test": "jest --runInBand --verbose",
     "coverage": "jest --coverage",
     "cacheTradablePairs": "ts-node scripts/cacheTradablePairs.ts",
-    "printTradablePairs": "ts-node scripts/printTradablePairs.ts"
+    "printTradablePairs": "ts-node scripts/printTradablePairs.ts",
+    "tradingLimits": "ts-node scripts/printTradingLimits.ts",
+    "poolConfigs": "ts-node scripts/printPoolConfigs.ts",
+    "breakerBox": "ts-node scripts/printBreakerBox.ts",
+    "quote": "ts-node scripts/quotes/index.ts",
+    "getTokenGraph": "ts-node scripts/visualizeTokenGraph.ts"
   },
   "husky": {
     "hooks": {
@@ -46,7 +52,7 @@
     ]
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=22"
   },
   "size-limit": [
     {
@@ -64,19 +70,25 @@
     "@size-limit/preset-small-lib": "^8.1.0",
     "@tsconfig/recommended": "^1.0.1",
     "@types/jest": "^29.4.0",
-    "@types/node": "^18.13.0",
+    "@types/node": "^22.13.0",
+    "@types/yargs-parser": "^21.0.3",
     "@typescript-eslint/eslint-plugin": "^5.53.0",
     "@typescript-eslint/parser": "^5.53.0",
+    "chalk": "4.1.2",
+    "cli-table3": "0.6.3",
+    "date-fns": "^4.1.0",
     "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.6.0",
     "ethers": "^5.7",
     "husky": "^8.0.2",
     "jest": "^29.4.2",
+    "ora": "8.2.0",
     "prettier": "^2.8.4",
     "size-limit": "^8.1.0",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "yargs-parser": "^21.1.1"
   },
   "dependencies": {
     "@mento-protocol/mento-core-ts": "^0.2.0",