@exponent-labs/precise-number 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.0.3](https://github.com/exponent-finance/exponent-core/compare/@exponent-labs/precise-number@0.0.2...@exponent-labs/precise-number@0.0.3) (2025-03-03)
+
+**Note:** Version bump only for package @exponent-labs/precise-number
+
+
+
+
+
+## [0.0.2](https://github.com/exponent-finance/exponent-core/compare/@exponent-labs/precise-number@0.0.1...@exponent-labs/precise-number@0.0.2) (2025-03-03)
+
+**Note:** Version bump only for package @exponent-labs/precise-number

package/build/index.d.ts

@@ -0,0 +1 @@
+export * from "./pnum";

package/build/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pnum"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB"}

package/build/pnum.d.ts

@@ -0,0 +1,21 @@
+import BN from "bn.js";
+export type PNumRaw = [BN, BN, BN, BN];
+export declare const DECIMAL_PLACES = 12;
+export declare const ONE: number;
+export declare class PreciseNumber {
+    value: PNumRaw;
+    valueString: string;
+    constructor(val: string);
+    /** Serialize for Solana Anchor deserialization
+     * The PreciseNumber type is a tuple struct `PreciseNumber([u64; 4])` in Rust
+     */
+    serialize(): {
+        0: PNumRaw;
+    };
+    anchorify(): {
+        0: PNumRaw;
+    };
+    static fromRaw(raw: BN[]): PreciseNumber;
+}
+export declare function stringToU256(str: string, decimalPlaces?: number): PNumRaw;
+export declare function u256ToString(bnArray: BN[], decimalPlaces?: number): string;

package/build/pnum.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.u256ToString = exports.stringToU256 = exports.PreciseNumber = exports.ONE = exports.DECIMAL_PLACES = void 0;
+const bn_js_1 = __importDefault(require("bn.js"));
+const decimal_js_1 = __importDefault(require("decimal.js"));
+exports.DECIMAL_PLACES = 12;
+exports.ONE = 10 ** exports.DECIMAL_PLACES;
+class PreciseNumber {
+    value;
+    valueString;
+    constructor(val) {
+        this.valueString = val;
+        this.value = stringToU256(val);
+    }
+    /** Serialize for Solana Anchor deserialization
+     * The PreciseNumber type is a tuple struct `PreciseNumber([u64; 4])` in Rust
+     */
+    serialize() {
+        return { 0: this.value };
+    }
+    anchorify() {
+        return this.serialize();
+    }
+    static fromRaw(raw) {
+        if (raw.length !== 4) {
+            throw new Error("Invalid input: raw must be an array of 4 BNs");
+        }
+        const n = u256ToString(raw);
+        return new PreciseNumber(n);
+    }
+}
+exports.PreciseNumber = PreciseNumber;
+function stringToU256(str, decimalPlaces = exports.DECIMAL_PLACES) {
+    try {
+        // 1. Parse as Decimal for precision
+        const decimalValue = new decimal_js_1.default(str);
+        // 2. Scale to integer representation
+        const scaledValue = decimalValue.times(new decimal_js_1.default(10).pow(decimalPlaces));
+        const integer = BigInt(scaledValue.round().toHexadecimal());
+        const u64Words = [];
+        for (let i = 0; i < 4; i++) {
+            const word = (integer >> BigInt(i * 64)) & BigInt("0xFFFFFFFFFFFFFFFF");
+            u64Words.push(new bn_js_1.default(word.toString()));
+        }
+        return u64Words;
+    }
+    catch (error) {
+        throw new Error(`Invalid input: ${error}`);
+    }
+}
+exports.stringToU256 = stringToU256;
+function u256ToString(bnArray, decimalPlaces = exports.DECIMAL_PLACES) {
+    if (bnArray.length !== 4) {
+        throw new Error("Invalid input: bnArray must be an array of 4 BNs");
+    }
+    // join words
+    const integer = bnArray[0].add(bnArray[1].shln(64)).add(bnArray[2].shln(128)).add(bnArray[3].shln(192));
+    // 2. Convert BN to Decimal
+    const decimalValue = new decimal_js_1.default(integer.toString());
+    // 3. Scale back to original fixed-point value
+    const originalValue = decimalValue.div(new decimal_js_1.default(10).pow(decimalPlaces));
+    // 4. Return the string representation
+    return originalValue.toString();
+}
+exports.u256ToString = u256ToString;
+//# sourceMappingURL=pnum.js.map

package/build/pnum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pnum.js","sourceRoot":"","sources":["../src/pnum.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAsB;AACtB,4DAAgC;AAGnB,QAAA,cAAc,GAAG,EAAE,CAAA;AAEnB,QAAA,GAAG,GAAG,EAAE,IAAI,sBAAc,CAAA;AAEvC,MAAa,aAAa;IACjB,KAAK,CAAS;IACd,WAAW,CAAQ;IAE1B,YAAY,GAAW;QACrB,IAAI,CAAC,WAAW,GAAG,GAAG,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,SAAS,EAAE,CAAA;IACzB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,GAAS;QACtB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACjE,CAAC;QACD,MAAM,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;QAC3B,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,CAAA;IAC7B,CAAC;CACF;AA3BD,sCA2BC;AAED,SAAgB,YAAY,CAAC,GAAW,EAAE,aAAa,GAAG,sBAAc;IACtE,IAAI,CAAC;QACH,oCAAoC;QACpC,MAAM,YAAY,GAAG,IAAI,oBAAO,CAAC,GAAG,CAAC,CAAA;QAErC,qCAAqC;QACrC,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,oBAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;QAC1E,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,aAAa,EAAE,CAAC,CAAA;QAC3D,MAAM,QAAQ,GAAS,EAAE,CAAA;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAA;YACvE,QAAQ,CAAC,IAAI,CAAC,IAAI,eAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QACxC,CAAC;QAED,OAAO,QAAmB,CAAA;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC;AAlBD,oCAkBC;AAED,SAAgB,YAAY,CAAC,OAAa,EAAE,aAAa,GAAG,sBAAc;IACxE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;IACrE,CAAC;IAED,aAAa;IACb,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAEvG,2BAA2B;IAC3B,MAAM,YAAY,GAAG,IAAI,oBAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEpD,8CAA8C;IAC9C,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,oBAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;IAE1E,sCAAsC;IACtC,OAAO,aAAa,CAAC,QAAQ,EAAE,CAAA;AACjC,CAAC;AAhBD,oCAgBC"}

package/jest.config.ts

@@ -0,0 +1,10 @@
+// jest.config.ts
+import type { Config } from "@jest/types"
+
+const config: Config.InitialOptions = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["**/*.test.ts"], // Adjust the pattern if your test files have a different naming convention
+}
+
+export default config

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@exponent-labs/precise-number",
+  "version": "0.0.3",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "license": "AGPL-3.0",
+  "scripts": {
+    "build": "tsc --build",
+    "test": "jest"
+  },
+  "dependencies": {
+    "bn.js": "5.2.1",
+    "decimal.js": "10.4.3"
+  },
+  "devDependencies": {
+    "@types/bn.js": "^5.1.0",
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "10.9.2",
+    "typescript": "5.4.5"
+  },
+  "gitHead": "209b8847e9a0fadb5b5ec96b9b47f0ace4a3bf9d"
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./pnum"

package/src/pnum.test.ts

@@ -0,0 +1,32 @@
+import BN from "bn.js"
+import { ONE, stringToU256, u256ToString } from "./pnum"
+
+describe("precise-number", () => {
+  it("handles 0", () => {
+    const pn = stringToU256("0")
+    expect(pn[0].isZero()).toBeTruthy()
+    expect(pn[1].isZero()).toBeTruthy()
+    expect(pn[2].isZero()).toBeTruthy()
+    expect(pn[3].isZero()).toBeTruthy()
+  })
+
+  it("handles 1", () => {
+    const pn = stringToU256("1")
+    expect(pn[0].toNumber()).toEqual(ONE)
+    expect(pn[1].isZero()).toBeTruthy()
+    expect(pn[2].isZero()).toBeTruthy()
+    expect(pn[3].isZero()).toBeTruthy()
+  })
+
+  it("handles multiple words", () => {
+    const val = "1000000000"
+    const pn = stringToU256(val)
+    const target = new BN(val).mul(new BN(ONE))
+    const pnVal = pn[0].add(pn[1].shln(64)).add(pn[2].shln(128)).add(pn[3].shln(192))
+    expect(pnVal.eq(target)).toBeTruthy()
+
+    // Check that it goes back to the original value
+    const s = u256ToString(pn)
+    expect(s).toEqual(val)
+  })
+})

package/src/pnum.ts

@@ -0,0 +1,74 @@
+import BN from "bn.js"
+import Decimal from "decimal.js"
+
+export type PNumRaw = [BN, BN, BN, BN]
+export const DECIMAL_PLACES = 12
+
+export const ONE = 10 ** DECIMAL_PLACES
+
+export class PreciseNumber {
+  public value: PNumRaw
+  public valueString: string
+
+  constructor(val: string) {
+    this.valueString = val
+    this.value = stringToU256(val)
+  }
+
+  /** Serialize for Solana Anchor deserialization
+   * The PreciseNumber type is a tuple struct `PreciseNumber([u64; 4])` in Rust
+   */
+  serialize() {
+    return { 0: this.value }
+  }
+
+  anchorify() {
+    return this.serialize()
+  }
+
+  static fromRaw(raw: BN[]): PreciseNumber {
+    if (raw.length !== 4) {
+      throw new Error("Invalid input: raw must be an array of 4 BNs")
+    }
+    const n = u256ToString(raw)
+    return new PreciseNumber(n)
+  }
+}
+
+export function stringToU256(str: string, decimalPlaces = DECIMAL_PLACES): PNumRaw {
+  try {
+    // 1. Parse as Decimal for precision
+    const decimalValue = new Decimal(str)
+
+    // 2. Scale to integer representation
+    const scaledValue = decimalValue.times(new Decimal(10).pow(decimalPlaces))
+    const integer = BigInt(scaledValue.round().toHexadecimal())
+    const u64Words: BN[] = []
+    for (let i = 0; i < 4; i++) {
+      const word = (integer >> BigInt(i * 64)) & BigInt("0xFFFFFFFFFFFFFFFF")
+      u64Words.push(new BN(word.toString()))
+    }
+
+    return u64Words as PNumRaw
+  } catch (error) {
+    throw new Error(`Invalid input: ${error}`)
+  }
+}
+
+export function u256ToString(bnArray: BN[], decimalPlaces = DECIMAL_PLACES): string {
+  if (bnArray.length !== 4) {
+    throw new Error("Invalid input: bnArray must be an array of 4 BNs")
+  }
+
+  // join words
+  const integer = bnArray[0].add(bnArray[1].shln(64)).add(bnArray[2].shln(128)).add(bnArray[3].shln(192))
+
+  // 2. Convert BN to Decimal
+  const decimalValue = new Decimal(integer.toString())
+
+  // 3. Scale back to original fixed-point value
+  const originalValue = decimalValue.div(new Decimal(10).pow(decimalPlaces))
+
+  // 4. Return the string representation
+  return originalValue.toString()
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "sourceMap": true,
+    "incremental": true /* Save .tsbuildinfo files to allow for incremental compilation of projects. */,
+    "composite": true /* Enable constraints that allow a TypeScript project to be used with project references. */,
+    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "module": "CommonJS" /* Specify what module code is generated. */,
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    "outDir": "./build" /* Specify an output folder for all emitted files. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src"],
+  "exclude": ["build", "node_modules", "**/*.test.ts"]
+}