@fanx-protocol/smart-order-router 0.0.1

package/build/main/routers/alpha-router/functions/compute-all-routes.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeAllRoutes = exports.computeAllMixedRoutes = exports.computeAllV2Routes = exports.computeAllV3Routes = void 0;
+const v2_sdk_1 = require("@fanx-protocol/v2-sdk");
+const v3_sdk_1 = require("@fanx-protocol/v3-sdk");
+// import { Pool as V4Pool } from '@fanx-protocol/v4-sdk';
+const util_1 = require("../../../util");
+const log_1 = require("../../../util/log");
+const routes_1 = require("../../../util/routes");
+const router_1 = require("../../router");
+// export function computeAllV4Routes(
+//   currencyIn: Currency,
+//   currencyOut: Currency,
+//   pools: V4Pool[],
+//   maxHops: number
+// ): V4Route[] {
+//   // TODO: ROUTE-217 - Support native currency routing in V4
+//   return computeAllRoutes<V4Pool, V4Route, Currency>(
+//     currencyIn,
+//     currencyOut,
+//     (route: V4Pool[], currencyIn: Currency, currencyOut: Currency) => {
+//       return new V4Route(route, currencyIn, currencyOut);
+//     },
+//     (pool: V4Pool, currency: Currency) => pool.involvesToken(currency),
+//     pools,
+//     maxHops
+//   );
+// }
+function computeAllV3Routes(tokenIn, tokenOut, pools, maxHops) {
+    return computeAllRoutes(tokenIn, tokenOut, (route, tokenIn, tokenOut) => {
+        return new router_1.V3Route(route, tokenIn, tokenOut);
+    }, (pool, token) => pool.involvesToken(token), pools, maxHops);
+}
+exports.computeAllV3Routes = computeAllV3Routes;
+function computeAllV2Routes(tokenIn, tokenOut, pools, maxHops) {
+    return computeAllRoutes(tokenIn, tokenOut, (route, tokenIn, tokenOut) => {
+        return new router_1.V2Route(route, tokenIn, tokenOut);
+    }, (pool, token) => pool.involvesToken(token), pools, maxHops);
+}
+exports.computeAllV2Routes = computeAllV2Routes;
+function computeAllMixedRoutes(currencyIn, currencyOut, parts, maxHops) {
+    const routesRaw = computeAllRoutes(currencyIn, currencyOut, (route, currencyIn, currencyOut) => {
+        return new router_1.MixedRoute(route, currencyIn, currencyOut);
+    }, (pool, currency) => 
+    // V4 not supported - native currency routing through V4 pools is not available
+    currency.isNative
+        ? false // Native currency routing not supported without V4
+        : pool.involvesToken(currency), parts, maxHops);
+    /// filter out pure v3 and v2 routes (V4 not supported)
+    return routesRaw.filter((route) => {
+        return (
+        // !route.pools.every((pool) => pool instanceof V4Pool) && // V4 not supported
+        !route.pools.every((pool) => pool instanceof v3_sdk_1.Pool) &&
+            !route.pools.every((pool) => pool instanceof v2_sdk_1.Pair));
+    });
+}
+exports.computeAllMixedRoutes = computeAllMixedRoutes;
+function computeAllRoutes(tokenIn, tokenOut, buildRoute, involvesToken, pools, maxHops) {
+    var _a;
+    const poolsUsed = Array(pools.length).fill(false);
+    const routes = [];
+    const computeRoutes = (tokenIn, tokenOut, currentRoute, poolsUsed, tokensVisited, _previousTokenOut) => {
+        if (currentRoute.length > maxHops) {
+            return;
+        }
+        if (currentRoute.length > 0 &&
+            involvesToken(currentRoute[currentRoute.length - 1], tokenOut)) {
+            routes.push(buildRoute([...currentRoute], tokenIn, tokenOut));
+            return;
+        }
+        for (let i = 0; i < pools.length; i++) {
+            if (poolsUsed[i]) {
+                continue;
+            }
+            const curPool = pools[i];
+            const previousTokenOut = _previousTokenOut ? _previousTokenOut : tokenIn;
+            if (!involvesToken(curPool, previousTokenOut)) {
+                continue;
+            }
+            const currentTokenOut = curPool.token0.equals(previousTokenOut)
+                ? curPool.token1
+                : curPool.token0;
+            // Native currency routing through V4 is not supported
+            if (tokensVisited.has((0, util_1.getAddressLowerCase)(currentTokenOut))) {
+                continue;
+            }
+            tokensVisited.add((0, util_1.getAddressLowerCase)(currentTokenOut));
+            currentRoute.push(curPool);
+            poolsUsed[i] = true;
+            computeRoutes(tokenIn, tokenOut, currentRoute, poolsUsed, tokensVisited, currentTokenOut);
+            poolsUsed[i] = false;
+            currentRoute.pop();
+            tokensVisited.delete((0, util_1.getAddressLowerCase)(currentTokenOut));
+        }
+    };
+    computeRoutes(tokenIn, tokenOut, [], poolsUsed, new Set([(0, util_1.getAddressLowerCase)(tokenIn)]));
+    log_1.log.info({
+        routes: routes.map(routes_1.routeToString),
+        pools: pools.map(routes_1.poolToString),
+    }, `Computed ${routes.length} possible routes for type ${(_a = routes[0]) === null || _a === void 0 ? void 0 : _a.protocol}.`);
+    return routes;
+}
+exports.computeAllRoutes = computeAllRoutes;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcHV0ZS1hbGwtcm91dGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3JvdXRlcnMvYWxwaGEtcm91dGVyL2Z1bmN0aW9ucy9jb21wdXRlLWFsbC1yb3V0ZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsa0RBQTZDO0FBQzdDLGtEQUF1RDtBQUN2RCwwREFBMEQ7QUFFMUQsd0NBQW9EO0FBQ3BELDJDQUF3QztBQUN4QyxpREFBbUU7QUFDbkUseUNBQTZFO0FBRTdFLHNDQUFzQztBQUN0QywwQkFBMEI7QUFDMUIsMkJBQTJCO0FBQzNCLHFCQUFxQjtBQUNyQixvQkFBb0I7QUFDcEIsaUJBQWlCO0FBQ2pCLCtEQUErRDtBQUMvRCx3REFBd0Q7QUFDeEQsa0JBQWtCO0FBQ2xCLG1CQUFtQjtBQUNuQiwwRUFBMEU7QUFDMUUsNERBQTREO0FBQzVELFNBQVM7QUFDVCwwRUFBMEU7QUFDMUUsYUFBYTtBQUNiLGNBQWM7QUFDZCxPQUFPO0FBQ1AsSUFBSTtBQUVKLFNBQWdCLGtCQUFrQixDQUNoQyxPQUFjLEVBQ2QsUUFBZSxFQUNmLEtBQWUsRUFDZixPQUFlO0lBRWYsT0FBTyxnQkFBZ0IsQ0FDckIsT0FBTyxFQUNQLFFBQVEsRUFDUixDQUFDLEtBQWUsRUFBRSxPQUFjLEVBQUUsUUFBZSxFQUFFLEVBQUU7UUFDbkQsT0FBTyxJQUFJLGdCQUFPLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxRQUFRLENBQUMsQ0FBQztJQUMvQyxDQUFDLEVBQ0QsQ0FBQyxJQUFZLEVBQUUsS0FBWSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxFQUN6RCxLQUFLLEVBQ0wsT0FBTyxDQUNSLENBQUM7QUFDSixDQUFDO0FBaEJELGdEQWdCQztBQUVELFNBQWdCLGtCQUFrQixDQUNoQyxPQUFjLEVBQ2QsUUFBZSxFQUNmLEtBQWEsRUFDYixPQUFlO0lBRWYsT0FBTyxnQkFBZ0IsQ0FDckIsT0FBTyxFQUNQLFFBQVEsRUFDUixDQUFDLEtBQWEsRUFBRSxPQUFjLEVBQUUsUUFBZSxFQUFFLEVBQUU7UUFDakQsT0FBTyxJQUFJLGdCQUFPLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxRQUFRLENBQUMsQ0FBQztJQUMvQyxDQUFDLEVBQ0QsQ0FBQyxJQUFVLEVBQUUsS0FBWSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxFQUN2RCxLQUFLLEVBQ0wsT0FBTyxDQUNSLENBQUM7QUFDSixDQUFDO0FBaEJELGdEQWdCQztBQUVELFNBQWdCLHFCQUFxQixDQUNuQyxVQUFvQixFQUNwQixXQUFxQixFQUNyQixLQUFjLEVBQ2QsT0FBZTtJQUVmLE1BQU0sU0FBUyxHQUFHLGdCQUFnQixDQUNoQyxVQUFVLEVBQ1YsV0FBVyxFQUNYLENBQUMsS0FBYyxFQUFFLFVBQW9CLEVBQUUsV0FBcUIsRUFBRSxFQUFFO1FBQzlELE9BQU8sSUFBSSxtQkFBVSxDQUFDLEtBQUssRUFBRSxVQUFVLEVBQUUsV0FBVyxDQUFDLENBQUM7SUFDeEQsQ0FBQyxFQUNELENBQUMsSUFBVyxFQUFFLFFBQWtCLEVBQUUsRUFBRTtJQUNsQywrRUFBK0U7SUFDL0UsUUFBUSxDQUFDLFFBQVE7UUFDZixDQUFDLENBQUMsS0FBSyxDQUFDLG1EQUFtRDtRQUMzRCxDQUFDLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsRUFDbEMsS0FBSyxFQUNMLE9BQU8sQ0FDUixDQUFDO0lBQ0YsdURBQXVEO0lBQ3ZELE9BQU8sU0FBUyxDQUFDLE1BQU0sQ0FBQyxDQUFDLEtBQUssRUFBRSxFQUFFO1FBQ2hDLE9BQU87UUFDTCw4RUFBOEU7UUFDOUUsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxZQUFZLGFBQU0sQ0FBQztZQUNwRCxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLFlBQVksYUFBSSxDQUFDLENBQ25ELENBQUM7SUFDSixDQUFDLENBQUMsQ0FBQztBQUNMLENBQUM7QUE1QkQsc0RBNEJDO0FBRUQsU0FBZ0IsZ0JBQWdCLENBSzlCLE9BQWtCLEVBQ2xCLFFBQW1CLEVBQ25CLFVBSVcsRUFDWCxhQUE0RCxFQUM1RCxLQUFpQixFQUNqQixPQUFlOztJQUVmLE1BQU0sU0FBUyxHQUFHLEtBQUssQ0FBVSxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzNELE1BQU0sTUFBTSxHQUFhLEVBQUUsQ0FBQztJQUU1QixNQUFNLGFBQWEsR0FBRyxDQUNwQixPQUFrQixFQUNsQixRQUFtQixFQUNuQixZQUF3QixFQUN4QixTQUFvQixFQUNwQixhQUEwQixFQUMxQixpQkFBNkIsRUFDN0IsRUFBRTtRQUNGLElBQUksWUFBWSxDQUFDLE1BQU0sR0FBRyxPQUFPLEVBQUU7WUFDakMsT0FBTztTQUNSO1FBRUQsSUFDRSxZQUFZLENBQUMsTUFBTSxHQUFHLENBQUM7WUFDdkIsYUFBYSxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBRSxFQUFFLFFBQVEsQ0FBQyxFQUMvRDtZQUNBLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsR0FBRyxZQUFZLENBQUMsRUFBRSxPQUFPLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQztZQUM5RCxPQUFPO1NBQ1I7UUFFRCxLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsS0FBSyxDQUFDLE1BQU0sRUFBRSxDQUFDLEVBQUUsRUFBRTtZQUNyQyxJQUFJLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRTtnQkFDaEIsU0FBUzthQUNWO1lBRUQsTUFBTSxPQUFPLEdBQUcsS0FBSyxDQUFDLENBQUMsQ0FBRSxDQUFDO1lBQzFCLE1BQU0sZ0JBQWdCLEdBQUcsaUJBQWlCLENBQUMsQ0FBQyxDQUFDLGlCQUFpQixDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUM7WUFFekUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxPQUFPLEVBQUUsZ0JBQWdCLENBQUMsRUFBRTtnQkFDN0MsU0FBUzthQUNWO1lBRUQsTUFBTSxlQUFlLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsZ0JBQWdCLENBQUM7Z0JBQzdELENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTTtnQkFDaEIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUM7WUFFbkIsc0RBQXNEO1lBQ3RELElBQUksYUFBYSxDQUFDLEdBQUcsQ0FBQyxJQUFBLDBCQUFtQixFQUFDLGVBQWUsQ0FBQyxDQUFDLEVBQUU7Z0JBQzNELFNBQVM7YUFDVjtZQUVELGFBQWEsQ0FBQyxHQUFHLENBQUMsSUFBQSwwQkFBbUIsRUFBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO1lBQ3hELFlBQVksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDM0IsU0FBUyxDQUFDLENBQUMsQ0FBQyxHQUFHLElBQUksQ0FBQztZQUNwQixhQUFhLENBQ1gsT0FBTyxFQUNQLFFBQVEsRUFDUixZQUFZLEVBQ1osU0FBUyxFQUNULGFBQWEsRUFDYixlQUE0QixDQUM3QixDQUFDO1lBQ0YsU0FBUyxDQUFDLENBQUMsQ0FBQyxHQUFHLEtBQUssQ0FBQztZQUNyQixZQUFZLENBQUMsR0FBRyxFQUFFLENBQUM7WUFDbkIsYUFBYSxDQUFDLE1BQU0sQ0FBQyxJQUFBLDBCQUFtQixFQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUM7U0FDNUQ7SUFDSCxDQUFDLENBQUM7SUFFRixhQUFhLENBQ1gsT0FBTyxFQUNQLFFBQVEsRUFDUixFQUFFLEVBQ0YsU0FBUyxFQUNULElBQUksR0FBRyxDQUFDLENBQUMsSUFBQSwwQkFBbUIsRUFBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQ3hDLENBQUM7SUFFRixTQUFHLENBQUMsSUFBSSxDQUNOO1FBQ0UsTUFBTSxFQUFFLE1BQU0sQ0FBQyxHQUFHLENBQUMsc0JBQWEsQ0FBQztRQUNqQyxLQUFLLEVBQUUsS0FBSyxDQUFDLEdBQUcsQ0FBQyxxQkFBWSxDQUFDO0tBQy9CLEVBQ0QsWUFBWSxNQUFNLENBQUMsTUFBTSw2QkFBNkIsTUFBQSxNQUFNLENBQUMsQ0FBQyxDQUFDLDBDQUFFLFFBQVEsR0FBRyxDQUM3RSxDQUFDO0lBRUYsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQztBQTlGRCw0Q0E4RkMifQ==

package/build/main/routers/alpha-router/functions/get-candidate-pools.d.ts

@@ -0,0 +1,100 @@
+import { Protocol } from '@fanx-protocol/router-sdk';
+import { ChainId, Token, TradeType } from '@fanx-protocol/sdk-core';
+import { ITokenListProvider, IV2SubgraphProvider, V2SubgraphPool } from '../../../providers';
+import { ITokenProvider } from '../../../providers/token-provider';
+import { IV2PoolProvider, V2PoolAccessor } from '../../../providers/v2/pool-provider';
+import { IV3PoolProvider, V3PoolAccessor } from '../../../providers/v3/pool-provider';
+import { IV3SubgraphProvider, V3SubgraphPool } from '../../../providers/v3/subgraph-provider';
+import { AlphaRouterConfig } from '../alpha-router';
+export declare type SubgraphPool = V2SubgraphPool | V3SubgraphPool;
+export declare type CandidatePoolsBySelectionCriteria = {
+    protocol: Protocol;
+    selections: CandidatePoolsSelections;
+};
+export declare type SupportedCandidatePools = V2CandidatePools | V3CandidatePools;
+export declare type CandidatePoolsSelections = {
+    topByBaseWithTokenIn: SubgraphPool[];
+    topByBaseWithTokenOut: SubgraphPool[];
+    topByDirectSwapPool: SubgraphPool[];
+    topByEthQuoteTokenPool: SubgraphPool[];
+    topByTVL: SubgraphPool[];
+    topByTVLUsingTokenIn: SubgraphPool[];
+    topByTVLUsingTokenOut: SubgraphPool[];
+    topByTVLUsingTokenInSecondHops: SubgraphPool[];
+    topByTVLUsingTokenOutSecondHops: SubgraphPool[];
+};
+export declare type MixedCrossLiquidityCandidatePoolsParams = {
+    tokenIn: Token;
+    tokenOut: Token;
+    v2SubgraphProvider: IV2SubgraphProvider;
+    v3SubgraphProvider: IV3SubgraphProvider;
+    v2Candidates?: V2CandidatePools;
+    v3Candidates?: V3CandidatePools;
+    blockNumber?: number | Promise<number>;
+};
+export declare type V3GetCandidatePoolsParams = {
+    tokenIn: Token;
+    tokenOut: Token;
+    routeType: TradeType;
+    routingConfig: AlphaRouterConfig;
+    subgraphProvider: IV3SubgraphProvider;
+    tokenProvider: ITokenProvider;
+    poolProvider: IV3PoolProvider;
+    blockedTokenListProvider?: ITokenListProvider;
+    chainId: ChainId;
+};
+export declare type V2GetCandidatePoolsParams = {
+    tokenIn: Token;
+    tokenOut: Token;
+    routeType: TradeType;
+    routingConfig: AlphaRouterConfig;
+    subgraphProvider: IV2SubgraphProvider;
+    tokenProvider: ITokenProvider;
+    poolProvider: IV2PoolProvider;
+    blockedTokenListProvider?: ITokenListProvider;
+    chainId: ChainId;
+};
+export declare type MixedRouteGetCandidatePoolsParams = {
+    v3CandidatePools: V3CandidatePools;
+    v2CandidatePools: V2CandidatePools;
+    crossLiquidityPools: CrossLiquidityCandidatePools;
+    routingConfig: AlphaRouterConfig;
+    tokenProvider: ITokenProvider;
+    v2poolProvider: IV2PoolProvider;
+    v3poolProvider: IV3PoolProvider;
+    blockedTokenListProvider?: ITokenListProvider;
+    chainId: ChainId;
+};
+export declare type CrossLiquidityCandidatePools = {
+    v2Pools: V2SubgraphPool[];
+    v3Pools: V3SubgraphPool[];
+};
+/**
+ * Function that finds any missing pools that were not selected by the heuristic but that would
+ *   create a route with the topPool by TVL with either tokenIn or tokenOut across protocols.
+ *
+ *   e.g. In V2CandidatePools we found that wstETH/DOG is the most liquid pool,
+ *        then in V3CandidatePools ETH/wstETH is *not* the most liquid pool, so it is not selected
+ *        This process will look for that pool in order to complete the route.
+ *
+ */
+export declare function getMixedCrossLiquidityCandidatePools({ tokenIn, tokenOut, blockNumber, v2SubgraphProvider, v3SubgraphProvider, v2Candidates, v3Candidates, }: MixedCrossLiquidityCandidatePoolsParams): Promise<CrossLiquidityCandidatePools>;
+export declare type V3CandidatePools = {
+    poolAccessor: V3PoolAccessor;
+    candidatePools: CandidatePoolsBySelectionCriteria;
+    subgraphPools: V3SubgraphPool[];
+};
+export declare function getV3CandidatePools({ tokenIn, tokenOut, routingConfig, subgraphProvider, tokenProvider, poolProvider, blockedTokenListProvider, chainId, }: V3GetCandidatePoolsParams): Promise<V3CandidatePools>;
+export declare type V2CandidatePools = {
+    poolAccessor: V2PoolAccessor;
+    candidatePools: CandidatePoolsBySelectionCriteria;
+    subgraphPools: V2SubgraphPool[];
+};
+export declare function getV2CandidatePools({ tokenIn, tokenOut, routeType, routingConfig, subgraphProvider, tokenProvider, poolProvider, blockedTokenListProvider, chainId, }: V2GetCandidatePoolsParams): Promise<V2CandidatePools>;
+export declare type MixedCandidatePools = {
+    V2poolAccessor: V2PoolAccessor;
+    V3poolAccessor: V3PoolAccessor;
+    candidatePools: CandidatePoolsBySelectionCriteria;
+    subgraphPools: SubgraphPool[];
+};
+export declare function getMixedRouteCandidatePools({ v3CandidatePools, v2CandidatePools, crossLiquidityPools, routingConfig, tokenProvider, v3poolProvider, v2poolProvider, }: MixedRouteGetCandidatePoolsParams): Promise<MixedCandidatePools>;