@picon-finance/dlmm-sdk 1.16.1 → 1.16.3

package/README.md

@@ -5,9 +5,22 @@ TypeScript SDK for the [Picon DLMM](https://github.com/picon-finance) protocol o
 ## Install
 
 ```bash
+bun add @picon-finance/dlmm-sdk
+yarn add @picon-finance/dlmm-sdk
 npm install @picon-finance/dlmm-sdk
 ```
 
+## Environments
+
+The package targets ESM (`"type": "module"`), but its ESM resolution has limitations —
+supported consumption splits into two scenarios:
+
+- **Server-side (Node scripts, tests, tooling): use [Bun](https://bun.sh).**
+- **Client-side / anything bundler-fronted (webpack, Vite, Rollup, ...): works as-is.** Webpack
+  needs `resolve.fullySpecified: false` on `.m?js$`; most other bundlers are lenient by default.
+
+**Not currently supported: bare `node` with no Bun and no bundler in front of it.**
+
 ## Usage
 
 The SDK is built around stateful classes (`DlmmProgram`, `Pool`, `Position`, `BinArray`) that cache on-chain state to avoid redundant RPC round trips. Every method returns unsigned `Instruction`s (never signs or sends) — build, sign, and send the transaction yourself with `@solana/kit`.
@@ -188,14 +201,6 @@ for (const claimIxs of claimTxs) {
 }
 ```
 
-### Admin
-
-`Pool.claimProtocolFee(authority)` drains `pool.data.protocolFeeX`/`protocolFeeY` to the admin's associated token accounts — `authority` must match `AdminConfig.authority`. `Pool.setProtocolShare(authority, protocolShare)` and `Pool.setDynamicFeeConfig(authority, config)` are similarly admin-gated single instructions:
-
-```ts
-const claimProtocolFeeIxs = await pool.claimProtocolFee(adminSigner);
-```
-
 ### Price math
 
 `getBaseBinPrice(binStep)`, `getBinPrice(baseBinPrice, binId)`, and `getBinPriceFromStep(binStep, binId)` are direct `bigint` ports of the on-chain Q64.64 price math (`bin_math.rs`'s `base_bin_price`/`bin_price`/`bin_price_from_step`) — useful for computing a bin's price without an RPC round trip, e.g. when picking `lowerBinId`/`upperBinId` for a new position before it exists on-chain. `getBinPrice`/`getBinPriceFromStep` return `undefined` (mirroring the Rust `Option`) if `binId` is outside the representable range for that `binStep`:

package/dist/picon_dlmm.json

@@ -2,7 +2,7 @@
     "address": "pDLMMk3KW3CUSxE1Wgjhx3jSmm2spe6Ry7Mq2HT26rC",
     "metadata": {
         "name": "picon_dlmm",
-        "version": "1.1.0",
+        "version": "1.1.1",
         "spec": "0.1.0",
         "description": "Created with Anchor"
     },

package/dist/utils/assert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/utils/assert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,UAAU,EACjB,KAAK,EAAE,UAAU,GAChB,IAAI,CAMN;AAED,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,EAC3B,IAAI,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,GACzB,IAAI,CAMN"}
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/utils/assert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,UAAU,EACjB,KAAK,EAAE,UAAU,GAChB,IAAI,CAMN;AAED,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,EAC3B,IAAI,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,GACzB,IAAI,CAMN"}

package/dist/utils/price.d.ts

@@ -1,4 +1,5 @@
 export declare function getBaseBinPrice(binStep: number): bigint;
 export declare function getBinPrice(baseBinPrice: bigint, binId: number): bigint | undefined;
 export declare function getBinPriceFromStep(binStep: number, binId: number): bigint | undefined;
+export declare function getBinIdFromPrice(binStep: number, price: bigint): number | undefined;
 //# sourceMappingURL=price.d.ts.map

package/dist/utils/price.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"price.d.ts","sourceRoot":"","sources":["../../src/utils/price.ts"],"names":[],"mappings":"AAGA,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAGvD;AAED,wBAAgB,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAmBnF;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEtF"}
+{"version":3,"file":"price.d.ts","sourceRoot":"","sources":["../../src/utils/price.ts"],"names":[],"mappings":"AAIA,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAGvD;AAED,wBAAgB,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAmBnF;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEtF;AA8BD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAsCpF"}

package/dist/utils/price.js

@@ -1,4 +1,5 @@
 import { MAX_BASIS_POINTS } from "./constants";
+import { isUndefined } from "./type_guards";
 import { expBySquaring, MAX, MAX_EXPONENTIAL, ONE, SCALE_OFFSET } from "./u64x64";
 export function getBaseBinPrice(binStep) {
     const priceStep = (BigInt(binStep) << SCALE_OFFSET) / BigInt(MAX_BASIS_POINTS);
@@ -16,8 +17,8 @@ export function getBinPrice(baseBinPrice, binId) {
     const absBinId = Math.abs(binId);
     if (absBinId >= MAX_EXPONENTIAL)
         return;
-    const invertedBase = MAX / baseBinPrice;
-    const price = expBySquaring(invertedBase, absBinId);
+    const invertedBaseBinPrice = MAX / baseBinPrice;
+    const price = expBySquaring(invertedBaseBinPrice, absBinId);
     if (price === 0n)
         return;
     return invert ? MAX / price : price;
@@ -25,3 +26,64 @@ export function getBinPrice(baseBinPrice, binId) {
 export function getBinPriceFromStep(binStep, binId) {
     return getBinPrice(getBaseBinPrice(binStep), binId);
 }
+const MAX_BIN_ID_BY_BIN_STEP = new Map([
+    [1, 443636],
+    [2, 221829],
+    [4, 110925],
+    [5, 88745],
+    [8, 55473],
+    [10, 44383],
+    [15, 29596],
+    [16, 27748],
+    [20, 22202],
+    [25, 17759],
+    [30, 14809],
+    [50, 8893],
+    [75, 5937],
+    [80, 5567],
+    [100, 4456],
+    [125, 3571],
+    [150, 2979],
+    [160, 2794],
+    [200, 2239],
+    [250, 1796],
+    [300, 1500],
+    [400, 1130],
+]);
+const MIN_PRICE = 1n;
+const MAX_PRICE = MAX;
+export function getBinIdFromPrice(binStep, price) {
+    if (price <= 0n)
+        return;
+    const maxBinId = MAX_BIN_ID_BY_BIN_STEP.get(binStep);
+    if (isUndefined(maxBinId)) {
+        throw new Error(`getBinIdFromPrice: unsupported binStep (${binStep})`);
+    }
+    if (price <= MIN_PRICE)
+        return -maxBinId;
+    if (price >= MAX_PRICE)
+        return maxBinId;
+    const baseBinPrice = getBaseBinPrice(binStep);
+    let lowerBinId = -maxBinId;
+    let upperBinId = maxBinId;
+    let currentPrice = MAX_PRICE;
+    let previousPrice;
+    while (lowerBinId < upperBinId) {
+        const middleBinId = lowerBinId + Math.floor((upperBinId - lowerBinId) / 2);
+        const middlePrice = getBinPrice(baseBinPrice, middleBinId);
+        if (middlePrice < price) {
+            lowerBinId = middleBinId + 1;
+            previousPrice = middlePrice;
+        }
+        else {
+            upperBinId = middleBinId;
+            currentPrice = middlePrice;
+        }
+    }
+    if (isUndefined(previousPrice))
+        return lowerBinId;
+    // previousPrice < price <= currentPrice always holds here, so both distances are non-negative.
+    const previousPriceDistance = price - previousPrice;
+    const currentPriceDistance = currentPrice - price;
+    return previousPriceDistance < currentPriceDistance ? lowerBinId - 1 : lowerBinId;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picon-finance/dlmm-sdk",
-  "version": "1.16.1",
+  "version": "1.16.3",
   "description": "Typescript SDK for interacting with the Picon DLMM protocol",
   "author": "Picon Finance",
   "license": "MIT",
@@ -23,7 +23,8 @@
   },
   "files": [
     "./dist/",
-    "./src/"
+    "./src/",
+    "!**/*.test.ts"
   ],
   "scripts": {
     "clean": "rm -rf ./dist/",
@@ -36,9 +37,10 @@
     "build-wasm-bindings-web": "wasm-bindgen ../target/wasm32-unknown-unknown/release/picon_dlmm_quote.wasm --out-dir ./src/quote/wasm-web --target web --typescript",
     "build-wasm": "bun run build-wasm-crate && bun run clean-wasm && bun run build-wasm-bindings-node && bun run build-wasm-bindings-web",
     "copy-wasm-binaries": "mkdir -p ./dist/quote/wasm-node ./dist/quote/wasm-web && cp ./src/quote/wasm-node/*.wasm ./src/quote/wasm-node/*.js ./src/quote/wasm-node/*.d.ts ./dist/quote/wasm-node/ && cp ./src/quote/wasm-web/*.wasm ./src/quote/wasm-web/*.js ./src/quote/wasm-web/*.d.ts ./dist/quote/wasm-web/",
-    "compile": "bun run clean && npx tsc && bun run copy-wasm-binaries",
+    "compile": "bun run clean && npx tsc -p tsconfig.build.json && bun run copy-wasm-binaries",
     "build": "bun run codama-generate-js && bun run build-wasm && bun run compile",
-    "prepublishOnly": "bun run build"
+    "prepublishOnly": "bun run build",
+    "test": "bun test"
   },
   "dependencies": {
     "@solana-program/system": "^0.13.0",

package/src/entities/position.ts

@@ -30,12 +30,12 @@ import {
   assertPositionBelongsToPool,
 } from "../utils/assert";
 import { isUndefined } from "../utils/type_guards";
-import { 
+import {
   chunk,
   fetchInChunks,
 } from "../utils/chunk";
 import { resolveAdminConfigAddress } from "./admin_config";
-import { 
+import {
   DEFAULT_POSITIONS_PER_CLAIM,
   MAX_ACCOUNTS_PER_RPC_BATCH,
 } from "../utils/constants";

package/src/picon_dlmm.json

@@ -2,7 +2,7 @@
   "address": "pDLMMk3KW3CUSxE1Wgjhx3jSmm2spe6Ry7Mq2HT26rC",
   "metadata": {
     "name": "picon_dlmm",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "spec": "0.1.0",
     "description": "Created with Anchor"
   },

package/src/utils/assert.ts

@@ -1,5 +1,4 @@
 import type { Address } from "@solana/kit";
-
 import type { BinIdRange } from "./bin_location";
 
 export function assertRangeWithinRange(

package/src/utils/price.ts

@@ -1,4 +1,5 @@
 import { MAX_BASIS_POINTS } from "./constants";
+import { isUndefined } from "./type_guards";
 import { expBySquaring, MAX, MAX_EXPONENTIAL, ONE, SCALE_OFFSET } from "./u64x64";
 
 export function getBaseBinPrice(binStep: number): bigint {
@@ -19,8 +20,8 @@ export function getBinPrice(baseBinPrice: bigint, binId: number): bigint | undef
 
   if (absBinId >= MAX_EXPONENTIAL) return;
 
-  const invertedBase = MAX / baseBinPrice;
-  const price = expBySquaring(invertedBase, absBinId);
+  const invertedBaseBinPrice = MAX / baseBinPrice;
+  const price = expBySquaring(invertedBaseBinPrice, absBinId);
 
   if (price === 0n) return;
 
@@ -30,3 +31,71 @@ export function getBinPrice(baseBinPrice: bigint, binId: number): bigint | undef
 export function getBinPriceFromStep(binStep: number, binId: number): bigint | undefined {
   return getBinPrice(getBaseBinPrice(binStep), binId);
 }
+
+const MAX_BIN_ID_BY_BIN_STEP = new Map<number, number>([
+  [1, 443636],
+  [2, 221829],
+  [4, 110925],
+  [5, 88745],
+  [8, 55473],
+  [10, 44383],
+  [15, 29596],
+  [16, 27748],
+  [20, 22202],
+  [25, 17759],
+  [30, 14809],
+  [50, 8893],
+  [75, 5937],
+  [80, 5567],
+  [100, 4456],
+  [125, 3571],
+  [150, 2979],
+  [160, 2794],
+  [200, 2239],
+  [250, 1796],
+  [300, 1500],
+  [400, 1130],
+]);
+
+const MIN_PRICE = 1n;
+const MAX_PRICE = MAX;
+
+export function getBinIdFromPrice(binStep: number, price: bigint): number | undefined {
+  if (price <= 0n) return;
+
+  const maxBinId = MAX_BIN_ID_BY_BIN_STEP.get(binStep);
+  if (isUndefined(maxBinId)) {
+    throw new Error(`getBinIdFromPrice: unsupported binStep (${binStep})`);
+  }
+
+  if (price <= MIN_PRICE) return -maxBinId;
+  if (price >= MAX_PRICE) return maxBinId;
+
+  const baseBinPrice = getBaseBinPrice(binStep);
+
+  let lowerBinId = -maxBinId;
+  let upperBinId = maxBinId;
+
+  let currentPrice = MAX_PRICE;
+  let previousPrice: bigint | undefined;
+
+  while (lowerBinId < upperBinId) {
+    const middleBinId = lowerBinId + Math.floor((upperBinId - lowerBinId) / 2);
+    const middlePrice = getBinPrice(baseBinPrice, middleBinId)!;
+
+    if (middlePrice < price) {
+      lowerBinId = middleBinId + 1;
+      previousPrice = middlePrice;
+    } else {
+      upperBinId = middleBinId;
+      currentPrice = middlePrice;
+    }
+  }
+
+  if (isUndefined(previousPrice)) return lowerBinId;
+
+  // previousPrice < price <= currentPrice always holds here, so both distances are non-negative.
+  const previousPriceDistance = price - previousPrice;
+  const currentPriceDistance = currentPrice - price;
+  return previousPriceDistance < currentPriceDistance ? lowerBinId - 1 : lowerBinId;
+}