@fanx-protocol/smart-order-router 0.0.1

package/README.md

@@ -0,0 +1,273 @@
+# Uniswap Smart Order Router
+
+This repository contains routing logic for the Uniswap V3 protocol.
+
+It searches for the most efficient way to swap token A for token B, considering splitting swaps across multiple routes and gas costs.
+
+## Testing
+
+### Unit Tests
+
+First make sure you have run `npm install` and `npm run build`.
+
+```
+npm run test
+```
+
+### Integration Tests
+
+Make sure the `.env` file is configured to connect to mainnet and other chains. See the [CLI](#cli) section below for more details.
+
+```
+npm run integ-test
+```
+
+### Tenderly Simulations
+
+Quotes can be simulated on Tenderly
+
+Ensure you set the following environment variables:
+
+```
+process.env.TENDERLY_BASE_URL!,
+process.env.TENDERLY_USER!,
+process.env.TENDERLY_PROJECT!,
+process.env.TENDERLY_ACCESS_KEY!,
+```
+
+### CLI
+
+The package can be run as a CLI for testing purposes.
+
+First create a `.env` file in the root of the project and configure:
+
+```
+JSON_RPC_PROVIDER = '<JSON_RPC_PROVIDER>'
+```
+
+To run on chains other than mainnet set up a connection by specifying the environment variable
+
+```
+JSON_RPC_PROVIDER_GORLI = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_OPTIMISM = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_OPTIMISM_GOERLI = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_ARBITRUM_ONE = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_ARBITRUM_GOERLI = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_POLYGON = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_POLYGON_MUMBAI = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_CELO = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_CELO_ALFAJORES = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_BNB = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_AVALANCHE = '<JSON_RPC_PROVIDER>'
+JSON_RPC_PROVIDER_BASE = '<JSON_RPC_PROVIDER>'
+```
+
+Then from the root directory you can execute the CLI.
+
+## Examples
+
+Some examples to use for manual CLI testing.
+
+### Mainnet
+
+```
+./bin/cli quote --tokenIn 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 --tokenOut 0x1f9840a85d5af5bf1d1762f925bdaddc4201f984 --amount 1000 --exactIn --recipient 0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B --protocols v2,v3
+
+Best Route:
+100.00% = USDC -- 0.3% --> UNI
+	Raw Quote Out:
+		35.72
+	Gas Adjusted Quote Out:
+		34.03
+
+Gas Used Quote Token: 1.691772
+Gas Used USD: 47.592951
+Calldata: 0x414bf389000000000000...
+Value: 0x00
+
+  blockNumber: "13088815"
+  estimatedGasUsed: "113000"
+  gasPriceWei: "130000000000"
+
+
+./bin/cli quote-to-ratio --token0 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 --token1 0xdac17f958d2ee523a2206206994597c13d831ec7 --feeAmount 3000 --recipient 0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B  --token0Balance 1000 --token1Balance 2000 --tickLower -120 --tickUpper 120
+
+Best Route:
+100.00% = USDT -- 0.05% --> USDC
+Raw Quote Exact In:
+	392.68
+Gas Adjusted Quote In}:
+	346.13
+
+Gas Used Quote Token: 46.550010
+Gas Used USD: 46.342899
+Calldata: 0x414bf389000000000000000000000000dac17f958d2ee523a2206206994597c13d831ec7000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb4800000000000000000000000000000000000000000000000000000000000001f4000000000000000000000000ab5801a7d398351b8be11c439e05c5b3259aec9b000000000000000000000000000000000000000000000000000000000000006400000000000000000000000000000000000000000000000000000000176a736c000000000000000000000000000000000000000000000000000000001764f8650000000000000000000000000000000000000000000000000000000000000000
+	Value: 0x00
+
+	blockNumber: "13239188"
+	estimatedGasUsed: "113000"
+	gasPriceWei: "116690684398"
+
+./bin/cli quote --tokenIn 0x0391D2021f89DC339F60Fff84546EA23E337750f --tokenOut 0x4d224452801ACEd8B2F0aebE155379bb5D594381 --amount 10000 --exactIn --recipient 0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B --protocols v2,v3,mixed
+Best Route:
+[V2 + V3] 100.00% = BOND -- [0x6591c4BcD6D7A1eb4E537DA8B78676C1576Ba244] --> USDC -- 0.3% [0xB07Fe2F407F971125D4EB1977f8aCEe8846C7324] --> APE
+	Raw Quote Exact In:
+		10437.85
+	Gas Adjusted Quote In:
+		10433.83
+
+Gas Used Quote Token: 4.018625
+Gas Used USD: 29.669402
+Calldata: 0x5ae401dc0000000000000000000000000000000000000000000000000000000000000064000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000016000000000000000000000000000000000000000000000000000000000000000e4472b43f300000000000000000000000000000000000000000000021e19e0c9bab240000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000391d2021f89dc339f60fff84546ea23e337750f000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000104b858183f00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000080000000000000000000000000ab5801a7d398351b8be11c439e05c5b3259aec9b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002358df5b3b4459a3f5b000000000000000000000000000000000000000000000000000000000000002ba0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000bb84d224452801aced8b2f0aebe155379bb5d59438100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+Value: 0x00
+
+  blockNumber: "15303839"
+  estimatedGasUsed: "434000"
+  gasPriceWei: "38218865879"
+Total ticks crossed: 7
+```
+
+## Rinkeby
+
+```
+./bin/cli quote --tokenIn 0x5592ec0cfb4dbc12d3ab100b257153436a1f0fea --tokenOut 0x4DBCdF9B62e891a7cec5A2568C3F4FAF9E8Abe2b --amount 200000 --exactIn --minSplits 1 --router alpha --chainId 4
+```
+
+## Sepolia
+
+```
+./bin/cli quote --tokenIn 0x7AF17A48a6336F7dc1beF9D485139f7B6f4FB5C8 --tokenOut 0x6f14C02Fc1F78322cFd7d707aB90f18baD3B54f5 --amount 10 --exactIn --minSplits 1 --router alpha --chainId 11155111
+```
+
+## Kovan
+
+```
+./bin/cli quote --tokenIn 0x4f96fe3b7a6cf9725f59d353f723c1bdb64ca6aa --tokenOut 0xd0a1e359811322d97991e03f863a0c30c2cf029c --amount 10 --exactIn --minSplits 1 --router alpha --chainId 42
+```
+
+## Ropsten
+
+```
+./bin/cli quote --tokenIn 0x07865c6e87b9f70255377e024ace6630c1eaa37f --tokenOut 0xc778417e063141139fce010982780140aa0cd5ab --amount 200000 --exactIn --minSplits 1 --router alpha --chainId 3
+```
+
+## Optimism
+
+```
+./bin/cli quote --tokenIn 0x7F5c764cBc14f9669B88837ca1490cCa17c31607 --tokenOut 0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1 --amount 200000 --exactIn --minSplits 1 --router alpha --chainId 10
+
+```
+
+```
+./bin/cli quote --tokenIn 0x7F5c764cBc14f9669B88837ca1490cCa17c31607 --tokenOut 0x4200000000000000000000000000000000000042 --amount 1 --exactIn --minSplits 1 --protocols v2 --router alpha --chainId 10
+```
+
+
+## Optimism-Goerli
+
+```
+./bin/cli quote --tokenIn 0x7E07E15D2a87A24492740D16f5bdF58c16db0c4E --tokenOut 0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1 --amount 200000 --exactIn --minSplits 1 --router alpha --chainId 420
+```
+
+## Optimistic-Kovan
+
+```
+./bin/cli quote --tokenIn 0x7F5c764cBc14f9669B88837ca1490cCa17c31607 --tokenOut 0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1 --amount 200 --exactIn --minSplits 1 --router alpha --chainId 69
+```
+
+## Arbitrum
+
+```
+./bin/cli quote --tokenIn 0xfd086bc7cd5c481dcc9c85ebe478a1c0b69fcbb9 --tokenOut 0x82af49447d8a07e3bd95bd0d56f35241523fbab1 --amount 20000 --exactIn --minSplits 1 --router alpha --chainId 42161 --debug
+```
+
+## Arbitrum-Rinkeby
+
+```
+./bin/cli quote --tokenIn 0x09b98f8b2395d076514037ff7d39a091a536206c --tokenOut 0xb47e6a5f8b33b3f17603c83a0535a9dcd7e32681 --amount 200 --exactIn --minSplits 1 --router alpha --chainId 421611
+```
+
+## Arbitrum-Goerli
+
+```
+./bin/cli quote --tokenIn 0xe39ab88f8a4777030a534146a9ca3b52bd5d43a3 --tokenOut 0x8FB1E3fC51F3b789dED7557E680551d93Ea9d892 --amount 200 --exactIn --minSplits 1 --router alpha --chainId 421613
+```
+
+## Polygon Mumbai
+
+```
+./bin/cli quote --tokenIn 0x001b3b4d0f3714ca98ba10f6042daebf0b1b7b6f --tokenOut 0x9c3c9283d3e44854697cd22d3faa240cfb032889 --amount 1 --exactIn --protocols v3 --recipient 0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B --minSplits 1 --router alpha --chainId 80001
+```
+
+## Polygon Mainnet
+
+```
+./bin/cli quote --tokenIn 0x2791bca1f2de4661ed88a30c99a7a9449aa84174 --tokenOut 0x7ceb23fd6bc0add59e62ac25578270cff1b9f619 --amount 5 --exactIn --minSplits 1 --protocols v3 --router alpha --chainId 137
+```
+
+## Celo Mainnet
+
+```
+./bin/cli quote --tokenIn CELO --tokenOut 0x765DE816845861e75A25fCA122bb6898B8B1282a --amount 5 --exactIn --minSplits 1 --protocols v3 --router alpha --chainId 42220
+```
+
+## BNB Mainnet
+
+```
+./bin/cli quote --tokenIn 0x55d398326f99059fF775485246999027B3197955 --tokenOut 0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d --amount 1 --exactIn --minSplits 1 --protocols v3 --router alpha --chainId 56
+```
+
+## AVAX Mainnet
+
+```
+./bin/cli quote --tokenIn 0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E --tokenOut 0xB31f66AA3C1e785363F0875A1B74E27b85FD66c7 --amount 1000 --exactIn --minSplits 1 --protocols v3 --router alpha --chainId 43114
+```
+
+## BASE Mainnet
+
+```
+./bin/cli quote --tokenIn 0xd9aAEc86B65D86f6A7B5B1b0c42FFA531710b6CA --tokenOut 0x4200000000000000000000000000000000000006 --amount 10 --exactIn --minSplits 1 --protocols v3 --router alpha --chainId 8453
+```
+
+## ZKSYNC Mainnet
+
+```
+./bin/cli quote --tokenIn 0x5aea5775959fbc2557cc8789bc1bf90a239d9a91 --tokenOut 0x1d17cbcf0d6d143135ae902365d2e5e2a16538d4 --amount 10 --exactIn --minSplits 1 --protocols v3 --router alpha --chainId 324
+```
+
+
+## Adding a new Chain
+
+The main components to complete are:
+
+- Deploy contracts on chain, add the pools to subgraph
+- Populate v3 providers in `src/providers/v3/subgraph-provider` and `src/providers/v3/static-subgraph-provider`
+- Populate chainId and addresses in `src/util/chains.ts` and `src/util/addresses.ts`
+- Populate token providers in `src/providers/caching-token-provider` and `src/providers/token-provider.ts`
+- Populate gas constants in `src/routers/alpha-router/gas-models/*`
+- Populate bases in `src/routers/legacy-router/bases.ts`
+- Populate `test/integ/routers/alpha-router/alpha-router.integration.test.ts` and `src/providers/v2/static-subgraph-provider.ts`
+- Populate `src/routers/alpha-router/*`
+- Add a log to `/CHANGELOG.md`
+- Run `npm run integ-test` successfully
+
+# Troubleshooting
+
+## ProviderGasLimit errors
+
+The package sends many large multicall requests to nodes. You must ensure that your node provider's `eth_call` gas limit is high enough to successfully process the RPC calls.
+
+By default each `eth_call` will consume up to:
+
+- 132,000,000 gas on Optimism
+- 120,000,000 gas on Arbitrum
+- 50,000,000 gas on Celo
+- 150,000,000 gas on every other network (Mainnet, Goerli, etc.)
+
+These parameters should work on Infura and Alchemy by default.
+
+This total amount of gas each `eth_call` can consume is equal to the `multicallChunk` config value multiplied by the `gasLimitPerCall` config value. If you are using a node provider with a lower gas limit per `eth_call` you will need to override the default `V3QuoteProvider` with an instance that lowers the `multicallChunk` and `gasLimitPerCall` parameters such that the multiplication is below your node providers limit. Lowering these values will cause each multicall to consume less gas. See [here](https://github.com/Uniswap/smart-order-router/blob/98c58bdee9981fd9ffac9e7d7a97b18302d5f77a/src/routers/alpha-router/alpha-router.ts#L415-L416) for examples of how to set these values. Note some providers have different limits per chain.
+
+If you are running your own node, we recommend you configure start your node with a higher gas limit per call. For example, on Geth you can use the command line argument `--rpc.gascap 150000000` to raise the limit to 150m, which is enough to run the default configuration of this package.
+
+If you are using Hardhat mainnet forking, you should add `blockGasLimit: 150_000_000` to your Hardhat config to use the default package configuration.

package/build/main/index.d.ts

@@ -0,0 +1,3 @@
+export * from './providers';
+export * from './routers';
+export * from './util';

package/build/main/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./providers"), exports);
+__exportStar(require("./routers"), exports);
+__exportStar(require("./util"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDhDQUE0QjtBQUM1Qiw0Q0FBMEI7QUFDMUIseUNBQXVCIn0=

package/build/main/providers/cache-node.d.ts

@@ -0,0 +1,10 @@
+import NodeCache from 'node-cache';
+import { ICache } from './cache';
+export declare class NodeJSCache<T> implements ICache<T> {
+    private nodeCache;
+    constructor(nodeCache: NodeCache);
+    get(key: string): Promise<T | undefined>;
+    batchGet(keys: Set<string>): Promise<Record<string, T | undefined>>;
+    set(key: string, value: T, ttl?: number): Promise<boolean>;
+    has(key: string): Promise<boolean>;
+}

package/build/main/providers/cache-node.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeJSCache = void 0;
+class NodeJSCache {
+    constructor(nodeCache) {
+        this.nodeCache = nodeCache;
+    }
+    async get(key) {
+        return this.nodeCache.get(key);
+    }
+    async batchGet(keys) {
+        const keysArr = Array.from(keys);
+        const values = await Promise.all(keysArr.map((key) => this.get(key)));
+        const result = {};
+        keysArr.forEach((key, index) => {
+            result[key] = values[index];
+        });
+        return result;
+    }
+    async set(key, value, ttl) {
+        if (ttl) {
+            return this.nodeCache.set(key, value, ttl);
+        }
+        else {
+            return this.nodeCache.set(key, value);
+        }
+    }
+    async has(key) {
+        return this.nodeCache.has(key);
+    }
+}
+exports.NodeJSCache = NodeJSCache;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGUtbm9kZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wcm92aWRlcnMvY2FjaGUtbm9kZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFJQSxNQUFhLFdBQVc7SUFDdEIsWUFBb0IsU0FBb0I7UUFBcEIsY0FBUyxHQUFULFNBQVMsQ0FBVztJQUFHLENBQUM7SUFFNUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFXO1FBQ25CLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUksR0FBRyxDQUFDLENBQUM7SUFDcEMsQ0FBQztJQUVELEtBQUssQ0FBQyxRQUFRLENBQUMsSUFBaUI7UUFDOUIsTUFBTSxPQUFPLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNqQyxNQUFNLE1BQU0sR0FBRyxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFFdEUsTUFBTSxNQUFNLEdBQWtDLEVBQUUsQ0FBQztRQUVqRCxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxFQUFFLEtBQUssRUFBRSxFQUFFO1lBQzdCLE1BQU0sQ0FBQyxHQUFHLENBQUMsR0FBRyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDOUIsQ0FBQyxDQUFDLENBQUM7UUFFSCxPQUFPLE1BQU0sQ0FBQztJQUNoQixDQUFDO0lBRUQsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFXLEVBQUUsS0FBUSxFQUFFLEdBQVk7UUFDM0MsSUFBSSxHQUFHLEVBQUU7WUFDUCxPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUM7U0FDNUM7YUFBTTtZQUNMLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxDQUFDO1NBQ3ZDO0lBQ0gsQ0FBQztJQUVELEtBQUssQ0FBQyxHQUFHLENBQUMsR0FBVztRQUNuQixPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7Q0FDRjtBQS9CRCxrQ0ErQkMifQ==

package/build/main/providers/cache.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generic cache used by providers. Allows caching of results to minimize
+ * round trips to external data sources.
+ *
+ * @export
+ * @interface ICache
+ * @template T
+ */
+export interface ICache<T> {
+    get(key: string): Promise<T | undefined>;
+    batchGet(keys: Set<string>): Promise<Record<string, T | undefined>>;
+    set(key: string, value: T, ttl?: number): Promise<boolean>;
+    has(key: string): Promise<boolean>;
+}

package/build/main/providers/cache.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcHJvdmlkZXJzL2NhY2hlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/build/main/providers/caching/route/index.d.ts

@@ -0,0 +1,2 @@
+export * from './model/';
+export * from './route-caching-provider';

package/build/main/providers/caching/route/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./model/"), exports);
+__exportStar(require("./route-caching-provider"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvcHJvdmlkZXJzL2NhY2hpbmcvcm91dGUvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDJDQUF5QjtBQUN6QiwyREFBeUMifQ==

package/build/main/providers/caching/route/model/cache-mode.d.ts

@@ -0,0 +1,16 @@
+/**
+ * CacheMode enum that controls the way that the RouteCachingProvider works.
+ * - *Livemode*:   This mode will set materialized routes into cache and fetch routes from cache.
+ *                 If the route exists in cache, it will be quoted and returned, otherwise it will materialized.
+ * - *Darkmode*:   This mode indicates that the cache will not be used, it will not be inserted nor fetched.
+ *                 Routes will always be materialized.
+ * - *Tapcompare*: In this mode we will insert and fetch routes to/from cache, and we will also materialize the route.
+ *                 Ultimately the materialized route will be returned, but we will log some metrics comparing both.
+ *
+ * @enum {string}
+ */
+export declare enum CacheMode {
+    Livemode = "livemode",
+    Darkmode = "darkmode",
+    Tapcompare = "tapcompare"
+}

package/build/main/providers/caching/route/model/cache-mode.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheMode = void 0;
+/**
+ * CacheMode enum that controls the way that the RouteCachingProvider works.
+ * - *Livemode*:   This mode will set materialized routes into cache and fetch routes from cache.
+ *                 If the route exists in cache, it will be quoted and returned, otherwise it will materialized.
+ * - *Darkmode*:   This mode indicates that the cache will not be used, it will not be inserted nor fetched.
+ *                 Routes will always be materialized.
+ * - *Tapcompare*: In this mode we will insert and fetch routes to/from cache, and we will also materialize the route.
+ *                 Ultimately the materialized route will be returned, but we will log some metrics comparing both.
+ *
+ * @enum {string}
+ */
+var CacheMode;
+(function (CacheMode) {
+    CacheMode["Livemode"] = "livemode";
+    CacheMode["Darkmode"] = "darkmode";
+    CacheMode["Tapcompare"] = "tapcompare";
+})(CacheMode = exports.CacheMode || (exports.CacheMode = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGUtbW9kZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvY2FjaGluZy9yb3V0ZS9tb2RlbC9jYWNoZS1tb2RlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7Ozs7Ozs7O0dBVUc7QUFDSCxJQUFZLFNBSVg7QUFKRCxXQUFZLFNBQVM7SUFDbkIsa0NBQXFCLENBQUE7SUFDckIsa0NBQXFCLENBQUE7SUFDckIsc0NBQXlCLENBQUE7QUFDM0IsQ0FBQyxFQUpXLFNBQVMsR0FBVCxpQkFBUyxLQUFULGlCQUFTLFFBSXBCIn0=

package/build/main/providers/caching/route/model/cached-route.d.ts

@@ -0,0 +1,29 @@
+import { Protocol } from '@fanx-protocol/router-sdk';
+import { Token } from '@fanx-protocol/sdk-core';
+import { SupportedRoutes } from '../../../../routers';
+interface CachedRouteParams<Route extends SupportedRoutes> {
+    route: Route;
+    percent: number;
+}
+/**
+ * Class defining the route to cache
+ *
+ * @export
+ * @class CachedRoute
+ */
+export declare class CachedRoute<Route extends SupportedRoutes> {
+    readonly route: Route;
+    readonly percent: number;
+    private hashCode;
+    /**
+     * @param route
+     * @param percent
+     */
+    constructor({ route, percent }: CachedRouteParams<Route>);
+    get protocol(): Protocol;
+    get tokenIn(): Token;
+    get tokenOut(): Token;
+    get routePath(): string;
+    get routeId(): number;
+}
+export {};

package/build/main/providers/caching/route/model/cached-route.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachedRoute = void 0;
+const router_sdk_1 = require("@fanx-protocol/router-sdk");
+const v2_sdk_1 = require("@fanx-protocol/v2-sdk");
+const v3_sdk_1 = require("@fanx-protocol/v3-sdk");
+/**
+ * Class defining the route to cache
+ *
+ * @export
+ * @class CachedRoute
+ */
+class CachedRoute {
+    /**
+     * @param route
+     * @param percent
+     */
+    constructor({ route, percent }) {
+        // Hashing function copying the same implementation as Java's `hashCode`
+        // Sourced from: https://gist.github.com/hyamamoto/fd435505d29ebfa3d9716fd2be8d42f0?permalink_comment_id=4613539#gistcomment-4613539
+        this.hashCode = (str) => [...str].reduce((s, c) => (Math.imul(31, s) + c.charCodeAt(0)) | 0, 0);
+        this.route = route;
+        this.percent = percent;
+    }
+    get protocol() {
+        return this.route.protocol;
+    }
+    // TODO: ROUTE-217 - Support native currency routing in V4
+    get tokenIn() {
+        return this.route.input.wrapped;
+    }
+    // TODO: ROUTE-217 - Support native currency routing in V4
+    get tokenOut() {
+        return this.route.output.wrapped;
+    }
+    get routePath() {
+        switch (this.protocol) {
+            // case Protocol.V4:
+            //   // TODO: ROUTE-217 - Support native currency routing in V4
+            //   return (this.route as V4Route).pools
+            //     .map(
+            //       (pool) =>
+            //         `[V4]${pool.token0.wrapped.address}/${pool.token1.wrapped.address}`
+            //     )
+            //     .join('->');
+            case router_sdk_1.Protocol.V3:
+                return this.route.pools
+                    .map((pool) => `[V3]${pool.token0.address}/${pool.token1.address}/${pool.fee}`)
+                    .join('->');
+            case router_sdk_1.Protocol.V2:
+                return this.route.pairs
+                    .map((pair) => `[V2]${pair.token0.address}/${pair.token1.address}`)
+                    .join('->');
+            case router_sdk_1.Protocol.MIXED:
+                return this.route.pools
+                    .map((pool) => {
+                    // if (pool instanceof V4Pool) {
+                    //   // TODO: ROUTE-217 - Support native currency routing in V4
+                    //   return `[V4]${
+                    //     pool.token0.isToken
+                    //       ? pool.token0.wrapped.address
+                    //       : pool.token0.symbol
+                    //   }/${
+                    //     pool.token1.isToken
+                    //       ? pool.token1.wrapped.address
+                    //       : pool.token1.symbol
+                    //   }`;
+                    // } else
+                    if (pool instanceof v3_sdk_1.Pool) {
+                        return `[V3]${pool.token0.address}/${pool.token1.address}/${pool.fee}`;
+                    }
+                    else if (pool instanceof v2_sdk_1.Pair) {
+                        return `[V2]${pool.token0.address}/${pool.token1.address}`;
+                    }
+                    else {
+                        throw new Error(`Unsupported pool type ${JSON.stringify(pool)}`);
+                    }
+                })
+                    .join('->');
+            default:
+                throw new Error(`Unsupported protocol ${this.protocol}`);
+        }
+    }
+    get routeId() {
+        return this.hashCode(this.routePath);
+    }
+}
+exports.CachedRoute = CachedRoute;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGVkLXJvdXRlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9jYWNoaW5nL3JvdXRlL21vZGVsL2NhY2hlZC1yb3V0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwwREFBcUQ7QUFFckQsa0RBQTZDO0FBQzdDLGtEQUF1RDtBQWV2RDs7Ozs7R0FLRztBQUNILE1BQWEsV0FBVztJQVF0Qjs7O09BR0c7SUFDSCxZQUFZLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBNEI7UUFUeEQsd0VBQXdFO1FBQ3hFLG9JQUFvSTtRQUM1SCxhQUFRLEdBQUcsQ0FBQyxHQUFXLEVBQUUsRUFBRSxDQUNqQyxDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBT3ZFLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDO1FBQ25CLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFFRCxJQUFXLFFBQVE7UUFDakIsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQztJQUM3QixDQUFDO0lBRUQsMERBQTBEO0lBQzFELElBQVcsT0FBTztRQUNoQixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQztJQUNsQyxDQUFDO0lBRUQsMERBQTBEO0lBQzFELElBQVcsUUFBUTtRQUNqQixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQztJQUNuQyxDQUFDO0lBRUQsSUFBVyxTQUFTO1FBQ2xCLFFBQVEsSUFBSSxDQUFDLFFBQVEsRUFBRTtZQUNyQixvQkFBb0I7WUFDcEIsK0RBQStEO1lBQy9ELHlDQUF5QztZQUN6QyxZQUFZO1lBQ1osa0JBQWtCO1lBQ2xCLDhFQUE4RTtZQUM5RSxRQUFRO1lBQ1IsbUJBQW1CO1lBQ25CLEtBQUsscUJBQVEsQ0FBQyxFQUFFO2dCQUNkLE9BQVEsSUFBSSxDQUFDLEtBQWlCLENBQUMsS0FBSztxQkFDakMsR0FBRyxDQUNGLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FDUCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FDbEU7cUJBQ0EsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2hCLEtBQUsscUJBQVEsQ0FBQyxFQUFFO2dCQUNkLE9BQVEsSUFBSSxDQUFDLEtBQWlCLENBQUMsS0FBSztxQkFDakMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxFQUFFLENBQUM7cUJBQ2xFLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUNoQixLQUFLLHFCQUFRLENBQUMsS0FBSztnQkFDakIsT0FBUSxJQUFJLENBQUMsS0FBb0IsQ0FBQyxLQUFLO3FCQUNwQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRTtvQkFDWixnQ0FBZ0M7b0JBQ2hDLCtEQUErRDtvQkFDL0QsbUJBQW1CO29CQUNuQiwwQkFBMEI7b0JBQzFCLHNDQUFzQztvQkFDdEMsNkJBQTZCO29CQUM3QixTQUFTO29CQUNULDBCQUEwQjtvQkFDMUIsc0NBQXNDO29CQUN0Qyw2QkFBNkI7b0JBQzdCLFFBQVE7b0JBQ1IsU0FBUztvQkFDVCxJQUFJLElBQUksWUFBWSxhQUFNLEVBQUU7d0JBQzFCLE9BQU8sT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sSUFBSSxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7cUJBQ3hFO3lCQUFNLElBQUksSUFBSSxZQUFZLGFBQUksRUFBRTt3QkFDL0IsT0FBTyxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxFQUFFLENBQUM7cUJBQzVEO3lCQUFNO3dCQUNMLE1BQU0sSUFBSSxLQUFLLENBQUMseUJBQXlCLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO3FCQUNsRTtnQkFDSCxDQUFDLENBQUM7cUJBQ0QsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2hCO2dCQUNFLE1BQU0sSUFBSSxLQUFLLENBQUMsd0JBQXdCLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1NBQzVEO0lBQ0gsQ0FBQztJQUVELElBQVcsT0FBTztRQUNoQixPQUFPLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ3ZDLENBQUM7Q0FDRjtBQXBGRCxrQ0FvRkMifQ==

package/build/main/providers/caching/route/model/cached-routes.d.ts

@@ -0,0 +1,67 @@
+import { Protocol } from '@fanx-protocol/router-sdk';
+import { ChainId, Currency, TradeType } from '@fanx-protocol/sdk-core';
+import { RouteWithValidQuote, SupportedRoutes } from '../../../../routers';
+import { CachedRoute } from './cached-route';
+interface CachedRoutesParams {
+    routes: CachedRoute<SupportedRoutes>[];
+    chainId: ChainId;
+    currencyIn: Currency;
+    currencyOut: Currency;
+    protocolsCovered: Protocol[];
+    blockNumber: number;
+    tradeType: TradeType;
+    originalAmount: string;
+    blocksToLive?: number;
+}
+/**
+ * Class defining the route to cache
+ *
+ * @export
+ * @class CachedRoute
+ */
+export declare class CachedRoutes {
+    readonly routes: CachedRoute<SupportedRoutes>[];
+    readonly chainId: ChainId;
+    readonly currencyIn: Currency;
+    readonly currencyOut: Currency;
+    readonly protocolsCovered: Protocol[];
+    readonly blockNumber: number;
+    readonly tradeType: TradeType;
+    readonly originalAmount: string;
+    blocksToLive: number;
+    /**
+     * @param routes
+     * @param chainId
+     * @param currencyIn
+     * @param currencyOut
+     * @param protocolsCovered
+     * @param blockNumber
+     * @param tradeType
+     * @param originalAmount
+     * @param blocksToLive
+     */
+    constructor({ routes, chainId, currencyIn, currencyOut, protocolsCovered, blockNumber, tradeType, originalAmount, blocksToLive, }: CachedRoutesParams);
+    /**
+     * Factory method that creates a `CachedRoutes` object from an array of RouteWithValidQuote.
+     *
+     * @public
+     * @static
+     * @param routes
+     * @param chainId
+     * @param currencyIn
+     * @param currencyOut
+     * @param protocolsCovered
+     * @param blockNumber
+     * @param tradeType
+     * @param originalAmount
+     */
+    static fromRoutesWithValidQuotes(routes: RouteWithValidQuote[], chainId: ChainId, currencyIn: Currency, currencyOut: Currency, protocolsCovered: Protocol[], blockNumber: number, tradeType: TradeType, originalAmount: string): CachedRoutes | undefined;
+    /**
+     * Function to determine if, given a block number, the CachedRoute is expired or not.
+     *
+     * @param currentBlockNumber
+     * @param optimistic
+     */
+    notExpired(currentBlockNumber: number, optimistic?: boolean): boolean;
+}
+export {};