@uniswap/universal-router-sdk 4.18.1 → 4.19.1

package/dist/{swapRouter.d.ts → cjs/src/swapRouter.d.ts}

@@ -1,37 +1,37 @@
-import { Interface } from '@ethersproject/abi';
-import { BigNumberish } from 'ethers';
-import { MethodParameters, Position as V3Position, RemoveLiquidityOptions as V3RemoveLiquidityOptions } from '@uniswap/v3-sdk';
-import { Position as V4Position, AddLiquidityOptions as V4AddLiquidityOptions } from '@uniswap/v4-sdk';
-import { Trade as RouterTrade } from '@uniswap/router-sdk';
-import { Currency, TradeType } from '@uniswap/sdk-core';
-import { SwapOptions } from './entities/actions/uniswap';
-export declare type SwapRouterConfig = {
-    sender?: string;
-    deadline?: BigNumberish;
-};
-export interface MigrateV3ToV4Options {
-    inputPosition: V3Position;
-    outputPosition: V4Position;
-    v3RemoveLiquidityOptions: V3RemoveLiquidityOptions;
-    v4AddLiquidityOptions: V4AddLiquidityOptions;
-}
-export declare abstract class SwapRouter {
-    static INTERFACE: Interface;
-    static swapCallParameters(trades: RouterTrade<Currency, Currency, TradeType>, options: SwapOptions): MethodParameters;
-    /**
-     * Builds the call parameters for a migration from a V3 position to a V4 position.
-     * Some requirements of the parameters:
-     *   - v3RemoveLiquidityOptions.collectOptions.recipient must equal v4PositionManager
-     *   - v3RemoveLiquidityOptions.liquidityPercentage must be 100%
-     *   - input pool and output pool must have the same tokens
-     *   - V3 NFT must be approved, or valid inputV3NFTPermit must be provided with UR as spender
-     */
-    static migrateV3ToV4CallParameters(options: MigrateV3ToV4Options, positionManagerOverride?: string): MethodParameters;
-    /**
-     * Encodes a planned route into a method name and parameters for the Router contract.
-     * @param planner the planned route
-     * @param nativeCurrencyValue the native currency value of the planned route
-     * @param config the router config
-     */
-    private static encodePlan;
-}
+import { Interface } from '@ethersproject/abi';
+import { BigNumberish } from 'ethers';
+import { MethodParameters, Position as V3Position, RemoveLiquidityOptions as V3RemoveLiquidityOptions } from '@uniswap/v3-sdk';
+import { Position as V4Position, AddLiquidityOptions as V4AddLiquidityOptions } from '@uniswap/v4-sdk';
+import { Trade as RouterTrade } from '@uniswap/router-sdk';
+import { Currency, TradeType } from '@uniswap/sdk-core';
+import { SwapOptions } from './entities/actions/uniswap';
+export type SwapRouterConfig = {
+    sender?: string;
+    deadline?: BigNumberish;
+};
+export interface MigrateV3ToV4Options {
+    inputPosition: V3Position;
+    outputPosition: V4Position;
+    v3RemoveLiquidityOptions: V3RemoveLiquidityOptions;
+    v4AddLiquidityOptions: V4AddLiquidityOptions;
+}
+export declare abstract class SwapRouter {
+    static INTERFACE: Interface;
+    static swapCallParameters(trades: RouterTrade<Currency, Currency, TradeType>, options: SwapOptions): MethodParameters;
+    /**
+     * Builds the call parameters for a migration from a V3 position to a V4 position.
+     * Some requirements of the parameters:
+     *   - v3RemoveLiquidityOptions.collectOptions.recipient must equal v4PositionManager
+     *   - v3RemoveLiquidityOptions.liquidityPercentage must be 100%
+     *   - input pool and output pool must have the same tokens
+     *   - V3 NFT must be approved, or valid inputV3NFTPermit must be provided with UR as spender
+     */
+    static migrateV3ToV4CallParameters(options: MigrateV3ToV4Options, positionManagerOverride?: string): MethodParameters;
+    /**
+     * Encodes a planned route into a method name and parameters for the Router contract.
+     * @param planner the planned route
+     * @param nativeCurrencyValue the native currency value of the planned route
+     * @param config the router config
+     */
+    private static encodePlan;
+}

package/dist/cjs/src/swapRouter.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwapRouter = void 0;
+const tslib_1 = require("tslib");
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const UniversalRouter_json_1 = require("@uniswap/universal-router/artifacts/contracts/UniversalRouter.sol/UniversalRouter.json");
+const abi_1 = require("@ethersproject/abi");
+const ethers_1 = require("ethers");
+const v3_sdk_1 = require("@uniswap/v3-sdk");
+const v4_sdk_1 = require("@uniswap/v4-sdk");
+const sdk_core_1 = require("@uniswap/sdk-core");
+const uniswap_1 = require("./entities/actions/uniswap");
+const routerCommands_1 = require("./utils/routerCommands");
+const inputTokens_1 = require("./utils/inputTokens");
+const constants_1 = require("./utils/constants");
+function isMint(options) {
+    return Object.keys(options).some((k) => k === 'recipient');
+}
+class SwapRouter {
+    static swapCallParameters(trades, options) {
+        // TODO: use permit if signature included in swapOptions
+        const planner = new routerCommands_1.RoutePlanner();
+        const trade = new uniswap_1.UniswapTrade(trades, options);
+        const inputCurrency = trade.trade.inputAmount.currency;
+        (0, tiny_invariant_1.default)(!(inputCurrency.isNative && !!options.inputTokenPermit), 'NATIVE_INPUT_PERMIT');
+        if (options.inputTokenPermit) {
+            (0, inputTokens_1.encodePermit)(planner, options.inputTokenPermit);
+        }
+        const nativeCurrencyValue = inputCurrency.isNative
+            ? ethers_1.BigNumber.from(trade.trade.maximumAmountIn(options.slippageTolerance).quotient.toString())
+            : ethers_1.BigNumber.from(0);
+        trade.encode(planner, { allowRevert: false });
+        return SwapRouter.encodePlan(planner, nativeCurrencyValue, {
+            deadline: options.deadlineOrPreviousBlockhash ? ethers_1.BigNumber.from(options.deadlineOrPreviousBlockhash) : undefined,
+        });
+    }
+    /**
+     * Builds the call parameters for a migration from a V3 position to a V4 position.
+     * Some requirements of the parameters:
+     *   - v3RemoveLiquidityOptions.collectOptions.recipient must equal v4PositionManager
+     *   - v3RemoveLiquidityOptions.liquidityPercentage must be 100%
+     *   - input pool and output pool must have the same tokens
+     *   - V3 NFT must be approved, or valid inputV3NFTPermit must be provided with UR as spender
+     */
+    static migrateV3ToV4CallParameters(options, positionManagerOverride) {
+        const v4Pool = options.outputPosition.pool;
+        const v3Token0 = options.inputPosition.pool.token0;
+        const v3Token1 = options.inputPosition.pool.token1;
+        const v4PositionManagerAddress = positionManagerOverride !== null && positionManagerOverride !== void 0 ? positionManagerOverride : sdk_core_1.CHAIN_TO_ADDRESSES_MAP[v4Pool.chainId].v4PositionManagerAddress;
+        // owner of the v3 nft must be the receiver of the v4 nft
+        // validate the parameters
+        if (v4Pool.currency0.isNative) {
+            (0, tiny_invariant_1.default)((v4Pool.currency0.wrapped.equals(v3Token0) && v4Pool.currency1.equals(v3Token1)) ||
+                (v4Pool.currency0.wrapped.equals(v3Token1) && v4Pool.currency1.equals(v3Token0)), 'TOKEN_MISMATCH');
+        }
+        else {
+            (0, tiny_invariant_1.default)(v3Token0 === v4Pool.token0, 'TOKEN0_MISMATCH');
+            (0, tiny_invariant_1.default)(v3Token1 === v4Pool.token1, 'TOKEN1_MISMATCH');
+        }
+        (0, tiny_invariant_1.default)(options.v3RemoveLiquidityOptions.liquidityPercentage.equalTo(new sdk_core_1.Percent(100, 100)), 'FULL_REMOVAL_REQUIRED');
+        (0, tiny_invariant_1.default)(options.v3RemoveLiquidityOptions.burnToken == true, 'BURN_TOKEN_REQUIRED');
+        (0, tiny_invariant_1.default)(options.v3RemoveLiquidityOptions.collectOptions.recipient === v4PositionManagerAddress, 'RECIPIENT_NOT_POSITION_MANAGER');
+        (0, tiny_invariant_1.default)(isMint(options.v4AddLiquidityOptions), 'MINT_REQUIRED');
+        (0, tiny_invariant_1.default)(options.v4AddLiquidityOptions.migrate, 'MIGRATE_REQUIRED');
+        const planner = new routerCommands_1.RoutePlanner();
+        // to prevent reentrancy by the pool hook, we initialize the v4 pool before moving funds
+        if (options.v4AddLiquidityOptions.createPool) {
+            const poolKey = v4_sdk_1.Pool.getPoolKey(v4Pool.currency0, v4Pool.currency1, v4Pool.fee, v4Pool.tickSpacing, v4Pool.hooks);
+            planner.addCommand(routerCommands_1.CommandType.V4_INITIALIZE_POOL, [poolKey, v4Pool.sqrtRatioX96.toString()]);
+            // remove createPool setting, so that it doesnt get encoded again later
+            delete options.v4AddLiquidityOptions.createPool;
+        }
+        // add position permit to the universal router planner
+        if (options.v3RemoveLiquidityOptions.permit) {
+            // permit spender should be UR
+            const universalRouterAddress = (0, constants_1.UNIVERSAL_ROUTER_ADDRESS)(constants_1.UniversalRouterVersion.V2_0, options.inputPosition.pool.chainId);
+            (0, tiny_invariant_1.default)(universalRouterAddress == options.v3RemoveLiquidityOptions.permit.spender, 'INVALID_SPENDER');
+            // don't need to transfer it because v3posm uses isApprovedOrOwner()
+            (0, inputTokens_1.encodeV3PositionPermit)(planner, options.v3RemoveLiquidityOptions.permit, options.v3RemoveLiquidityOptions.tokenId);
+            // remove permit so that multicall doesnt add it again
+            delete options.v3RemoveLiquidityOptions.permit;
+        }
+        // encode v3 withdraw
+        const v3RemoveParams = v3_sdk_1.NonfungiblePositionManager.removeCallParameters(options.inputPosition, options.v3RemoveLiquidityOptions);
+        const v3Calls = v3_sdk_1.Multicall.decodeMulticall(v3RemoveParams.calldata);
+        for (const v3Call of v3Calls) {
+            // slice selector - 0x + 4 bytes = 10 characters
+            const selector = v3Call.slice(0, 10);
+            (0, tiny_invariant_1.default)(selector == v3_sdk_1.NonfungiblePositionManager.INTERFACE.getSighash('collect') ||
+                selector == v3_sdk_1.NonfungiblePositionManager.INTERFACE.getSighash('decreaseLiquidity') ||
+                selector == v3_sdk_1.NonfungiblePositionManager.INTERFACE.getSighash('burn'), 'INVALID_V3_CALL: ' + selector);
+            planner.addCommand(routerCommands_1.CommandType.V3_POSITION_MANAGER_CALL, [v3Call]);
+        }
+        // encode v4 mint
+        const v4AddParams = v4_sdk_1.V4PositionManager.addCallParameters(options.outputPosition, options.v4AddLiquidityOptions);
+        // only modifyLiquidities can be called by the UniversalRouter
+        const selector = v4AddParams.calldata.slice(0, 10);
+        (0, tiny_invariant_1.default)(selector == v4_sdk_1.V4PositionManager.INTERFACE.getSighash('modifyLiquidities'), 'INVALID_V4_CALL: ' + selector);
+        planner.addCommand(routerCommands_1.CommandType.V4_POSITION_MANAGER_CALL, [v4AddParams.calldata]);
+        return SwapRouter.encodePlan(planner, ethers_1.BigNumber.from(0), {
+            deadline: ethers_1.BigNumber.from(options.v4AddLiquidityOptions.deadline),
+        });
+    }
+    /**
+     * Encodes a planned route into a method name and parameters for the Router contract.
+     * @param planner the planned route
+     * @param nativeCurrencyValue the native currency value of the planned route
+     * @param config the router config
+     */
+    static encodePlan(planner, nativeCurrencyValue, config = {}) {
+        const { commands, inputs } = planner;
+        const functionSignature = !!config.deadline ? 'execute(bytes,bytes[],uint256)' : 'execute(bytes,bytes[])';
+        const parameters = !!config.deadline ? [commands, inputs, config.deadline] : [commands, inputs];
+        const calldata = SwapRouter.INTERFACE.encodeFunctionData(functionSignature, parameters);
+        return { calldata, value: nativeCurrencyValue.toHexString() };
+    }
+}
+exports.SwapRouter = SwapRouter;
+SwapRouter.INTERFACE = new abi_1.Interface(UniversalRouter_json_1.abi);
+//# sourceMappingURL=swapRouter.js.map

package/dist/cjs/src/swapRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swapRouter.js","sourceRoot":"","sources":["../../../src/swapRouter.ts"],"names":[],"mappings":";;;;AAAA,4EAAsC;AACtC,iIAA4G;AAC5G,4CAA8C;AAC9C,mCAAgD;AAChD,4CAMwB;AACxB,4CAOwB;AAExB,gDAA6G;AAC7G,wDAAsE;AACtE,2DAAkE;AAClE,qDAA0E;AAC1E,iDAAoF;AAcpF,SAAS,MAAM,CAAC,OAA8B;IAC5C,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,WAAW,CAAC,CAAA;AAC5D,CAAC;AAED,MAAsB,UAAU;IAGvB,MAAM,CAAC,kBAAkB,CAC9B,MAAkD,EAClD,OAAoB;QAEpB,wDAAwD;QACxD,MAAM,OAAO,GAAG,IAAI,6BAAY,EAAE,CAAA;QAElC,MAAM,KAAK,GAAiB,IAAI,sBAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAA;QACtD,IAAA,wBAAS,EAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAC,CAAA;QAEzF,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,IAAA,0BAAY,EAAC,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;SAChD;QAED,MAAM,mBAAmB,GAAG,aAAa,CAAC,QAAQ;YAChD,CAAC,CAAC,kBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC5F,CAAC,CAAC,kBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAErB,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAA;QAC7C,OAAO,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,mBAAmB,EAAE;YACzD,QAAQ,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC,kBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,SAAS;SAChH,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,2BAA2B,CACvC,OAA6B,EAC7B,uBAAgC;QAEhC,MAAM,MAAM,GAAW,OAAO,CAAC,cAAc,CAAC,IAAI,CAAA;QAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAA;QAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAA;QAClD,MAAM,wBAAwB,GAC5B,uBAAuB,aAAvB,uBAAuB,cAAvB,uBAAuB,GAAI,iCAAsB,CAAC,MAAM,CAAC,OAA8B,CAAC,CAAC,wBAAwB,CAAA;QAEnH,yDAAyD;QAEzD,0BAA0B;QAC1B,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;YAC7B,IAAA,wBAAS,EACP,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC9E,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAClF,gBAAgB,CACjB,CAAA;SACF;aAAM;YACL,IAAA,wBAAS,EAAC,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;YACxD,IAAA,wBAAS,EAAC,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;SACzD;QAED,IAAA,wBAAS,EACP,OAAO,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,kBAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACnF,uBAAuB,CACxB,CAAA;QACD,IAAA,wBAAS,EAAC,OAAO,CAAC,wBAAwB,CAAC,SAAS,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAA;QACpF,IAAA,wBAAS,EACP,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,SAAS,KAAK,wBAAwB,EACtF,gCAAgC,CACjC,CAAA;QACD,IAAA,wBAAS,EAAC,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,eAAe,CAAC,CAAA;QACjE,IAAA,wBAAS,EAAC,OAAO,CAAC,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;QAEpE,MAAM,OAAO,GAAG,IAAI,6BAAY,EAAE,CAAA;QAElC,wFAAwF;QACxF,IAAI,OAAO,CAAC,qBAAqB,CAAC,UAAU,EAAE;YAC5C,MAAM,OAAO,GAAY,aAAM,CAAC,UAAU,CACxC,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,GAAG,EACV,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,KAAK,CACb,CAAA;YACD,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;YAC7F,uEAAuE;YACvE,OAAO,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAA;SAChD;QAED,sDAAsD;QACtD,IAAI,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE;YAC3C,8BAA8B;YAC9B,MAAM,sBAAsB,GAAG,IAAA,oCAAwB,EACrD,kCAAsB,CAAC,IAAI,EAC3B,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,OAA8B,CAC1D,CAAA;YACD,IAAA,wBAAS,EAAC,sBAAsB,IAAI,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAA;YACvG,oEAAoE;YACpE,IAAA,oCAAsB,EAAC,OAAO,EAAE,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAA;YAClH,sDAAsD;YACtD,OAAO,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAA;SAC/C;QAED,qBAAqB;QACrB,MAAM,cAAc,GAAqB,mCAAiB,CAAC,oBAAoB,CAC7E,OAAO,CAAC,aAAa,EACrB,OAAO,CAAC,wBAAwB,CACjC,CAAA;QACD,MAAM,OAAO,GAAa,kBAAS,CAAC,eAAe,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA;QAE5E,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,gDAAgD;YAChD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;YACpC,IAAA,wBAAS,EACP,QAAQ,IAAI,mCAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC;gBAC3D,QAAQ,IAAI,mCAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBACvE,QAAQ,IAAI,mCAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,EAC5D,mBAAmB,GAAG,QAAQ,CAC/B,CAAA;YACD,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;SACnE;QAED,iBAAiB;QACjB,MAAM,WAAW,GAAG,0BAAiB,CAAC,iBAAiB,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAA;QAC9G,8DAA8D;QAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QAClD,IAAA,wBAAS,EAAC,QAAQ,IAAI,0BAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,QAAQ,CAAC,CAAA;QAElH,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,wBAAwB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAA;QAEhF,OAAO,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,kBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;YACvD,QAAQ,EAAE,kBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,QAAQ,CAAC;SACjE,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,UAAU,CACvB,OAAqB,EACrB,mBAA8B,EAC9B,SAA2B,EAAE;QAE7B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;QACpC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,gCAAgC,CAAC,CAAC,CAAC,wBAAwB,CAAA;QACzG,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC/F,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAA;QACvF,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,mBAAmB,CAAC,WAAW,EAAE,EAAE,CAAA;IAC/D,CAAC;;AAvJH,gCAwJC;AAvJe,oBAAS,GAAc,IAAI,eAAS,CAAC,0BAAG,CAAC,CAAA"}

package/dist/{utils → cjs/src/utils}/commandParser.d.ts

@@ -1,34 +1,34 @@
-import { Interface } from '@ethersproject/abi';
-import { CommandType, CommandDefinition } from '../utils/routerCommands';
-export declare type Param = {
-    readonly name: string;
-    readonly value: any;
-};
-export declare type UniversalRouterCommand = {
-    readonly commandName: string;
-    readonly commandType: CommandType;
-    readonly params: readonly Param[];
-};
-export declare type UniversalRouterCall = {
-    readonly commands: readonly UniversalRouterCommand[];
-};
-export declare type V3PathItem = {
-    readonly tokenIn: string;
-    readonly tokenOut: string;
-    readonly fee: number;
-};
-export interface CommandsDefinition {
-    [key: number]: CommandDefinition;
-}
-export declare abstract class CommandParser {
-    static INTERFACE: Interface;
-    static parseCalldata(calldata: string): UniversalRouterCall;
-}
-export declare class GenericCommandParser {
-    private readonly commandDefinition;
-    constructor(commandDefinition: CommandsDefinition);
-    parse(commands: string, inputs: string[]): UniversalRouterCall;
-    private static getCommands;
-}
-export declare function parseV3PathExactIn(path: string): readonly V3PathItem[];
-export declare function parseV3PathExactOut(path: string): readonly V3PathItem[];
+import { Interface } from '@ethersproject/abi';
+import { CommandType, CommandDefinition } from '../utils/routerCommands';
+export type Param = {
+    readonly name: string;
+    readonly value: any;
+};
+export type UniversalRouterCommand = {
+    readonly commandName: string;
+    readonly commandType: CommandType;
+    readonly params: readonly Param[];
+};
+export type UniversalRouterCall = {
+    readonly commands: readonly UniversalRouterCommand[];
+};
+export type V3PathItem = {
+    readonly tokenIn: string;
+    readonly tokenOut: string;
+    readonly fee: number;
+};
+export interface CommandsDefinition {
+    [key: number]: CommandDefinition;
+}
+export declare abstract class CommandParser {
+    static INTERFACE: Interface;
+    static parseCalldata(calldata: string): UniversalRouterCall;
+}
+export declare class GenericCommandParser {
+    private readonly commandDefinition;
+    constructor(commandDefinition: CommandsDefinition);
+    parse(commands: string, inputs: string[]): UniversalRouterCall;
+    private static getCommands;
+}
+export declare function parseV3PathExactIn(path: string): readonly V3PathItem[];
+export declare function parseV3PathExactOut(path: string): readonly V3PathItem[];

package/dist/cjs/src/utils/commandParser.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseV3PathExactOut = exports.parseV3PathExactIn = exports.GenericCommandParser = exports.CommandParser = void 0;
+const ethers_1 = require("ethers");
+const UniversalRouter_json_1 = require("@uniswap/universal-router/artifacts/contracts/UniversalRouter.sol/UniversalRouter.json");
+const abi_1 = require("@ethersproject/abi");
+const v4_sdk_1 = require("@uniswap/v4-sdk");
+const routerCommands_1 = require("../utils/routerCommands");
+// Parses UniversalRouter V2 commands
+class CommandParser {
+    static parseCalldata(calldata) {
+        const genericParser = new GenericCommandParser(routerCommands_1.COMMAND_DEFINITION);
+        const txDescription = CommandParser.INTERFACE.parseTransaction({ data: calldata });
+        const { commands, inputs } = txDescription.args;
+        return genericParser.parse(commands, inputs);
+    }
+}
+exports.CommandParser = CommandParser;
+CommandParser.INTERFACE = new abi_1.Interface(UniversalRouter_json_1.abi);
+// Parses commands based on given command definition
+class GenericCommandParser {
+    constructor(commandDefinition) {
+        this.commandDefinition = commandDefinition;
+    }
+    parse(commands, inputs) {
+        const commandTypes = GenericCommandParser.getCommands(commands);
+        return {
+            commands: commandTypes.map((commandType, i) => {
+                const commandDef = this.commandDefinition[commandType];
+                if (commandDef.parser === routerCommands_1.Parser.V4Actions) {
+                    const { actions } = v4_sdk_1.V4BaseActionsParser.parseCalldata(inputs[i]);
+                    return {
+                        commandName: routerCommands_1.CommandType[commandType],
+                        commandType,
+                        params: v4RouterCallToParams(actions),
+                    };
+                }
+                else if (commandDef.parser === routerCommands_1.Parser.Abi) {
+                    const abiDef = commandDef.params;
+                    const rawParams = ethers_1.ethers.utils.defaultAbiCoder.decode(abiDef.map((command) => command.type), inputs[i]);
+                    const params = rawParams.map((param, j) => {
+                        switch (abiDef[j].subparser) {
+                            case routerCommands_1.Subparser.V3PathExactIn:
+                                return {
+                                    name: abiDef[j].name,
+                                    value: parseV3PathExactIn(param),
+                                };
+                            case routerCommands_1.Subparser.V3PathExactOut:
+                                return {
+                                    name: abiDef[j].name,
+                                    value: parseV3PathExactOut(param),
+                                };
+                            default:
+                                return {
+                                    name: abiDef[j].name,
+                                    value: param,
+                                };
+                        }
+                    });
+                    return {
+                        commandName: routerCommands_1.CommandType[commandType],
+                        commandType,
+                        params,
+                    };
+                }
+                else if (commandDef.parser === routerCommands_1.Parser.V3Actions) {
+                    // TODO: implement better parsing here
+                    return {
+                        commandName: routerCommands_1.CommandType[commandType],
+                        commandType,
+                        params: inputs.map((input) => ({ name: 'command', value: input })),
+                    };
+                }
+                else {
+                    throw new Error(`Unsupported parser: ${commandDef}`);
+                }
+            }),
+        };
+    }
+    // parse command types from bytes string
+    static getCommands(commands) {
+        const commandTypes = [];
+        for (let i = 2; i < commands.length; i += 2) {
+            const byte = commands.substring(i, i + 2);
+            commandTypes.push(parseInt(byte, 16));
+        }
+        return commandTypes;
+    }
+}
+exports.GenericCommandParser = GenericCommandParser;
+function parseV3PathExactIn(path) {
+    const strippedPath = path.replace('0x', '');
+    let tokenIn = ethers_1.ethers.utils.getAddress(strippedPath.substring(0, 40));
+    let loc = 40;
+    const res = [];
+    while (loc < strippedPath.length) {
+        const feeAndTokenOut = strippedPath.substring(loc, loc + 46);
+        const fee = parseInt(feeAndTokenOut.substring(0, 6), 16);
+        const tokenOut = ethers_1.ethers.utils.getAddress(feeAndTokenOut.substring(6, 46));
+        res.push({
+            tokenIn,
+            tokenOut,
+            fee,
+        });
+        tokenIn = tokenOut;
+        loc += 46;
+    }
+    return res;
+}
+exports.parseV3PathExactIn = parseV3PathExactIn;
+function parseV3PathExactOut(path) {
+    const strippedPath = path.replace('0x', '');
+    let tokenIn = ethers_1.ethers.utils.getAddress(strippedPath.substring(strippedPath.length - 40));
+    let loc = strippedPath.length - 86; // 86 = (20 addr + 3 fee + 20 addr) * 2 (for hex characters)
+    const res = [];
+    while (loc >= 0) {
+        const feeAndTokenOut = strippedPath.substring(loc, loc + 46);
+        const tokenOut = ethers_1.ethers.utils.getAddress(feeAndTokenOut.substring(0, 40));
+        const fee = parseInt(feeAndTokenOut.substring(40, 46), 16);
+        res.push({
+            tokenIn,
+            tokenOut,
+            fee,
+        });
+        tokenIn = tokenOut;
+        loc -= 46;
+    }
+    return res;
+}
+exports.parseV3PathExactOut = parseV3PathExactOut;
+function v4RouterCallToParams(actions) {
+    return actions.map((action) => {
+        return {
+            name: action.actionName,
+            value: action.params.map((param) => {
+                return {
+                    name: param.name,
+                    value: param.value,
+                };
+            }),
+        };
+    });
+}
+//# sourceMappingURL=commandParser.js.map

package/dist/cjs/src/utils/commandParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandParser.js","sourceRoot":"","sources":["../../../../src/utils/commandParser.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAC/B,iIAA4G;AAC5G,4CAA8C;AAC9C,4CAAqE;AACrE,4DAA+G;AA2B/G,qCAAqC;AACrC,MAAsB,aAAa;IAG1B,MAAM,CAAC,aAAa,CAAC,QAAgB;QAC1C,MAAM,aAAa,GAAG,IAAI,oBAAoB,CAAC,mCAAkB,CAAC,CAAA;QAClE,MAAM,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAA;QAClF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAA;QAC/C,OAAO,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC9C,CAAC;;AARH,sCASC;AARe,uBAAS,GAAc,IAAI,eAAS,CAAC,0BAAG,CAAC,CAAA;AAUzD,oDAAoD;AACpD,MAAa,oBAAoB;IAC/B,YAA6B,iBAAqC;QAArC,sBAAiB,GAAjB,iBAAiB,CAAoB;IAAG,CAAC;IAE/D,KAAK,CAAC,QAAgB,EAAE,MAAgB;QAC7C,MAAM,YAAY,GAAG,oBAAoB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QAE/D,OAAO;YACL,QAAQ,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,WAAwB,EAAE,CAAS,EAAE,EAAE;gBACjE,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAA;gBAEtD,IAAI,UAAU,CAAC,MAAM,KAAK,uBAAM,CAAC,SAAS,EAAE;oBAC1C,MAAM,EAAE,OAAO,EAAE,GAAG,4BAAmB,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;oBAChE,OAAO;wBACL,WAAW,EAAE,4BAAW,CAAC,WAAW,CAAC;wBACrC,WAAW;wBACX,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;qBACtC,CAAA;iBACF;qBAAM,IAAI,UAAU,CAAC,MAAM,KAAK,uBAAM,CAAC,GAAG,EAAE;oBAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;oBAChC,MAAM,SAAS,GAAG,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CACnD,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EACrC,MAAM,CAAC,CAAC,CAAC,CACV,CAAA;oBAED,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,CAAS,EAAE,EAAE;wBACrD,QAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE;4BAC3B,KAAK,0BAAS,CAAC,aAAa;gCAC1B,OAAO;oCACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oCACpB,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;iCACjC,CAAA;4BACH,KAAK,0BAAS,CAAC,cAAc;gCAC3B,OAAO;oCACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oCACpB,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC;iCAClC,CAAA;4BACH;gCACE,OAAO;oCACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oCACpB,KAAK,EAAE,KAAK;iCACb,CAAA;yBACJ;oBACH,CAAC,CAAC,CAAA;oBACF,OAAO;wBACL,WAAW,EAAE,4BAAW,CAAC,WAAW,CAAC;wBACrC,WAAW;wBACX,MAAM;qBACP,CAAA;iBACF;qBAAM,IAAI,UAAU,CAAC,MAAM,KAAK,uBAAM,CAAC,SAAS,EAAE;oBACjD,sCAAsC;oBACtC,OAAO;wBACL,WAAW,EAAE,4BAAW,CAAC,WAAW,CAAC;wBACrC,WAAW;wBACX,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;qBACnE,CAAA;iBACF;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAA;iBACrD;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC;IAED,wCAAwC;IAChC,MAAM,CAAC,WAAW,CAAC,QAAgB;QACzC,MAAM,YAAY,GAAG,EAAE,CAAA;QAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC3C,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;YACzC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAgB,CAAC,CAAA;SACrD;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AAzED,oDAyEC;AAED,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC3C,IAAI,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IACpE,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,MAAM,GAAG,GAAG,EAAE,CAAA;IACd,OAAO,GAAG,GAAG,YAAY,CAAC,MAAM,EAAE;QAChC,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;QAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACxD,MAAM,QAAQ,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;QAEzE,GAAG,CAAC,IAAI,CAAC;YACP,OAAO;YACP,QAAQ;YACR,GAAG;SACJ,CAAC,CAAA;QACF,OAAO,GAAG,QAAQ,CAAA;QAClB,GAAG,IAAI,EAAE,CAAA;KACV;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AApBD,gDAoBC;AAED,SAAgB,mBAAmB,CAAC,IAAY;IAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC3C,IAAI,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAA;IACvF,IAAI,GAAG,GAAG,YAAY,CAAC,MAAM,GAAG,EAAE,CAAA,CAAC,4DAA4D;IAC/F,MAAM,GAAG,GAAG,EAAE,CAAA;IACd,OAAO,GAAG,IAAI,CAAC,EAAE;QACf,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;QAC5D,MAAM,QAAQ,GAAG,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;QACzE,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;QAE1D,GAAG,CAAC,IAAI,CAAC;YACP,OAAO;YACP,QAAQ;YACR,GAAG;SACJ,CAAC,CAAA;QACF,OAAO,GAAG,QAAQ,CAAA;QAElB,GAAG,IAAI,EAAE,CAAA;KACV;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AArBD,kDAqBC;AAED,SAAS,oBAAoB,CAAC,OAAkC;IAC9D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC5B,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,UAAU;YACvB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjC,OAAO;oBACL,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,KAAK,EAAE,KAAK,CAAC,KAAK;iBACnB,CAAA;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/{utils → cjs/src/utils}/constants.d.ts

@@ -1,30 +1,30 @@
-import { BigNumber } from 'ethers';
-export declare enum UniversalRouterVersion {
-    V1_2 = "1.2",
-    V2_0 = "2.0"
-}
-export declare type RouterConfig = {
-    address: string;
-    creationBlock: number;
-};
-declare type ChainConfig = {
-    weth: string;
-    routerConfigs: {
-        [key in UniversalRouterVersion]: RouterConfig;
-    };
-};
-export declare const CHAIN_CONFIGS: {
-    [key: number]: ChainConfig;
-};
-export declare const UNIVERSAL_ROUTER_ADDRESS: (version: UniversalRouterVersion, chainId: number) => string;
-export declare const UNIVERSAL_ROUTER_CREATION_BLOCK: (version: UniversalRouterVersion, chainId: number) => number;
-export declare const WETH_ADDRESS: (chainId: number) => string;
-export declare const CONTRACT_BALANCE: BigNumber;
-export declare const ETH_ADDRESS = "0x0000000000000000000000000000000000000000";
-export declare const E_ETH_ADDRESS = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
-export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
-export declare const MAX_UINT256: BigNumber;
-export declare const MAX_UINT160: BigNumber;
-export declare const SENDER_AS_RECIPIENT = "0x0000000000000000000000000000000000000001";
-export declare const ROUTER_AS_RECIPIENT = "0x0000000000000000000000000000000000000002";
-export {};
+import { BigNumber } from 'ethers';
+export declare enum UniversalRouterVersion {
+    V1_2 = "1.2",
+    V2_0 = "2.0"
+}
+export type RouterConfig = {
+    address: string;
+    creationBlock: number;
+};
+type ChainConfig = {
+    weth: string;
+    routerConfigs: {
+        [key in UniversalRouterVersion]: RouterConfig;
+    };
+};
+export declare const CHAIN_CONFIGS: {
+    [key: number]: ChainConfig;
+};
+export declare const UNIVERSAL_ROUTER_ADDRESS: (version: UniversalRouterVersion, chainId: number) => string;
+export declare const UNIVERSAL_ROUTER_CREATION_BLOCK: (version: UniversalRouterVersion, chainId: number) => number;
+export declare const WETH_ADDRESS: (chainId: number) => string;
+export declare const CONTRACT_BALANCE: BigNumber;
+export declare const ETH_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const E_ETH_ADDRESS = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
+export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const MAX_UINT256: BigNumber;
+export declare const MAX_UINT160: BigNumber;
+export declare const SENDER_AS_RECIPIENT = "0x0000000000000000000000000000000000000001";
+export declare const ROUTER_AS_RECIPIENT = "0x0000000000000000000000000000000000000002";
+export {};