feat(v4-sdk): additional options when migrating

sdks/v4-sdk/src/PositionManager.ts

@@ -59,11 +59,6 @@ export interface MintSpecificOptions {
    * Initial price to set on the pool if creating
    */
   sqrtPriceX96?: BigintIsh
-
-  /**
-   * Whether the mint is part of a migration from V3 to V4.
-   */
-  migrate?: boolean
 }
 
 /**
@@ -130,6 +125,23 @@ export interface TransferOptions {
   tokenId: BigintIsh
 }
 
+export interface MigrateSpecificOptions {
+  /**
+   * Whether the mint is part of a migration from V3 to V4.
+   */
+  migrate: boolean
+
+  /**
+   * Whether the migrate needs additional transfer or not
+   */
+  additionalTransfer?: AdditionalTransferDetails
+}
+
+export interface AdditionalTransferDetails {
+  neededCurrency: Currency
+  neededAmount: BigintIsh
+}
+
 export interface PermitDetails {
   token: string
   amount: BigintIsh
@@ -182,9 +194,10 @@ export interface NFTPermitData {
 }
 
 export type MintOptions = CommonOptions & CommonAddLiquidityOptions & MintSpecificOptions
+export type MigrateOptions = MintOptions & MigrateSpecificOptions
 export type IncreaseLiquidityOptions = CommonOptions & CommonAddLiquidityOptions & ModifyPositionSpecificOptions
 
-export type AddLiquidityOptions = MintOptions | IncreaseLiquidityOptions
+export type AddLiquidityOptions = MintOptions | IncreaseLiquidityOptions | MigrateOptions
 
 export type RemoveLiquidityOptions = CommonOptions & RemoveLiquiditySpecificOptions & ModifyPositionSpecificOptions
 
@@ -195,6 +208,10 @@ function isMint(options: AddLiquidityOptions): options is MintOptions {
   return Object.keys(options).some((k) => k === 'recipient')
 }
 
+function isMigrate(options: AddLiquidityOptions): options is MigrateOptions {
+  return Object.keys(options).some((k) => k === 'migrate')
+}
+
 function shouldCreatePool(options: MintOptions): boolean {
   if (options.createPool) {
     invariant(options.sqrtPriceX96 !== undefined, NO_SQRT_PRICE)
@@ -275,7 +292,7 @@ export abstract class V4PositionManager {
     }
 
     // If migrating, we need to settle and sweep both currencies individually
-    if (isMint(options) && options.migrate) {
+    if (isMigrate(options) && options.migrate) {
       // payer is v4 positiion manager
       planner.addSettle(position.pool.currency0, false)
       planner.addSettle(position.pool.currency1, false)