@lunarbase-lab/pmm-math 0.1.0

package/README.md

@@ -0,0 +1,94 @@
+# @lunarbase-lab/pmm-math
+
+N-API binding exposing [`lunarbase-pmm-math`](https://crates.io/crates/lunarbase-pmm-math)
+to Node.js. Bit-exact mirror of the on-chain LunarBase Curve PMM quoting
+math; every quote is verified against deterministic and fuzz vectors
+generated from the on-chain Solidity contract.
+
+## Install
+
+```bash
+npm install @lunarbase-lab/pmm-math
+```
+
+The native `.node` binary is shipped per-platform via npm's
+`optionalDependencies` mechanism — only the binary matching your OS / arch
+is downloaded.
+
+### Supported platforms
+
+| OS    | Architecture | Sub-package                          |
+| ----- | ------------ | ------------------------------------ |
+| macOS | arm64        | `@lunarbase-lab/pmm-math-darwin-arm64`   |
+| Linux | x64 (glibc)  | `@lunarbase-lab/pmm-math-linux-x64-gnu`  |
+
+Other targets (`linux-arm64-gnu`, `linux-x64-musl`, `darwin-x64`,
+`win32-x64-msvc`) are not currently shipped — open an issue if you need
+one.
+
+## Usage
+
+```ts
+import { quoteXToY, quoteYToX, type QuoteParams, type QuoteResult } from "@lunarbase-lab/pmm-math";
+
+const params: QuoteParams = {
+  // Live sqrt-price (uint80, Q32.48). Optional — defaults to anchorSqrtPriceX48.
+  sqrtPriceX48: "281474976710656",
+  // Operator-published anchor sqrt-price (uint80, Q32.48). Required.
+  anchorSqrtPriceX48: "281474976710656",
+  // Directional fees (uint24, Q24, where 2^24 represents 100%).
+  feeAskX24: 0,        // charged on yToX swaps
+  feeBidX24: 838860,   // charged on xToY swaps (≈ 5%)
+  // Reserves (uint112).
+  reserveX: "1000000000000000000000",
+  reserveY: "1000000000000000000000",
+  // Concentration multiplier (uint32) stored in Q20.12.
+  // Effective K = concentrationK / 2^12. Legacy plain-int K=5000 maps to
+  // 5000 << 12 = 20_480_000 here.
+  concentrationK: 5000 << 12,
+  // Input amount in the source token (decimal or 0x-hex).
+  amountIn: "1000000000000000000",
+  // Optional. Defaults to "1" (whitelisted swapper). Pass the on-chain
+  // `blacklistFeeMultiplier` for the gated path.
+  feeMultiplier: "1",
+};
+
+const result: QuoteResult = quoteXToY(params);
+console.log(result.amountOut, result.sqrtPriceNext, result.fee);
+```
+
+All numeric inputs are passed as **strings** — decimal or `0x`-prefixed hex —
+to preserve full `U256` precision. Outputs are decimal strings.
+
+### tsconfig
+
+For the imports above to type-check you need `"moduleResolution": "node16"`
+or `"bundler"`. A minimal setup:
+
+```json
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node16",
+    "esModuleInterop": true,
+    "strict": true
+  }
+}
+```
+
+## Pure-Rust crate
+
+The same math is also published on crates.io as
+[`lunarbase-pmm-math`](https://crates.io/crates/lunarbase-pmm-math). Both
+packages share the upstream test vectors and are guaranteed bit-identical.
+
+## Building from source
+
+See the [maintainer notes](https://github.com/Lunarbase-Lab/lunarbase-pmm-math/tree/main/math/rust-node/lunarbase-pmm-math-node)
+in the source repository for cross-compilation, musl/Alpine notes, and
+release process.
+
+## License
+
+Dual-licensed under MIT or Apache-2.0.

package/index.cjs

@@ -0,0 +1,316 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'lunarbase-pmm-math.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.android-arm64.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'lunarbase-pmm-math.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'lunarbase-pmm-math.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'lunarbase-pmm-math.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'lunarbase-pmm-math.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'lunarbase-pmm-math.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./lunarbase-pmm-math.darwin-universal.node')
+      } else {
+        nativeBinding = require('@lunarbase-lab/pmm-math-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'lunarbase-pmm-math.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.darwin-x64.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'lunarbase-pmm-math.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'lunarbase-pmm-math.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./lunarbase-pmm-math.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@lunarbase-lab/pmm-math-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'lunarbase-pmm-math.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./lunarbase-pmm-math.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@lunarbase-lab/pmm-math-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'lunarbase-pmm-math.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./lunarbase-pmm-math.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@lunarbase-lab/pmm-math-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { quoteXToY, quoteYToX } = nativeBinding
+
+module.exports.quoteXToY = quoteXToY
+module.exports.quoteYToX = quoteYToX

package/index.d.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface QuoteParams {
+  /** sqrtPriceX48 as decimal or hex string */
+  sqrtPriceX48: string
+  /** anchor sqrtPriceX48 as decimal or hex string. Defaults to sqrtPriceX48 when omitted. */
+  anchorSqrtPriceX48?: string
+  /** fee charged on Y → X swaps in Q24 (uint24). */
+  feeAskX24: number
+  /** fee charged on X → Y swaps in Q24 (uint24). */
+  feeBidX24: number
+  /** reserve X as decimal or hex string */
+  reserveX: string
+  /** reserve Y as decimal or hex string */
+  reserveY: string
+  /** concentration multiplier in Q20.12 (uint32). Effective K = concentration_k_q12 / 2^12. */
+  concentrationKQ12: number
+  /** input amount as decimal or hex string */
+  amountIn: string
+}
+export interface QuoteResult {
+  /** output amount as decimal string */
+  amountOut: string
+  /** new sqrt price as decimal string */
+  sqrtPriceNext: string
+  /** fee amount as decimal string */
+  fee: string
+}
+export declare function quoteXToY(params: QuoteParams): QuoteResult
+export declare function quoteYToX(params: QuoteParams): QuoteResult

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@lunarbase-lab/pmm-math",
+  "version": "0.1.0",
+  "description": "N-API binding exposing lunarbase-pmm-math to Node.js. Bit-exact mirror of the on-chain LunarBase Curve PMM quoting math.",
+  "license": "MIT OR Apache-2.0",
+  "type": "module",
+  "main": "wrapper.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./wrapper.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
+  "files": [
+    "wrapper.js",
+    "index.cjs",
+    "index.d.ts",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Lunarbase-Lab/lunarbase-pmm-math.git",
+    "directory": "math/rust-node/lunarbase-pmm-math-node"
+  },
+  "homepage": "https://github.com/Lunarbase-Lab/lunarbase-pmm-math#readme",
+  "bugs": {
+    "url": "https://github.com/Lunarbase-Lab/lunarbase-pmm-math/issues"
+  },
+  "keywords": [
+    "lunarbase",
+    "pmm",
+    "amm",
+    "defi",
+    "napi",
+    "rust"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "napi": {
+    "name": "lunarbase-pmm-math",
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "aarch64-apple-darwin",
+        "x86_64-unknown-linux-gnu"
+      ]
+    }
+  },
+  "optionalDependencies": {
+    "@lunarbase-lab/pmm-math-darwin-arm64": "0.1.0",
+    "@lunarbase-lab/pmm-math-linux-x64-gnu": "0.1.0"
+  },
+  "scripts": {
+    "build": "CARGO_TARGET_DIR=target napi build --platform --release && mv -f index.js index.cjs",
+    "build:debug": "CARGO_TARGET_DIR=target napi build --platform && mv -f index.js index.cjs",
+    "artifacts": "napi artifacts",
+    "test": "node --test test/quote.test.mjs",
+    "prepublishOnly": "napi prepublish -t npm --skip-gh-release"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/wrapper.js

@@ -0,0 +1,9 @@
+// ESM wrapper for the napi-rs native module.
+// index.js is CJS (auto-generated by napi-rs), so we re-export via createRequire.
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+const binding = require("./index.cjs");
+
+export const quoteXToY = binding.quoteXToY;
+export const quoteYToX = binding.quoteYToX;