@swapkit/helpers 4.4.5 → 4.5.3

package/src/modules/__tests__/swapKitNumber.test.ts

@@ -0,0 +1,535 @@
+import { describe, expect, test } from "bun:test";
+
+import { SwapKitNumber } from "../swapKitNumber";
+
+describe("SwapKitNumber", () => {
+  describe("constructors", () => {
+    test("creates numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(1);
+      expect(skNumber1.getValue("string")).toBe("1");
+      expect(skNumber1.getValue("number")).toBe(1);
+      expect(skNumber1.getBaseValue("bigint")).toBe(100000000n);
+
+      const skNumber2 = new SwapKitNumber("1");
+      expect(skNumber2.getValue("string")).toBe("1");
+      expect(skNumber2.getBaseValue("bigint")).toBe(100000000n);
+
+      /**
+       * because by default we have 8 decimals - it will be rounded to 0 on base value
+       */
+      const skNumber3 = new SwapKitNumber("0.0000000001");
+      expect(skNumber3.getValue("string")).toBe("0.0000000001");
+      expect(skNumber3.getBaseValue("bigint")).toBe(0n);
+
+      const skNumber4 = new SwapKitNumber({ decimal: 10, value: "0.0000000001" });
+      expect(skNumber4.getValue("string")).toBe("0.0000000001");
+      expect(skNumber4.getBaseValue("bigint")).toBe(1n);
+
+      const skNumber5 = new SwapKitNumber({ decimal: 3, value: 0.1005 });
+      expect(skNumber5.getValue("string")).toBe("0.101");
+      expect(skNumber5.getBaseValue("bigint")).toBe(101n);
+
+      const skNumber6 = new SwapKitNumber({ decimal: 3, value: -0.1005 });
+      expect(skNumber6.getValue("string")).toBe("-0.101");
+      expect(skNumber6.getBaseValue("bigint")).toBe(-101n);
+      expect(skNumber6.decimal).toBe(3);
+      expect(skNumber6.getValue("number")).toBe(-0.101);
+      expect(skNumber6.decimalMultiplier).toBe(100000000n);
+    });
+
+    test("creates SwapKitInstance from BigInt: (12.345678901234, decimals: 12)", () => {
+      const skNumber = SwapKitNumber.fromBigInt(12345678901234n, 12);
+
+      expect(skNumber.getValue("string")).toBe("12.345678901234");
+      expect(skNumber.getBaseValue("bigint")).toBe(12345678901234n);
+    });
+  });
+
+  describe("shiftDecimals", () => {
+    test("shifts up and bumps number", () => {
+      const skNumber = new SwapKitNumber(1);
+      expect(skNumber.getValue("string")).toBe("1");
+      expect(skNumber.getBaseValue("bigint")).toBe(100000000n);
+
+      const shiftedSkNumber = SwapKitNumber.shiftDecimals({ from: 8, to: 6, value: skNumber });
+
+      expect(shiftedSkNumber.getValue("string")).toBe("1");
+      expect(shiftedSkNumber.getBaseValue("bigint")).toBe(1000000n);
+    });
+
+    test("shifts down and rounds down number", () => {
+      const skNumber = new SwapKitNumber(2.12345678);
+      expect(skNumber.getValue("string")).toBe("2.12345678");
+      expect(skNumber.getBaseValue("bigint")).toBe(212345678n);
+
+      const shiftedSkNumber = SwapKitNumber.shiftDecimals({ from: 8, to: 6, value: skNumber });
+
+      expect(shiftedSkNumber.getValue("string")).toBe("2.123456");
+      expect(shiftedSkNumber.getBaseValue("bigint")).toBe(2123456n);
+    });
+
+    test("shift eth from 18 to 8", () => {
+      const skNumber = new SwapKitNumber({ decimal: 18, value: "0.2" });
+
+      const shiftedSkNumber = SwapKitNumber.shiftDecimals({ from: 18, to: 8, value: skNumber });
+
+      expect(shiftedSkNumber.getValue("string")).toBe("0.2");
+      expect(shiftedSkNumber.getBaseValue("bigint")).toBe(20000000n);
+    });
+  });
+
+  describe("getValue", () => {
+    describe("string", () => {
+      test("returns string value", () => {
+        const skNumber = new SwapKitNumber(1);
+        expect(skNumber.getValue("string")).toBe("1");
+      });
+
+      test("returns string value with decimals", () => {
+        const skNumber = new SwapKitNumber(0.01);
+        expect(skNumber.getValue("string")).toBe("0.01");
+      });
+
+      test("returns string value with adjusted decimals", () => {
+        const skNumber = new SwapKitNumber({ decimal: 18, value: "1.234567890123456789" });
+        expect(skNumber.getValue("string", 8)).toBe("1.23456789");
+      });
+
+      test("returns string base value with adjusted decimals", () => {
+        const skNumber = new SwapKitNumber({ decimal: 18, value: "1.234567890123456789" });
+        expect(skNumber.getBaseValue("string", 8)).toBe("123456789");
+        expect(skNumber.getBaseValue("string", 10)).toBe("12345678901");
+      });
+    });
+
+    describe("number", () => {
+      test("returns number value", () => {
+        const skNumber = new SwapKitNumber(1);
+        expect(skNumber.getValue("number")).toBe(1);
+      });
+
+      test("returns number value with decimals", () => {
+        const skNumber = new SwapKitNumber(0.01);
+        expect(skNumber.getValue("number")).toBe(0.01);
+      });
+
+      test("returns number value with adjusted decimals", () => {
+        const skNumber = new SwapKitNumber({ decimal: 18, value: "1.234567890123456789" });
+        expect(skNumber.getValue("number", 8)).toBe(1.23456789);
+      });
+
+      test("returns number base value with adjusted decimals", () => {
+        const skNumber = new SwapKitNumber({ decimal: 18, value: "1.234567890123456789" });
+        expect(skNumber.getBaseValue("number", 8)).toBe(123456789);
+        expect(skNumber.getBaseValue("number", 10)).toBe(12345678901);
+      });
+    });
+
+    describe("bigint", () => {
+      test("returns bigint value", () => {
+        const skNumber = new SwapKitNumber(1);
+        expect(skNumber.getBaseValue("bigint")).toBe(100000000n);
+      });
+
+      test("returns bigint value with adjusted decimals", () => {
+        const skNumber = new SwapKitNumber({ decimal: 18, value: "1.234567890123456789" });
+        expect(skNumber.getBaseValue("bigint", 8)).toBe(123456789n);
+        expect(skNumber.getBaseValue("bigint", 10)).toBe(12345678901n);
+      });
+    });
+  });
+
+  describe("toSignificant", () => {
+    describe("normal cases", () => {
+      test("returns first significant number of digits", () => {
+        const usdLikeNumber = new SwapKitNumber(1234.5678);
+        expect(usdLikeNumber.toSignificant(2)).toBe("1200");
+        expect(usdLikeNumber.toSignificant(3)).toBe("1230");
+        expect(usdLikeNumber.toSignificant(4)).toBe("1234");
+        expect(usdLikeNumber.toSignificant(5)).toBe("1234.5");
+        expect(usdLikeNumber.toSignificant(6)).toBe("1234.56");
+        expect(usdLikeNumber.toSignificant(7)).toBe("1234.567");
+        expect(usdLikeNumber.toSignificant(8)).toBe("1234.5678");
+
+        const btcLikeNumber = new SwapKitNumber(0.00005678);
+        expect(btcLikeNumber.toSignificant(2)).toBe("0.000056");
+        expect(btcLikeNumber.toSignificant(3)).toBe("0.0000567");
+        expect(btcLikeNumber.toSignificant(4)).toBe("0.00005678");
+        expect(btcLikeNumber.toSignificant(5)).toBe("0.00005678");
+        expect(btcLikeNumber.toSignificant(8)).toBe("0.00005678");
+      });
+    });
+
+    describe("custom decimals", () => {
+      test("returns first significant number of digits", () => {
+        const usdLikeNumber = new SwapKitNumber({ decimal: 2, value: 1234.5678 });
+        expect(usdLikeNumber.toSignificant(2)).toBe("1200");
+        expect(usdLikeNumber.toSignificant(3)).toBe("1230");
+        expect(usdLikeNumber.toSignificant(4)).toBe("1234");
+        expect(usdLikeNumber.toSignificant(5)).toBe("1234.5");
+        expect(usdLikeNumber.toSignificant(6)).toBe("1234.57");
+        expect(usdLikeNumber.toSignificant(7)).toBe("1234.57");
+        expect(usdLikeNumber.toSignificant(8)).toBe("1234.57");
+
+        const ethLikeNumber = new SwapKitNumber({ decimal: 18, value: 0.00005678 });
+        expect(ethLikeNumber.toSignificant(2)).toBe("0.000056");
+        expect(ethLikeNumber.toSignificant(3)).toBe("0.0000567");
+        expect(ethLikeNumber.toSignificant(4)).toBe("0.00005678");
+        expect(ethLikeNumber.toSignificant(5)).toBe("0.00005678");
+        expect(ethLikeNumber.toSignificant(8)).toBe("0.00005678");
+        expect(ethLikeNumber.toSignificant(18)).toBe("0.00005678");
+      });
+    });
+  });
+
+  describe("toAbbreviation", () => {
+    test("returns abbreviation with up to 3 integer digits", () => {
+      const skNumber = new SwapKitNumber(1234.5678);
+      expect(skNumber.toAbbreviation()).toBe("1.23K");
+
+      const skNumber2 = new SwapKitNumber(1234567.5678);
+      expect(skNumber2.toAbbreviation()).toBe("1.23M");
+
+      const skNumber3 = new SwapKitNumber(1234567890.5678);
+      expect(skNumber3.toAbbreviation()).toBe("1.23B");
+
+      const skNumber4 = new SwapKitNumber("1234567890123.5678");
+      expect(skNumber4.toAbbreviation()).toBe("1.23T");
+
+      const skNumber5 = new SwapKitNumber("1234567890123456.5678");
+      expect(skNumber5.toAbbreviation()).toBe("1.23Q");
+
+      const skNumber6 = new SwapKitNumber("1234567890123456789.5678");
+      expect(skNumber6.toAbbreviation()).toBe("1.23Qi");
+
+      const skNumber7 = new SwapKitNumber("1234567890123456789012.5678");
+      expect(skNumber7.toAbbreviation()).toBe("1.23S");
+
+      const skNumber8 = new SwapKitNumber(1234.5678);
+      expect(skNumber8.toAbbreviation(0)).toBe("1K");
+
+      const skNumber9 = new SwapKitNumber(1234.5678);
+      expect(skNumber9.toAbbreviation(1)).toBe("1.2K");
+
+      const skNumber10 = new SwapKitNumber(123456.78);
+      expect(skNumber10.toAbbreviation()).toBe("123.46K");
+    });
+  });
+
+  describe("toCurrency", () => {
+    test("returns abbreviation with up to 3 integer digits", () => {
+      const skNumber = new SwapKitNumber(1234.5678);
+      expect(skNumber.toCurrency()).toBe("$1,234.57");
+      expect(skNumber.toCurrency("€", { currencyPosition: "end", decimalSeparator: ",", thousandSeparator: " " })).toBe(
+        "1 234,57€",
+      );
+
+      const skNumber2 = new SwapKitNumber(0.5678);
+      expect(skNumber2.toCurrency()).toBe("$0.5678");
+      expect(skNumber2.toCurrency("€", { currencyPosition: "end", decimalSeparator: "," })).toBe("0,5678€");
+
+      const skNumber3 = new SwapKitNumber(0.00005678);
+      expect(skNumber3.toCurrency()).toBe("$0.00005678");
+      expect(
+        skNumber3.toCurrency("€", { currencyPosition: "end", decimalSeparator: ",", thousandSeparator: " " }),
+      ).toBe("0,00005678€");
+
+      const skNumber4 = new SwapKitNumber(12345);
+      expect(skNumber4.toCurrency()).toBe("$12,345");
+    });
+  });
+
+  describe("add", () => {
+    test("adds same type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+      const skNumber3 = new SwapKitNumber("0.5");
+      const result = skNumber1.add(skNumber2, skNumber3);
+
+      expect(result.getValue("string")).toBe("15.5");
+      expect(result.getBaseValue("bigint")).toBe(1550000000n);
+    });
+
+    test("adds different type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const result = skNumber1.add(6, "0.5");
+
+      expect(result.getValue("string")).toBe("16.5");
+      expect(result.getBaseValue("bigint")).toBe(1650000000n);
+    });
+
+    test("adds large decimal numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(0.0000000001);
+      const result = skNumber1.add(6.000000000001, "0.0000000000000005");
+      expect(result.getValue("string")).toBe("6.0000000001010005");
+      expect(result.getBaseValue("bigint")).toBe(600000000n);
+    });
+  });
+
+  describe("sub", () => {
+    test("subtracts same type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+      const skNumber3 = new SwapKitNumber(0.5);
+      const result = skNumber1.sub(skNumber2, skNumber3);
+
+      expect(result.getValue("string")).toBe("4.5");
+      expect(result.getBaseValue("bigint")).toBe(450000000n);
+    });
+
+    test("subtracts different type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const result = skNumber1.sub(6, "0.5");
+
+      expect(result.getValue("string")).toBe("3.5");
+      expect(result.getBaseValue("bigint")).toBe(350000000n);
+    });
+
+    test("can process negative results", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const result0 = skNumber1.sub(10);
+      const resultMinus = result0.sub("10");
+
+      expect(result0.getValue("string")).toBe("0");
+      expect(resultMinus.getValue("string")).toBe("-10");
+      expect(result0.getBaseValue("bigint")).toBe(0n);
+      expect(resultMinus.getBaseValue("bigint")).toBe(-1000000000n);
+    });
+  });
+
+  describe("mul", () => {
+    test("multiplies same type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+      const skNumber3 = new SwapKitNumber(0.5);
+      const result = skNumber1.mul(skNumber2, skNumber3);
+
+      expect(result.getValue("string")).toBe("25");
+      expect(result.getBaseValue("bigint")).toBe(2500000000n);
+    });
+
+    test("multiplies different type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const result = skNumber1.mul(6, "0.5");
+
+      expect(result.getValue("string")).toBe("30");
+      expect(result.getBaseValue("bigint")).toBe(3000000000n);
+    });
+
+    test("multiplies numbers correctly if decimals of SKN is lower than number multiplied with", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 4, value: 1000000 });
+      const result = skNumber1.mul("0.00001");
+
+      expect(result.getValue("string")).toBe("10");
+      expect(result.getBaseValue("bigint")).toBe(100000n);
+    });
+
+    test("should correctly round the result of multiplication", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 3, value: 1.23 });
+      const skNumber2 = new SwapKitNumber({ decimal: 4, value: 4.56 });
+
+      const result = skNumber1.mul(skNumber2);
+
+      expect(result.getValue("string")).toBe("5.609");
+      expect(result.getBaseValue("bigint")).toBe(5609n);
+
+      const skNumber3 = new SwapKitNumber({ decimal: 2, value: 1.23 });
+      const skNumber4 = new SwapKitNumber(-1.234567891);
+
+      const result2 = skNumber3.mul(skNumber4);
+
+      // The exact result of 1.23 * -1.234567891 is -1,518518505
+      // If we round it to 2 decimal places, we should get 5.61
+      expect(result2.getValue("string")).toBe("-1.52");
+      expect(result2.getBaseValue("bigint")).toBe(-152n);
+    });
+  });
+
+  describe("div", () => {
+    test("divides same type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+      const skNumber3 = new SwapKitNumber(0.5);
+      const result = skNumber1.div(skNumber2, skNumber3);
+
+      expect(result.getValue("string")).toBe("4");
+      expect(result.getBaseValue("bigint")).toBe(400000000n);
+
+      const skNumber4 = new SwapKitNumber(10.12);
+      const result2 = skNumber4.div(0.0001);
+
+      expect(result2.getValue("string")).toBe("101200");
+      expect(result2.getBaseValue("bigint")).toBe(10120000000000n);
+    });
+
+    test("divides different type numbers correctly", () => {
+      const skNumber1 = new SwapKitNumber(20);
+      const result = skNumber1.div(5, "0.5");
+
+      expect(result.getValue("string")).toBe("8");
+      expect(result.getBaseValue("bigint")).toBe(800000000n);
+    });
+
+    test("divides different type numbers correctly when decimal is set", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 2, value: "1.2" });
+      const result = skNumber1.div(0.001);
+
+      expect(result.getValue("string")).toBe("1200");
+      expect(result.getBaseValue("bigint")).toBe(120000n);
+    });
+
+    test("divides smaller number by larger number", () => {
+      const skNumber1 = new SwapKitNumber(1);
+      const result = skNumber1.div(2);
+
+      expect(result.getValue("string")).toBe("0.5");
+      expect(result.getBaseValue("bigint")).toBe(50000000n);
+    });
+
+    test("divides a number with 18 decimals by a negative number with less decimals", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 18, value: "1.000000000000000010" });
+      const skNumber2 = new SwapKitNumber({ decimal: 1, value: "-2" });
+
+      const result = skNumber1.div(skNumber2);
+
+      // The exact result of 1.000000000000000010 / -2 is -0.500000000000000005
+      expect(result.getValue("string")).toBe("-0.500000000000000005");
+      expect(result.getBaseValue("bigint")).toBe(-500000000000000005n);
+    });
+
+    test("divides a number with 2 decimals by a negative number with more decimals", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 2, value: "2" });
+      const skNumber2 = new SwapKitNumber({ decimal: 18, value: "-0.000005" });
+
+      const result = skNumber1.div(skNumber2);
+
+      // The exact result of 2 / -0.000005 is -400000
+      expect(result.getValue("string")).toBe("-400000");
+      expect(result.getBaseValue("bigint")).toBe(-40000000n);
+    });
+  });
+
+  describe("shitcoin cases", () => {
+    test("multiply huge numbers", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 18, value: 1_000_000_000_000_001 });
+      const skNumber2 = new SwapKitNumber({ decimal: 18, value: 987_654_321_000 });
+
+      const result = skNumber1.mul(skNumber2);
+      expect(result.getValue("string")).toBe("987654321000000987654321000");
+      expect(result.getBaseValue("bigint")).toBe(987654321000000987654321000000000000000000000n);
+    });
+
+    test("divide huge numbers", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 18, value: 1_000_000_000_000_001 });
+      const skNumber2 = new SwapKitNumber({ decimal: 18, value: 987_654_321_000 });
+
+      const result = skNumber1.div(skNumber2);
+      expect(result.getValue("string")).toBe("1012.4999999873447625");
+      expect(result.getBaseValue("bigint")).toBe(1012499999987344762500n);
+    });
+  });
+
+  describe("extending multiplier without loosing precision", () => {
+    test("edge case 1", () => {
+      const asset1 = new SwapKitNumber({ decimal: 8, value: 41.90963702 });
+      const multiplier = 5.337952274462478;
+      const divider = 105.2562773915526;
+      const result = asset1.mul(multiplier).div(divider);
+
+      expect(result.getValue("string")).toBe("2.12539953");
+    });
+
+    test("edge case 2", () => {
+      const asset1 = new SwapKitNumber("41.90963702");
+      const multiplier = new SwapKitNumber("5.337952274462478");
+      const divider = new SwapKitNumber("105.2562773915526");
+      const result = asset1.mul(multiplier).div(divider);
+
+      expect(result.getValue("string")).toBe("2.12539952767472630150052259932285534");
+    });
+  });
+
+  describe("gt", () => {
+    test("greater than", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+
+      expect(skNumber1.gt(skNumber2)).toBe(true);
+      expect(skNumber2.gt(skNumber1)).toBe(false);
+    });
+
+    test("different decimals doesn't affect comparison", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 18, value: 10 });
+      const skNumber2 = new SwapKitNumber({ decimal: 8, value: "50" });
+
+      expect(skNumber1.lt(skNumber2)).toBe(true);
+      expect(skNumber2.gt(skNumber1)).toBe(true);
+    });
+  });
+
+  describe("gte", () => {
+    test("greater than or equal", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+
+      expect(skNumber1.gte(skNumber2)).toBe(true);
+      expect(skNumber1.gte(skNumber1)).toBe(true);
+      expect(skNumber2.gte(skNumber1)).toBe(false);
+    });
+  });
+
+  describe("lt", () => {
+    test("less than", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+
+      expect(skNumber1.lt(skNumber2)).toBe(false);
+      expect(skNumber2.lt(skNumber1)).toBe(true);
+    });
+  });
+
+  describe("lte", () => {
+    test("less than or equal", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+
+      expect(skNumber1.lte(skNumber2)).toBe(false);
+      expect(skNumber1.lte(skNumber1)).toBe(true);
+      expect(skNumber2.lte(skNumber1)).toBe(true);
+    });
+  });
+
+  describe("eq", () => {
+    test("equal", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("5");
+
+      expect(skNumber1.eq(skNumber2)).toBe(false);
+      expect(skNumber1.eq(skNumber1)).toBe(true);
+      expect(skNumber2.eq(skNumber1)).toBe(false);
+    });
+  });
+
+  describe("comparison edge cases with decimals", () => {
+    test("compare on cut decimals", () => {
+      const skNumber1 = new SwapKitNumber({ decimal: 3, value: 0.001 });
+      const value = "0.0019";
+
+      expect(skNumber1.lt(value)).toBe(true);
+      expect(skNumber1.gt(value)).toBe(false);
+      expect(skNumber1.eq(value)).toBe(false);
+      expect(skNumber1.lte(value)).toBe(true);
+      expect(skNumber1.gte(value)).toBe(false);
+    });
+  });
+
+  describe("Throws", () => {
+    test("throws if division by zero", () => {
+      const skNumber1 = new SwapKitNumber(10);
+      const skNumber2 = new SwapKitNumber("0");
+
+      expect(() => skNumber1.div(skNumber2)).toThrow(RangeError);
+      expect(() => skNumber1.div(0)).toThrow(RangeError);
+    });
+  });
+});