Release 2.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crocswap-libs/sdk",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "description": "🛠🐊🛠 An SDK for building applications on top of CrocSwap",
   "author": "Ben Wolski <ben@crocodilelabs.io>",
   "repository": "https://github.com/CrocSwap/sdk.git",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "lint": "eslint .",
-    "test": "jest",
+    "test": "vitest",
     "clean": "rm -rf dist build package",
     "ts-node": "ts-node",
     "docs": "typedoc --entryPoints src/index.ts",
@@ -27,22 +27,16 @@
     "build-local": "yarn build-all && yarn copy-local"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.12",
-    "@typescript-eslint/eslint-plugin": "^7.11.0",
-    "@typescript-eslint/parser": "^7.11.0",
-    "esbuild": "^0.21.4",
-    "eslint": "^9.3.0",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.4",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "esbuild": "^0.24.2",
+    "eslint": "^9.17.0",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typedoc": "^0.27.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
   },
   "dependencies": {
-    "ethers": "^6.13.3"
-  },
-  "resolutions": {
-    "@babel/traverse": "7.24.6"
+    "ethers": "^6.13.4"
   }
 }

src/__tests__/main.test.ts

@@ -1,159 +1,107 @@
-// import { sum } from "../index";
-import { fromDisplayQty } from "../utils/token";
-import { toDisplayQty } from "../utils/token";
+import { describe, expect, it } from "vitest";
 import {
-  // fromDisplayPrice,
-  // encodeCrocPrice,
-  pinTickUpper,
-  pinTickLower,
+  baseConcFactor,
   calcRangeTilt,
-  // truncateRightBits,
-  // liquidityForBaseQty,
-  toDisplayPrice,
+  concDepositSkew,
   fromDisplayPrice,
+  pinTickLower,
+  pinTickUpper,
+  quoteConcFactor,
+  toDisplayPrice
 } from "../utils";
-
-test("1 is 1?", () => {
-  expect(1).toBe(1);
-});
-
-test("scaleQty integer as string", () => {
-  const scaledQty = fromDisplayQty("1", 18).toString();
-  expect(scaledQty).toBe("1000000000000000000");
+import { fromDisplayQty, toDisplayQty } from "../utils/token";
+
+describe("Utility Functions Tests", () => {
+  it("1 is 1?", () => {
+    expect(1).toBe(1);
+  });
+
+  it("scaleQty integer as string", () => {
+    const scaledQty = fromDisplayQty("1", 18).toString();
+    expect(scaledQty).toBe("1000000000000000000");
+  });
+
+  it("scaledQty float as string", () => {
+    const scaledQty = fromDisplayQty(".1", 18).toString();
+    expect(scaledQty).toBe("100000000000000000");
+  });
+
+  // it("throws error on scaledQty longer than decimals", () => {
+  //   expect(() => {
+  //     fromDisplayQty("1.1234567", 6);
+  //   }).toThrowError();
+  // });
+
+  it("unscaleQty integer as string", () => {
+    const unscaledQty = toDisplayQty("100", 2).toString();
+    expect(unscaledQty).toBe("1.0");
+  });
+
+  it("throws error on unscaleQty float as string", () => {
+    expect(() => {
+      toDisplayQty("100.1", 2).toString();
+    }).toThrowError();
+  });
+
+  it("to display price", () => {
+    expect(toDisplayPrice(1500, 18, 18, false)).toBeCloseTo(1500, 0.0001);
+    expect(toDisplayPrice(2000, 18, 18, true)).toBeCloseTo(0.0005, 0.0001);
+    expect(toDisplayPrice(20, 6, 10, false)).toBeCloseTo(200000, 0.0001);
+    expect(toDisplayPrice(20, 6, 10, true)).toBeCloseTo(0.000005, 0.0001);
+  });
+
+  it("from display price", () => {
+    expect(fromDisplayPrice(toDisplayPrice(1500, 18, 18, false), 18, 18, false)).toBeCloseTo(1500, 0.0001);
+    expect(fromDisplayPrice(toDisplayPrice(2000, 18, 18, true), 18, 18, true)).toBeCloseTo(2000, 0.0001);
+    expect(fromDisplayPrice(toDisplayPrice(20, 10, 6, false), 10, 6, false)).toBeCloseTo(20, 0.0001);
+    expect(fromDisplayPrice(toDisplayPrice(20, 10, 6, true), 10, 6, true)).toBeCloseTo(20, 0.0001);
+  });
+
+  it("pin tick upper", () => {
+    expect(pinTickUpper(5943, 50)).toBe(86950);
+    expect(pinTickUpper(0.042, 50)).toBe(-31700);
+  });
+
+  it("pin tick lower", () => {
+    expect(pinTickLower(5943, 50)).toBe(86900);
+    expect(pinTickLower(0.042, 50)).toBe(-31750);
+  });
+
+  it("range collateral tilt", () => {
+    expect(calcRangeTilt(0.9, -5000, -3000)).toBe(Infinity);
+    expect(calcRangeTilt(0.9, 3000, 5000)).toBe(0);
+    expect(calcRangeTilt(0.9, -5000, 5000)).toBe(0.9);
+  });
+
+  it("base conc factor", () => {
+    expect(baseConcFactor(25.0, 9.0, 100.0)).toBe(2.5);
+    expect(baseConcFactor(1.0, 9.0, 100.0)).toBe(Infinity);
+    expect(baseConcFactor(400.0, 9.0, 100.0)).toBe(1 / 0.35);
+  });
+
+  it("quote conc factor", () => {
+    expect(quoteConcFactor(25.0, 9.0, 64.0)).toBe(1 / 0.375);
+    expect(quoteConcFactor(1.0, 16.0, 100.0)).toBe(1 / 0.15);
+    expect(quoteConcFactor(400.0, 9.0, 100.0)).toBe(Infinity);
+  });
+
+  it("conc deposit skew", () => {
+    expect(concDepositSkew(25.0, 9.0, 100.0)).toBe(0.8);
+    expect(concDepositSkew(1.0, 16.0, 100.0)).toBe(0);
+    expect(concDepositSkew(400.0, 9.0, 100.0)).toBe(Infinity);
+  });
+
+  // it("liquidity quote tokens", () => {
+  //   expect(liquidityForQuoteQty(0.01 ** 2, BigInt(10000))).toBe(100);
+  //   expect(liquidityForQuoteQty(0.01075 ** 2, BigInt(9998))).toBe(107);
+  // });
+
+  // it("liquidity base tokens", () => {
+  //   expect(liquidityForBaseQty(0.01 ** 2, BigInt(50))).toBe(5000);
+  //   expect(liquidityForBaseQty(109 ** 2, BigInt(9999))).toBe(91);
+  // });
+
+  // it("truncate right bits", () => {
+  //   expect(truncateRightBits(BigInt(48024845023), 10)).toBe(48024844288);
+  // });
 });
-
-test("scaledQty float as string", () => {
-  const scaledQty = fromDisplayQty(".1", 18).toString();
-  expect(scaledQty).toBe("100000000000000000");
-});
-// test("throws error on scaledQty longer than decimals", () => {
-//   expect(() => {
-//     fromDisplayQty("1.1234567", 6);
-//   }).toThrowError();
-// });
-
-test("unscaleQty integer as string", () => {
-  const unscaledQty = toDisplayQty("100", 2).toString();
-  expect(unscaledQty).toBe("1.0");
-});
-
-test("throws error on unscaleQty float as string", () => {
-  expect(() => {
-    toDisplayQty("100.1", 2).toString();
-  }).toThrowError();
-});
-
-// test("encode croc price", () => {
-//   const price = encodeCrocPrice(625);
-//   expect(price.eq(BigNumber.from(25).mul(BigNumber.from(2).pow(64))));
-// });
-
-// test("encode croc price oversized", () => {
-//   const price = encodeCrocPrice(625 * 2 ** 40);
-//   expect(price.eq(BigNumber.from(25 * 2 ** 20).mul(BigNumber.from(2).pow(64))));
-// });
-
-test("to display price", () => {
-  expect(toDisplayPrice(1500, 18, 18, false)).toBeCloseTo(1500)
-  expect(toDisplayPrice(2000, 18, 18, true)).toBeCloseTo(0.0005)
-  expect(toDisplayPrice(20, 6, 10, false)).toBeCloseTo(200000)
-  expect(toDisplayPrice(20, 6, 10, true)).toBeCloseTo(0.000005)
-})
-
-test("from display price", () => {
-  expect(fromDisplayPrice(toDisplayPrice(1500, 18, 18, false), 18, 18, false)).toBeCloseTo(1500)
-  expect(fromDisplayPrice(toDisplayPrice(2000, 18, 18, true), 18, 18, true)).toBeCloseTo(2000)
-  expect(fromDisplayPrice(toDisplayPrice(20, 10, 6, false), 10, 6, false)).toBeCloseTo(20)
-  expect(fromDisplayPrice(toDisplayPrice(20, 10, 6, true), 10, 6, true)).toBeCloseTo(20)
-})
-
-test("pin tick upper", () => {
-  expect(pinTickUpper(5943, 50)).toBe(86950);
-  expect(pinTickUpper(0.042, 50)).toBe(-31700);
-});
-
-test("pin tick lower", () => {
-  expect(pinTickLower(5943, 50)).toBe(86900);
-  expect(pinTickLower(0.042, 50)).toBe(-31750);
-});
-
-test("range collateral tilt", () => {
-  expect(calcRangeTilt(0.9, -5000, -3000)).toBe(Infinity);
-  expect(calcRangeTilt(0.9, 3000, 5000)).toBe(0);
-  expect(calcRangeTilt(0.9, -5000, 5000)).toBe(0.9);
-});
-
-/*test("base conc factor", () => {
-  expect(baseConcFactor(25.0, 9.0, 100.0)).toBe(2.5)
-  expect(baseConcFactor(1.0, 9.0, 100.0)).toBe(Infinity)
-  expect(baseConcFactor(400.0, 9.0, 100.0)).toBe(1/0.35)
-})
-
-test("quote conc factor", () => {
-  expect(quoteConcFactor(25.0, 9.0, 64.0)).toBe(1/0.375)
-  expect(quoteConcFactor(1.0, 16.0, 100.0)).toBe(1/0.15)
-  expect(quoteConcFactor(400.0, 9.0, 100.0)).toBe(Infinity)
-})
-
-test("conc deposit skew", () => {
-  expect(concDepositSkew(25.0, 9.0, 100.0)).toBe(0.8)
-  expect(concDepositSkew(1.0, 16.0, 100.0)).toBe(0)
-  expect(concDepositSkew(400.0, 9.0, 100.0)).toBe(Infinity)
-})
-
-test("liquidity quote tokens", () => {
-  expect(liquidityForQuoteQty(0.01 ** 2, BigNumber.from(10000)).toNumber()).toBe(100)
-  // Rounds down
-  expect(liquidityForQuoteQty(0.01075 ** 2, BigNumber.from(9998)).toNumber()).toBe(107)
-});
-
-test("liquidity base tokens", () => {
-  expect(liquidityForBaseQty(0.01 ** 2, BigNumber.from(50)).toNumber()).toBe(5000)
-  // Rounds down
-  expect(liquidityForBaseQty(109 ** 2, BigNumber.from(9999)).toNumber()).toBe(91)
-});
-
-test("liquidity quote concentrated", () => {
-  expect(liquidityForQuoteConc(0.01 ** 2, BigNumber.from(10000), 0.005 ** 2, 0.02 ** 2).toNumber()).toBe(200)
-  expect(liquidityForQuoteConc(0.01 ** 2, BigNumber.from(10000), 0.015 ** 2, 0.02 ** 2).toNumber()).toBe(16)
-  expect(liquidityForQuoteConc(0.01 ** 2, BigNumber.from(10000), 0.001 ** 2, 0.005 ** 2).toNumber()).toBe(Infinity)
-});
-
-test("liquidity base concentrated", () => {
-  expect(liquidityForBaseConc(0.01 ** 2, BigNumber.from(50), 0.005 ** 2, 0.02 ** 2).toNumber()).toBe(10000)
-  expect(liquidityForBaseConc(0.01 ** 2, BigNumber.from(50), 0.015 ** 2, 0.02 ** 2).toNumber()).toBe(Infinity)
-  expect(liquidityForBaseConc(0.01 ** 2, BigNumber.from(50), 0.001 ** 2, 0.005 ** 2).toNumber()).toBe(2000)
-});*/
-
-// test("liquidity quote tokens", () => {
-//   expect(liquidityForBaseQty(0.01 ** 2, BigNumber.from(50)).toNumber()).toBe(5000)
-//   // Rounds down
-//   expect(liquidityForBaseQty(109 ** 2, BigNumber.from(9999)).toNumber()).toBe(91)
-// });
-
-// test("liquidity wild number", () => {
-//   expect((liquidityForBaseQty(0.004567483987661575, 
-//     BigNumber.from(1000000000000000))).toString()).toBe("14796584656896000")
-//   expect((liquidityForBaseQty(3572831664.789597, 
-//     BigNumber.from(1000000000000000))).toString()).toBe("16729914544")    
-// });
-
-// test("ambient slot", () => {
-//   const owner = "0x01e650abfc761c6a0fc60f62a4e4b3832bb1178b"
-//   const token = "0x07865c6E87B9F70255377e024ace6630C1Eaa37F"
-//   const slot = "0x83143c5d6e1dadd337e7d8618d6c0bf50bdfd154f08c7f9310dda845cf77ad53"
-//   expect(ambientPosSlot(owner, ZeroAddress, token, 36000)).toBe(slot)
-// });
-
-// test("concentrated slot", () => {
-//   const owner = "0x01e650abfc761c6a0fc60f62a4e4b3832bb1178b"
-//   const token = "0xad6d458402f60fd3bd25163575031acdce07538d"
-//   const lower = -69090
-//   const upper = -52980
-//   const slot = "0xf264f3cd87277c5d536c08d094f4cd23707a7fb7c8da08b44c0dc25bea3b9b54"
-//   expect(concPosSlot(owner, ZeroAddress, token, lower, upper, 36000)).toBe(slot)
-// });
-
-// test("truncate right bits", () => {
-//   expect(truncateRightBits(BigNumber.from(48024845023), 10).toNumber()).toBe(48024844288)
-// })