feat(v4-sdk): additional options when migrating

sdks/v4-sdk/src/PositionManager.test.ts

@@ -367,6 +367,85 @@ describe('PositionManager', () => {
       expect(value).toEqual('0x00')
     })
 
+    it('succeeds when migrating out of range and need to transfer eth', () => {
+      const position: Position = new Position({
+        pool: pool_1_eth,
+        tickLower: TICK_SPACINGS[FeeAmount.MEDIUM],
+        tickUpper: TICK_SPACINGS[FeeAmount.MEDIUM] * 2,
+        liquidity: 1,
+      })
+      const { calldata, value } = V4PositionManager.addCallParameters(position, {
+        recipient,
+        slippageTolerance,
+        deadline,
+        migrate: true,
+        currencyAmount: { inputCurrency: currency_native, inputAmount: 1 },
+        useNative: currency_native,
+      })
+
+      // Rebuild the data with the planner for the expected mint. MUST sweep since we are using the native currency.
+      const planner = new V4Planner()
+      const { amount0: amount0Max, amount1: amount1Max } = position.mintAmountsWithSlippage(slippageTolerance)
+      // Expect position to be minted correctly
+      planner.addAction(Actions.MINT_POSITION, [
+        pool_1_eth.poolKey,
+        TICK_SPACINGS[FeeAmount.MEDIUM],
+        TICK_SPACINGS[FeeAmount.MEDIUM] * 2,
+        1,
+        toHex(amount0Max),
+        toHex(amount1Max),
+        recipient,
+        EMPTY_BYTES,
+      ])
+
+      planner.addAction(Actions.SETTLE, [toAddress(pool_1_eth.currency0), OPEN_DELTA, false])
+      planner.addAction(Actions.SETTLE, [toAddress(pool_1_eth.currency1), OPEN_DELTA, false])
+      planner.addAction(Actions.SWEEP, [toAddress(pool_1_eth.currency0), recipient])
+      planner.addAction(Actions.SWEEP, [toAddress(pool_1_eth.currency1), recipient])
+      expect(calldata).toEqual(V4PositionManager.encodeModifyLiquidities(planner.finalize(), deadline))
+
+      expect(value).toEqual('0x00')
+    })
+
+    it('succeeds when migrating out of range and need to transfer extra currency', () => {
+      const position: Position = new Position({
+        pool: pool_0_1,
+        tickLower: TICK_SPACINGS[FeeAmount.MEDIUM],
+        tickUpper: TICK_SPACINGS[FeeAmount.MEDIUM] * 2,
+        liquidity: 1,
+      })
+      const { calldata, value } = V4PositionManager.addCallParameters(position, {
+        recipient,
+        slippageTolerance,
+        deadline,
+        migrate: true,
+        currencyAmount: { inputCurrency: currency0, inputAmount: 1 },
+      })
+
+      // Rebuild the data with the planner for the expected mint. MUST sweep since we are using the native currency.
+      const planner = new V4Planner()
+      const { amount0: amount0Max, amount1: amount1Max } = position.mintAmountsWithSlippage(slippageTolerance)
+      // Expect position to be minted correctly
+      planner.addAction(Actions.MINT_POSITION, [
+        pool_0_1.poolKey,
+        TICK_SPACINGS[FeeAmount.MEDIUM],
+        TICK_SPACINGS[FeeAmount.MEDIUM] * 2,
+        1,
+        toHex(amount0Max),
+        toHex(amount1Max),
+        recipient,
+        EMPTY_BYTES,
+      ])
+
+      planner.addAction(Actions.SETTLE, [toAddress(pool_0_1.currency0), OPEN_DELTA, false])
+      planner.addAction(Actions.SETTLE, [toAddress(pool_0_1.currency1), OPEN_DELTA, false])
+      planner.addAction(Actions.SWEEP, [toAddress(pool_0_1.currency0), recipient])
+      planner.addAction(Actions.SWEEP, [toAddress(pool_0_1.currency1), recipient])
+      expect(calldata).toEqual(V4PositionManager.encodeModifyLiquidities(planner.finalize(), deadline))
+
+      expect(value).toEqual('0x00')
+    })
+
     it('succeeds for batchPermit', () => {
       const position: Position = new Position({
         pool: pool_0_1,

sdks/v4-sdk/src/PositionManager.ts

@@ -1,4 +1,4 @@
-import { BigintIsh, Percent, validateAndParseAddress, NativeCurrency } from '@uniswap/sdk-core'
+import { BigintIsh, Percent, validateAndParseAddress, NativeCurrency, Currency } from '@uniswap/sdk-core'
 import { TypedDataDomain, TypedDataField } from '@ethersproject/abstract-signer'
 import JSBI from 'jsbi'
 import { Position } from './entities/position'
@@ -62,7 +62,7 @@ export interface MintSpecificOptions {
   sqrtPriceX96?: BigintIsh
 
   /**
-   * Whether the mint is part of a migration from V3 to V4.
+   * Whether the mint is part of a migration from V3 to V4
    */
   migrate?: boolean
 }
@@ -114,21 +114,22 @@ export interface CollectSpecificOptions {
   recipient: string
 }
 
-export interface TransferOptions {
+export interface MigrateSpecificOptions {
   /**
-   * The account sending the NFT.
+   * The additional currency and amount that needs to be transferred if migrating (a) from out-of-range to in-range, or (b) from out-of-range to out-of-range on the opposite side
    */
-  sender: string
+  currencyAmount?: CurrencyAmount
+}
 
+export interface CurrencyAmount {
   /**
-   * The account that should receive the NFT.
+   * The additional currency that needs to be transferred
    */
-  recipient: string
-
+  inputCurrency: Currency
   /**
-   * The id of the token being sent.
+   * The amount of additional currency that needs to be transferred
    */
-  tokenId: BigintIsh
+  inputAmount: BigintIsh
 }
 
 export interface PermitDetails {
@@ -182,7 +183,7 @@ export interface NFTPermitData {
   values: NFTPermitValues
 }
 
-export type MintOptions = CommonOptions & CommonAddLiquidityOptions & MintSpecificOptions
+export type MintOptions = CommonOptions & CommonAddLiquidityOptions & MintSpecificOptions & MigrateSpecificOptions
 export type IncreaseLiquidityOptions = CommonOptions & CommonAddLiquidityOptions & ModifyPositionSpecificOptions
 
 export type AddLiquidityOptions = MintOptions | IncreaseLiquidityOptions
@@ -284,9 +285,11 @@ export abstract class V4PositionManager {
 
     let value: string = toHex(0)
 
+    let needToSendEth = isMint(options) && options.migrate && options.currencyAmount?.inputCurrency.isNative
+
     // If migrating, we need to settle and sweep both currencies individually
     if (isMint(options) && options.migrate) {
-      if (options.useNative) {
+      if (options.useNative && !needToSendEth) {
         // unwrap the exact amount needed to send to the pool manager
         planner.addUnwrap(OPEN_DELTA)
         // payer is v4 position manager