@magmaprotocol/magma-clmm-sdk 0.4.3 → 0.5.0

package/dist/index.d.ts

@@ -965,6 +965,45 @@ type RewarderAmountOwed = {
  * @returns {T} The retrieved configuration.
  */
 declare function getPackagerConfigs<T>(packageObj: Package<T>): T & ({} | null);
+type OpenPositionAddLiquidityWithProtectionParams = {
+    pool: SuiAddressType;
+    tick_lower: number;
+    tick_upper: number;
+    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;
+    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;
+};
 
 /**
  * Represents tick data for a liquidity pool.
@@ -2635,6 +2674,8 @@ 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.
@@ -3729,6 +3770,8 @@ 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
@@ -3959,4 +4002,4 @@ interface InitMagmaSDKOptions {
  */
 declare function initMagmaSDK(options: InitMagmaSDKOptions): MagmaClmmSDK;
 
-export { AMM_SWAP_MODULE, AddLiquidityCommonParams, AddLiquidityFixTokenParams, AddLiquidityParams, AddressAndDirection, AdjustResult, AggregatorResult, AmountSpecified, BasePath, BigNumber, Bits, BuildCoinResult, CLOCK_ADDRESS, CachedContent, CalculateRatesParams, CalculateRatesResult, ClaimAndLockParams, ClaimFeesParams, ClaimFeesPoolsParams, ClmmConfig, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, ClmmPoolConfig, ClmmPoolUtil, ClmmPositionStatus, ClmmpoolData, ClosePositionParams, CoinAmounts, CoinAsset, CoinAssist, CoinConfig, CoinInfoAddress, CoinNode, CoinPairType, CoinProvider, CoinStoreAddress, CollectFeeParams, CollectFeesQuote, CollectFeesQuoteParam, CollectRewarderParams, ConfigModule, CreateLockParams, CreatePartnerEvent, CreatePoolAddLiquidityParams, CreatePoolParams, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, DataPage, DeepbookClobV2Moudle, DeepbookCustodianV2Moudle, DeepbookEndpointsV2Moudle, DeepbookPool, DeepbookUtils, FEE_RATE_DENOMINATOR, FaucetCoin, FetchParams, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, IncreaseLockAmountParams, IncreaseUnlockTimeParams, LaunchpadPoolConfig, LiquidityInput, LockModule, LockPermanentParams, MAX_SQRT_PRICE, MAX_TICK_INDEX, MIN_SQRT_PRICE, MIN_TICK_INDEX, MagmaClmmSDK, MagmaConfigs, MathUtil, MergeLockParams, NFT, ONE, OnePath, OpenPositionParams, Order, POOL_STRUCT, Package, PageQuery, PaginationArgs, PathLink, PathProvider, Percentage, PokeParams, Pool, PoolImmutables, PoolInfo, PoolModule, Position, PositionModule, PositionReward, PositionStatus, PositionUtil, PreRouterSwapParams, PreSwapLpChangeParams, PreSwapParams, PreSwapResult, PreSwapWithMultiPoolParams, PriceResult, RemoveLiquidityParams, RewardDistributor, Rewarder, RewarderAmountOwed, RouterModule, RouterModuleV2, RpcModule, SUI_SYSTEM_STATE_OBJECT_ID, SdkOptions, SplitPath, SplitSwap, SplitSwapResult, SplitUnit, SuiAddressType, SuiBasicTypes, SuiInputTypes, SuiObjectDataWithContent, SuiObjectIdType, SuiResource, SuiStructTag, SuiTxArg, SwapDirection, SwapModule, SwapParams, SwapResult, SwapStepResult, SwapUtils, SwapWithRouterParams, TICK_ARRAY_SIZE, TWO, Tick, TickData, TickMath, TickUtil, TokenConfig, TokenConfigEvent, TokenInfo, TokenModule, TransPreSwapWithMultiPoolParams, TransactionUtil, TransferLockParams, TxBlock, U128, U128_MAX, U64_MAX, VoteParams, Voter, VotingEscrow, ZERO, addHexPrefix, adjustForCoinSlippage, adjustForSlippage, asIntN, asUintN, bufferToHex, buildClmmPositionName, buildNFT, buildPool, buildPosition, buildPositionReward, buildTickData, buildTickDataByEvent, cacheTime24h, cacheTime5min, checkAddress, checkInvalidSuiAddress, clmmMainnet, clmmTestnet, collectFeesQuote, composeType, computeSwap, computeSwapStep, createSplitAmountArray, createSplitArray, createTestTransferTxPayloadParams, d, decimalsMultiplier, MagmaClmmSDK as default, estPoolAPR, estPosAPRResult, estPositionAPRWithDeltaMethod, estPositionAPRWithMultiMethod, estimateLiquidityForCoinA, estimateLiquidityForCoinB, extractAddressFromType, extractStructTagFromType, findAdjustCoin, fixCoinType, fixSuiObjectId, fromDecimalsAmount, getAmountFixedDelta, getAmountUnfixedDelta, getCoinAFromLiquidity, getCoinBFromLiquidity, getDefaultSuiInputType, getDeltaA, getDeltaB, getDeltaDownFromOutput, getDeltaUpFromInput, getFutureTime, getLiquidityFromCoinA, getLiquidityFromCoinB, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getMoveObject, getMoveObjectType, getMovePackageContent, getNearestTickByTick, getNextSqrtPriceAUp, getNextSqrtPriceBDown, getNextSqrtPriceFromInput, getNextSqrtPriceFromOutput, getObjectDeletedResponse, getObjectDisplay, getObjectFields, getObjectId, getObjectNotExistsResponse, getObjectOwner, getObjectPreviousTransactionDigest, getObjectReference, getObjectType, getObjectVersion, getPackagerConfigs, getRewardInTickRange, getSuiObjectData, getTickDataFromUrlData, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, hasPublicTransfer, hexToNumber, hexToString, initMagmaSDK, initMainnetSDK, initTestnetSDK, isSortedSymbols, isSuiObjectResponse, newBits, normalizeCoinType, patchFixSuiObjectId, printTransaction, removeHexPrefix, secretKeyToEd25519Keypair, secretKeyToSecp256k1Keypair, shortAddress, shortString, tickScore, toBuffer, toCoinAmount, toDecimalsAmount, transClmmpoolDataWithoutTicks, utf8to16 };
+export { AMM_SWAP_MODULE, AddLiquidityCommonParams, AddLiquidityFixTokenParams, AddLiquidityParams, AddLiquidityWithProtectionParams, AddressAndDirection, AdjustResult, AggregatorResult, AmountSpecified, BasePath, BigNumber, Bits, BuildCoinResult, CLOCK_ADDRESS, CachedContent, CalculateRatesParams, CalculateRatesResult, ClaimAndLockParams, ClaimFeesParams, ClaimFeesPoolsParams, ClmmConfig, ClmmExpectSwapModule, ClmmFetcherModule, ClmmIntegratePoolModule, ClmmIntegratePoolV2Module, ClmmIntegratePoolV3Module, ClmmIntegrateRouterModule, ClmmIntegrateRouterWithPartnerModule, ClmmIntegrateUtilsModule, ClmmPartnerModule, ClmmPoolConfig, ClmmPoolUtil, ClmmPositionStatus, ClmmpoolData, ClosePositionParams, CoinAmounts, CoinAsset, CoinAssist, CoinConfig, CoinInfoAddress, CoinNode, CoinPairType, CoinProvider, CoinStoreAddress, CollectFeeParams, CollectFeesQuote, CollectFeesQuoteParam, CollectRewarderParams, ConfigModule, CreateLockParams, CreatePartnerEvent, CreatePoolAddLiquidityParams, CreatePoolParams, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, DataPage, DeepbookClobV2Moudle, DeepbookCustodianV2Moudle, DeepbookEndpointsV2Moudle, DeepbookPool, DeepbookUtils, FEE_RATE_DENOMINATOR, FaucetCoin, FetchParams, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, IncreaseLockAmountParams, IncreaseUnlockTimeParams, LaunchpadPoolConfig, LiquidityInput, LockModule, LockPermanentParams, MAX_SQRT_PRICE, MAX_TICK_INDEX, MIN_SQRT_PRICE, MIN_TICK_INDEX, MagmaClmmSDK, MagmaConfigs, MathUtil, MergeLockParams, NFT, ONE, OnePath, OpenPositionAddLiquidityWithProtectionParams, OpenPositionParams, Order, POOL_STRUCT, Package, PageQuery, PaginationArgs, PathLink, PathProvider, Percentage, PokeParams, Pool, PoolImmutables, PoolInfo, PoolModule, Position, PositionModule, PositionReward, PositionStatus, PositionUtil, PreRouterSwapParams, PreSwapLpChangeParams, PreSwapParams, PreSwapResult, PreSwapWithMultiPoolParams, PriceResult, RemoveLiquidityParams, RewardDistributor, Rewarder, RewarderAmountOwed, RouterModule, RouterModuleV2, RpcModule, SUI_SYSTEM_STATE_OBJECT_ID, SdkOptions, SplitPath, SplitSwap, SplitSwapResult, SplitUnit, SuiAddressType, SuiBasicTypes, SuiInputTypes, SuiObjectDataWithContent, SuiObjectIdType, SuiResource, SuiStructTag, SuiTxArg, SwapDirection, SwapModule, SwapParams, SwapResult, SwapStepResult, SwapUtils, SwapWithRouterParams, TICK_ARRAY_SIZE, TWO, Tick, TickData, TickMath, TickUtil, TokenConfig, TokenConfigEvent, TokenInfo, TokenModule, TransPreSwapWithMultiPoolParams, TransactionUtil, TransferLockParams, TxBlock, U128, U128_MAX, U64_MAX, VoteParams, Voter, VotingEscrow, ZERO, addHexPrefix, adjustForCoinSlippage, adjustForSlippage, asIntN, asUintN, bufferToHex, buildClmmPositionName, buildNFT, buildPool, buildPosition, buildPositionReward, buildTickData, buildTickDataByEvent, cacheTime24h, cacheTime5min, checkAddress, checkInvalidSuiAddress, clmmMainnet, clmmTestnet, collectFeesQuote, composeType, computeSwap, computeSwapStep, createSplitAmountArray, createSplitArray, createTestTransferTxPayloadParams, d, decimalsMultiplier, MagmaClmmSDK as default, estPoolAPR, estPosAPRResult, estPositionAPRWithDeltaMethod, estPositionAPRWithMultiMethod, estimateLiquidityForCoinA, estimateLiquidityForCoinB, extractAddressFromType, extractStructTagFromType, findAdjustCoin, fixCoinType, fixSuiObjectId, fromDecimalsAmount, getAmountFixedDelta, getAmountUnfixedDelta, getCoinAFromLiquidity, getCoinBFromLiquidity, getDefaultSuiInputType, getDeltaA, getDeltaB, getDeltaDownFromOutput, getDeltaUpFromInput, getFutureTime, getLiquidityFromCoinA, getLiquidityFromCoinB, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getMoveObject, getMoveObjectType, getMovePackageContent, getNearestTickByTick, getNextSqrtPriceAUp, getNextSqrtPriceBDown, getNextSqrtPriceFromInput, getNextSqrtPriceFromOutput, getObjectDeletedResponse, getObjectDisplay, getObjectFields, getObjectId, getObjectNotExistsResponse, getObjectOwner, getObjectPreviousTransactionDigest, getObjectReference, getObjectType, getObjectVersion, getPackagerConfigs, getRewardInTickRange, getSuiObjectData, getTickDataFromUrlData, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, hasPublicTransfer, hexToNumber, hexToString, initMagmaSDK, initMainnetSDK, initTestnetSDK, isSortedSymbols, isSuiObjectResponse, newBits, normalizeCoinType, patchFixSuiObjectId, printTransaction, removeHexPrefix, secretKeyToEd25519Keypair, secretKeyToSecp256k1Keypair, shortAddress, shortString, tickScore, toBuffer, toCoinAmount, toDecimalsAmount, transClmmpoolDataWithoutTicks, utf8to16 };

package/dist/index.js

@@ -1186,11 +1186,7 @@ var ClmmPoolUtil = class {
       coinB = new decimal_default(0);
     } else if (curSqrtPrice.lt(upperSqrtPrice)) {
       coinA = MathUtil.toX64_Decimal(liq).mul(upperPriceStr.sub(curSqrtPriceStr)).div(curSqrtPriceStr.mul(upperPriceStr));
-      const a = curSqrtPriceStr.sub(lowerPriceStr);
-      const b = liq.mul(a);
-      const c = MathUtil.fromX64_Decimal(b);
-      coinB = c;
-      console.log("########## a, b, c", a, b, c);
+      coinB = MathUtil.fromX64_Decimal(liq.mul(curSqrtPriceStr.sub(lowerPriceStr)));
     } else {
       coinA = new decimal_default(0);
       coinB = MathUtil.fromX64_Decimal(liq.mul(upperPriceStr.sub(lowerPriceStr)));
@@ -3181,6 +3177,65 @@ 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);
@@ -5700,6 +5755,20 @@ 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.