@magmaprotocol/magma-clmm-sdk 0.5.0 → 0.5.1

package/dist/index.d.ts

@@ -985,25 +985,7 @@ type OpenPositionAddLiquidityWithProtectionParams = {
     min_amount_b: number;
     by_amount_a: boolean;
 };
-type AddLiquidityWithProtectionParams = {
-    pool: SuiAddressType;
-    position: SuiObjectIdType;
-    coin_a: number | string;
-    coin_b: number | string;
-    /**
-     * The address type of the coin A.
-     */
-    coinAType: SuiAddressType;
-    /**
-     * The address type of the coin A.
-     */
-    coinBType: SuiAddressType;
-    max_amount_a: number;
-    max_amount_b: number;
-    min_amount_a: number;
-    min_amount_b: number;
-    fix_amount_a: boolean;
-};
+type AddLiquidityWithProtectionParams = AddLiquidityFixTokenParams & {};
 
 /**
  * Represents tick data for a liquidity pool.
@@ -2632,6 +2614,17 @@ declare class PositionModule implements IModule {
         slippage: number;
         curSqrtPrice: BN;
     }, tx?: Transaction, inputCoinA?: TransactionObjectArgument, inputCoinB?: TransactionObjectArgument): Promise<Transaction>;
+    /**
+     * create add liquidity transaction payload with fix token
+     * @param {AddLiquidityFixTokenParams} params
+     * @param gasEstimateArg : When the fix input amount is SUI, gasEstimateArg can control whether to recalculate the number of SUI to prevent insufficient gas.
+     * If this parameter is not passed, gas estimation is not performed
+     * @returns {Promise<TransactionBlock>}
+     */
+    createAddLiquidityFixTokenWithProtectionPayload(params: AddLiquidityWithProtectionParams, gasEstimateArg?: {
+        slippage: number;
+        curSqrtPrice: BN;
+    }, tx?: Transaction, inputCoinA?: TransactionObjectArgument, inputCoinB?: TransactionObjectArgument): Promise<Transaction>;
     /**
      * create add liquidity transaction payload
      * @param {AddLiquidityParams} params
@@ -2674,8 +2667,6 @@ declare class PositionModule implements IModule {
         feeOwedA: any;
         feeOwedB: any;
     }>;
-    openPositionWithLiquidityByFixCoinWithProtection(params: OpenPositionAddLiquidityWithProtectionParams): Promise<Transaction>;
-    addLiquidityByFixCoinWithProtection(params: AddLiquidityWithProtectionParams): Promise<Transaction>;
     /**
      * Updates the cache for the given key.
      * @param {string} key The key of the cache entry to update.
@@ -3724,6 +3715,13 @@ declare class TransactionUtil {
      * @returns
      */
     static buildAddLiquidityFixToken(sdk: MagmaClmmSDK, allCoinAsset: CoinAsset[], params: AddLiquidityFixTokenParams, tx?: Transaction, inputCoinA?: TransactionObjectArgument, inputCoinB?: TransactionObjectArgument): Promise<Transaction>;
+    /**
+     * build add liquidity with protection transaction
+     * @param params
+     * @param packageId
+     * @returns
+     */
+    static buildAddLiquidityWithProtectionFixToken(sdk: MagmaClmmSDK, allCoinAsset: CoinAsset[], params: AddLiquidityFixTokenParams, tx?: Transaction, inputCoinA?: TransactionObjectArgument, inputCoinB?: TransactionObjectArgument): Promise<Transaction>;
     static buildAddLiquidityFixTokenCoinInput(tx: Transaction, need_interval_amount: boolean, amount: number | string, slippage: number, coinType: string, allCoinAsset: CoinAsset[], buildVector?: boolean): BuildCoinResult;
     /**
      * fix add liquidity fix token for coin amount
@@ -3734,6 +3732,7 @@ declare class TransactionUtil {
      */
     static fixAddLiquidityFixTokenParams(params: AddLiquidityFixTokenParams, slippage: number, curSqrtPrice: BN): AddLiquidityFixTokenParams;
     private static buildAddLiquidityFixTokenArgs;
+    private static buildAddLiquidityWithProtectionFixTokenArgs;
     /**
      * build add liquidity transaction
      * @param params
@@ -3770,8 +3769,6 @@ declare class TransactionUtil {
     static buildClaimVotingRewardsPoolsTransaction(sdk: MagmaClmmSDK, params: ClaimFeesPoolsParams): Transaction;
     static buildClaimAndLockRebases(sdk: MagmaClmmSDK, params: ClaimAndLockParams): Transaction;
     static buildPoke(sdk: MagmaClmmSDK, params: PokeParams): Transaction;
-    static buildOpenPositionWithLiquidityByFixCoinWithProtection(sdk: MagmaClmmSDK, params: OpenPositionAddLiquidityWithProtectionParams, allCoinAsset: CoinAsset[]): Transaction;
-    static buildAddLiquidityByFixCoinWithProtection(sdk: MagmaClmmSDK, params: AddLiquidityWithProtectionParams, allCoinAsset: CoinAsset[]): Transaction;
     static buildClaimVotingBribe(sdk: MagmaClmmSDK, locks: string[], incentive_tokens: string[]): Transaction;
     /**
      * build swap transaction

package/dist/index.js

@@ -1235,8 +1235,8 @@ var ClmmPoolUtil = class {
       liquidity = estimateLiquidityForCoinB(curSqrtPrice, lowerSqrtPrice, coinAmount);
     }
     const coinAmounts = ClmmPoolUtil.getCoinAmountFromLiquidity(liquidity, curSqrtPrice, lowerSqrtPrice, upperSqrtPrice, roundUp);
-    const tokenLimitA = roundUp ? d(coinAmounts.coinA.toString()).mul(1 + slippage).toString() : d(coinAmounts.coinA.toString()).mul(1 - slippage).toString();
-    const tokenLimitB = roundUp ? d(coinAmounts.coinB.toString()).mul(1 + slippage).toString() : d(coinAmounts.coinB.toString()).mul(1 - slippage).toString();
+    const tokenLimitA = iscoinA ? d(coinAmounts.coinA.toString()).mul(1 + slippage).toString() : d(coinAmounts.coinA.toString()).mul(1 - slippage).toString();
+    const tokenLimitB = iscoinA ? d(coinAmounts.coinB.toString()).mul(1 + slippage).toString() : d(coinAmounts.coinB.toString()).mul(1 - slippage).toString();
     return {
       coinAmountA: coinAmounts.coinA,
       coinAmountB: coinAmounts.coinB,
@@ -2817,6 +2817,62 @@ var _TransactionUtil = class {
     );
     return tx;
   }
+  /**
+   * build add liquidity with protection transaction
+   * @param params
+   * @param packageId
+   * @returns
+   */
+  static async buildAddLiquidityWithProtectionFixToken(sdk, allCoinAsset, params, tx, inputCoinA, inputCoinB) {
+    if (sdk.senderAddress.length === 0) {
+      throw Error("this config sdk senderAddress is empty");
+    }
+    tx = tx || new import_transactions.Transaction();
+    let primaryCoinAInputs;
+    let primaryCoinBInputs;
+    if (inputCoinA == null || inputCoinB == null) {
+      primaryCoinAInputs = _TransactionUtil.buildAddLiquidityFixTokenCoinInput(
+        tx,
+        !params.fix_amount_a,
+        params.amount_a,
+        params.slippage,
+        params.coinTypeA,
+        allCoinAsset,
+        false
+      );
+      primaryCoinBInputs = _TransactionUtil.buildAddLiquidityFixTokenCoinInput(
+        tx,
+        params.fix_amount_a,
+        params.amount_b,
+        params.slippage,
+        params.coinTypeB,
+        allCoinAsset,
+        false
+      );
+    } else {
+      primaryCoinAInputs = {
+        targetCoin: inputCoinA,
+        remainCoins: [],
+        isMintZeroCoin: false,
+        tragetCoinAmount: "0"
+      };
+      primaryCoinBInputs = {
+        targetCoin: inputCoinB,
+        remainCoins: [],
+        isMintZeroCoin: false,
+        tragetCoinAmount: "0"
+      };
+    }
+    tx = _TransactionUtil.buildAddLiquidityWithProtectionFixTokenArgs(
+      tx,
+      sdk,
+      allCoinAsset,
+      params,
+      primaryCoinAInputs,
+      primaryCoinBInputs
+    );
+    return tx;
+  }
   static buildAddLiquidityFixTokenCoinInput(tx, need_interval_amount, amount, slippage, coinType, allCoinAsset, buildVector = true) {
     return need_interval_amount ? _TransactionUtil.buildCoinForAmountInterval(
       tx,
@@ -2892,6 +2948,67 @@ var _TransactionUtil = class {
     });
     return tx;
   }
+  static buildAddLiquidityWithProtectionFixTokenArgs(tx, sdk, allCoinAsset, params, primaryCoinAInputs, primaryCoinBInputs) {
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const functionName = params.is_open ? "open_position_with_liquidity_by_fix_coin_with_protection" : "add_liquidity_by_fix_coin_with_protection";
+    const { clmm_pool, integrate } = sdk.sdkOptions;
+    if (!params.is_open) {
+      tx = _TransactionUtil.createCollectRewarderAndFeeParams(
+        sdk,
+        tx,
+        params,
+        allCoinAsset,
+        primaryCoinAInputs.remainCoins,
+        primaryCoinBInputs.remainCoins
+      );
+    }
+    const clmmConfig = getPackagerConfigs(clmm_pool);
+    let min_amount_a, max_amount_a, min_amount_b, max_amount_b;
+    if (params.fix_amount_a) {
+      max_amount_a = params.amount_a;
+      min_amount_a = params.amount_a;
+      max_amount_b = params.amount_b;
+      min_amount_b = new import_decimal7.default(params.amount_b).div(new import_decimal7.default(1).plus(new import_decimal7.default(params.slippage))).mul(new import_decimal7.default(1).minus(new import_decimal7.default(params.slippage))).toNumber();
+    } else {
+      max_amount_b = params.amount_b;
+      min_amount_b = params.amount_b;
+      max_amount_a = params.amount_a;
+      min_amount_a = new import_decimal7.default(params.amount_a).div(new import_decimal7.default(1).plus(new import_decimal7.default(params.slippage))).mul(new import_decimal7.default(1).minus(new import_decimal7.default(params.slippage))).toNumber();
+    }
+    const args = params.is_open ? [
+      tx.object(clmmConfig.global_config_id),
+      tx.object(params.pool_id),
+      tx.pure.u32(Number(asUintN(BigInt(params.tick_lower)).toString())),
+      tx.pure.u32(Number(asUintN(BigInt(params.tick_upper)).toString())),
+      primaryCoinAInputs.targetCoin,
+      primaryCoinBInputs.targetCoin,
+      tx.pure.u64(max_amount_a),
+      tx.pure.u64(max_amount_b),
+      tx.pure.u64(min_amount_a),
+      tx.pure.u64(min_amount_b),
+      tx.pure.bool(params.fix_amount_a),
+      tx.object(CLOCK_ADDRESS)
+    ] : [
+      tx.object(clmmConfig.global_config_id),
+      tx.object(params.pool_id),
+      tx.object(params.pos_id),
+      primaryCoinAInputs.targetCoin,
+      primaryCoinBInputs.targetCoin,
+      tx.pure.u64(max_amount_a),
+      tx.pure.u64(max_amount_b),
+      tx.pure.u64(min_amount_a),
+      tx.pure.u64(min_amount_b),
+      tx.pure.bool(params.fix_amount_a),
+      tx.object(CLOCK_ADDRESS),
+      tx.object(CLOCK_ADDRESS)
+    ];
+    tx.moveCall({
+      target: `${integrate.published_at}::${ClmmIntegratePoolV2Module}::${functionName}`,
+      typeArguments,
+      arguments: args
+    });
+    return tx;
+  }
   // -------------------------------------------swap--------------------------------------------------//
   /**
    * build add liquidity transaction
@@ -3177,65 +3294,6 @@ var _TransactionUtil = class {
     });
     return tx;
   }
-  static buildOpenPositionWithLiquidityByFixCoinWithProtection(sdk, params, allCoinAsset) {
-    const tx = new import_transactions.Transaction();
-    tx.setSender(sdk.senderAddress);
-    const { clmm_pool, integrate } = sdk.sdkOptions;
-    const globalConfigID = getPackagerConfigs(clmm_pool).global_config_id;
-    const typeArguments = [params.coinAType, params.coinBType];
-    const functionName = "open_position_with_liquidity_by_fix_coin_with_protection";
-    const coinA = _TransactionUtil.buildCoinForAmount(tx, allCoinAsset, BigInt(params.max_amount_a), params.coinAType, false, true);
-    const coinB = _TransactionUtil.buildCoinForAmount(tx, allCoinAsset, BigInt(params.max_amount_b), params.coinBType, false, true);
-    const args = [
-      tx.object(globalConfigID),
-      tx.object(params.pool),
-      tx.pure.u32(params.tick_lower),
-      tx.pure.u32(params.tick_upper),
-      coinA.targetCoin,
-      coinB.targetCoin,
-      tx.pure.u64(params.max_amount_a),
-      tx.pure.u64(params.max_amount_b),
-      tx.pure.u64(params.min_amount_a),
-      tx.pure.u64(params.min_amount_b),
-      tx.pure.bool(params.by_amount_a),
-      tx.object(CLOCK_ADDRESS)
-    ];
-    tx.moveCall({
-      target: `${integrate.published_at}::${Voter}::${functionName}`,
-      typeArguments,
-      arguments: args
-    });
-    return tx;
-  }
-  static buildAddLiquidityByFixCoinWithProtection(sdk, params, allCoinAsset) {
-    const tx = new import_transactions.Transaction();
-    tx.setSender(sdk.senderAddress);
-    const { clmm_pool, integrate } = sdk.sdkOptions;
-    const globalConfigID = getPackagerConfigs(clmm_pool).global_config_id;
-    const typeArguments = [params.coinAType, params.coinBType];
-    const functionName = "add_liquidity_by_fix_coin_with_protection";
-    const coinA = _TransactionUtil.buildCoinForAmount(tx, allCoinAsset, BigInt(params.max_amount_a), params.coinAType, false, true);
-    const coinB = _TransactionUtil.buildCoinForAmount(tx, allCoinAsset, BigInt(params.max_amount_b), params.coinBType, false, true);
-    const args = [
-      tx.object(globalConfigID),
-      tx.object(params.pool),
-      tx.object(params.position),
-      coinA.targetCoin,
-      coinB.targetCoin,
-      tx.pure.u64(params.max_amount_a),
-      tx.pure.u64(params.max_amount_b),
-      tx.pure.u64(params.min_amount_a),
-      tx.pure.u64(params.min_amount_b),
-      tx.pure.bool(params.fix_amount_a),
-      tx.object(CLOCK_ADDRESS)
-    ];
-    tx.moveCall({
-      target: `${integrate.published_at}::${Voter}::${functionName}`,
-      typeArguments,
-      arguments: args
-    });
-    return tx;
-  }
   static buildClaimVotingBribe(sdk, locks, incentive_tokens) {
     const tx = new import_transactions.Transaction();
     tx.setGasBudget(5e8);
@@ -5509,6 +5567,36 @@ var PositionModule = class {
     }
     return TransactionUtil.buildAddLiquidityFixToken(this._sdk, allCoinAsset, params, tx, inputCoinA, inputCoinB);
   }
+  /**
+   * create add liquidity transaction payload with fix token
+   * @param {AddLiquidityFixTokenParams} params
+   * @param gasEstimateArg : When the fix input amount is SUI, gasEstimateArg can control whether to recalculate the number of SUI to prevent insufficient gas.
+   * If this parameter is not passed, gas estimation is not performed
+   * @returns {Promise<TransactionBlock>}
+   */
+  async createAddLiquidityFixTokenWithProtectionPayload(params, gasEstimateArg, tx, inputCoinA, inputCoinB) {
+    if (!checkInvalidSuiAddress(this._sdk.senderAddress)) {
+      throw new ClmmpoolsError("this config sdk senderAddress is not set right", "InvalidSendAddress" /* InvalidSendAddress */);
+    }
+    const allCoinAsset = await this._sdk.getOwnerCoinAssets(this._sdk.senderAddress);
+    if (gasEstimateArg) {
+      const { isAdjustCoinA, isAdjustCoinB } = findAdjustCoin(params);
+      params = params;
+      if (params.fix_amount_a && isAdjustCoinA || !params.fix_amount_a && isAdjustCoinB) {
+        tx = await TransactionUtil.buildAddLiquidityFixTokenForGas(
+          this._sdk,
+          allCoinAsset,
+          params,
+          gasEstimateArg,
+          tx,
+          inputCoinA,
+          inputCoinB
+        );
+        return tx;
+      }
+    }
+    return TransactionUtil.buildAddLiquidityWithProtectionFixToken(this._sdk, allCoinAsset, params, tx, inputCoinA, inputCoinB);
+  }
   /**
    * create add liquidity transaction payload
    * @param {AddLiquidityParams} params
@@ -5755,20 +5843,6 @@ var PositionModule = class {
       feeOwedB: "0"
     };
   }
-  async openPositionWithLiquidityByFixCoinWithProtection(params) {
-    if (this._sdk.senderAddress.length === 0) {
-      throw Error("this config sdk senderAddress is empty");
-    }
-    const allCoinAsset = await this._sdk.getOwnerCoinAssets(this._sdk.senderAddress);
-    return TransactionUtil.buildOpenPositionWithLiquidityByFixCoinWithProtection(this.sdk, params, allCoinAsset);
-  }
-  async addLiquidityByFixCoinWithProtection(params) {
-    if (this._sdk.senderAddress.length === 0) {
-      throw Error("this config sdk senderAddress is empty");
-    }
-    const allCoinAsset = await this._sdk.getOwnerCoinAssets(this._sdk.senderAddress);
-    return TransactionUtil.buildAddLiquidityByFixCoinWithProtection(this.sdk, params, allCoinAsset);
-  }
   /**
    * Updates the cache for the given key.
    * @param {string} key The key of the cache entry to update.