@uniswap/universal-router-sdk 3.4.0 → 4.1.0

package/dist/index.d.ts

@@ -2,5 +2,5 @@ export { SwapRouter } from './swapRouter';
 export * from './entities';
 export * from './utils/routerTradeAdapter';
 export { RoutePlanner, CommandType } from './utils/routerCommands';
-export { UNIVERSAL_ROUTER_CREATION_BLOCK, UNIVERSAL_ROUTER_ADDRESS, PERMIT2_ADDRESS, ROUTER_AS_RECIPIENT, WETH_ADDRESS, UniversalRouterVersion, } from './utils/constants';
+export { UNIVERSAL_ROUTER_CREATION_BLOCK, UNIVERSAL_ROUTER_ADDRESS, ROUTER_AS_RECIPIENT, WETH_ADDRESS, UniversalRouterVersion, } from './utils/constants';
 export { CommandParser, UniversalRouterCommand, UniversalRouterCall, Param } from './utils/commandParser';

package/dist/swapRouter.d.ts

@@ -1,6 +1,7 @@
 import { Interface } from '@ethersproject/abi';
 import { BigNumberish } from 'ethers';
-import { MethodParameters } from '@uniswap/v3-sdk';
+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';
@@ -8,9 +9,24 @@ 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): MethodParameters;
     /**
      * Encodes a planned route into a method name and parameters for the Router contract.
      * @param planner the planned route

package/dist/test/utils/addresses.d.ts

@@ -4,5 +4,5 @@ export declare const FORGE_PERMIT2_ADDRESS = "0x4a873bdd49f7f9cc0a5458416a12973f
 export declare const FORGE_SENDER_ADDRESS = "0xcf03dd0a894ef79cb5b601a43c4b25e3ae4c67ed";
 export declare const TEST_RECIPIENT_ADDRESS = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
 export declare const TEST_FEE_RECIPIENT_ADDRESS = "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
-export declare const PERMIT2_ADDRESS: string;
+export declare const PERMIT2_ADDRESS: any;
 export declare const ROUTER_ADDRESS: string;

package/dist/universal-router-sdk.cjs.development.js

@@ -8,12 +8,12 @@ var invariant = _interopDefault(require('tiny-invariant'));
 var UniversalRouter_json = require('@uniswap/universal-router/artifacts/contracts/UniversalRouter.sol/UniversalRouter.json');
 var abi = require('@ethersproject/abi');
 var ethers = require('ethers');
-var utils = require('ethers/lib/utils');
-var v2Sdk = require('@uniswap/v2-sdk');
 var v3Sdk = require('@uniswap/v3-sdk');
 var v4Sdk = require('@uniswap/v4-sdk');
-var routerSdk = require('@uniswap/router-sdk');
 var sdkCore = require('@uniswap/sdk-core');
+var utils = require('ethers/lib/utils');
+var v2Sdk = require('@uniswap/v2-sdk');
+var routerSdk = require('@uniswap/router-sdk');
 require('jsbi');
 require('bignumber.js');
 
@@ -515,7 +515,6 @@ var WETH_ADDRESS = function WETH_ADDRESS(chainId) {
   if (CHAIN_CONFIGS[chainId].weth == WETH_NOT_SUPPORTED_ON_CHAIN) throw new Error("Chain " + chainId + " does not have WETH");
   return CHAIN_CONFIGS[chainId].weth;
 };
-var PERMIT2_ADDRESS = '0x000000000022D473030F116dDEE9F6B43aC78BA3';
 var CONTRACT_BALANCE = /*#__PURE__*/ethers.BigNumber.from(2).pow(255);
 var ETH_ADDRESS = '0x0000000000000000000000000000000000000000';
 var E_ETH_ADDRESS = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee';
@@ -784,6 +783,10 @@ function encodePermit(planner, permit2) {
   }
   planner.addCommand(exports.CommandType.PERMIT2_PERMIT, [permit2, signature]);
 }
+function encodeV3PositionPermit(planner, permit, tokenId) {
+  var calldata = v3Sdk.NonfungiblePositionManager.INTERFACE.encodeFunctionData('permit', [sdkCore.validateAndParseAddress(permit.spender), tokenId, permit.deadline, permit.v, permit.r, permit.s]);
+  planner.addCommand(exports.CommandType.V3_POSITION_MANAGER_PERMIT, [calldata]);
+}
 // Handles the encoding of commands needed to gather input tokens for a trade
 // Approval: The router approving another address to take tokens.
 //   note: Only seaport and sudoswap support this action. Approvals are left open.
@@ -801,6 +804,11 @@ function encodeInputTokenOptions(planner, options) {
   }
 }
 
+function isMint(options) {
+  return Object.keys(options).some(function (k) {
+    return k === 'recipient';
+  });
+}
 var SwapRouter = /*#__PURE__*/function () {
   function SwapRouter() {}
   SwapRouter.swapCallParameters = function swapCallParameters(trades, options) {
@@ -820,6 +828,43 @@ var SwapRouter = /*#__PURE__*/function () {
       deadline: options.deadlineOrPreviousBlockhash ? ethers.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
+   */;
+  SwapRouter.migrateV3ToV4CallParameters = function migrateV3ToV4CallParameters(options) {
+    var token0 = options.inputPosition.pool.token0;
+    var token1 = options.inputPosition.pool.token1;
+    var v4PositionManagerAddress = sdkCore.CHAIN_TO_ADDRESSES_MAP[options.outputPosition.pool.chainId].v4PositionManagerAddress;
+    !(token0 === options.outputPosition.pool.token0) ?  invariant(false, 'TOKEN0_MISMATCH')  : void 0;
+    !(token1 === options.outputPosition.pool.token1) ?  invariant(false, 'TOKEN1_MISMATCH')  : void 0;
+    !options.v3RemoveLiquidityOptions.liquidityPercentage.equalTo(new sdkCore.Percent(100, 100)) ?  invariant(false, 'FULL_REMOVAL_REQUIRED')  : void 0;
+    !(options.v3RemoveLiquidityOptions.burnToken == true) ?  invariant(false, 'BURN_TOKEN_REQUIRED')  : void 0;
+    !(options.v3RemoveLiquidityOptions.collectOptions.recipient === v4PositionManagerAddress) ?  invariant(false, 'RECIPIENT_NOT_POSITION_MANAGER')  : void 0;
+    !isMint(options.v4AddLiquidityOptions) ?  invariant(false, 'MINT_REQUIRED')  : void 0;
+    !options.v4AddLiquidityOptions.migrate ?  invariant(false, 'MIGRATE_REQUIRED')  : void 0;
+    var planner = new RoutePlanner();
+    if (options.v3RemoveLiquidityOptions.permit) {
+      // permit spender should be UR
+      var universalRouterAddress = UNIVERSAL_ROUTER_ADDRESS(exports.UniversalRouterVersion.V2_0, options.inputPosition.pool.chainId);
+      !(universalRouterAddress == options.v3RemoveLiquidityOptions.permit.spender) ?  invariant(false, 'INVALID_SPENDER')  : void 0;
+      // don't need to transfer it because v3posm uses isApprovedOrOwner()
+      encodeV3PositionPermit(planner, options.v3RemoveLiquidityOptions.permit, options.v3RemoveLiquidityOptions.tokenId);
+    }
+    // encode v3 withdraw
+    var v3RemoveParams = v3Sdk.NonfungiblePositionManager.removeCallParameters(options.inputPosition, options.v3RemoveLiquidityOptions);
+    planner.addCommand(exports.CommandType.V3_POSITION_MANAGER_CALL, [v3RemoveParams.calldata]);
+    // encode v4 mint
+    var v4AddParams = v4Sdk.V4PositionManager.addCallParameters(options.outputPosition, options.v4AddLiquidityOptions);
+    planner.addCommand(exports.CommandType.V4_POSITION_CALL, [v4AddParams.calldata]);
+    return SwapRouter.encodePlan(planner, ethers.BigNumber.from(0), {
+      deadline: ethers.BigNumber.from(options.v4AddLiquidityOptions.deadline)
+    });
+  }
   /**
    * Encodes a planned route into a method name and parameters for the Router contract.
    * @param planner the planned route
@@ -1085,7 +1130,6 @@ function parseV3PathExactOut(path) {
 }
 
 exports.CommandParser = CommandParser;
-exports.PERMIT2_ADDRESS = PERMIT2_ADDRESS;
 exports.ROUTER_AS_RECIPIENT = ROUTER_AS_RECIPIENT;
 exports.RoutePlanner = RoutePlanner;
 exports.RouterTradeAdapter = RouterTradeAdapter;