feat(v4-sdk): additional options when migrating

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

@@ -300,7 +300,7 @@ describe('PositionManager', () => {
         recipient,
         slippageTolerance,
         deadline,
-        migrate: true,
+        migrateOptions: { migrate: true },
       })
 
       // Rebuild the data with the planner for the expected mint. MUST sweep since we are using the native currency.
@@ -338,7 +338,7 @@ describe('PositionManager', () => {
         recipient,
         slippageTolerance,
         deadline,
-        migrate: true,
+        migrateOptions: { migrate: true },
         useNative: currency_native,
       })
 
@@ -367,6 +367,45 @@ 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,
+        migrateOptions: { migrate: true, neededCurrency: currency_native, neededAmount: 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 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,9 +62,9 @@ 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 and the additional currency and amount to send if needed
    */
-  migrate?: boolean
+  migrateOptions?: MigrateOptions
 }
 
 /**
@@ -114,21 +114,19 @@ export interface CollectSpecificOptions {
   recipient: string
 }
 
-export interface TransferOptions {
+export interface MigrateOptions {
   /**
-   * The account sending the NFT.
+   * Whether the mint is part of a migration from V3 to V4.
    */
-  sender: string
-
+  migrate?: boolean
   /**
-   * The account that should receive the NFT.
+   * The additional currency that needs to be transferred if migrating from out of range to in range or out of range to opposite side out of range
    */
-  recipient: string
-
+  neededCurrency?: Currency
   /**
-   * The id of the token being sent.
+   * The amount of additional currency that needs to be transferred if migrating from out of range to in range or out of range to opposite side out of range
    */
-  tokenId: BigintIsh
+  neededAmount?: BigintIsh
 }
 
 export interface PermitDetails {
@@ -284,9 +282,11 @@ export abstract class V4PositionManager {
 
     let value: string = toHex(0)
 
+    let needToSendEth = isMint(options) && options.migrateOptions?.neededCurrency?.isNative
+
     // If migrating, we need to settle and sweep both currencies individually
-    if (isMint(options) && options.migrate) {
-      if (options.useNative) {
+    if (isMint(options) && options.migrateOptions?.migrate) {
+      if (options.useNative && !needToSendEth) {
         // unwrap the exact amount needed to send to the pool manager
         planner.addUnwrap(OPEN_DELTA)
         // payer is v4 position manager