@magmaprotocol/magma-clmm-sdk 0.5.34 → 0.5.35

package/README.md

@@ -7,7 +7,7 @@
 <br />
 <div align="center">
   <a >
-    <img src="./icon_color.svg" alt="Logo" width="100" height="100">
+    <img src="https://app.magmafinance.io/magma.svg" alt="Logo" width="100" height="100">
   </a>
 
   <h3 align="center">Magma-CLMM-SDK</h3>

package/dist/index.d.ts

@@ -37,6 +37,7 @@ declare const Voter = "voter";
 declare const RewardDistributor = "reward_distributor";
 declare const Gauge = "gauge";
 declare const Minter = "minter";
+declare const DlmmScript = "dlmm_script";
 /**
  * The address for CoinInfo module.
  */
@@ -451,6 +452,9 @@ type ClmmConfig = {
      */
     partners_id?: SuiObjectIdType;
 };
+type DlmmConfig = {
+    factory: SuiObjectIdType;
+};
 /**
  * Represents an event to create a liquidity mining partner.
  */
@@ -800,7 +804,7 @@ type CalculateRatesResult = {
 /**
  * Represents parameters for a swap operation.
  */
-type SwapParams = {
+type SwapParams$1 = {
     /**
      * The identifier of the pool.
      */
@@ -2998,7 +3002,7 @@ declare class SwapModule implements IModule {
      * If this parameter is not passed, gas estimation is not performed
      * @returns
      */
-    createSwapTransactionPayload(params: SwapParams, gasEstimateArg?: {
+    createSwapTransactionPayload(params: SwapParams$1, gasEstimateArg?: {
         byAmountIn: boolean;
         slippage: Percentage;
         decimalsA: number;
@@ -3013,7 +3017,7 @@ declare class SwapModule implements IModule {
      * If this parameter is not passed, gas estimation is not performed
      * @returns tx and coin ABs
      */
-    createSwapTransactionWithoutTransferCoinsPayload(params: SwapParams, gasEstimateArg?: {
+    createSwapTransactionWithoutTransferCoinsPayload(params: SwapParams$1, gasEstimateArg?: {
         byAmountIn: boolean;
         slippage: Percentage;
         decimalsA: number;
@@ -3376,6 +3380,134 @@ declare class GaugeModule implements IModule {
     getEpochRewardByPool(pool: string, incentive_tokens: string[]): Promise<Map<string, string>>;
 }
 
+type FetchPairParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+};
+type CreatePairParams = {
+    bin_step: number;
+    coinTypeA: string;
+    coinTypeB: string;
+    coinADecimal: number;
+    coinBDecimal: number;
+    priceTokenBPerTokenA: string;
+};
+type MintPercentParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+    amountATotal: number;
+    amountBTotal: number;
+    storageIds: number[];
+    binsAPercent: number[];
+    binsBPercent: number[];
+    to: string;
+};
+type MintAmountParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+    amountATotal: number;
+    amountBTotal: number;
+    storageIds: number[];
+    amountsA: number[];
+    amountsB: number[];
+    to: string;
+};
+type SwapParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+    amountIn: number;
+    minAmountOut: number;
+    swapForY: boolean;
+    to: string;
+};
+type FetchBinsParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+    offset: number;
+    limit: number;
+};
+type GetPositionLiquidityParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+    positionId: string;
+};
+type GetPairLiquidityParams = {
+    pair: string;
+    coinTypeA: string;
+    coinTypeB: string;
+};
+type EventPairParams = {
+    base_factor: number;
+    filter_period: number;
+    decay_period: number;
+    reduction_factor: number;
+    variable_fee_control: number;
+    protocol_share: number;
+    max_volatility_accumulator: number;
+    volatility_accumulator: number;
+    volatility_reference: number;
+    index_reference: number;
+    time_of_last_update: number | string;
+    oracle_index: number;
+    active_index: number;
+};
+type EventBin = {
+    storage_id: number | string;
+    price_q128: number | string;
+    reserve_x: number | string;
+    reserve_y: number | string;
+    staked_liquidity: number | string;
+    staked_lp_amount: number | string;
+    fee_x: number | string;
+    fee_y: number | string;
+    fee_growth_x: number | string;
+    fee_growth_y: number | string;
+    rewarder_growth: number[] | string[];
+    distribution_growth: number | string;
+    distribution_last_updated: number | string;
+};
+type EventPositionLiquidity = {
+    shares: number | string;
+    liquidity: number | string;
+    x_equivalent: number | string;
+    y_equivalent: number | string;
+    bin_ids: number[] | string[];
+    bin_x_eq: number[] | string[];
+    bin_y_eq: number[] | string[];
+    bin_liquidity: number[] | string[];
+};
+type EventPairLiquidity = {
+    shares: number | string;
+    liquidity: number | string;
+    x: number | string;
+    y: number | string;
+    bin_ids: number[] | string[];
+    bin_x: number[] | string[];
+    bin_y: number[] | string[];
+};
+
+declare class DlmmModule implements IModule {
+    protected _sdk: MagmaClmmSDK;
+    constructor(sdk: MagmaClmmSDK);
+    get sdk(): MagmaClmmSDK;
+    fetchPairParams(params: FetchPairParams): Promise<EventPairParams>;
+    price_to_storage_id(price: string, bin_step: number, tokenADecimal: number, tokenBDecimal: number): number;
+    createPairPayload(params: CreatePairParams): Promise<Transaction>;
+    createAddLiquidityPayload(): Promise<Transaction>;
+    mintPercent(params: MintPercentParams): Promise<Transaction>;
+    createPositionByAmount(params: MintAmountParams): Promise<Transaction>;
+    swap(params: SwapParams): Promise<Transaction>;
+    fetchBins(params: FetchBinsParams): Promise<EventBin[]>;
+    getPositionLiquidity(params: GetPositionLiquidityParams): Promise<EventPositionLiquidity>;
+    getPairLiquidity(params: GetPairLiquidityParams): Promise<EventPairLiquidity>;
+}
+
 /**
  * Represents options and configurations for an SDK.
  */
@@ -3413,6 +3545,7 @@ type SdkOptions = {
      * Package containing Cryptocurrency Liquidity Mining Module (CLMM) pool configurations.
      */
     clmm_pool: Package<ClmmConfig>;
+    dlmm_pool: Package<DlmmConfig>;
     distribution: Package;
     /**
      * Package containing integration-related configurations.
@@ -3461,6 +3594,7 @@ declare class MagmaClmmSDK {
      */
     protected _lock: LockModule;
     protected _gauge: GaugeModule;
+    protected _dlmm: DlmmModule;
     /**
      * Provide interact  with a position rewarder interface.
      */
@@ -3508,6 +3642,7 @@ declare class MagmaClmmSDK {
     get Swap(): SwapModule;
     get Lock(): LockModule;
     get Gauge(): GaugeModule;
+    get Dlmm(): DlmmModule;
     /**
      * Getter for the fullClient property.
      * @returns {RpcModule} The fullClient property value.
@@ -3839,7 +3974,7 @@ declare class TransactionUtil {
      * @param curSqrtPrice
      * @returns
      */
-    static buildSwapTransactionForGas(sdk: MagmaClmmSDK, params: SwapParams, allCoinAsset: CoinAsset[], gasEstimateArg: {
+    static buildSwapTransactionForGas(sdk: MagmaClmmSDK, params: SwapParams$1, allCoinAsset: CoinAsset[], gasEstimateArg: {
         byAmountIn: boolean;
         slippage: Percentage;
         decimalsA: number;
@@ -3853,7 +3988,7 @@ declare class TransactionUtil {
      * @param packageId
      * @returns
      */
-    static buildSwapTransaction(sdk: MagmaClmmSDK, params: SwapParams, allCoinAsset: CoinAsset[]): Transaction;
+    static buildSwapTransaction(sdk: MagmaClmmSDK, params: SwapParams$1, allCoinAsset: CoinAsset[]): Transaction;
     static buildCreateLockTransaction(sdk: MagmaClmmSDK, params: CreateLockParams, allCoinAsset: CoinAsset[]): Transaction;
     static buildCreateTransactionArgs(tx: Transaction, params: CreateLockParams, sdkOptions: SdkOptions, lockCoinInput: BuildCoinResult): Transaction;
     static buildIncreaseLockAmountTransaction(sdk: MagmaClmmSDK, params: IncreaseLockAmountParams, allCoinAsset: CoinAsset[]): Transaction;
@@ -3877,7 +4012,7 @@ declare class TransactionUtil {
      * @param packageId
      * @returns
      */
-    static buildSwapTransactionArgs(tx: Transaction, params: SwapParams, sdkOptions: SdkOptions, primaryCoinInputA: BuildCoinResult, primaryCoinInputB: BuildCoinResult): Transaction;
+    static buildSwapTransactionArgs(tx: Transaction, params: SwapParams$1, sdkOptions: SdkOptions, primaryCoinInputA: BuildCoinResult, primaryCoinInputB: BuildCoinResult): Transaction;
     /**
      * build add liquidity transaction with out transfer coins
      * @param params
@@ -3885,7 +4020,7 @@ declare class TransactionUtil {
      * @param curSqrtPrice
      * @returns
      */
-    static buildSwapTransactionWithoutTransferCoinsForGas(sdk: MagmaClmmSDK, params: SwapParams, allCoinAsset: CoinAsset[], gasEstimateArg: {
+    static buildSwapTransactionWithoutTransferCoinsForGas(sdk: MagmaClmmSDK, params: SwapParams$1, allCoinAsset: CoinAsset[], gasEstimateArg: {
         byAmountIn: boolean;
         slippage: Percentage;
         decimalsA: number;
@@ -3902,7 +4037,7 @@ declare class TransactionUtil {
      * @param packageId
      * @returns
      */
-    static buildSwapTransactionWithoutTransferCoins(sdk: MagmaClmmSDK, params: SwapParams, allCoinAsset: CoinAsset[]): {
+    static buildSwapTransactionWithoutTransferCoins(sdk: MagmaClmmSDK, params: SwapParams$1, allCoinAsset: CoinAsset[]): {
         tx: Transaction;
         coinABs: TransactionObjectArgument[];
     };
@@ -3912,18 +4047,18 @@ declare class TransactionUtil {
      * @param packageId
      * @returns
      */
-    static buildSwapTransactionWithoutTransferCoinArgs(sdk: MagmaClmmSDK, tx: Transaction, params: SwapParams, sdkOptions: SdkOptions, primaryCoinInputA: BuildCoinResult, primaryCoinInputB: BuildCoinResult): {
+    static buildSwapTransactionWithoutTransferCoinArgs(sdk: MagmaClmmSDK, tx: Transaction, params: SwapParams$1, sdkOptions: SdkOptions, primaryCoinInputA: BuildCoinResult, primaryCoinInputB: BuildCoinResult): {
         tx: Transaction;
         txRes: TransactionObjectArgument[];
     };
-    static fixSwapParams(sdk: MagmaClmmSDK, params: SwapParams, gasEstimateArg: {
+    static fixSwapParams(sdk: MagmaClmmSDK, params: SwapParams$1, gasEstimateArg: {
         byAmountIn: boolean;
         slippage: Percentage;
         decimalsA: number;
         decimalsB: number;
         swapTicks: Array<TickData>;
         currentPool: Pool;
-    }): Promise<SwapParams>;
+    }): Promise<SwapParams$1>;
     static syncBuildCoinInputForAmount(sdk: MagmaClmmSDK, tx: Transaction, amount: bigint, coinType: string, buildVector?: boolean, fixAmount?: boolean): Promise<TransactionObjectArgument | undefined>;
     static buildCoinForAmount(tx: Transaction, allCoins: CoinAsset[], amount: bigint, coinType: string, buildVector?: boolean, fixAmount?: boolean): BuildCoinResult;
     private static buildVectorCoin;
@@ -4103,4 +4238,4 @@ interface InitMagmaSDKOptions {
  */
 declare function initMagmaSDK(options: InitMagmaSDKOptions): MagmaClmmSDK;
 
-export { AMM_SWAP_MODULE, AddBribeReward, 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, DepositPosition, EpochEmission, FEE_RATE_DENOMINATOR, FaucetCoin, FetchParams, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, Gauge, GetRewardByPosition, IncreaseLockAmountParams, IncreaseUnlockTimeParams, LaunchpadPoolConfig, LiquidityInput, LockModule, LockPermanentParams, LockVoteEvent, MAX_SQRT_PRICE, MAX_TICK_INDEX, MIN_SQRT_PRICE, MIN_TICK_INDEX, MagmaClmmSDK, MagmaConfigs, MathUtil, MergeLockParams, Minter, 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, StakedPositionOfPool, 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, WithdrawPosition, 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, AddBribeReward, 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, DepositPosition, DlmmConfig, DlmmScript, EpochEmission, FEE_RATE_DENOMINATOR, FaucetCoin, FetchParams, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, Gauge, GetRewardByPosition, IncreaseLockAmountParams, IncreaseUnlockTimeParams, LaunchpadPoolConfig, LiquidityInput, LockModule, LockPermanentParams, LockVoteEvent, MAX_SQRT_PRICE, MAX_TICK_INDEX, MIN_SQRT_PRICE, MIN_TICK_INDEX, MagmaClmmSDK, MagmaConfigs, MathUtil, MergeLockParams, Minter, 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, StakedPositionOfPool, SuiAddressType, SuiBasicTypes, SuiInputTypes, SuiObjectDataWithContent, SuiObjectIdType, SuiResource, SuiStructTag, SuiTxArg, SwapDirection, SwapModule, SwapParams$1 as 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, WithdrawPosition, 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

@@ -64,6 +64,7 @@ __export(src_exports, {
   DeepbookCustodianV2Moudle: () => DeepbookCustodianV2Moudle,
   DeepbookEndpointsV2Moudle: () => DeepbookEndpointsV2Moudle,
   DeepbookUtils: () => DeepbookUtils,
+  DlmmScript: () => DlmmScript,
   FEE_RATE_DENOMINATOR: () => FEE_RATE_DENOMINATOR,
   GAS_SYMBOL: () => GAS_SYMBOL,
   GAS_TYPE_ARG: () => GAS_TYPE_ARG,
@@ -508,6 +509,7 @@ var Voter = "voter";
 var RewardDistributor = "reward_distributor";
 var Gauge = "gauge";
 var Minter = "minter";
+var DlmmScript = "dlmm_script";
 var CoinInfoAddress = "0x1::coin::CoinInfo";
 var CoinStoreAddress = "0x1::coin::CoinStore";
 var DeepbookCustodianV2Moudle = "custodian_v2";
@@ -10049,6 +10051,277 @@ var GaugeModule = class {
   }
 };
 
+// src/modules/dlmm.ts
+var import_transactions12 = require("@mysten/sui/transactions");
+var import_decimal10 = __toESM(require("decimal.js"));
+var import_calc_dlmm = require("@magmaprotocol/calc_dlmm");
+var DlmmModule = class {
+  _sdk;
+  constructor(sdk) {
+    this._sdk = sdk;
+  }
+  get sdk() {
+    return this._sdk;
+  }
+  // eg: fetch pool active_index
+  async fetchPairParams(params) {
+    const tx = new import_transactions12.Transaction();
+    const { integrate, simulationAccount } = this.sdk.sdkOptions;
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const args = [tx.object(params.pair)];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::fetch_pair_params`,
+      arguments: args,
+      typeArguments
+    });
+    const simulateRes = await this.sdk.fullClient.devInspectTransactionBlock({
+      transactionBlock: tx,
+      sender: simulationAccount.address
+    });
+    if (simulateRes.error != null) {
+      throw new Error(`fetchBins error code: ${simulateRes.error ?? "unknown error"}`);
+    }
+    let res = {
+      base_factor: 0,
+      filter_period: 0,
+      decay_period: 0,
+      reduction_factor: 0,
+      variable_fee_control: 0,
+      protocol_share: 0,
+      max_volatility_accumulator: 0,
+      volatility_accumulator: 0,
+      volatility_reference: 0,
+      index_reference: 0,
+      time_of_last_update: 0,
+      oracle_index: 0,
+      active_index: 0
+    };
+    simulateRes.events?.forEach((item) => {
+      console.log(extractStructTagFromType(item.type).name);
+      if (extractStructTagFromType(item.type).name === `EventPairParams`) {
+        res = item.parsedJson.params;
+      }
+    });
+    return res;
+  }
+  // params price: input (b/(10^b_decimal))/(a/(10^a_decimal))
+  price_to_storage_id(price, bin_step, tokenADecimal, tokenBDecimal) {
+    const priceDec = new import_decimal10.default(price);
+    const tenDec = new import_decimal10.default(10);
+    const twoDec = new import_decimal10.default(2);
+    const price_x128 = priceDec.mul(tenDec.pow(tokenBDecimal)).div(tenDec.pow(tokenADecimal)).mul(twoDec.pow(128));
+    const active_id = (0, import_calc_dlmm.get_real_id_from_price)(price_x128.toFixed(0).toString(), bin_step);
+    return (0, import_calc_dlmm.get_storage_id_from_real_id)(active_id);
+  }
+  // NOTE: x, y should be sorted
+  async createPairPayload(params) {
+    const storage_id = this.price_to_storage_id(params.priceTokenBPerTokenA, params.bin_step, params.coinADecimal, params.coinBDecimal);
+    const tx = new import_transactions12.Transaction();
+    tx.setSender(this.sdk.senderAddress);
+    const { clmm_pool, dlmm_pool, integrate } = this.sdk.sdkOptions;
+    const { global_config_id } = getPackagerConfigs(clmm_pool);
+    const dlmmConfig = getPackagerConfigs(dlmm_pool);
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const args = [tx.object(dlmmConfig.factory), tx.object(global_config_id), tx.pure.u16(params.bin_step), tx.pure.u32(storage_id)];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::create_pair`,
+      typeArguments,
+      arguments: args
+    });
+    return tx;
+  }
+  async createAddLiquidityPayload() {
+    const tx = new import_transactions12.Transaction();
+    return tx;
+  }
+  // Create a position by percent
+  async mintPercent(params) {
+    const tx = new import_transactions12.Transaction();
+    tx.setSender(this.sdk.senderAddress);
+    const { dlmm_pool, integrate } = this.sdk.sdkOptions;
+    const dlmmConfig = getPackagerConfigs(dlmm_pool);
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const allCoins = await this._sdk.getOwnerCoinAssets(this._sdk.senderAddress);
+    const primaryCoinAInputs = TransactionUtil.buildCoinForAmount(tx, allCoins, BigInt(params.amountATotal), params.coinTypeA, false, true);
+    const primaryCoinBInputs = TransactionUtil.buildCoinForAmount(tx, allCoins, BigInt(params.amountBTotal), params.coinTypeB, false, true);
+    const args = [
+      tx.object(params.pair),
+      tx.object(dlmmConfig.factory),
+      primaryCoinAInputs.targetCoin,
+      primaryCoinBInputs.targetCoin,
+      tx.pure.u64(params.amountATotal),
+      tx.pure.u64(params.amountBTotal),
+      tx.pure.vector("u32", params.storageIds),
+      tx.pure.vector("u64", params.binsAPercent),
+      tx.pure.vector("u64", params.binsBPercent),
+      tx.pure.address(params.to),
+      tx.object(CLOCK_ADDRESS)
+    ];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::mint_percent`,
+      typeArguments,
+      arguments: args
+    });
+    return tx;
+  }
+  // Create a position by amount
+  async createPositionByAmount(params) {
+    const tx = new import_transactions12.Transaction();
+    tx.setSender(this.sdk.senderAddress);
+    const { dlmm_pool, integrate } = this.sdk.sdkOptions;
+    const dlmmConfig = getPackagerConfigs(dlmm_pool);
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const allCoins = await this._sdk.getOwnerCoinAssets(this._sdk.senderAddress);
+    const primaryCoinAInputs = TransactionUtil.buildCoinForAmount(tx, allCoins, BigInt(params.amountATotal), params.coinTypeA, false, true);
+    const primaryCoinBInputs = TransactionUtil.buildCoinForAmount(tx, allCoins, BigInt(params.amountBTotal), params.coinTypeB, false, true);
+    const args = [
+      tx.object(params.pair),
+      tx.object(dlmmConfig.factory),
+      primaryCoinAInputs.targetCoin,
+      primaryCoinBInputs.targetCoin,
+      tx.pure.vector("u32", params.storageIds),
+      tx.pure.vector("u64", params.amountsA),
+      tx.pure.vector("u64", params.amountsB),
+      tx.pure.address(params.to),
+      tx.object(CLOCK_ADDRESS)
+    ];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::mint_amounts`,
+      typeArguments,
+      arguments: args
+    });
+    return tx;
+  }
+  async swap(params) {
+    const tx = new import_transactions12.Transaction();
+    tx.setSender(this.sdk.senderAddress);
+    const { clmm_pool, integrate } = this.sdk.sdkOptions;
+    const { global_config_id } = getPackagerConfigs(clmm_pool);
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const args = [
+      tx.object(params.pair),
+      tx.object(global_config_id),
+      tx.object(params.coinTypeA),
+      tx.object(params.coinTypeB),
+      tx.pure.u64(params.amountIn),
+      tx.pure.u64(params.minAmountOut),
+      tx.pure.bool(params.swapForY),
+      tx.pure.address(params.to),
+      tx.object(CLOCK_ADDRESS)
+    ];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::swap`,
+      typeArguments,
+      arguments: args
+    });
+    return tx;
+  }
+  async fetchBins(params) {
+    const tx = new import_transactions12.Transaction();
+    const { integrate, simulationAccount } = this.sdk.sdkOptions;
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const args = [tx.object(params.pair), tx.pure.u64(params.offset), tx.pure.u64(params.limit)];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::fetch_bins`,
+      arguments: args,
+      typeArguments
+    });
+    const simulateRes = await this.sdk.fullClient.devInspectTransactionBlock({
+      transactionBlock: tx,
+      sender: simulationAccount.address
+    });
+    if (simulateRes.error != null) {
+      throw new Error(`fetchBins error code: ${simulateRes.error ?? "unknown error"}`);
+    }
+    const res = [];
+    simulateRes.events?.forEach((item) => {
+      if (extractStructTagFromType(item.type).name === `EventFetchBins`) {
+      }
+    });
+    return res;
+  }
+  async getPositionLiquidity(params) {
+    const tx = new import_transactions12.Transaction();
+    const { integrate, simulationAccount } = this.sdk.sdkOptions;
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const args = [tx.object(params.pair), tx.object(params.positionId)];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::position_liquidity`,
+      arguments: args,
+      typeArguments
+    });
+    const simulateRes = await this.sdk.fullClient.devInspectTransactionBlock({
+      transactionBlock: tx,
+      sender: simulationAccount.address
+    });
+    if (simulateRes.error != null) {
+      throw new Error(`fetchBins error code: ${simulateRes.error ?? "unknown error"}`);
+    }
+    const out = {
+      shares: 0,
+      liquidity: 0,
+      x_equivalent: 0,
+      y_equivalent: 0,
+      bin_ids: [],
+      bin_x_eq: [],
+      bin_y_eq: [],
+      bin_liquidity: []
+    };
+    simulateRes.events?.forEach((item) => {
+      if (extractStructTagFromType(item.type).name === `EventPositionLiquidity`) {
+        out.shares = item.parsedJson.shares;
+        out.liquidity = item.parsedJson.liquidity;
+        out.x_equivalent = item.parsedJson.x_equivalent;
+        out.y_equivalent = item.parsedJson.y_equivalent;
+        out.bin_ids = item.parsedJson.bin_id;
+        out.bin_x_eq = item.parsedJson.bin_x_eq;
+        out.bin_y_eq = item.parsedJson.bin_y_eq;
+        out.bin_liquidity = item.parsedJson.bin_liquidity;
+      }
+    });
+    return out;
+  }
+  async getPairLiquidity(params) {
+    const tx = new import_transactions12.Transaction();
+    const { integrate, simulationAccount } = this.sdk.sdkOptions;
+    const typeArguments = [params.coinTypeA, params.coinTypeB];
+    const args = [tx.object(params.pair)];
+    tx.moveCall({
+      target: `${integrate.published_at}::${DlmmScript}::pair_liquidity`,
+      arguments: args,
+      typeArguments
+    });
+    const simulateRes = await this.sdk.fullClient.devInspectTransactionBlock({
+      transactionBlock: tx,
+      sender: simulationAccount.address
+    });
+    if (simulateRes.error != null) {
+      throw new Error(`fetchBins error code: ${simulateRes.error ?? "unknown error"}`);
+    }
+    const out = {
+      shares: 0,
+      liquidity: 0,
+      x: 0,
+      y: 0,
+      bin_ids: [],
+      bin_x: [],
+      bin_y: []
+    };
+    simulateRes.events?.forEach((item) => {
+      if (extractStructTagFromType(item.type).name === `EventPositionLiquidity`) {
+        out.shares = item.parsedJson.shares;
+        out.liquidity = item.parsedJson.liquidity;
+        out.x = item.parsedJson.x;
+        out.y = item.parsedJson.y;
+        out.bin_ids = item.bin_ids;
+        out.bin_x = item.bin_x;
+        out.bin_y = item.bin_y;
+      }
+    });
+    return out;
+  }
+};
+
 // src/sdk.ts
 var MagmaClmmSDK = class {
   _cache = {};
@@ -10073,6 +10346,7 @@ var MagmaClmmSDK = class {
    */
   _lock;
   _gauge;
+  _dlmm;
   /**
    * Provide interact  with a position rewarder interface.
    */
@@ -10110,6 +10384,7 @@ var MagmaClmmSDK = class {
     this._swap = new SwapModule(this);
     this._lock = new LockModule(this);
     this._gauge = new GaugeModule(this);
+    this._dlmm = new DlmmModule(this);
     this._pool = new PoolModule(this);
     this._position = new PositionModule(this);
     this._rewarder = new RewarderModule(this);
@@ -10147,6 +10422,9 @@ var MagmaClmmSDK = class {
   get Gauge() {
     return this._gauge;
   }
+  get Dlmm() {
+    return this._dlmm;
+  }
   /**
    * Getter for the fullClient property.
    * @returns {RpcModule} The fullClient property value.
@@ -10320,6 +10598,7 @@ var main_default = MagmaClmmSDK;
 var SDKConfig = {
   clmmConfig: {
     pools_id: "0xfa145b9de10fe858be81edd1c6cdffcf27be9d016de02a1345eb1009a68ba8b2",
+    // clmm and dlmm both use this global_config
     global_config_id: "0x4c4e1402401f72c7d8533d0ed8d5f8949da363c7a3319ccef261ffe153d32f8a",
     global_vault_id: "0xa7e1102f222b6eb81ccc8a126e7feb2353342be9df6f6646a77c4519da29c071",
     admin_cap_id: "0x89c1a321291d15ddae5a086c9abc533dff697fde3d89e0ca836c41af73e36a75"
@@ -10339,7 +10618,11 @@ var SDKConfig = {
     distribution_cfg: "0xaff8d151ac29317201151f97d28c546b3c5923d8cfc5499f40dea61c4022c949",
     magma_token: "0x7161c6c6bb65f852797c8f7f5c4f8d57adaf796e1b840921f9e23fabeadfd54e::magma::MAGMA",
     minter_id: "0x4fa5766cd83b33b215b139fec27ac344040f3bbd84fcbee7b61fc671aadc51fa"
-  }
+  },
+  dlmmConfig: {
+    factory: ""
+  },
+  gaugeConfig: {}
 };
 var clmmMainnet = {
   fullRpcUrl: (0, import_client2.getFullnodeUrl)("mainnet"),
@@ -10356,6 +10639,11 @@ var clmmMainnet = {
     published_at: "0x4a35d3dfef55ed3631b7158544c6322a23bc434fe4fca1234cb680ce0505f82d",
     config: SDKConfig.clmmConfig
   },
+  dlmm_pool: {
+    package_id: "",
+    published_at: "",
+    config: SDKConfig.dlmmConfig
+  },
   distribution: {
     package_id: "0xee4a1f231dc45a303389998fe26c4e39278cf68b404b32e4f0b9769129b8267b",
     published_at: "0xee4a1f231dc45a303389998fe26c4e39278cf68b404b32e4f0b9769129b8267b"
@@ -10409,6 +10697,9 @@ var SDKConfig2 = {
     distribution_cfg: "0x94e23846c975e2faf89a61bfc2b10ad64decab9069eb1f9fc39752b010868c74",
     magma_token: "0x45ac2371c33ca0df8dc784d62c8ce5126d42edd8c56820396524dff2ae0619b1::magma_token::MAGMA_TOKEN",
     minter_id: "0x89435d6b2a510ba50ca23303f10e91ec058f138a88f69a43fe03cd22edb214c5"
+  },
+  dlmmConfig: {
+    factory: ""
   }
 };
 var clmmTestnet = {
@@ -10423,6 +10714,11 @@ var clmmTestnet = {
     published_at: "0x23e0b5ab4aa63d0e6fd98fa5e247bcf9b36ad716b479d39e56b2ba9ff631e09d",
     config: SDKConfig2.clmmConfig
   },
+  dlmm_pool: {
+    package_id: "",
+    published_at: "",
+    config: SDKConfig2.dlmmConfig
+  },
   distribution: {
     package_id: "0x45ac2371c33ca0df8dc784d62c8ce5126d42edd8c56820396524dff2ae0619b1",
     published_at: "0x45ac2371c33ca0df8dc784d62c8ce5126d42edd8c56820396524dff2ae0619b1"
@@ -10498,6 +10794,7 @@ var src_default = MagmaClmmSDK;
   DeepbookCustodianV2Moudle,
   DeepbookEndpointsV2Moudle,
   DeepbookUtils,
+  DlmmScript,
   FEE_RATE_DENOMINATOR,
   GAS_SYMBOL,
   GAS_TYPE_ARG,