@magmaprotocol/magma-clmm-sdk 0.5.39 → 0.5.41

package/dist/index.d.ts

@@ -2180,6 +2180,122 @@ type CollectFeesQuote = {
  */
 declare function collectFeesQuote(param: CollectFeesQuoteParam): CollectFeesQuote;
 
+declare enum StrategyType {
+    Spot = 0,
+    Curve = 1,
+    BidAsk = 2
+}
+type BinLiquidity = {
+    ActiveId: number;
+    StorageId: number;
+    Price: number;
+    CoinAType: number;
+    CoinBType: number;
+    CoinAAmount: number;
+    CoinBAmount: number;
+};
+declare function autoFillYByStrategy(activeId: number, binStep: number, amountX: BN, amountXInActiveBin: BN, amountYInActiveBin: BN, minBinId: number, maxBinId: number, strategyType: StrategyType): BN;
+declare function autoFillXByStrategy(activeId: number, binStep: number, amountY: BN, amountXInActiveBin: BN, amountYInActiveBin: BN, minBinId: number, maxBinId: number, strategyType: StrategyType): BN;
+/**
+ * Given a strategy type and amounts of X and Y, returns the distribution of liquidity.
+ * @param activeId The bin id of the active bin.
+ * @param binStep The step size of each bin.
+ * @param minBinId The min bin id.
+ * @param maxBinId The max bin id.
+ * @param amountX The amount of X token to deposit.
+ * @param amountY The amount of Y token to deposit.
+ * @param amountXInActiveBin The amount of X token in the active bin.
+ * @param amountYInActiveBin The amount of Y token in the active bin.
+ * @param strategyType The strategy type.
+ * @param mintX The mint info of X token. Get from DLMM instance.
+ * @param mintY The mint info of Y token. Get from DLMM instance.
+ * @param clock The clock info. Get from DLMM instance.
+ * @returns The distribution of liquidity.
+ */
+declare function toAmountsBothSideByStrategy(activeId: number, binStep: number, minBinId: number, maxBinId: number, amountX: BN, amountY: BN, amountXInActiveBin: BN, amountYInActiveBin: BN, strategyType: StrategyType): {
+    binId: number;
+    amountX: BN;
+    amountY: BN;
+}[];
+
+declare function getPriceOfBinByBinId(binId: number, binStep: number): Decimal;
+declare function autoFillYByWeight(activeId: number, binStep: number, amountX: BN, amountXInActiveBin: BN, amountYInActiveBin: BN, distributions: {
+    binId: number;
+    weight: number;
+}[]): BN;
+declare function autoFillXByWeight(activeId: number, binStep: number, amountY: BN, amountXInActiveBin: BN, amountYInActiveBin: BN, distributions: {
+    binId: number;
+    weight: number;
+}[]): BN;
+/**
+ * Distribute totalAmount to all bid side bins according to given distributions.
+ * @param activeId active bin id
+ * @param totalAmount total amount of token Y to be distributed
+ * @param distributions weight distribution of each bin
+ * @param mintY mint of token Y, get from DLMM instance
+ * @param clock clock of the program, for calculating transfer fee, get from DLMM instance
+ * @returns array of {binId, amount} where amount is the amount of token Y in each bin
+ */
+declare function toAmountBidSide(activeId: number, totalAmount: BN, distributions: {
+    binId: number;
+    weight: number;
+}[]): {
+    binId: number;
+    amount: BN;
+}[];
+/**
+ * Distribute totalAmount to all ask side bins according to given distributions.
+ * @param activeId active bin id
+ * @param totalAmount total amount of token Y to be distributed
+ * @param distributions weight distribution of each bin
+ * @param mintX mint of token X, get from DLMM instance
+ * @param clock clock of the program, for calculating transfer fee, get from DLMM instance
+ * @returns array of {binId, amount} where amount is the amount of token X in each bin
+ */
+declare function toAmountAskSide(activeId: number, binStep: number, totalAmount: BN, distributions: {
+    binId: number;
+    weight: number;
+}[]): {
+    binId: number;
+    amount: BN;
+}[];
+/**
+ * Distributes the given amounts of tokens X and Y to both bid and ask side bins
+ * based on the provided weight distributions.
+ *
+ * @param activeId - The id of the active bin.
+ * @param binStep - The step interval between bin ids.
+ * @param amountX - Total amount of token X to distribute.
+ * @param amountY - Total amount of token Y to distribute.
+ * @param amountXInActiveBin - Amount of token X already in the active bin.
+ * @param amountYInActiveBin - Amount of token Y already in the active bin.
+ * @param distributions - Array of bins with their respective weight distributions.
+ * @param mintX - Mint information for token X. Get from DLMM instance.
+ * @param mintY - Mint information for token Y. Get from DLMM instance.
+ * @param clock - Clock instance. Get from DLMM instance.
+ * @returns An array of objects containing binId, amountX, and amountY for each bin.
+ */
+declare function toAmountBothSide(activeId: number, binStep: number, amountX: BN, amountY: BN, amountXInActiveBin: BN, amountYInActiveBin: BN, distributions: {
+    binId: number;
+    weight: number;
+}[]): {
+    binId: number;
+    amountX: BN;
+    amountY: BN;
+}[];
+
+declare function withLiquiditySlippage(value: Decimal.Instance, slippage: Decimal.Instance, mode: 'plus' | 'minus'): Decimal;
+type POOL_NO_LIQUIDITY = -1;
+type LiquidityAndCoinYResult = {
+    coinYAmount: Decimal;
+    lpAmount: Decimal;
+};
+declare function getLiquidityAndCoinYByCoinX(coinInVal: Decimal.Instance, reserveInSize: Decimal.Instance, reserveOutSize: Decimal.Instance, lpSupply: Decimal.Instance): LiquidityAndCoinYResult | POOL_NO_LIQUIDITY;
+declare function getCoinXYForLiquidity(liquidity: Decimal.Instance, reserveInSize: Decimal.Instance, reserveOutSize: Decimal.Instance, lpSuply: Decimal.Instance): {
+    coinXAmount: Decimal;
+    coinYAmount: Decimal;
+};
+
 /**
  * Percentage - the util set for percentage struct.
  */
@@ -3377,6 +3493,7 @@ declare class GaugeModule implements IModule {
     getEmissions(): Promise<EpochEmission>;
     getRewardByPosition(params: GetRewardByPosition): Promise<Transaction>;
     getAllRewardByPositions(paramsList: GetRewardByPosition[]): Promise<Transaction>;
+    testTeacherCap(): Promise<Transaction>;
     getEpochRewardByPool(pool: string, incentive_tokens: string[]): Promise<Map<string, string>>;
 }
 
@@ -3433,9 +3550,9 @@ type FetchBinsParams = {
 };
 type GetPositionLiquidityParams = {
     pair: string;
+    positionId: string;
     coinTypeA: string;
     coinTypeB: string;
-    positionId: string;
 };
 type GetPairLiquidityParams = {
     pair: string;
@@ -3500,6 +3617,72 @@ type DlmmPoolInfo = {
     base_fee: number;
     active_index: number;
 };
+type DlmmAddLiquidityParams = {
+    pool_id: string;
+    coin_a: string;
+    coin_b: string;
+    position_id: string;
+    amounts_a: number[];
+    amounts_b: number[];
+    receiver: string;
+    rewards_token: string[];
+};
+type DlmmBurnPositionParams = {
+    pool_id: string;
+    position_id: string;
+    coin_a: string;
+    coin_b: string;
+    rewards_token: string[];
+};
+type DlmmShrinkPosition = {
+    pool_id: string;
+    position_id: string;
+    coin_a: string;
+    coin_b: string;
+    delta_percentage: number;
+    rewards_token: string[];
+};
+type DlmmCollectRewardParams = {
+    pool_id: string;
+    coin_a: string;
+    coin_b: string;
+    position_id: string;
+    rewards_token: string[];
+};
+type DlmmCollectFeeParams = {
+    pool_id: string;
+    coin_a: string;
+    coin_b: string;
+    position_id: string;
+};
+type DlmmRewardsParams = {
+    pool_id: string;
+    position_id: string;
+    coin_a: string;
+    coin_b: string;
+    rewards_token: string[];
+};
+type DlmmEventEarnedFees = {
+    position_id: string;
+    x: string;
+    y: string;
+    fee_x: number;
+    fee_y: number;
+};
+type DlmmEventEarnedRewards = {
+    position_id: string;
+    reward: string[];
+    amount: number[];
+};
+type GetPairRewarderParams = {
+    pool_id: string;
+    coin_a: string;
+    coin_b: string;
+};
+type DlmmEventPairRewardTypes = {
+    pair_id: string;
+    tokens: string[];
+};
 
 declare class DlmmModule implements IModule {
     protected _sdk: MagmaClmmSDK;
@@ -3512,10 +3695,22 @@ declare class DlmmModule implements IModule {
     createAddLiquidityPayload(): Promise<Transaction>;
     mintPercent(params: MintPercentParams): Promise<Transaction>;
     createPositionByAmount(params: MintAmountParams): Promise<Transaction>;
+    addLiquidity(params: DlmmAddLiquidityParams): Promise<Transaction>;
+    private _raisePositionByAmounts;
+    private _raisePositionByAmountsReward;
+    burnPosition(params: DlmmBurnPositionParams): Promise<Transaction>;
+    shrinkPosition(params: DlmmShrinkPosition): Promise<Transaction>;
+    collectReward(params: DlmmCollectRewardParams): Promise<Transaction>;
+    collectFees(params: DlmmCollectFeeParams): Promise<Transaction>;
     swap(params: SwapParams): Promise<Transaction>;
     fetchBins(params: FetchBinsParams): Promise<EventBin[]>;
     getPositionLiquidity(params: GetPositionLiquidityParams): Promise<EventPositionLiquidity>;
     getPairLiquidity(params: GetPairLiquidityParams): Promise<EventPairLiquidity>;
+    getEarnedFees(params: DlmmCollectFeeParams): Promise<DlmmEventEarnedFees>;
+    getEarnedRewards(params: DlmmRewardsParams): Promise<DlmmEventEarnedRewards>;
+    getPairRewarders(params: GetPairRewarderParams[]): Promise<Map<string, DlmmEventPairRewardTypes[]>>;
+    private _getPairRewarders;
+    private _parsePairRewarders;
 }
 
 /**
@@ -4248,4 +4443,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, 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 };
+export { AMM_SWAP_MODULE, AddBribeReward, AddLiquidityCommonParams, AddLiquidityFixTokenParams, AddLiquidityParams, AddLiquidityWithProtectionParams, AddressAndDirection, AdjustResult, AggregatorResult, AmountSpecified, BasePath, BigNumber, BinLiquidity, 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, LiquidityAndCoinYResult, 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_NO_LIQUIDITY, 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, StrategyType, 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, autoFillXByStrategy, autoFillXByWeight, autoFillYByStrategy, autoFillYByWeight, 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, getCoinXYForLiquidity, getDefaultSuiInputType, getDeltaA, getDeltaB, getDeltaDownFromOutput, getDeltaUpFromInput, getFutureTime, getLiquidityAndCoinYByCoinX, getLiquidityFromCoinA, getLiquidityFromCoinB, getLowerSqrtPriceFromCoinA, getLowerSqrtPriceFromCoinB, getMoveObject, getMoveObjectType, getMovePackageContent, getNearestTickByTick, getNextSqrtPriceAUp, getNextSqrtPriceBDown, getNextSqrtPriceFromInput, getNextSqrtPriceFromOutput, getObjectDeletedResponse, getObjectDisplay, getObjectFields, getObjectId, getObjectNotExistsResponse, getObjectOwner, getObjectPreviousTransactionDigest, getObjectReference, getObjectType, getObjectVersion, getPackagerConfigs, getPriceOfBinByBinId, getRewardInTickRange, getSuiObjectData, getTickDataFromUrlData, getUpperSqrtPriceFromCoinA, getUpperSqrtPriceFromCoinB, hasPublicTransfer, hexToNumber, hexToString, initMagmaSDK, initMainnetSDK, initTestnetSDK, isSortedSymbols, isSuiObjectResponse, newBits, normalizeCoinType, patchFixSuiObjectId, printTransaction, removeHexPrefix, secretKeyToEd25519Keypair, secretKeyToSecp256k1Keypair, shortAddress, shortString, tickScore, toAmountAskSide, toAmountBidSide, toAmountBothSide, toAmountsBothSideByStrategy, toBuffer, toCoinAmount, toDecimalsAmount, transClmmpoolDataWithoutTicks, utf8to16, withLiquiditySlippage };