@mento-protocol/mento-sdk 2.0.0-beta.8 → 3.0.0-beta.1

package/dist/utils/routeUtils.d.ts

@@ -0,0 +1,295 @@
+import type { Route, RouteID, RouteWithCost, Pool } from '../core/types';
+type TokenSymbol = string;
+type Address = string;
+/**
+ * =============================================================================
+ * ROUTE GENERATION UTILITIES
+ * =============================================================================
+ *
+ * Utilities for generating optimal trading routes in the Mento protocol.
+ *
+ * The main workflow is:
+ *
+ * 1. Build connectivity structures from direct trading pairs
+ * 2. Generate all possible routes (direct + two-hop)
+ * 3. Select optimal routes using cost data or heuristics
+ *
+ * ALGORITHM OVERVIEW:
+ * - Creates a graph where tokens are nodes and direct exchanges are edges
+ * - Uses graph traversal to find two-hop routes through intermediate tokens
+ * - Optimizes route selection based on cost data when available
+ * - Falls back to heuristics (prefer direct routes, major stablecoins)
+ * =============================================================================
+ */
+/**
+ * Connectivity data structure that represents the token graph connecting all tokens.
+ * Helps to efficiently answer: "How can I trade from token A to token B?"
+ *
+ * CONCRETE EXAMPLE:
+ * Given these direct trading pairs:
+ * - cUSD ↔ CELO (direct exchange exists)
+ * - CELO ↔ cEUR (direct exchange exists)
+ * - cUSD ↔ cREAL (direct exchange exists)
+ *
+ * How route finding works:
+ * - Direct route: cUSD → cEUR? Check token graph: cUSD connects to [CELO, cREAL], none is cEUR → No direct route
+ * - Two-hop route: cUSD → ? → cEUR?
+ *   - cUSD connects to CELO, CELO connects to cEUR → Found route: cUSD → CELO → cEUR
+ *   - cUSD connects to cREAL, cREAL connects to [cUSD] → No route via cREAL
+ *
+ * The "connectivity" part means we can quickly traverse the network of
+ * token connections to find all possible trading paths.
+ */
+export interface ConnectivityData {
+    /** Maps token address to symbol for efficient lookups
+     *
+     *    ```
+     *    '0x765D...' → 'cUSD'
+     *    '0x471E...' → 'CELO'
+     *    '0xD876...' → 'cEUR'
+     *    ```
+     */
+    addrToSymbol: Map<Address, TokenSymbol>;
+    /** Adjacency list mapping which tokens connect to which
+     * Used for finding two-hop routes by traversing token → neighbor → neighbor.
+     *
+     * Example for a cUSD => cEUR swap: First we find cUSD → [CELO, cKES, ...]
+     * Then we find CELO → [cUSD, cEUR, ...] = found route via cUSD → CELO → cEUR
+     *
+     *    ```
+     *    'cUSD_addr' → Set(['CELO_addr', 'cKES_addr'])  // cUSD connects to CELO and cKES
+     *    'CELO_addr' → Set(['cUSD_addr', 'cEUR_addr'])  // CELO connects to cUSD and cEUR
+     *    'cEUR_addr' → Set(['CELO_addr'])               // cEUR connects to CELO
+     *    'cKES_addr' → Set(['cUSD_addr'])               // cKES connects to cUSD
+     *    ```
+     */
+    tokenGraph: Map<Address, Set<Address>>;
+    /** Maps sorted token address pairs to their direct route details
+     *    ```
+     *    'CELO_addr-cEUR_addr' → { route details for CELO ↔ cEUR }
+     *    'CELO_addr-cUSD_addr' → { route details for CELO ↔ cUSD }
+     *    'cUSD_addr-cKES_addr' → { route details for cUSD ↔ cKES }
+     *    ```
+     */
+    directRouteMap: Map<RouteID, Pool>;
+    /** Original direct routes from mento.getDirectRoutes() for reference */
+    directRoutes: Route[];
+}
+/**
+ * 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 directRoutes - 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 declare function buildConnectivityStructures(directRoutes: Route[]): ConnectivityData;
+/**
+ * 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)
+ * 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 cost data or heuristics.
+ *
+ * **Canonical Route IDs**: All routes 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
+ *
+ * @example
+ * ```typescript
+ * // Given direct routes: 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 declare function generateAllRoutes(connectivityData: ConnectivityData): Map<RouteID, Route[]>;
+/**
+ * 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 declare function createTwoHopRoute(startAddr: Address, intermediateAddr: Address, endAddr: Address, addrToSymbol: Map<Address, TokenSymbol>, directRouteMap: Map<RouteID, Pool>): Route | null;
+/**
+ * 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], costData: { totalCostPercent: 0.5 } },
+ *     { path: [cUSD->cREAL->cEUR], costData: { totalCostPercent: 0.3 } },
+ *     { path: [cUSD->cEUR] } // direct route, no cost data
+ *   ]]
+ * ])
+ *
+ * const optimal = selectOptimalRoutes(candidates, false, assetMap)
+ * // Returns the cUSD->cREAL->cEUR route (lowest cost: 0.3%)
+ * ```
+ */
+export declare function selectOptimalRoutes(allRoutes: Map<RouteID, Route[]>, returnAllRoutes: boolean, addrToSymbol: Map<Address, TokenSymbol>): (Route | RouteWithCost)[];
+/**
+ * Selects the best route from candidates using cost 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`
+ * - This provides the most cost-efficient trading
+ *
+ * **Tier 2 - Direct Route Preference** (Fallback):
+ * - If no cost 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], costData: { totalCostPercent: 0.8 } },
+ *   { path: [A->D->C], costData: { totalCostPercent: 0.4 } }, // Winner: lowest cost
+ *   { path: [A->C] }, // direct route, no cost data
+ * ]
+ *
+ * const best = selectBestRoute(candidates, assetMap)
+ * // Returns the A->D->C route (0.4% cost)
+ * ```
+ */
+export declare function selectBestRoute(candidates: Route[], addrToSymbol: Map<Address, TokenSymbol>): Route | RouteWithCost;
+/**
+ * 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 declare function getIntermediateToken(route: Route): Address | undefined;
+/**
+ * Type guard to check if a Route has cost data.
+ */
+export declare function hasCostData(pair: Route | RouteWithCost): pair is RouteWithCost;
+export {};
+//# sourceMappingURL=routeUtils.d.ts.map

package/dist/utils/routeUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeUtils.d.ts","sourceRoot":"","sources":["../../src/utils/routeUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAS,aAAa,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AAI/E,KAAK,WAAW,GAAG,MAAM,CAAA;AACzB,KAAK,OAAO,GAAG,MAAM,CAAA;AAErB;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;IAEvC;;;;;;;;;;;;OAYG;IACH,UAAU,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAA;IAEtC;;;;;;OAMG;IACH,cAAc,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IAElC,wEAAwE;IACxE,YAAY,EAAE,KAAK,EAAE,CAAA;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAgB,2BAA2B,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,gBAAgB,CA4BnF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,iBAAiB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAgD3F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,OAAO,EAClB,gBAAgB,EAAE,OAAO,EACzB,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,EACvC,cAAc,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,GACjC,KAAK,GAAG,IAAI,CAgCd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,EAChC,eAAe,EAAE,OAAO,EACxB,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,GACtC,CAAC,KAAK,GAAG,aAAa,CAAC,EAAE,CAoB3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,KAAK,GAAG,aAAa,CAwBnH;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,CAMtE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,aAAa,GAAG,IAAI,IAAI,aAAa,CAE9E"}

package/dist/utils/routeUtils.js

@@ -0,0 +1,371 @@
+"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");
+/**
+ * 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 directRoutes - 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
+ * ```
+ */
+function buildConnectivityStructures(directRoutes) {
+    const addrToSymbol = new Map();
+    const directRouteMap = new Map();
+    const tokenGraph = new Map();
+    for (const route of directRoutes) {
+        const [tokenA, tokenB] = route.tokens;
+        // Build address-to-symbol map for quick symbol lookups
+        addrToSymbol.set(tokenA.address, tokenA.symbol);
+        addrToSymbol.set(tokenB.address, tokenB.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]);
+        }
+        // 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);
+    }
+    return { addrToSymbol, directRouteMap, tokenGraph, directRoutes };
+}
+/**
+ * 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)
+ * 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 cost data or heuristics.
+ *
+ * **Canonical Route IDs**: All routes 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
+ *
+ * @example
+ * ```typescript
+ * // Given direct routes: 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
+ * // ]
+ * ```
+ */
+function generateAllRoutes(connectivityData) {
+    const { addrToSymbol, directRouteMap, tokenGraph, directRoutes } = 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, []);
+        }
+        allRoutes.get(route.id).push(route);
+    }
+    // Step 2: Generate two-hop routes 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 twoHopRoute = createTwoHopRoute(start, intermediate, end, addrToSymbol, directRouteMap);
+                // If we successfully created the pair, add it to our collection
+                if (twoHopRoute) {
+                    if (!allRoutes.has(twoHopRoute.id)) {
+                        allRoutes.set(twoHopRoute.id, []);
+                    }
+                    allRoutes.get(twoHopRoute.id).push(twoHopRoute);
+                }
+            }
+        }
+    }
+    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 }
+ * //   ]
+ * // }
+ * ```
+ */
+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)
+        return null;
+    // 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);
+    // 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];
+    return {
+        id: routeId,
+        tokens,
+        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], costData: { totalCostPercent: 0.5 } },
+ *     { path: [cUSD->cREAL->cEUR], costData: { totalCostPercent: 0.3 } },
+ *     { path: [cUSD->cEUR] } // direct route, no cost data
+ *   ]]
+ * ])
+ *
+ * const optimal = selectOptimalRoutes(candidates, false, assetMap)
+ * // Returns the cUSD->cREAL->cEUR route (lowest cost: 0.3%)
+ * ```
+ */
+function selectOptimalRoutes(allRoutes, returnAllRoutes, addrToSymbol) {
+    const result = new Map();
+    for (const [routeId, routes] of allRoutes) {
+        if (routes.length === 1) {
+            // Only one route available - use it directly
+            result.set(routeId, routes[0]);
+        }
+        else if (returnAllRoutes) {
+            // Return all routes with unique keys (used for cache generation)
+            routes.forEach((route, index) => {
+                result.set(`${routeId}_${index}`, route);
+            });
+        }
+        else {
+            // Multiple routes - select the best one using optimization logic
+            const bestRoute = selectBestRoute(routes, addrToSymbol);
+            result.set(routeId, bestRoute);
+        }
+    }
+    return Array.from(result.values());
+}
+/**
+ * Selects the best route from candidates using cost 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`
+ * - This provides the most cost-efficient trading
+ *
+ * **Tier 2 - Direct Route Preference** (Fallback):
+ * - If no cost 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], costData: { totalCostPercent: 0.8 } },
+ *   { path: [A->D->C], costData: { totalCostPercent: 0.4 } }, // Winner: lowest cost
+ *   { path: [A->C] }, // direct route, no cost data
+ * ]
+ *
+ * const best = selectBestRoute(candidates, assetMap)
+ * // Returns the A->D->C route (0.4% cost)
+ * ```
+ */
+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 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).
+ */
+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));
+}
+/**
+ * Type guard to check if a Route has cost data.
+ */
+function hasCostData(pair) {
+    return 'costData' in pair && pair.costData !== undefined;
+}
+//# sourceMappingURL=routeUtils.js.map

package/dist/utils/routeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeUtils.js","sourceRoot":"","sources":["../../src/utils/routeUtils.ts"],"names":[],"mappings":";;AA4IA,kEA4BC;AAoCD,8CAgDC;AA6CD,8CAsCC;AAoCD,kDAwBC;AAwCD,0CAwBC;AAMD,oDAMC;AAKD,kCAEC;AA7dD,2CAAqE;AAsFrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,SAAgB,2BAA2B,CAAC,YAAqB;IAC/D,MAAM,YAAY,GAAG,IAAI,GAAG,EAAwB,CAAA;IACpD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAiB,CAAA;IAC/C,MAAM,UAAU,GAAG,IAAI,GAAG,EAAuB,CAAA;IAEjD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAA;QAErC,uDAAuD;QACvD,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;QAC/C,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;QAE/C,kEAAkE;QAClE,0DAA0D;QAC1D,MAAM,OAAO,GAAG,IAAA,8BAAkB,EAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAY,CAAA;QAC3E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5C,CAAC;QAED,6DAA6D;QAC7D,qDAAqD;QACrD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;QAC9E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;QAC9E,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACnD,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACrD,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,CAAA;AACnE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,iBAAiB,CAAC,gBAAkC;IAClE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,gBAAgB,CAAA;IACnF,MAAM,SAAS,GAAG,IAAI,GAAG,EAAoB,CAAA;IAE7C,mDAAmD;IACnD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YAC7B,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QAC7B,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IAED,wDAAwD;IACxD,2DAA2D;IAE3D,0EAA0E;IAC1E,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACtD,qEAAqE;QACrE,kEAAkE;QAClE,KAAK,MAAM,YAAY,IAAI,SAAS,EAAE,CAAC;YACrC,kFAAkF;YAClF,MAAM,kBAAkB,GAAG,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;YACvD,IAAI,CAAC,kBAAkB;gBAAE,SAAQ;YAEjC,0EAA0E;YAC1E,kFAAkF;YAClF,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;gBACrC,2DAA2D;gBAC3D,IAAI,GAAG,KAAK,KAAK;oBAAE,SAAQ;gBAE3B,sEAAsE;gBACtE,8BAA8B;gBAE9B,6DAA6D;gBAC7D,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAA;gBAE7F,gEAAgE;gBAChE,IAAI,WAAW,EAAE,CAAC;oBAChB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;wBACnC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;oBACnC,CAAC;oBACD,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAClD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,SAAgB,iBAAiB,CAC/B,SAAkB,EAClB,gBAAyB,EACzB,OAAgB,EAChB,YAAuC,EACvC,cAAkC;IAElC,mEAAmE;IACnE,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IAC/C,MAAM,kBAAkB,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAC7D,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,CAAC,WAAW,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAA;IAElE,4DAA4D;IAC5D,wDAAwD;IACxD,MAAM,OAAO,GAAG,IAAA,8BAAkB,EAAC,WAAW,EAAE,kBAAkB,CAAY,CAAA;IAC9E,MAAM,OAAO,GAAG,IAAA,8BAAkB,EAAC,kBAAkB,EAAE,SAAS,CAAY,CAAA;IAC5E,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAExC,qDAAqD;IACrD,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAA;IAE/B,iEAAiE;IACjE,MAAM,OAAO,GAAG,IAAA,8BAAkB,EAAC,WAAW,EAAE,SAAS,CAAY,CAAA;IAErE,+CAA+C;IAC/C,MAAM,UAAU,GAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;IACrE,MAAM,QAAQ,GAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;IAE/D,4DAA4D;IAC5D,MAAM,MAAM,GAAmB,WAAW,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;IAEzG,OAAO;QACL,EAAE,EAAE,OAAO;QACX,MAAM;QACN,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,8CAA8C;KACnE,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,mBAAmB,CACjC,SAAgC,EAChC,eAAwB,EACxB,YAAuC;IAEvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiC,CAAA;IAEvD,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,6CAA6C;YAC7C,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAChC,CAAC;aAAM,IAAI,eAAe,EAAE,CAAC;YAC3B,iEAAiE;YACjE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC9B,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,IAAI,KAAK,EAAE,EAAE,KAAK,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,iEAAiE;YACjE,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;YACvD,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,eAAe,CAAC,UAAmB,EAAE,YAAuC;IAC1F,0DAA0D;IAC1D,MAAM,kBAAkB,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IACzD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CACpF,CAAA;IACH,CAAC;IAED,wDAAwD;IACxD,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;IAC/D,IAAI,WAAW;QAAE,OAAO,WAAW,CAAA;IAEnC,qEAAqE;IACrE,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACpD,MAAM,mBAAmB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QACxD,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAA;QACzD,IAAI,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAA;QACpC,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QAClD,OAAO,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IAEF,mDAAmD;IACnD,OAAO,mBAAmB,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;AAC7C,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,KAAY;IAC/C,6CAA6C;IAC7C,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAA;IAC/B,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7C,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7C,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,IAA2B;IACrD,OAAO,UAAU,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAA;AAC1D,CAAC"}