@meteora-ag/dlmm 1.0.0 → 1.0.1

package/README.md

@@ -7,7 +7,7 @@
 
 ## Getting started
 
-NPM: https://www.npmjs.com/package/@meteora-ag/dlmm-sdk-public
+NPM: https://www.npmjs.com/package/@meteora-ag/dlmm
 
 SDK: https://github.com/MeteoraAg/dlmm-sdk
 
@@ -20,21 +20,19 @@ Discord: https://discord.com/channels/841152225564950528/864859354335412224
 1. Install deps
 
 ```
-npm i @meteora-ag/dlmm-sdk-public @coral-xyz/anchor @solana/web3.js
+npm i @meteora-ag/dlmm @coral-xyz/anchor @solana/web3.js
 ```
 
 2. Initialize DLMM instance
 
 ```ts
+import DLMM from '@meteora-ag/dlmm'
+
 const USDC_USDT_POOL = new PublicKey('ARwi1S4DaiTG5DX7S4M4ZsrXqpMD1MrTmbu9ue2tpmEq') // You can get your desired pool address from the API https://dlmm-api.meteora.ag/pair/all
-const dlmmPool = await DLMM.create(connection, USDC_USDT_POOL, {
-    cluster: "devnet",
-});
+const dlmmPool = await DLMM.create(connection, USDC_USDT_POOL);
 
 // If you need to create multiple, can consider using `createMultiple`
-const dlmmPool = await DLMM.create(connection, [USDC_USDT_POOL, ...], {
-    cluster: "devnet",
-});
+const dlmmPool = await DLMM.create(connection, [USDC_USDT_POOL, ...]);
 
 ```
 
@@ -168,7 +166,14 @@ try {
 ```ts
 const swapAmount = new BN(100);
 // Swap quote
-const swapQuote = await dlmmPool.swapQuote(swapAmount, true, new BN(10));
+const swapYtoX = true;
+const binArrays = await dlmmPool.getBinArrayForSwap(swapYtoX);
+const swapQuote = await dlmmPool.swapQuote(
+  swapAmount,
+  swapYtoX,
+  new BN(10),
+  binArrays
+);
 
 // Swap
 const swapTx = await dlmmPool.swap({
@@ -202,6 +207,7 @@ try {
 | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
 | `refetchStates`                             | Update onchain state of DLMM instance. It's recommend to call this before interact with the program (Deposit/ Withdraw/ Swap) | `Promise<void>`                                                                          |
 | `getBinArrays`                              | Retrieves List of Bin Arrays                                                                                                  | `Promise<BinArrayAccount[]>`                                                             |
+| `getBinArrayForSwap`                        | Retrieves List of Bin Arrays for swap purpose                                                                                 | `Promise<BinArrayAccount[]>`                                                             |
 | `getFeeInfo`                                | Retrieves LbPair's fee info including `base fee`, `protocol fee` & `max fee`                                                  | `FeeInfo`                                                                                |
 | `getDynamicFee`                             | Retrieves LbPair's dynamic fee                                                                                                | `Decimal`                                                                                |
 | `getBinsAroundActiveBin`                    | retrieves a specified number of bins to the left and right of the active bin and returns them along with the active bin ID.   | `Promise<{ activeBin: number; bins: BinLiquidity[] }>`                                   |

package/dist/index.d.ts

@@ -4642,6 +4642,15 @@ declare class DLMM {
      * @returns a Promise that resolves to an array of BinArrayAccount objects.
      */
     getBinArrays(): Promise<BinArrayAccount[]>;
+    /**
+     * The function `getBinArrayAroundActiveBin` retrieves a specified number of `BinArrayAccount`
+     * objects from the blockchain, based on the active bin and its surrounding bin arrays.
+     * @param
+     *    swapForY - The `swapForY` parameter is a boolean value that indicates whether the swap is using quote token as input.
+     *    [count=4] - The `count` parameter is the number of bin arrays to retrieve on left and right respectively. By default, it is set to 4.
+     * @returns an array of `BinArrayAccount` objects.
+     */
+    getBinArrayForSwap(swapForY: any, count?: number): Promise<BinArrayAccount[]>;
     /**
      * The function `getFeeInfo` calculates and returns the base fee rate percentage, maximum fee rate
      * percentage, and protocol fee percentage.

package/dist/index.js

@@ -6152,6 +6152,63 @@ var DLMM = class {
       }
     ]);
   }
+  /**
+   * The function `getBinArrayAroundActiveBin` retrieves a specified number of `BinArrayAccount`
+   * objects from the blockchain, based on the active bin and its surrounding bin arrays.
+   * @param
+   *    swapForY - The `swapForY` parameter is a boolean value that indicates whether the swap is using quote token as input.
+   *    [count=4] - The `count` parameter is the number of bin arrays to retrieve on left and right respectively. By default, it is set to 4.
+   * @returns an array of `BinArrayAccount` objects.
+   */
+  async getBinArrayForSwap(swapForY, count = 4) {
+    await this.refetchStates();
+    const binArraysPubkey = /* @__PURE__ */ new Set();
+    let shouldStop = false;
+    let activeIdToLoop = this.lbPair.activeId;
+    while (!shouldStop) {
+      const binArrayIndex = findNextBinArrayIndexWithLiquidity(
+        swapForY,
+        new (0, _anchor.BN)(activeIdToLoop),
+        this.lbPair,
+        _nullishCoalesce(_optionalChain([this, 'access', _51 => _51.binArrayBitmapExtension, 'optionalAccess', _52 => _52.account]), () => ( null))
+      );
+      if (binArrayIndex === null)
+        shouldStop = true;
+      else {
+        const [binArrayPubKey] = deriveBinArray(
+          this.pubkey,
+          binArrayIndex,
+          this.program.programId
+        );
+        binArraysPubkey.add(binArrayPubKey.toBase58());
+        const [lowerBinId, upperBinId] = getBinArrayLowerUpperBinId(binArrayIndex);
+        activeIdToLoop = swapForY ? lowerBinId.toNumber() - 1 : upperBinId.toNumber() + 1;
+      }
+      if (binArraysPubkey.size === count)
+        shouldStop = true;
+    }
+    const accountsToFetch = Array.from(binArraysPubkey).map(
+      (pubkey) => new (0, _web3js.PublicKey)(pubkey)
+    );
+    const binArraysAccInfoBuffer = await chunkedGetMultipleAccountInfos(
+      this.program.provider.connection,
+      accountsToFetch
+    );
+    const binArrays = await Promise.all(
+      binArraysAccInfoBuffer.map(async (accInfo, idx) => {
+        const account = this.program.coder.accounts.decode(
+          "binArray",
+          accInfo.data
+        );
+        const publicKey = accountsToFetch[idx];
+        return {
+          account,
+          publicKey
+        };
+      })
+    );
+    return binArrays;
+  }
   /**
    * The function `getFeeInfo` calculates and returns the base fee rate percentage, maximum fee rate
    * percentage, and protocol fee percentage.
@@ -7203,7 +7260,7 @@ var DLMM = class {
         swapForY,
         activeId,
         this.lbPair,
-        _optionalChain([this, 'access', _51 => _51.binArrayBitmapExtension, 'optionalAccess', _52 => _52.account]),
+        _optionalChain([this, 'access', _53 => _53.binArrayBitmapExtension, 'optionalAccess', _54 => _54.account]),
         binArrays
       );
       if (binArrayAccountToSwap == null) {