@exponent-labs/i80f48-util 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/i80f48-util@0.0.2...@exponent-labs/i80f48-util@0.0.3) (2025-03-03)
+
+**Note:** Version bump only for package @exponent-labs/i80f48-util
+
+
+
+
+
+## [0.0.2](https://github.com/exponent-finance/exponent-core/compare/@exponent-labs/i80f48-util@0.0.1...@exponent-labs/i80f48-util@0.0.2) (2025-03-03)
+
+**Note:** Version bump only for package @exponent-labs/i80f48-util

package/build/i80f48.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import BigNumber from "bignumber.js";
+import { Buffer } from "buffer";
+export declare function decodeBufferLE(buffer: Buffer): string;
+export declare function toI80f48(bigNum: BigNumber): BigNumber;
+export declare function encodeI80f48ToBufferLE(bigNum: BigNumber): Buffer;
+export declare function stringToI80f48Buffer(input: string): Buffer;

package/build/i80f48.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToI80f48Buffer = exports.encodeI80f48ToBufferLE = exports.toI80f48 = exports.decodeBufferLE = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const bn_js_1 = __importDefault(require("bn.js"));
+const buffer_1 = require("buffer");
+const FRACTIONAL_BITS = 48;
+const FRACTIONAL_MASK = new bn_js_1.default("FFFFFFFFFFFF", 16); // Mask for the lowest 48 bits
+function decodeBufferLE(buffer) {
+    const h = buffer.reverse().toString("hex");
+    const bn = new bn_js_1.default(h, 16);
+    const integerPart = bn.shrn(FRACTIONAL_BITS); // Shift right to get the integer part
+    const fractionalPart = bn.and(FRACTIONAL_MASK);
+    const fractionalDecimal = new bignumber_js_1.default(fractionalPart.toString(10)).div(new bignumber_js_1.default(2).pow(FRACTIONAL_BITS));
+    const result = new bignumber_js_1.default(integerPart.toString(10)).plus(fractionalDecimal);
+    return result.toString();
+}
+exports.decodeBufferLE = decodeBufferLE;
+// Function to convert a BigNumber to i80f48
+function toI80f48(bigNum) {
+    const BIT_SHIFT = 48;
+    // Shift the fractional part to the integer part
+    const shiftedNum = bigNum.multipliedBy(new bignumber_js_1.default(2).pow(BIT_SHIFT)).integerValue();
+    return shiftedNum;
+}
+exports.toI80f48 = toI80f48;
+// Function to encode an i80f48 BigNumber to a 128-bit buffer in little-endian format
+function encodeI80f48ToBufferLE(bigNum) {
+    // Convert to i80f48 format
+    const i80f48Num = toI80f48(bigNum);
+    // Create a buffer of 128 bits (16 bytes)
+    const buffer = buffer_1.Buffer.alloc(16);
+    // Split the BigNumber into two 64-bit parts
+    const high = i80f48Num.dividedToIntegerBy(new bignumber_js_1.default(2).pow(64));
+    const low = i80f48Num.mod(new bignumber_js_1.default(2).pow(64));
+    // Write the low part (64 bits) in little-endian order
+    buffer.writeBigUInt64LE(BigInt(low.toFixed()), 0);
+    // Write the high part (64 bits) in little-endian order
+    buffer.writeBigUInt64LE(BigInt(high.toFixed()), 8);
+    return buffer;
+}
+exports.encodeI80f48ToBufferLE = encodeI80f48ToBufferLE;
+// Function to convert a string to an i80f48 buffer
+function stringToI80f48Buffer(input) {
+    // Convert the string to a BigNumber
+    const bigNum = new bignumber_js_1.default(input);
+    // Encode the BigNumber to an i80f48 buffer
+    return encodeI80f48ToBufferLE(bigNum);
+}
+exports.stringToI80f48Buffer = stringToI80f48Buffer;
+//# sourceMappingURL=i80f48.js.map

package/build/i80f48.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i80f48.js","sourceRoot":"","sources":["../src/i80f48.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAoC;AACpC,kDAAsB;AACtB,mCAA+B;AAE/B,MAAM,eAAe,GAAG,EAAE,CAAA;AAC1B,MAAM,eAAe,GAAG,IAAI,eAAE,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA,CAAC,8BAA8B;AAEjF,SAAgB,cAAc,CAAC,MAAc;IAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC1C,MAAM,EAAE,GAAG,IAAI,eAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IACxB,MAAM,WAAW,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA,CAAC,sCAAsC;IACnF,MAAM,cAAc,GAAG,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IAC9C,MAAM,iBAAiB,GAAG,IAAI,sBAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAA;IAC/G,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAE9E,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC;AATD,wCASC;AACD,4CAA4C;AAC5C,SAAgB,QAAQ,CAAC,MAAiB;IACxC,MAAM,SAAS,GAAG,EAAE,CAAA;IAEpB,gDAAgD;IAChD,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,EAAE,CAAA;IAEtF,OAAO,UAAU,CAAA;AACnB,CAAC;AAPD,4BAOC;AAED,qFAAqF;AACrF,SAAgB,sBAAsB,CAAC,MAAiB;IACtD,2BAA2B;IAC3B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;IAElC,yCAAyC;IACzC,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAE/B,4CAA4C;IAC5C,MAAM,IAAI,GAAG,SAAS,CAAC,kBAAkB,CAAC,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IACnE,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IAEnD,sDAAsD;IACtD,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAEjD,uDAAuD;IACvD,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAElD,OAAO,MAAM,CAAA;AACf,CAAC;AAlBD,wDAkBC;AAED,mDAAmD;AACnD,SAAgB,oBAAoB,CAAC,KAAa;IAChD,oCAAoC;IACpC,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC,KAAK,CAAC,CAAA;IAEnC,2CAA2C;IAC3C,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAA;AACvC,CAAC;AAND,oDAMC"}

package/build/index.d.ts

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

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("./i80f48"), 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,2CAAwB"}

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,23 @@
+{
+  "name": "@exponent-labs/i80f48-util",
+  "version": "0.0.3",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "license": "AGPL-3.0",
+  "scripts": {
+    "build": "tsc --build",
+    "test": "jest"
+  },
+  "dependencies": {
+    "bignumber.js": "9.1.2",
+    "bn.js": "5.2.0"
+  },
+  "devDependencies": {
+    "@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/i80f48.ts

@@ -0,0 +1,56 @@
+import BigNumber from "bignumber.js"
+import BN from "bn.js"
+import { Buffer } from "buffer"
+
+const FRACTIONAL_BITS = 48
+const FRACTIONAL_MASK = new BN("FFFFFFFFFFFF", 16) // Mask for the lowest 48 bits
+
+export function decodeBufferLE(buffer: Buffer): string {
+  const h = buffer.reverse().toString("hex")
+  const bn = new BN(h, 16)
+  const integerPart = bn.shrn(FRACTIONAL_BITS) // Shift right to get the integer part
+  const fractionalPart = bn.and(FRACTIONAL_MASK)
+  const fractionalDecimal = new BigNumber(fractionalPart.toString(10)).div(new BigNumber(2).pow(FRACTIONAL_BITS))
+  const result = new BigNumber(integerPart.toString(10)).plus(fractionalDecimal)
+
+  return result.toString()
+}
+// Function to convert a BigNumber to i80f48
+export function toI80f48(bigNum: BigNumber): BigNumber {
+  const BIT_SHIFT = 48
+
+  // Shift the fractional part to the integer part
+  const shiftedNum = bigNum.multipliedBy(new BigNumber(2).pow(BIT_SHIFT)).integerValue()
+
+  return shiftedNum
+}
+
+// Function to encode an i80f48 BigNumber to a 128-bit buffer in little-endian format
+export function encodeI80f48ToBufferLE(bigNum: BigNumber): Buffer {
+  // Convert to i80f48 format
+  const i80f48Num = toI80f48(bigNum)
+
+  // Create a buffer of 128 bits (16 bytes)
+  const buffer = Buffer.alloc(16)
+
+  // Split the BigNumber into two 64-bit parts
+  const high = i80f48Num.dividedToIntegerBy(new BigNumber(2).pow(64))
+  const low = i80f48Num.mod(new BigNumber(2).pow(64))
+
+  // Write the low part (64 bits) in little-endian order
+  buffer.writeBigUInt64LE(BigInt(low.toFixed()), 0)
+
+  // Write the high part (64 bits) in little-endian order
+  buffer.writeBigUInt64LE(BigInt(high.toFixed()), 8)
+
+  return buffer
+}
+
+// Function to convert a string to an i80f48 buffer
+export function stringToI80f48Buffer(input: string): Buffer {
+  // Convert the string to a BigNumber
+  const bigNum = new BigNumber(input)
+
+  // Encode the BigNumber to an i80f48 buffer
+  return encodeI80f48ToBufferLE(bigNum)
+}

package/src/index.ts

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

package/src/main.test.ts

@@ -0,0 +1,16 @@
+import { decodeBufferLE, stringToI80f48Buffer } from "./i80f48"
+describe("i80f48-util", () => {
+  it("handles 0", () => {
+    const n = stringToI80f48Buffer("0")
+    expect(n.length).toEqual(16)
+    for (let i = 0; i < 16; i++) {
+      expect(n[i]).toEqual(0)
+    }
+  })
+
+  it("handles rational numbers", () => {
+    const n = stringToI80f48Buffer("1.001")
+    const s = decodeBufferLE(n)
+    expect(parseFloat(s)).toBeCloseTo(1.001)
+  })
+})

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"]
+}