@cetusprotocol/burn-sdk 1.0.0

package/README.md

@@ -0,0 +1,275 @@
+# @cetusprotocol/burn-sdk
+
+The primary functionality of this project, referred to as "`LP Burn`," is designed for users who wish to permanently lock their liquidity positions. Once locked, the liquidity within these positions cannot be withdrawn; however, users can still claim any transaction fees and mining rewards generated from these positions. This locking mechanism is implemented by wrapping the original position, effectively sealing the liquidity while still allowing the accrual of rewards.
+
+The `Burn SDK` is specifically tailored for projects that have established liquidity pools and wish to relinquish their liquidity rights. This feature enables these projects to demonstrate commitment to their community and ecosystem by permanently locking liquidity, thereby enhancing stability and fostering trust in the longevity of the liquidity pool.
+
+## Getting Started
+
+## How to Use the Burn SDK ?
+
+### Installation
+
+To start using the `Burn SDK`, you first need to install it in your TypeScript project. You can add it using npm, yarn, or bun:
+
+npm link: https://www.npmjs.com/package/@cetusprotocol/burn-sdk
+
+```bash
+npm install @cetusprotocol/burn-sdk
+```
+
+### Setup
+
+Import the SDK into the TypeScript file where you intend to use it:
+
+```typescript
+import { CetusBurnSDK } from '@cetusprotocol/burn-sdk'
+```
+
+### Initializing the SDK
+
+Initialize the SDK with the required configuration parameters. This typically includes setting up the network and API keys, if needed.
+
+If you would like to use the mainnet network and the official Sui rpc url, you can do so as follows:
+
+```typescript
+const sdk = CetusBurnSDK.createSDK()
+```
+
+If you wish to set your own full node URL or network (You have the option to select either 'mainnet' or 'testnet' for the network), you can do so as follows:
+
+```typescript
+const env = 'mainnet'
+const full_rpc_url = 'YOUR_FULL_NODE_URL'
+const wallet = 'YOUR_WALLET_ADDRESS'
+
+const sdk = CetusBurnSDK.createSDK({ env })
+```
+
+If you wish to set your own full node URL or SuiClient, you can do so as follows:
+
+```typescript
+const sdk = CetusBurnSDK.createSDK({ env, sui_client })
+// or
+const sdk = CetusBurnSDK.createSDK({ env, full_rpc_url })
+```
+
+## Usage
+
+After linking your wallet, if you need use your wallet address to do something, you should set it by `sdk.setSenderAddress`.
+
+```typescript
+const wallet = 'YOUR_WALLET_ADDRESS'
+sdk.setSenderAddress(wallet)
+```
+
+### 1. getBurnPoolList
+
+This method retrieves a list of existing burn pools by calling `sdk.Burn.getBurnPoolList()`, then prints the result.
+
+```typescript
+const pool_ids = await sdk.Burn.getBurnPoolList()
+
+// result:
+pool_ids: [
+  '0x2dea79f17e61f8d02ff02ed75510283...',
+  '0x6fd4915e6d8d3e2ba6d81787046eb94...',
+  '0xc41621d02d5ee00a7a993b912a8550d...',
+  '0xaccdd1c40fdd6abf168def70044a565...',
+  '0xc10e379b4658d455ee4b8656213c715...',
+  '0x1861771ab3b7f0f6a4252e1c60ed270...',
+  '0x1b9b4f2271bc69df97ddafcb3f64599...',
+  '0x473ab0306ff8952d473b10bb4c3516c...',
+  '0x3a61bd98686e4aa6213fb5b3b535645...',
+]
+```
+
+### 2. getPoolBurnPositionList
+
+This method fetches a list of burn positions for a specified pool ID by calling the `sdk.Burn.getPoolBurnPositionList(pool_id)`, then prints the result.
+
+```typescript
+const pool_id = '0x...'
+const position_ids = await sdk.Burn.getPoolBurnPositionList(pool_id)
+// result:
+position_ids: [{
+    id: '0x88678e4cd2681bf41b7f2afdd49c15...',
+    url: 'https://bq7bkvdje7gvgmv66hrxdy7wx5h5ggtrrnmt66rdkkehb64rvz3q.arweave.net/DD4VVGknzVMyvvHj...',
+    pool_id: '0xc41621d02d5ee00a7a993b912a8550d...',
+    coin_type_a: '0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdc::USDC',
+    coin_type_b: '0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS',
+    description: 'Cetus Liquidity Position',
+    name: 'Cetus Burned LP | Pool9-115',
+    liquidity: '19387676',
+    clmm_position_id: '0x092f07a470479f86927fe161a53074b...',
+    clmm_pool_id: '0xc41621d02d5ee00a7a993b912a8550d...',
+    tick_lower_index: -443580,
+    tick_upper_index: 443580,
+    index: '115',
+    is_lp_burn: true
+},...]
+```
+
+### 3. getBurnPositionList
+
+This method fetches a list of burn positions for a specified account by calling the `sdk.Burn.getBurnPositionList(account_address)` method.
+
+```typescript
+const account_address = '0x...'
+const position_ids = await sdk.Burn.getBurnPositionList(account_address)
+// result:
+positionIds: ['0x1b9b4f2271bc69df97ddafcb3f645...']
+```
+
+### 4. getBurnPosition
+
+This method obtains detailed information about a specific burn position by calling the `sdk.Burn.getBurnPosition(pos_id)` method, where pos_id is the specified burn position ID, and prints the result.
+
+```typescript
+const pos_id = '0x...'
+const position_info = await sdk.Burn.getBurnPosition(pos_id)
+
+// result:
+position_info: {
+    id: '0x88678e4cd2681bf41b7f2afdd49c15...',
+    url: 'https://bq7bkvdje7gvgmv66hrxdy7wx5h5ggtrrnmt66rdkkehb64rvz3q.arweave.net/DD4VVGknzVMyvvHj...',
+    pool_id: '0xc41621d02d5ee00a7a993b912a8550...',
+    coin_type_a: '0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdc::USDC',
+    coin_type_b: '0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS',
+    description: 'Cetus Liquidity Position',
+    name: 'Cetus Burned LP | Pool9-115',
+    liquidity: '19387676',
+    clmm_position_id: '0x092f07a470479f86927fe161a5307...',
+    clmm_pool_id: '0xc41621d02d5ee00a7a993b912a8550...',
+    tick_lower_index: -443580,
+    tick_upper_index: 443580,
+    index: '115',
+    is_lp_burn: true
+}
+```
+
+### 5. burn lock
+
+This method creates a transaction builder for a burn lock transaction.
+
+```typescript
+const pool_id = '0xc41621d02d5ee00a7a993b912a8550...'
+const pos_id = '0x4e1970683fc49de834478339724509a05...' // is burn success
+const coin_type_a = '26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdc::USDC'
+const coin_type_b = '26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS'
+const txb = await sdk.Burn.createBurnPayload({
+  pool_id,
+  pos_id,
+  coin_type_a,
+  coin_type_b,
+})
+
+const simulate_res = await sdk.FullClient.devInspectTransactionBlock({
+  transactionBlock: txb,
+  sender: account,
+})
+```
+
+### 6. claim
+
+This method creates a transaction builder for fee collection.
+
+```typescript
+const pool_id = '0xc41621d02d5ee00a7a993b912a8550df...'
+const pos_id = '0x2f10a5816747fd02218dd7a3a7d0417d28...' // is wrap pos id
+const coin_type_a = '26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdc::USDC'
+const coin_type_b = '26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS'
+
+const rewarder_coin_types = ['0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS']
+let tx = sdk.Burn.createCollectFeePayload({
+  pool_id,
+  pos_id,
+  coin_type_a,
+  coin_type_b,
+  account,
+})
+
+tx = sdk.Burn.crateCollectRewardPayload({
+  pool_id,
+  pos_id,
+  coin_type_a,
+  coin_type_b,
+  rewarder_coin_types,
+  account,
+})
+
+const simulate_res = await sdk.FullClient.devInspectTransactionBlock({
+  transactionBlock: txb,
+  sender: account,
+})
+```
+
+### 7. batch claim
+
+This method creates a transaction builder for batch fee collection.
+
+```typescript
+const pool_id = '0xc41621d02d5ee00a7a993b912a855...'
+const pos_id = '0x2f10a5816747fd02218dd7a3a7d0417d...' // is wrap pos id
+const coin_type_a = '26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::usdc::USDC'
+const coin_type_b = '26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS'
+
+const rewarder_coin_types = ['0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::cetus::CETUS']
+let tx = sdk.Burn.createCollectFeesPayload([{
+  pool_id,
+  pos_id,
+  coin_type_a,
+  coin_type_b,
+  account,
+}, ...])
+
+tx = sdk.Burn.crateCollectRewardsPayload([{
+  pool_id,
+  pos_id,
+  coin_type_a,
+  coin_type_b,
+  rewarder_coin_types,
+  account,
+}, ...])
+
+const simulate_res = await sdk.FullClient.devInspectTransactionBlock({
+  transactionBlock: txb,
+  sender: account,
+})
+```
+
+### 8. burn LP position
+
+When the position is burned, a CetusLPBurnProof will be returned. Compared to the `burn_lp` function, this V2 version does not require the pool object as a parameter, making it more convenient to use. The function will automatically verify the position's validity through the position object itself. This design also enables users to create a pool, add liquidity, and burn the position all within a single transaction.
+
+```typescript
+const pos_id = '0x4e1970683fc49de834478339724509...' // is burn success
+const txb = await sdk.Burn.createBurnLPV2Payload(pos_id)
+
+const simulate_res = await sdk.FullClient.devInspectTransactionBlock({
+  transactionBlock: txb,
+  sender: account,
+})
+```
+
+# Contract Error Codes
+
+the Cetus smart contract may return the following error codes:
+
+| Module  | Error Code | Description                                                                | Contract Methods             |
+| ------- | ---------- | -------------------------------------------------------------------------- | ---------------------------- |
+| lp_burn | 1          | The version of the contract has been deprecated                            | The vast majority of methods |
+| lp_burn | 2          | The current liquidity position does not fully cover the entire price range | burn_lp_v2                   |
+| lp_burn | 3          | The current liquidity position does not belong to this pool                | burn_lp                      |
+
+# More About Cetus
+
+Use the following links to learn more about Cetus:
+
+Learn more about working with Cetus in the [Cetus Documentation](https://cetus-1.gitbook.io/cetus-docs).
+
+Join the Cetus community on [Cetus Discord](https://discord.com/channels/1009749448022315008/1009751382783447072).
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,154 @@
+import { CoinPairType, IModule, SdkWrapper, BaseSdkOptions, Package } from '@cetusprotocol/common-sdk';
+import { TransactionObjectArgument, Transaction } from '@mysten/sui/transactions';
+
+type BurnConfigs = {
+    manager_id: string;
+    clmm_global_config: string;
+    clmm_global_vault_id: string;
+    burn_pool_handle: string;
+};
+type BurnPositionNFT = {
+    id: string;
+    url: string;
+    pool_id: string;
+    description: string;
+    name: string;
+    liquidity: string;
+    clmm_position_id: string;
+    clmm_pool_id: string;
+    tick_lower_index: number;
+    tick_upper_index: number;
+    index: number;
+    is_lp_burn: boolean;
+} & CoinPairType;
+type CommonParams = {
+    pool_id: string;
+    pos_id: string | TransactionObjectArgument;
+} & CoinPairType;
+type BurnParams = CommonParams;
+type CollectFeeParams = CommonParams & {
+    account: string;
+};
+type CollectRewardParams = CommonParams & {
+    rewarder_coin_types: string[];
+    account: string;
+};
+
+declare class BurnModule implements IModule<CetusBurnSDK> {
+    protected _sdk: CetusBurnSDK;
+    constructor(sdk: CetusBurnSDK);
+    get sdk(): CetusBurnSDK;
+    /**
+     * @description Get the list of pools that have been burned.
+     * @returns
+     */
+    getBurnPoolList(): Promise<any[] | undefined>;
+    /**
+     * @description Get the position handle for a given pool.
+     * @param pool_id - The pool ID.
+     * @returns
+     */
+    private getPositionHandle;
+    /**
+     * @description Get the list of burned positions for a given pool.
+     * @param pool_id - The pool ID.
+     * @returns
+     */
+    getPoolBurnPositionList(pool_id: string): Promise<BurnPositionNFT[] | undefined>;
+    /**
+     * @description Get the list of burned positions for a given account.
+     * @param account_address - The account address.
+     * @returns
+     */
+    getBurnPositionList(account_address: string): Promise<BurnPositionNFT[] | undefined>;
+    /**
+     * @description Get the burned position information for a given position ID.
+     * @param pos_id - The position ID.
+     * @returns
+     */
+    getBurnPosition(pos_id: string): Promise<BurnPositionNFT | null | undefined>;
+    /**
+     * @description Create a burn payload for a given pool and position.
+     * @param params - The burn parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    createBurnPayload(params: BurnParams, tx?: Transaction): Transaction;
+    /**
+     * When the position is burned, a CetusLPBurnProof will be returned. Compared to the burn_lp function,
+     * this V2 version does not require the pool object as a parameter, making it more convenient to use.
+     * The function will automatically verify the position's validity through the position object itself.
+     * This design also allows users to create a pool, add liquidity, and burn the position all within one transaction.
+     *
+     * @param {string | TransactionObjectArgument} pos - The LP position to be burned,
+     *        either as an object argument or its ID (string).
+     * @param {Transaction} [tx] - An optional `Transaction` object; if not provided, a new one is created.
+     * @returns {CetusLPBurnProof} - The CetusLPBurnProof object ID .
+     */
+    createBurnLPV2Payload(pos: string | TransactionObjectArgument, tx?: Transaction): TransactionObjectArgument;
+    /**
+     * @description Create a collect fee payload for a given pool and position.
+     * @param params - The collect fee parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    createCollectFeePayload(params: CollectFeeParams, tx?: Transaction): Transaction;
+    /**
+     * @description Create a collect reward payload for a given pool and position.
+     * @param params - The collect reward parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    crateCollectRewardPayload(params: CollectRewardParams, tx?: Transaction): Transaction;
+    /**
+     * @description Create a collect fee payload for a given pool and position.
+     * @param params - The collect fee parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    createCollectFeesPayload(params: CollectFeeParams[], tx?: Transaction): Transaction;
+    /**
+     * @description Create a collect reward payload for a given pool and position.
+     * @param params - The collect reward parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    crateCollectRewardsPayload(params: CollectRewardParams[], tx?: Transaction): Transaction;
+}
+
+/**
+ * Represents options and configurations for an SDK.
+ */
+interface SdkOptions extends BaseSdkOptions {
+    burn: Package<BurnConfigs>;
+}
+/**
+ * The entry class of CetusDcaSDK, which is almost responsible for all interactions with dca.
+ */
+declare class CetusBurnSDK extends SdkWrapper<SdkOptions> {
+    protected _burn: BurnModule;
+    constructor(options: SdkOptions);
+    get Burn(): BurnModule;
+    /**
+     * Static factory method to initialize the SDK
+     * @param options SDK initialization options
+     * @returns An instance of CetusBurnDK
+     */
+    static createSDK(options: BaseSdkOptions): CetusBurnSDK;
+    /**
+     * Create a custom SDK instance with the given options
+     * @param options The options for the SDK
+     * @returns An instance of CetusBurnSDK
+     */
+    static createCustomSDK<T extends BaseSdkOptions>(options: T & SdkOptions): CetusBurnSDK;
+}
+
+declare class BurnUtils {
+    static buildBurnPositionNFT(fields: any): BurnPositionNFT;
+}
+
+declare const burnMainnet: SdkOptions;
+
+declare const burnTestnet: SdkOptions;
+
+export { type BurnConfigs, BurnModule, type BurnParams, type BurnPositionNFT, BurnUtils, CetusBurnSDK, type CollectFeeParams, type CollectRewardParams, type SdkOptions, burnMainnet, burnTestnet, CetusBurnSDK as default };

package/dist/index.d.ts

@@ -0,0 +1,154 @@
+import { CoinPairType, IModule, SdkWrapper, BaseSdkOptions, Package } from '@cetusprotocol/common-sdk';
+import { TransactionObjectArgument, Transaction } from '@mysten/sui/transactions';
+
+type BurnConfigs = {
+    manager_id: string;
+    clmm_global_config: string;
+    clmm_global_vault_id: string;
+    burn_pool_handle: string;
+};
+type BurnPositionNFT = {
+    id: string;
+    url: string;
+    pool_id: string;
+    description: string;
+    name: string;
+    liquidity: string;
+    clmm_position_id: string;
+    clmm_pool_id: string;
+    tick_lower_index: number;
+    tick_upper_index: number;
+    index: number;
+    is_lp_burn: boolean;
+} & CoinPairType;
+type CommonParams = {
+    pool_id: string;
+    pos_id: string | TransactionObjectArgument;
+} & CoinPairType;
+type BurnParams = CommonParams;
+type CollectFeeParams = CommonParams & {
+    account: string;
+};
+type CollectRewardParams = CommonParams & {
+    rewarder_coin_types: string[];
+    account: string;
+};
+
+declare class BurnModule implements IModule<CetusBurnSDK> {
+    protected _sdk: CetusBurnSDK;
+    constructor(sdk: CetusBurnSDK);
+    get sdk(): CetusBurnSDK;
+    /**
+     * @description Get the list of pools that have been burned.
+     * @returns
+     */
+    getBurnPoolList(): Promise<any[] | undefined>;
+    /**
+     * @description Get the position handle for a given pool.
+     * @param pool_id - The pool ID.
+     * @returns
+     */
+    private getPositionHandle;
+    /**
+     * @description Get the list of burned positions for a given pool.
+     * @param pool_id - The pool ID.
+     * @returns
+     */
+    getPoolBurnPositionList(pool_id: string): Promise<BurnPositionNFT[] | undefined>;
+    /**
+     * @description Get the list of burned positions for a given account.
+     * @param account_address - The account address.
+     * @returns
+     */
+    getBurnPositionList(account_address: string): Promise<BurnPositionNFT[] | undefined>;
+    /**
+     * @description Get the burned position information for a given position ID.
+     * @param pos_id - The position ID.
+     * @returns
+     */
+    getBurnPosition(pos_id: string): Promise<BurnPositionNFT | null | undefined>;
+    /**
+     * @description Create a burn payload for a given pool and position.
+     * @param params - The burn parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    createBurnPayload(params: BurnParams, tx?: Transaction): Transaction;
+    /**
+     * When the position is burned, a CetusLPBurnProof will be returned. Compared to the burn_lp function,
+     * this V2 version does not require the pool object as a parameter, making it more convenient to use.
+     * The function will automatically verify the position's validity through the position object itself.
+     * This design also allows users to create a pool, add liquidity, and burn the position all within one transaction.
+     *
+     * @param {string | TransactionObjectArgument} pos - The LP position to be burned,
+     *        either as an object argument or its ID (string).
+     * @param {Transaction} [tx] - An optional `Transaction` object; if not provided, a new one is created.
+     * @returns {CetusLPBurnProof} - The CetusLPBurnProof object ID .
+     */
+    createBurnLPV2Payload(pos: string | TransactionObjectArgument, tx?: Transaction): TransactionObjectArgument;
+    /**
+     * @description Create a collect fee payload for a given pool and position.
+     * @param params - The collect fee parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    createCollectFeePayload(params: CollectFeeParams, tx?: Transaction): Transaction;
+    /**
+     * @description Create a collect reward payload for a given pool and position.
+     * @param params - The collect reward parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    crateCollectRewardPayload(params: CollectRewardParams, tx?: Transaction): Transaction;
+    /**
+     * @description Create a collect fee payload for a given pool and position.
+     * @param params - The collect fee parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    createCollectFeesPayload(params: CollectFeeParams[], tx?: Transaction): Transaction;
+    /**
+     * @description Create a collect reward payload for a given pool and position.
+     * @param params - The collect reward parameters.
+     * @param tx - The transaction object.
+     * @returns
+     */
+    crateCollectRewardsPayload(params: CollectRewardParams[], tx?: Transaction): Transaction;
+}
+
+/**
+ * Represents options and configurations for an SDK.
+ */
+interface SdkOptions extends BaseSdkOptions {
+    burn: Package<BurnConfigs>;
+}
+/**
+ * The entry class of CetusDcaSDK, which is almost responsible for all interactions with dca.
+ */
+declare class CetusBurnSDK extends SdkWrapper<SdkOptions> {
+    protected _burn: BurnModule;
+    constructor(options: SdkOptions);
+    get Burn(): BurnModule;
+    /**
+     * Static factory method to initialize the SDK
+     * @param options SDK initialization options
+     * @returns An instance of CetusBurnDK
+     */
+    static createSDK(options: BaseSdkOptions): CetusBurnSDK;
+    /**
+     * Create a custom SDK instance with the given options
+     * @param options The options for the SDK
+     * @returns An instance of CetusBurnSDK
+     */
+    static createCustomSDK<T extends BaseSdkOptions>(options: T & SdkOptions): CetusBurnSDK;
+}
+
+declare class BurnUtils {
+    static buildBurnPositionNFT(fields: any): BurnPositionNFT;
+}
+
+declare const burnMainnet: SdkOptions;
+
+declare const burnTestnet: SdkOptions;
+
+export { type BurnConfigs, BurnModule, type BurnParams, type BurnPositionNFT, BurnUtils, CetusBurnSDK, type CollectFeeParams, type CollectRewardParams, type SdkOptions, burnMainnet, burnTestnet, CetusBurnSDK as default };

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";var P=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var A=Object.prototype.hasOwnProperty;var v=(a,t)=>{for(var e in t)P(a,e,{get:t[e],enumerable:!0})},I=(a,t,e,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of E(t))!A.call(a,n)&&n!==e&&P(a,n,{get:()=>t[n],enumerable:!(o=S(t,n))||o.enumerable});return a};var D=a=>I(P({},"__esModule",{value:!0}),a);var R={};v(R,{BurnModule:()=>m,BurnUtils:()=>b,CetusBurnSDK:()=>g,burnMainnet:()=>h,burnTestnet:()=>k,default:()=>F});module.exports=D(R);var T=require("@cetusprotocol/common-sdk");var w=require("@cetusprotocol/common-sdk"),h={env:"mainnet",full_rpc_url:w.FullRpcUrlMainnet,burn:{package_id:"0x12d73de9a6bc3cb658ec9dc0fe7de2662be1cea5c76c092fcc3606048cdbac27",published_at:"0xb977b00649d3ab8950bcbbafb01fcf32e2e7718eb3133eff2e48c0cef04b1495",config:{manager_id:"0x1d94aa32518d0cb00f9de6ed60d450c9a2090761f326752ffad06b2e9404f845",clmm_global_config:"0xdaa46292632c3c4d8f31f23ea0f9b36a28ff3677e9684980e4438403a67a3d8f",clmm_global_vault_id:"0xce7bceef26d3ad1f6d9b6f13a953f053e6ed3ca77907516481ce99ae8e588f2b",burn_pool_handle:"0xc9aacf74bd7cc8da8820ae28ca4473b7e01c87be19bc35bf81c9c7311e1b299e"}}};var C=require("@cetusprotocol/common-sdk"),k={env:"testnet",full_rpc_url:C.FullRpcUrlTestnet,burn:{package_id:"0x3b494006831b046481c8046910106e2dfbe0d1fa9bc01e41783fb3ff6534ed3a",published_at:"0xaf89f8215c5b07eaac8b77c7745ce62f94cb76ef4bcb854e283f644c519ef43e",config:{manager_id:"0xd04529ef15b7dad6699ee905daca0698858cab49724b2b2a1fc6b1ebc5e474ef",clmm_global_config:"0x9774e359588ead122af1c7e7f64e14ade261cfeecdb5d0eb4a5b3b4c8ab8bd3e",clmm_global_vault_id:"0xf78d2ee3c312f298882cb680695e5e8c81b1d441a646caccc058006c2851ddea",burn_pool_handle:"0x20262dac8853ab8f63c98e0b17bfb1c758efc33d0092ac3c5f204dfb7ba81ac5"}}};var p=require("@mysten/sui/transactions"),s=require("@cetusprotocol/common-sdk");var B=require("@cetusprotocol/common-sdk");var y=class extends B.BaseError{constructor(t,e,o){super(t,e||"UnknownError",o)}static isBurnErrorCode(t,e){return this.isErrorCode(t,e)}},u=(a,t,e)=>{throw t instanceof Error?new y(t.message,a,e):new y(t,a,e)};var f=require("@cetusprotocol/common-sdk"),b=class{static buildBurnPositionNFT(t){let e=t.position.fields,o=`Cetus Burned LP | Pool${e.name.split("Pool")?.[1]}`;return{id:t.id.id,url:e.url,pool_id:e.pool,coin_type_a:(0,f.extractStructTagFromType)(e.coin_type_a.fields.name).full_address,coin_type_b:(0,f.extractStructTagFromType)(e.coin_type_b.fields.name).full_address,description:e.description,name:o,liquidity:e.liquidity,clmm_position_id:e.id.id,clmm_pool_id:e.pool,tick_lower_index:(0,f.asIntN)(BigInt(e.tick_lower_index.fields.bits)),tick_upper_index:(0,f.asIntN)(BigInt(e.tick_upper_index.fields.bits)),index:e.index,is_lp_burn:!0}}};var m=class{constructor(t){this._sdk=t}get sdk(){return this._sdk}async getBurnPoolList(){try{let{burn:t}=this._sdk.sdkOptions,{manager_id:e}=(0,s.getPackagerConfigs)(t),n=(await this._sdk.FullClient.getObject({id:e,options:{showType:!0,showContent:!0}}))?.data?.content?.fields?.position?.fields?.id?.id;return(await this._sdk.FullClient.getDynamicFieldsByPage(n))?.data?.map(d=>d?.name?.value)}catch(t){console.log("getBurnPoolList ~ error:",t),u("FetchError",t,{[s.DETAILS_KEYS.METHOD_NAME]:"getBurnPoolList"})}}async getPositionHandle(t){let{burn:e}=this._sdk.sdkOptions,{burn_pool_handle:o}=(0,s.getPackagerConfigs)(e),n=`getPosHandle_${t}`,r=this._sdk.getCache(n);if(r)return r;try{return r=(await this._sdk.FullClient.getDynamicFieldObject({parentId:o,name:{type:"0x2::object::ID",value:t}})).data.content.fields.value.fields.id.id,r&&this._sdk.updateCache(n,r),r}catch(i){u("InvalidPoolId",i,{[s.DETAILS_KEYS.METHOD_NAME]:"getPositionHandle",[s.DETAILS_KEYS.REQUEST_PARAMS]:{pool_id:t}})}}async getPoolBurnPositionList(t){try{let e=await this.getPositionHandle(t);e===void 0&&u("InvalidPoolId",`${t} is a invalid pool id, please check it and try another valid pool id`,{[s.DETAILS_KEYS.METHOD_NAME]:"getPositionHandle",[s.DETAILS_KEYS.REQUEST_PARAMS]:{pool_id:t}});let n=(await this._sdk.FullClient.getDynamicFieldsByPage(e))?.data?.map(r=>r.objectId);if(n.length>0){let i=(await this._sdk.FullClient.batchGetObjects(n,{showContent:!0})).map(c=>c.data.content.fields.value.fields.burned_position_id);return(await this._sdk.FullClient.batchGetObjects(i,{showContent:!0}))?.map(c=>b.buildBurnPositionNFT(c?.data?.content?.fields))}return[]}catch(e){console.log("getPoolBurnPositionList ~ error:",e),u("InvalidPoolId",`${t} is a invalid pool id, please check it and try another valid pool id`,{[s.DETAILS_KEYS.METHOD_NAME]:"getPoolBurnPositionList",[s.DETAILS_KEYS.REQUEST_PARAMS]:{pool_id:t}})}}async getBurnPositionList(t){let{package_id:e}=this._sdk.sdkOptions.burn;try{return(await this._sdk.FullClient.getOwnedObjectsByPage(t,{options:{showType:!0,showContent:!0,showOwner:!0,showDisplay:!0},filter:{MatchAny:[{StructType:`${e}::lp_burn::CetusLPBurnProof`}]}}))?.data?.map(r=>b.buildBurnPositionNFT(r?.data?.content?.fields))}catch(o){u("InvalidAccountAddress",o,{[s.DETAILS_KEYS.METHOD_NAME]:"getBurnPositionList",[s.DETAILS_KEYS.REQUEST_PARAMS]:{account_address:t}})}}async getBurnPosition(t){try{let e=await this._sdk.FullClient.getObject({id:t,options:{showContent:!0,showType:!0}});return e?.data?.content?.fields?b.buildBurnPositionNFT(e?.data?.content?.fields):null}catch(e){u("InvalidPositionId",e,{[s.DETAILS_KEYS.METHOD_NAME]:"getBurnPosition",[s.DETAILS_KEYS.REQUEST_PARAMS]:{pos_id:t}})}}createBurnPayload(t,e){e=e||new p.Transaction;let o=typeof t.pos_id=="string"?e.object(t.pos_id):t.pos_id,{burn:n}=this._sdk.sdkOptions,{manager_id:r}=(0,s.getPackagerConfigs)(n),i=`${n.published_at}::lp_burn::burn`;return e.moveCall({target:i,arguments:[e.object(r),e.object(t.pool_id),o],typeArguments:[t.coin_type_a,t.coin_type_b]}),e}createBurnLPV2Payload(t,e){e=e||new p.Transaction;let o=typeof t=="string"?e.object(t):t,{burn:n}=this._sdk.sdkOptions,{manager_id:r}=(0,s.getPackagerConfigs)(n),i=`${n.published_at}::lp_burn::burn_lp_v2`,[d]=e.moveCall({target:i,arguments:[e.object(r),o],typeArguments:[]});return d}createCollectFeePayload(t,e){e=e||new p.Transaction;let{burn:o}=this._sdk.sdkOptions,{manager_id:n,clmm_global_config:r}=(0,s.getPackagerConfigs)(o),i=`${o.published_at}::lp_burn::collect_fee`,d=e.moveCall({target:i,arguments:[e.object(n),e.object(r),e.object(t.pool_id),e.object(t.pos_id)],typeArguments:[t.coin_type_a,t.coin_type_b]});return e.transferObjects(d,e.pure.address(t.account)),e}crateCollectRewardPayload(t,e){e=e||new p.Transaction;let{burn:o}=this._sdk.sdkOptions,{manager_id:n,clmm_global_config:r,clmm_global_vault_id:i}=(0,s.getPackagerConfigs)(o),d=`${o.published_at}::lp_burn::collect_reward`;for(let l=0;l<t.rewarder_coin_types?.length;l++){let c=t.rewarder_coin_types?.[l],_=e.moveCall({target:d,arguments:[e.object(n),e.object(r),e.object(t.pool_id),e.object(t.pos_id),e.object(i),e.object(s.CLOCK_ADDRESS)],typeArguments:[t.coin_type_a,t.coin_type_b,c]});e.transferObjects([_],e.pure.address(t.account))}return e}createCollectFeesPayload(t,e){e=e||new p.Transaction;let{burn:o}=this._sdk.sdkOptions,{manager_id:n,clmm_global_config:r}=(0,s.getPackagerConfigs)(o),i=`${o.published_at}::lp_burn::collect_fee`;for(let d=0;d<t.length;d++){let l=t[d],c=e.moveCall({target:i,arguments:[e.object(n),e.object(r),e.object(l.pool_id),e.object(l.pos_id)],typeArguments:[l.coin_type_a,l.coin_type_b]});e.transferObjects(c,e.pure.address(l.account))}return e}crateCollectRewardsPayload(t,e){e=e||new p.Transaction;let{burn:o}=this._sdk.sdkOptions,{manager_id:n,clmm_global_config:r,clmm_global_vault_id:i}=(0,s.getPackagerConfigs)(o),d=`${o.published_at}::lp_burn::collect_reward`;for(let l=0;l<t.length;l++){let c=t[l];for(let _=0;_<c.rewarder_coin_types?.length;_++){let j=c.rewarder_coin_types?.[_],O=e.moveCall({target:d,arguments:[e.object(n),e.object(r),e.object(c.pool_id),e.object(c.pos_id),e.object(i),e.object(s.CLOCK_ADDRESS)],typeArguments:[c.coin_type_a,c.coin_type_b,j]});e.transferObjects([O],e.pure.address(c.account))}}return e}};var g=class a extends T.SdkWrapper{constructor(t){super(t),this._burn=new m(this)}get Burn(){return this._burn}static createSDK(t){let{env:e="mainnet"}=t;return e==="mainnet"?a.createCustomSDK({...h,...t}):a.createCustomSDK({...k,...t})}static createCustomSDK(t){return new a(t)}};var F=g;0&&(module.exports={BurnModule,BurnUtils,CetusBurnSDK,burnMainnet,burnTestnet});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/sdk.ts","../src/config/mainnet.ts","../src/config/testnet.ts","../src/modules/burnModule.ts","../src/errors/errors.ts","../src/utils/burn.ts"],"sourcesContent":["import { CetusBurnSDK, SdkOptions } from './sdk'\n\nexport * from './utils'\nexport * from './types'\nexport * from './modules'\nexport * from './config'\nexport { CetusBurnSDK, SdkOptions }\nexport default CetusBurnSDK\n","import type { BaseSdkOptions, Package } from '@cetusprotocol/common-sdk'\nimport { SdkWrapper } from '@cetusprotocol/common-sdk'\nimport { burnMainnet, burnTestnet } from './config'\nimport { BurnModule } from './modules/burnModule'\nimport type { BurnConfigs } from './types/burn'\n\n/**\n * Represents options and configurations for an SDK.\n */\nexport interface SdkOptions extends BaseSdkOptions {\n  burn: Package<BurnConfigs>\n}\n\n/**\n * The entry class of CetusDcaSDK, which is almost responsible for all interactions with dca.\n */\nexport class CetusBurnSDK extends SdkWrapper<SdkOptions> {\n  protected _burn: BurnModule\n\n  constructor(options: SdkOptions) {\n    super(options)\n\n    this._burn = new BurnModule(this)\n  }\n\n  get Burn(): BurnModule {\n    return this._burn\n  }\n\n  /**\n   * Static factory method to initialize the SDK\n   * @param options SDK initialization options\n   * @returns An instance of CetusBurnDK\n   */\n  static createSDK(options: BaseSdkOptions): CetusBurnSDK {\n    const { env = 'mainnet' } = options\n    return env === 'mainnet'\n      ? CetusBurnSDK.createCustomSDK({ ...burnMainnet, ...options })\n      : CetusBurnSDK.createCustomSDK({ ...burnTestnet, ...options })\n  }\n\n  /**\n   * Create a custom SDK instance with the given options\n   * @param options The options for the SDK\n   * @returns An instance of CetusBurnSDK\n   */\n  static createCustomSDK<T extends BaseSdkOptions>(options: T & SdkOptions): CetusBurnSDK {\n    return new CetusBurnSDK(options)\n  }\n}\n","import { FullRpcUrlMainnet } from '@cetusprotocol/common-sdk'\nimport type { SdkOptions } from '../sdk'\nimport { CetusBurnSDK } from '../sdk'\n// mainnet\nexport const burnMainnet: SdkOptions = {\n  env: 'mainnet',\n  full_rpc_url: FullRpcUrlMainnet,\n  burn: {\n    package_id: '0x12d73de9a6bc3cb658ec9dc0fe7de2662be1cea5c76c092fcc3606048cdbac27',\n    published_at: '0xb977b00649d3ab8950bcbbafb01fcf32e2e7718eb3133eff2e48c0cef04b1495',\n    config: {\n      manager_id: '0x1d94aa32518d0cb00f9de6ed60d450c9a2090761f326752ffad06b2e9404f845',\n      clmm_global_config: '0xdaa46292632c3c4d8f31f23ea0f9b36a28ff3677e9684980e4438403a67a3d8f',\n      clmm_global_vault_id: '0xce7bceef26d3ad1f6d9b6f13a953f053e6ed3ca77907516481ce99ae8e588f2b',\n      burn_pool_handle: '0xc9aacf74bd7cc8da8820ae28ca4473b7e01c87be19bc35bf81c9c7311e1b299e',\n    },\n  },\n}\n","import { FullRpcUrlTestnet } from '@cetusprotocol/common-sdk'\nimport type { SdkOptions } from '../sdk'\nimport { CetusBurnSDK } from '../sdk'\n\nexport const burnTestnet: SdkOptions = {\n  env: 'testnet',\n  full_rpc_url: FullRpcUrlTestnet,\n  burn: {\n    package_id: '0x3b494006831b046481c8046910106e2dfbe0d1fa9bc01e41783fb3ff6534ed3a',\n    published_at: '0xaf89f8215c5b07eaac8b77c7745ce62f94cb76ef4bcb854e283f644c519ef43e',\n    config: {\n      manager_id: '0xd04529ef15b7dad6699ee905daca0698858cab49724b2b2a1fc6b1ebc5e474ef',\n      clmm_global_config: '0x9774e359588ead122af1c7e7f64e14ade261cfeecdb5d0eb4a5b3b4c8ab8bd3e',\n      clmm_global_vault_id: '0xf78d2ee3c312f298882cb680695e5e8c81b1d441a646caccc058006c2851ddea',\n      burn_pool_handle: '0x20262dac8853ab8f63c98e0b17bfb1c758efc33d0092ac3c5f204dfb7ba81ac5',\n    },\n  },\n}\n","import type { TransactionObjectArgument } from '@mysten/sui/transactions'\nimport { Transaction } from '@mysten/sui/transactions'\nimport { CLOCK_ADDRESS, DETAILS_KEYS, getPackagerConfigs, IModule } from '@cetusprotocol/common-sdk'\nimport { BurnErrorCode, handleError } from '../errors/errors'\nimport type { CetusBurnSDK } from '../sdk'\nimport type { BurnParams, CollectFeeParams, CollectRewardParams } from '../types/burn'\nimport { BurnUtils } from '../utils'\n\nexport class BurnModule implements IModule<CetusBurnSDK> {\n  protected _sdk: CetusBurnSDK\n\n  constructor(sdk: CetusBurnSDK) {\n    this._sdk = sdk\n  }\n\n  get sdk() {\n    return this._sdk\n  }\n\n  /**\n   * @description Get the list of pools that have been burned.\n   * @returns\n   */\n  async getBurnPoolList() {\n    try {\n      const { burn } = this._sdk.sdkOptions\n      // TODO positionTableId is a constant, it can be written in the configuration later\n      const { manager_id } = getPackagerConfigs(burn)\n      const object: any = await this._sdk.FullClient.getObject({\n        id: manager_id,\n        options: {\n          showType: true,\n          showContent: true,\n        },\n      })\n\n      const positionTableId = object?.data?.content?.fields?.position?.fields?.id?.id\n\n      const positionTableData = await this._sdk.FullClient.getDynamicFieldsByPage(positionTableId)\n\n      const burnPools = positionTableData?.data?.map((item: any) => {\n        return item?.name?.value\n      })\n\n      return burnPools\n    } catch (error) {\n      console.log('getBurnPoolList ~ error:', error)\n      handleError(BurnErrorCode.FetchError, error as Error, {\n        [DETAILS_KEYS.METHOD_NAME]: 'getBurnPoolList',\n      })\n    }\n  }\n\n  /**\n   * @description Get the position handle for a given pool.\n   * @param pool_id - The pool ID.\n   * @returns\n   */\n  private async getPositionHandle(pool_id: string) {\n    const { burn } = this._sdk.sdkOptions\n    const { burn_pool_handle } = getPackagerConfigs(burn)\n    const cacheKey = `getPosHandle_${pool_id}`\n    let posHandle = this._sdk.getCache<string>(cacheKey)\n    if (posHandle) {\n      return posHandle\n    }\n    try {\n      const posHandleRes: any = await this._sdk.FullClient.getDynamicFieldObject({\n        parentId: burn_pool_handle,\n        name: {\n          type: '0x2::object::ID',\n          value: pool_id,\n        },\n      })\n      posHandle = posHandleRes.data.content.fields.value.fields.id.id\n\n      if (posHandle) {\n        this._sdk.updateCache(cacheKey, posHandle)\n      }\n\n      return posHandle\n    } catch (error) {\n      handleError(BurnErrorCode.InvalidPoolId, error as Error, {\n        [DETAILS_KEYS.METHOD_NAME]: 'getPositionHandle',\n        [DETAILS_KEYS.REQUEST_PARAMS]: { pool_id },\n      })\n    }\n  }\n\n  /**\n   * @description Get the list of burned positions for a given pool.\n   * @param pool_id - The pool ID.\n   * @returns\n   */\n  async getPoolBurnPositionList(pool_id: string) {\n    try {\n      const posHandle = await this.getPositionHandle(pool_id)\n      if (posHandle === undefined) {\n        handleError(BurnErrorCode.InvalidPoolId, `${pool_id} is a invalid pool id, please check it and try another valid pool id`, {\n          [DETAILS_KEYS.METHOD_NAME]: 'getPositionHandle',\n          [DETAILS_KEYS.REQUEST_PARAMS]: { pool_id },\n        })\n      }\n\n      const positionTableData = await this._sdk.FullClient.getDynamicFieldsByPage(posHandle as string)\n\n      const warpPosIds = positionTableData?.data?.map((item: any) => {\n        return item.objectId\n      })\n\n      if (warpPosIds.length > 0) {\n        const warpPosRes = await this._sdk.FullClient.batchGetObjects(warpPosIds, { showContent: true })\n\n        const burnedPositionIds = warpPosRes.map((item: any) => {\n          return item.data.content.fields.value.fields.burned_position_id\n        })\n\n        const burnedPositionsRes = await this._sdk.FullClient.batchGetObjects(burnedPositionIds, { showContent: true })\n\n        const burnPositionList = burnedPositionsRes?.map((item: any) => {\n          const info = BurnUtils.buildBurnPositionNFT(item?.data?.content?.fields)\n          return info\n        })\n        return burnPositionList\n      }\n\n      return []\n    } catch (error: any) {\n      console.log('getPoolBurnPositionList ~ error:', error)\n      handleError(BurnErrorCode.InvalidPoolId, `${pool_id} is a invalid pool id, please check it and try another valid pool id`, {\n        [DETAILS_KEYS.METHOD_NAME]: 'getPoolBurnPositionList',\n        [DETAILS_KEYS.REQUEST_PARAMS]: { pool_id },\n      })\n    }\n  }\n\n  /**\n   * @description Get the list of burned positions for a given account.\n   * @param account_address - The account address.\n   * @returns\n   */\n  async getBurnPositionList(account_address: string) {\n    const { package_id } = this._sdk.sdkOptions.burn\n    try {\n      const ownerRes = await this._sdk.FullClient.getOwnedObjectsByPage(account_address, {\n        options: { showType: true, showContent: true, showOwner: true, showDisplay: true },\n        filter: {\n          MatchAny: [\n            {\n              StructType: `${package_id}::lp_burn::CetusLPBurnProof`,\n            },\n          ],\n        },\n      })\n      const burnPositionList = ownerRes?.data?.map((item: any) => {\n        const info = BurnUtils.buildBurnPositionNFT(item?.data?.content?.fields)\n        return info\n      })\n      return burnPositionList\n    } catch (error) {\n      handleError(BurnErrorCode.InvalidAccountAddress, error as Error, {\n        [DETAILS_KEYS.METHOD_NAME]: 'getBurnPositionList',\n        [DETAILS_KEYS.REQUEST_PARAMS]: { account_address },\n      })\n    }\n  }\n\n  /**\n   * @description Get the burned position information for a given position ID.\n   * @param pos_id - The position ID.\n   * @returns\n   */\n  async getBurnPosition(pos_id: string) {\n    try {\n      const object: any = await this._sdk.FullClient.getObject({ id: pos_id, options: { showContent: true, showType: true } })\n\n      if (object?.data?.content?.fields) {\n        const info = BurnUtils.buildBurnPositionNFT(object?.data?.content?.fields)\n        return info\n      }\n\n      return null\n    } catch (error) {\n      handleError(BurnErrorCode.InvalidPositionId, error as Error, {\n        [DETAILS_KEYS.METHOD_NAME]: 'getBurnPosition',\n        [DETAILS_KEYS.REQUEST_PARAMS]: { pos_id },\n      })\n    }\n  }\n\n  /**\n   * @description Create a burn payload for a given pool and position.\n   * @param params - The burn parameters.\n   * @param tx - The transaction object.\n   * @returns\n   */\n  createBurnPayload(params: BurnParams, tx?: Transaction) {\n    tx = tx || new Transaction()\n\n    const positionArg = typeof params.pos_id === 'string' ? tx.object(params.pos_id) : params.pos_id\n\n    const { burn } = this._sdk.sdkOptions\n    const { manager_id } = getPackagerConfigs(burn)\n    const target = `${burn.published_at}::lp_burn::burn`\n    tx.moveCall({\n      target,\n      arguments: [tx.object(manager_id), tx.object(params.pool_id), positionArg],\n      typeArguments: [params.coin_type_a, params.coin_type_b],\n    })\n\n    return tx\n  }\n\n  /**\n   * When the position is burned, a CetusLPBurnProof will be returned. Compared to the burn_lp function,\n   * this V2 version does not require the pool object as a parameter, making it more convenient to use.\n   * The function will automatically verify the position's validity through the position object itself.\n   * This design also allows users to create a pool, add liquidity, and burn the position all within one transaction.\n   *\n   * @param {string | TransactionObjectArgument} pos - The LP position to be burned,\n   *        either as an object argument or its ID (string).\n   * @param {Transaction} [tx] - An optional `Transaction` object; if not provided, a new one is created.\n   * @returns {CetusLPBurnProof} - The CetusLPBurnProof object ID .\n   */\n  createBurnLPV2Payload(pos: string | TransactionObjectArgument, tx?: Transaction): TransactionObjectArgument {\n    tx = tx || new Transaction()\n\n    const positionArg = typeof pos === 'string' ? tx.object(pos) : pos\n\n    const { burn } = this._sdk.sdkOptions\n    const { manager_id } = getPackagerConfigs(burn)\n\n    const target = `${burn.published_at}::lp_burn::burn_lp_v2`\n    const [cetusLPBurnProof] = tx.moveCall({\n      target,\n      arguments: [tx.object(manager_id), positionArg],\n      typeArguments: [],\n    })\n\n    return cetusLPBurnProof\n  }\n\n  /**\n   * @description Create a collect fee payload for a given pool and position.\n   * @param params - The collect fee parameters.\n   * @param tx - The transaction object.\n   * @returns\n   */\n  createCollectFeePayload(params: CollectFeeParams, tx?: Transaction) {\n    tx = tx || new Transaction()\n\n    const { burn } = this._sdk.sdkOptions\n    const { manager_id, clmm_global_config } = getPackagerConfigs(burn)\n\n    const target = `${burn.published_at}::lp_burn::collect_fee`\n\n    const coins = tx.moveCall({\n      target,\n      arguments: [tx.object(manager_id), tx.object(clmm_global_config), tx.object(params.pool_id), tx.object(params.pos_id)],\n      typeArguments: [params.coin_type_a, params.coin_type_b],\n    })\n    tx.transferObjects(coins, tx.pure.address(params.account))\n\n    return tx\n  }\n\n  /**\n   * @description Create a collect reward payload for a given pool and position.\n   * @param params - The collect reward parameters.\n   * @param tx - The transaction object.\n   * @returns\n   */\n  crateCollectRewardPayload(params: CollectRewardParams, tx?: Transaction) {\n    tx = tx || new Transaction()\n\n    const { burn } = this._sdk.sdkOptions\n    const { manager_id, clmm_global_config, clmm_global_vault_id } = getPackagerConfigs(burn)\n\n    const target = `${burn.published_at}::lp_burn::collect_reward`\n\n    for (let i = 0; i < params.rewarder_coin_types?.length; i++) {\n      const item = params.rewarder_coin_types?.[i]\n      const coin = tx.moveCall({\n        target,\n        arguments: [\n          tx.object(manager_id),\n          tx.object(clmm_global_config),\n          tx.object(params.pool_id),\n          tx.object(params.pos_id),\n          tx.object(clmm_global_vault_id),\n          tx.object(CLOCK_ADDRESS),\n        ],\n        typeArguments: [params.coin_type_a, params.coin_type_b, item],\n      })\n\n      tx.transferObjects([coin], tx.pure.address(params.account))\n    }\n\n    return tx\n  }\n\n  /**\n   * @description Create a collect fee payload for a given pool and position.\n   * @param params - The collect fee parameters.\n   * @param tx - The transaction object.\n   * @returns\n   */\n  createCollectFeesPayload(params: CollectFeeParams[], tx?: Transaction) {\n    tx = tx || new Transaction()\n\n    const { burn } = this._sdk.sdkOptions\n    const { manager_id, clmm_global_config } = getPackagerConfigs(burn)\n\n    const target = `${burn.published_at}::lp_burn::collect_fee`\n\n    for (let i = 0; i < params.length; i++) {\n      const item = params[i]\n      const coins = tx.moveCall({\n        target,\n        arguments: [tx.object(manager_id), tx.object(clmm_global_config), tx.object(item.pool_id), tx.object(item.pos_id)],\n        typeArguments: [item.coin_type_a, item.coin_type_b],\n      })\n      tx.transferObjects(coins, tx.pure.address(item.account))\n    }\n\n    return tx\n  }\n\n  /**\n   * @description Create a collect reward payload for a given pool and position.\n   * @param params - The collect reward parameters.\n   * @param tx - The transaction object.\n   * @returns\n   */\n  crateCollectRewardsPayload(params: CollectRewardParams[], tx?: Transaction) {\n    tx = tx || new Transaction()\n\n    const { burn } = this._sdk.sdkOptions\n    const { manager_id, clmm_global_config, clmm_global_vault_id } = getPackagerConfigs(burn)\n\n    const target = `${burn.published_at}::lp_burn::collect_reward`\n    for (let j = 0; j < params.length; j++) {\n      const item = params[j]\n      for (let i = 0; i < item.rewarder_coin_types?.length; i++) {\n        const items = item.rewarder_coin_types?.[i]\n        const coin = tx.moveCall({\n          target,\n          arguments: [\n            tx.object(manager_id),\n            tx.object(clmm_global_config),\n            tx.object(item.pool_id),\n            tx.object(item.pos_id),\n            tx.object(clmm_global_vault_id),\n            tx.object(CLOCK_ADDRESS),\n          ],\n          typeArguments: [item.coin_type_a, item.coin_type_b, items],\n        })\n\n        tx.transferObjects([coin], tx.pure.address(item.account))\n      }\n    }\n\n    return tx\n  }\n}\n","import { BaseError } from '@cetusprotocol/common-sdk'\n\nexport enum BurnErrorCode {\n  InvalidPoolId = `InvalidPoolId`,\n  InvalidPositionId = `InvalidPositionId`,\n  InvalidAccountAddress = `InvalidAccountAddress`,\n  BuildError = 'BuildError',\n  FetchError = 'FetchError',\n}\n\nexport class BurnError extends BaseError {\n  constructor(message: string, error_code?: BurnErrorCode, details?: Record<string, any>) {\n    super(message, error_code || 'UnknownError', details)\n  }\n\n  static isBurnErrorCode(e: any, code: BurnErrorCode): boolean {\n    return this.isErrorCode<BurnError>(e, code)\n  }\n}\n\nexport const handleError = (code: BurnErrorCode, error: Error | string, details?: Record<string, any>) => {\n  if (error instanceof Error) {\n    throw new BurnError(error.message, code, details)\n  } else {\n    throw new BurnError(error, code, details)\n  }\n}\n","import { asIntN, extractStructTagFromType } from '@cetusprotocol/common-sdk'\nimport { BurnPositionNFT } from '../types/burn'\n\nexport class BurnUtils {\n  static buildBurnPositionNFT(fields: any): BurnPositionNFT {\n    const burnFields = fields.position.fields\n    const name = `Cetus Burned LP | Pool${burnFields.name.split('Pool')?.[1]}`\n    const burnPositionNft: BurnPositionNFT = {\n      id: fields.id.id,\n      url: burnFields.url,\n      pool_id: burnFields.pool,\n      coin_type_a: extractStructTagFromType(burnFields.coin_type_a.fields.name).full_address,\n      coin_type_b: extractStructTagFromType(burnFields.coin_type_b.fields.name).full_address,\n      description: burnFields.description,\n      name,\n      liquidity: burnFields.liquidity,\n      clmm_position_id: burnFields.id.id,\n      clmm_pool_id: burnFields.pool,\n      tick_lower_index: asIntN(BigInt(burnFields.tick_lower_index.fields.bits)),\n      tick_upper_index: asIntN(BigInt(burnFields.tick_upper_index.fields.bits)),\n      index: burnFields.index,\n      is_lp_burn: true,\n    }\n    return burnPositionNft\n  }\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,gBAAAE,EAAA,cAAAC,EAAA,iBAAAC,EAAA,gBAAAC,EAAA,gBAAAC,EAAA,YAAAC,IAAA,eAAAC,EAAAR,GCCA,IAAAS,EAA2B,qCCD3B,IAAAC,EAAkC,qCAIrBC,EAA0B,CACrC,IAAK,UACL,aAAc,oBACd,KAAM,CACJ,WAAY,qEACZ,aAAc,qEACd,OAAQ,CACN,WAAY,qEACZ,mBAAoB,qEACpB,qBAAsB,qEACtB,iBAAkB,oEACpB,CACF,CACF,ECjBA,IAAAC,EAAkC,qCAIrBC,EAA0B,CACrC,IAAK,UACL,aAAc,oBACd,KAAM,CACJ,WAAY,qEACZ,aAAc,qEACd,OAAQ,CACN,WAAY,qEACZ,mBAAoB,qEACpB,qBAAsB,qEACtB,iBAAkB,oEACpB,CACF,CACF,EChBA,IAAAC,EAA4B,oCAC5BC,EAAyE,qCCFzE,IAAAC,EAA0B,qCAUnB,IAAMC,EAAN,cAAwB,WAAU,CACvC,YAAYC,EAAiBC,EAA4BC,EAA+B,CACtF,MAAMF,EAASC,GAAc,eAAgBC,CAAO,CACtD,CAEA,OAAO,gBAAgBC,EAAQC,EAA8B,CAC3D,OAAO,KAAK,YAAuBD,EAAGC,CAAI,CAC5C,CACF,EAEaC,EAAc,CAACD,EAAqBE,EAAuBJ,IAAkC,CACxG,MAAII,aAAiB,MACb,IAAIP,EAAUO,EAAM,QAASF,EAAMF,CAAO,EAE1C,IAAIH,EAAUO,EAAOF,EAAMF,CAAO,CAE5C,EC1BA,IAAAK,EAAiD,qCAGpCC,EAAN,KAAgB,CACrB,OAAO,qBAAqBC,EAA8B,CACxD,IAAMC,EAAaD,EAAO,SAAS,OAC7BE,EAAO,yBAAyBD,EAAW,KAAK,MAAM,MAAM,IAAI,CAAC,CAAC,GAiBxE,MAhByC,CACvC,GAAID,EAAO,GAAG,GACd,IAAKC,EAAW,IAChB,QAASA,EAAW,KACpB,eAAa,4BAAyBA,EAAW,YAAY,OAAO,IAAI,EAAE,aAC1E,eAAa,4BAAyBA,EAAW,YAAY,OAAO,IAAI,EAAE,aAC1E,YAAaA,EAAW,YACxB,KAAAC,EACA,UAAWD,EAAW,UACtB,iBAAkBA,EAAW,GAAG,GAChC,aAAcA,EAAW,KACzB,oBAAkB,UAAO,OAAOA,EAAW,iBAAiB,OAAO,IAAI,CAAC,EACxE,oBAAkB,UAAO,OAAOA,EAAW,iBAAiB,OAAO,IAAI,CAAC,EACxE,MAAOA,EAAW,MAClB,WAAY,EACd,CAEF,CACF,EFjBO,IAAME,EAAN,KAAkD,CAGvD,YAAYC,EAAmB,CAC7B,KAAK,KAAOA,CACd,CAEA,IAAI,KAAM,CACR,OAAO,KAAK,IACd,CAMA,MAAM,iBAAkB,CACtB,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,KAAK,KAAK,WAErB,CAAE,WAAAC,CAAW,KAAI,sBAAmBD,CAAI,EASxCE,GARc,MAAM,KAAK,KAAK,WAAW,UAAU,CACvD,GAAID,EACJ,QAAS,CACP,SAAU,GACV,YAAa,EACf,CACF,CAAC,IAE+B,MAAM,SAAS,QAAQ,UAAU,QAAQ,IAAI,GAQ7E,OAN0B,MAAM,KAAK,KAAK,WAAW,uBAAuBC,CAAe,IAEtD,MAAM,IAAKC,GACvCA,GAAM,MAAM,KACpB,CAGH,OAASC,EAAO,CACd,QAAQ,IAAI,2BAA4BA,CAAK,EAC7CC,eAAsCD,EAAgB,CACpD,CAAC,eAAa,WAAW,EAAG,iBAC9B,CAAC,CACH,CACF,CAOA,MAAc,kBAAkBE,EAAiB,CAC/C,GAAM,CAAE,KAAAN,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,iBAAAO,CAAiB,KAAI,sBAAmBP,CAAI,EAC9CQ,EAAW,gBAAgBF,CAAO,GACpCG,EAAY,KAAK,KAAK,SAAiBD,CAAQ,EACnD,GAAIC,EACF,OAAOA,EAET,GAAI,CAQF,OAAAA,GAP0B,MAAM,KAAK,KAAK,WAAW,sBAAsB,CACzE,SAAUF,EACV,KAAM,CACJ,KAAM,kBACN,MAAOD,CACT,CACF,CAAC,GACwB,KAAK,QAAQ,OAAO,MAAM,OAAO,GAAG,GAEzDG,GACF,KAAK,KAAK,YAAYD,EAAUC,CAAS,EAGpCA,CACT,OAASL,EAAO,CACdC,kBAAyCD,EAAgB,CACvD,CAAC,eAAa,WAAW,EAAG,oBAC5B,CAAC,eAAa,cAAc,EAAG,CAAE,QAAAE,CAAQ,CAC3C,CAAC,CACH,CACF,CAOA,MAAM,wBAAwBA,EAAiB,CAC7C,GAAI,CACF,IAAMG,EAAY,MAAM,KAAK,kBAAkBH,CAAO,EAClDG,IAAc,QAChBJ,kBAAyC,GAAGC,CAAO,uEAAwE,CACzH,CAAC,eAAa,WAAW,EAAG,oBAC5B,CAAC,eAAa,cAAc,EAAG,CAAE,QAAAA,CAAQ,CAC3C,CAAC,EAKH,IAAMI,GAFoB,MAAM,KAAK,KAAK,WAAW,uBAAuBD,CAAmB,IAEzD,MAAM,IAAKN,GACxCA,EAAK,QACb,EAED,GAAIO,EAAW,OAAS,EAAG,CAGzB,IAAMC,GAFa,MAAM,KAAK,KAAK,WAAW,gBAAgBD,EAAY,CAAE,YAAa,EAAK,CAAC,GAE1D,IAAKP,GACjCA,EAAK,KAAK,QAAQ,OAAO,MAAM,OAAO,kBAC9C,EAQD,OAN2B,MAAM,KAAK,KAAK,WAAW,gBAAgBQ,EAAmB,CAAE,YAAa,EAAK,CAAC,IAEjE,IAAKR,GACnCS,EAAU,qBAAqBT,GAAM,MAAM,SAAS,MAAM,CAExE,CAEH,CAEA,MAAO,CAAC,CACV,OAASC,EAAY,CACnB,QAAQ,IAAI,mCAAoCA,CAAK,EACrDC,kBAAyC,GAAGC,CAAO,uEAAwE,CACzH,CAAC,eAAa,WAAW,EAAG,0BAC5B,CAAC,eAAa,cAAc,EAAG,CAAE,QAAAA,CAAQ,CAC3C,CAAC,CACH,CACF,CAOA,MAAM,oBAAoBO,EAAyB,CACjD,GAAM,CAAE,WAAAC,CAAW,EAAI,KAAK,KAAK,WAAW,KAC5C,GAAI,CAeF,OAdiB,MAAM,KAAK,KAAK,WAAW,sBAAsBD,EAAiB,CACjF,QAAS,CAAE,SAAU,GAAM,YAAa,GAAM,UAAW,GAAM,YAAa,EAAK,EACjF,OAAQ,CACN,SAAU,CACR,CACE,WAAY,GAAGC,CAAU,6BAC3B,CACF,CACF,CACF,CAAC,IACkC,MAAM,IAAKX,GAC/BS,EAAU,qBAAqBT,GAAM,MAAM,SAAS,MAAM,CAExE,CAEH,OAASC,EAAO,CACdC,0BAAiDD,EAAgB,CAC/D,CAAC,eAAa,WAAW,EAAG,sBAC5B,CAAC,eAAa,cAAc,EAAG,CAAE,gBAAAS,CAAgB,CACnD,CAAC,CACH,CACF,CAOA,MAAM,gBAAgBE,EAAgB,CACpC,GAAI,CACF,IAAMC,EAAc,MAAM,KAAK,KAAK,WAAW,UAAU,CAAE,GAAID,EAAQ,QAAS,CAAE,YAAa,GAAM,SAAU,EAAK,CAAE,CAAC,EAEvH,OAAIC,GAAQ,MAAM,SAAS,OACZJ,EAAU,qBAAqBI,GAAQ,MAAM,SAAS,MAAM,EAIpE,IACT,OAASZ,EAAO,CACdC,sBAA6CD,EAAgB,CAC3D,CAAC,eAAa,WAAW,EAAG,kBAC5B,CAAC,eAAa,cAAc,EAAG,CAAE,OAAAW,CAAO,CAC1C,CAAC,CACH,CACF,CAQA,kBAAkBE,EAAoBC,EAAkB,CACtDA,EAAKA,GAAM,IAAI,cAEf,IAAMC,EAAc,OAAOF,EAAO,QAAW,SAAWC,EAAG,OAAOD,EAAO,MAAM,EAAIA,EAAO,OAEpF,CAAE,KAAAjB,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,WAAAC,CAAW,KAAI,sBAAmBD,CAAI,EACxCoB,EAAS,GAAGpB,EAAK,YAAY,kBACnC,OAAAkB,EAAG,SAAS,CACV,OAAAE,EACA,UAAW,CAACF,EAAG,OAAOjB,CAAU,EAAGiB,EAAG,OAAOD,EAAO,OAAO,EAAGE,CAAW,EACzE,cAAe,CAACF,EAAO,YAAaA,EAAO,WAAW,CACxD,CAAC,EAEMC,CACT,CAaA,sBAAsBG,EAAyCH,EAA6C,CAC1GA,EAAKA,GAAM,IAAI,cAEf,IAAMC,EAAc,OAAOE,GAAQ,SAAWH,EAAG,OAAOG,CAAG,EAAIA,EAEzD,CAAE,KAAArB,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,WAAAC,CAAW,KAAI,sBAAmBD,CAAI,EAExCoB,EAAS,GAAGpB,EAAK,YAAY,wBAC7B,CAACsB,CAAgB,EAAIJ,EAAG,SAAS,CACrC,OAAAE,EACA,UAAW,CAACF,EAAG,OAAOjB,CAAU,EAAGkB,CAAW,EAC9C,cAAe,CAAC,CAClB,CAAC,EAED,OAAOG,CACT,CAQA,wBAAwBL,EAA0BC,EAAkB,CAClEA,EAAKA,GAAM,IAAI,cAEf,GAAM,CAAE,KAAAlB,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,WAAAC,EAAY,mBAAAsB,CAAmB,KAAI,sBAAmBvB,CAAI,EAE5DoB,EAAS,GAAGpB,EAAK,YAAY,yBAE7BwB,EAAQN,EAAG,SAAS,CACxB,OAAAE,EACA,UAAW,CAACF,EAAG,OAAOjB,CAAU,EAAGiB,EAAG,OAAOK,CAAkB,EAAGL,EAAG,OAAOD,EAAO,OAAO,EAAGC,EAAG,OAAOD,EAAO,MAAM,CAAC,EACrH,cAAe,CAACA,EAAO,YAAaA,EAAO,WAAW,CACxD,CAAC,EACD,OAAAC,EAAG,gBAAgBM,EAAON,EAAG,KAAK,QAAQD,EAAO,OAAO,CAAC,EAElDC,CACT,CAQA,0BAA0BD,EAA6BC,EAAkB,CACvEA,EAAKA,GAAM,IAAI,cAEf,GAAM,CAAE,KAAAlB,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,WAAAC,EAAY,mBAAAsB,EAAoB,qBAAAE,CAAqB,KAAI,sBAAmBzB,CAAI,EAElFoB,EAAS,GAAGpB,EAAK,YAAY,4BAEnC,QAAS0B,EAAI,EAAGA,EAAIT,EAAO,qBAAqB,OAAQS,IAAK,CAC3D,IAAMvB,EAAOc,EAAO,sBAAsBS,CAAC,EACrCC,EAAOT,EAAG,SAAS,CACvB,OAAAE,EACA,UAAW,CACTF,EAAG,OAAOjB,CAAU,EACpBiB,EAAG,OAAOK,CAAkB,EAC5BL,EAAG,OAAOD,EAAO,OAAO,EACxBC,EAAG,OAAOD,EAAO,MAAM,EACvBC,EAAG,OAAOO,CAAoB,EAC9BP,EAAG,OAAO,eAAa,CACzB,EACA,cAAe,CAACD,EAAO,YAAaA,EAAO,YAAad,CAAI,CAC9D,CAAC,EAEDe,EAAG,gBAAgB,CAACS,CAAI,EAAGT,EAAG,KAAK,QAAQD,EAAO,OAAO,CAAC,CAC5D,CAEA,OAAOC,CACT,CAQA,yBAAyBD,EAA4BC,EAAkB,CACrEA,EAAKA,GAAM,IAAI,cAEf,GAAM,CAAE,KAAAlB,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,WAAAC,EAAY,mBAAAsB,CAAmB,KAAI,sBAAmBvB,CAAI,EAE5DoB,EAAS,GAAGpB,EAAK,YAAY,yBAEnC,QAAS0B,EAAI,EAAGA,EAAIT,EAAO,OAAQS,IAAK,CACtC,IAAMvB,EAAOc,EAAOS,CAAC,EACfF,EAAQN,EAAG,SAAS,CACxB,OAAAE,EACA,UAAW,CAACF,EAAG,OAAOjB,CAAU,EAAGiB,EAAG,OAAOK,CAAkB,EAAGL,EAAG,OAAOf,EAAK,OAAO,EAAGe,EAAG,OAAOf,EAAK,MAAM,CAAC,EACjH,cAAe,CAACA,EAAK,YAAaA,EAAK,WAAW,CACpD,CAAC,EACDe,EAAG,gBAAgBM,EAAON,EAAG,KAAK,QAAQf,EAAK,OAAO,CAAC,CACzD,CAEA,OAAOe,CACT,CAQA,2BAA2BD,EAA+BC,EAAkB,CAC1EA,EAAKA,GAAM,IAAI,cAEf,GAAM,CAAE,KAAAlB,CAAK,EAAI,KAAK,KAAK,WACrB,CAAE,WAAAC,EAAY,mBAAAsB,EAAoB,qBAAAE,CAAqB,KAAI,sBAAmBzB,CAAI,EAElFoB,EAAS,GAAGpB,EAAK,YAAY,4BACnC,QAAS4B,EAAI,EAAGA,EAAIX,EAAO,OAAQW,IAAK,CACtC,IAAMzB,EAAOc,EAAOW,CAAC,EACrB,QAASF,EAAI,EAAGA,EAAIvB,EAAK,qBAAqB,OAAQuB,IAAK,CACzD,IAAMG,EAAQ1B,EAAK,sBAAsBuB,CAAC,EACpCC,EAAOT,EAAG,SAAS,CACvB,OAAAE,EACA,UAAW,CACTF,EAAG,OAAOjB,CAAU,EACpBiB,EAAG,OAAOK,CAAkB,EAC5BL,EAAG,OAAOf,EAAK,OAAO,EACtBe,EAAG,OAAOf,EAAK,MAAM,EACrBe,EAAG,OAAOO,CAAoB,EAC9BP,EAAG,OAAO,eAAa,CACzB,EACA,cAAe,CAACf,EAAK,YAAaA,EAAK,YAAa0B,CAAK,CAC3D,CAAC,EAEDX,EAAG,gBAAgB,CAACS,CAAI,EAAGT,EAAG,KAAK,QAAQf,EAAK,OAAO,CAAC,CAC1D,CACF,CAEA,OAAOe,CACT,CACF,EH5VO,IAAMY,EAAN,MAAMC,UAAqB,YAAuB,CAGvD,YAAYC,EAAqB,CAC/B,MAAMA,CAAO,EAEb,KAAK,MAAQ,IAAIC,EAAW,IAAI,CAClC,CAEA,IAAI,MAAmB,CACrB,OAAO,KAAK,KACd,CAOA,OAAO,UAAUD,EAAuC,CACtD,GAAM,CAAE,IAAAE,EAAM,SAAU,EAAIF,EAC5B,OAAOE,IAAQ,UACXH,EAAa,gBAAgB,CAAE,GAAGI,EAAa,GAAGH,CAAQ,CAAC,EAC3DD,EAAa,gBAAgB,CAAE,GAAGK,EAAa,GAAGJ,CAAQ,CAAC,CACjE,CAOA,OAAO,gBAA0CA,EAAuC,CACtF,OAAO,IAAID,EAAaC,CAAO,CACjC,CACF,ED1CA,IAAOK,EAAQC","names":["index_exports","__export","BurnModule","BurnUtils","CetusBurnSDK","burnMainnet","burnTestnet","index_default","__toCommonJS","import_common_sdk","import_common_sdk","burnMainnet","import_common_sdk","burnTestnet","import_transactions","import_common_sdk","import_common_sdk","BurnError","message","error_code","details","e","code","handleError","error","import_common_sdk","BurnUtils","fields","burnFields","name","BurnModule","sdk","burn","manager_id","positionTableId","item","error","handleError","pool_id","burn_pool_handle","cacheKey","posHandle","warpPosIds","burnedPositionIds","BurnUtils","account_address","package_id","pos_id","object","params","tx","positionArg","target","pos","cetusLPBurnProof","clmm_global_config","coins","clmm_global_vault_id","i","coin","j","items","CetusBurnSDK","_CetusBurnSDK","options","BurnModule","env","burnMainnet","burnTestnet","index_default","CetusBurnSDK"]}