npm - @morpho-org/blue-sdk - Versions diffs - 1.0.0 - Mend

@morpho-org/blue-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (59) hide show

package/README.md +98 -0
package/package.json +54 -0
package/src/addresses.ts +261 -0
package/src/chain/chain.constants.ts +235 -0
package/src/chain/chain.test.ts +51 -0
package/src/chain/chain.types.ts +42 -0
package/src/chain/chain.utils.ts +44 -0
package/src/chain/index.ts +2 -0
package/src/constants.ts +18 -0
package/src/errors.ts +75 -0
package/src/ethers/ethers.test.ts +17 -0
package/src/ethers/index.ts +2 -0
package/src/ethers/safeGetAddress.ts +4 -0
package/src/ethers/safeParseUnits.ts +29 -0
package/src/evm.ts +172 -0
package/src/helpers/format/format.test.ts +340 -0
package/src/helpers/format/format.ts +416 -0
package/src/helpers/format/index.ts +1 -0
package/src/helpers/getChecksumedAddress.ts +15 -0
package/src/helpers/index.ts +4 -0
package/src/helpers/isZeroAddressOrUnset.ts +13 -0
package/src/helpers/locale.ts +108 -0
package/src/holding/Holding.ts +109 -0
package/src/holding/index.ts +1 -0
package/src/index.ts +34 -0
package/src/market/Market.ts +479 -0
package/src/market/MarketConfig.ts +108 -0
package/src/market/MarketUtils.test.ts +25 -0
package/src/market/MarketUtils.ts +467 -0
package/src/market/index.ts +3 -0
package/src/maths/AdaptiveCurveIrmLib.ts +143 -0
package/src/maths/MathLib.ts +208 -0
package/src/maths/MathUtils.ts +31 -0
package/src/maths/SharesMath.ts +40 -0
package/src/maths/index.ts +4 -0
package/src/notifications.ts +167 -0
package/src/position/Position.ts +251 -0
package/src/position/index.ts +1 -0
package/src/signatures/index.ts +18 -0
package/src/signatures/manager.ts +50 -0
package/src/signatures/permit.ts +126 -0
package/src/signatures/permit2.ts +120 -0
package/src/signatures/types.ts +18 -0
package/src/signatures/utils.ts +83 -0
package/src/tests/mocks/markets.ts +110 -0
package/src/token/ERC20Metadata.ts +124 -0
package/src/token/Token.ts +83 -0
package/src/token/TokenNamespace.ts +76 -0
package/src/token/WrappedToken.ts +142 -0
package/src/token/index.ts +2 -0
package/src/types.ts +37 -0
package/src/user/User.ts +32 -0
package/src/user/index.ts +2 -0
package/src/user/user.types.ts +23 -0
package/src/vault/Vault.ts +370 -0
package/src/vault/VaultAllocation.ts +58 -0
package/src/vault/VaultConfig.ts +55 -0
package/src/vault/VaultUtils.ts +47 -0
package/src/vault/index.ts +4 -0

package/src/helpers/format/format.test.ts ADDED Viewed

@@ -0,0 +1,340 @@
+import { format } from "./format";
+describe("format", () => {
+  const number = 12345.6789;
+  const bigint = 123456789n;
+  const decimals = 4;
+  describe("hex", () => {
+    describe("should properly format number in hex format", () => {
+      it("without option", () => {
+        expect(format.hex.of(number)).toEqual((123456789).toString(16));
+      });
+    });
+    describe("should properly format bigint in hex format", () => {
+      it("without option", () => {
+        expect(format.hex.of(bigint, decimals)).toEqual(
+          (123456789).toString(16)
+        );
+      });
+    });
+  });
+  describe("number", () => {
+    describe("should properly format number in number format", () => {
+      it("without option", () => {
+        expect(format.number.of(number)).toEqual("12345.6789");
+      });
+      it("with digits", () => {
+        expect(format.number.digits(2).of(number)).toEqual("12345.67");
+      });
+      it("with min", () => {
+        expect(format.number.min(20000).of(number)).toEqual("< 20000.0000");
+      });
+      it("with max", () => {
+        expect(format.number.max(10000).of(number)).toEqual("> 10000.0000");
+      });
+      it("with sign", () => {
+        expect(format.number.sign().of(number)).toEqual("+12345.6789");
+      });
+      it("with unit", () => {
+        expect(format.number.unit("$").of(number)).toEqual("$12345.6789");
+      });
+      it("without trailing zeros", () => {
+        expect(format.number.digits(6).of(number)).toEqual("12345.678900");
+        expect(format.number.digits(6).removeTrailingZero().of(number)).toEqual(
+          "12345.6789"
+        );
+      });
+      it("with locale", () => {
+        expect(format.number.locale("fr-FR").of(number)).toEqual("12345,6789");
+      });
+    });
+    describe("should properly format bigint in number format", () => {
+      it("without option", () => {
+        expect(format.number.of(bigint, decimals)).toEqual("12345.6789");
+      });
+      it("with digits", () => {
+        expect(format.number.digits(2).of(bigint, decimals)).toEqual(
+          "12345.67"
+        );
+      });
+      it("with min", () => {
+        expect(format.number.min(20000).of(bigint, decimals)).toEqual(
+          "< 20000.0000"
+        );
+      });
+      it("with max", () => {
+        expect(format.number.max(10000).of(bigint, decimals)).toEqual(
+          "> 10000.0000"
+        );
+      });
+      it("with sign", () => {
+        expect(format.number.sign().of(bigint, decimals)).toEqual(
+          "+12345.6789"
+        );
+      });
+      it("with unit", () => {
+        expect(format.number.unit("$").of(bigint, decimals)).toEqual(
+          "$12345.6789"
+        );
+      });
+      it("without trailing zeros", () => {
+        expect(format.number.digits(6).of(bigint, decimals)).toEqual(
+          "12345.678900"
+        );
+        expect(
+          format.number.digits(6).removeTrailingZero().of(bigint, decimals)
+        ).toEqual("12345.6789");
+      });
+      it("with locale", () => {
+        expect(format.number.locale("fr-FR").of(bigint, decimals)).toEqual(
+          "12345,6789"
+        );
+      });
+    });
+  });
+  describe("short", () => {
+    describe("should properly format number in short format", () => {
+      it("without option", () => {
+        expect(format.short.of(number)).toEqual("12.3456789k");
+      });
+      it("with digits", () => {
+        expect(format.short.digits(2).of(number)).toEqual("12.34k");
+      });
+      it("with min", () => {
+        expect(format.short.min(20000).of(number)).toEqual("< 20.0000000k");
+      });
+      it("with max", () => {
+        expect(format.short.max(10000).of(number)).toEqual("> 10.0000000k");
+      });
+      it("with sign", () => {
+        expect(format.short.sign().of(number)).toEqual("+12.3456789k");
+      });
+      it("with unit", () => {
+        expect(format.short.unit("€").of(number)).toEqual("12.3456789k €");
+      });
+      it("without trailing zeros", () => {
+        expect(format.short.digits(8).of(number)).toEqual("12.34567890k");
+        expect(format.short.digits(8).removeTrailingZero().of(number)).toEqual(
+          "12.3456789k"
+        );
+      });
+      it("with small numbers with commas", () => {
+        expect(format.short.smallValuesWithCommas().of(number / 10)).toEqual(
+          "1,234.56789"
+        );
+      });
+      it("with locale", () => {
+        expect(format.short.locale("fr-FR").of(number)).toEqual("12,3456789k");
+      });
+    });
+    describe("should properly format bigint in short format", () => {
+      it("without option", () => {
+        expect(format.short.of(bigint, decimals)).toEqual("12.3456789k");
+      });
+      it("with digits", () => {
+        expect(format.short.digits(2).of(bigint, decimals)).toEqual("12.34k");
+      });
+      it("with min", () => {
+        expect(format.short.min(20000).of(bigint, decimals)).toEqual(
+          "< 20.0000000k"
+        );
+      });
+      it("with max", () => {
+        expect(format.short.max(10000).of(bigint, decimals)).toEqual(
+          "> 10.0000000k"
+        );
+      });
+      it("with sign", () => {
+        expect(format.short.sign().of(bigint, decimals)).toEqual(
+          "+12.3456789k"
+        );
+      });
+      it("with unit", () => {
+        expect(format.short.unit("€").of(bigint, decimals)).toEqual(
+          "12.3456789k €"
+        );
+      });
+      it("without trailing zeros", () => {
+        expect(format.short.digits(8).of(bigint, decimals)).toEqual(
+          "12.34567890k"
+        );
+        expect(
+          format.short.digits(8).removeTrailingZero().of(bigint, decimals)
+        ).toEqual("12.3456789k");
+      });
+      it("with locale", () => {
+        expect(format.short.locale("fr-FR").of(bigint, decimals)).toEqual(
+          "12,3456789k"
+        );
+      });
+      it("with small numbers with commas", () => {
+        expect(
+          format.short.smallValuesWithCommas().of(bigint, decimals + 1)
+        ).toEqual("1,234.56789");
+      });
+      it("with small numbers with commas with locale", () => {
+        expect(
+          format.short
+            .smallValuesWithCommas()
+            .locale("fr-FR")
+            .of(bigint, decimals + 1)
+          // the correct space in fr-FR is narrow no-break space (U+202F)
+        ).toEqual("1\u202F234,56789");
+      });
+    });
+  });
+  describe("commas", () => {
+    describe("should properly format number in commas format", () => {
+      it("without option", () => {
+        expect(format.commas.of(number)).toEqual("12,345.6789");
+      });
+      it("with digits", () => {
+        expect(format.commas.digits(2).of(number)).toEqual("12,345.67");
+      });
+      it("with min", () => {
+        expect(format.commas.min(20000).of(number)).toEqual("< 20,000.0000");
+      });
+      it("with max", () => {
+        expect(format.commas.max(10000).of(number)).toEqual("> 10,000.0000");
+      });
+      it("with sign", () => {
+        expect(format.commas.sign().of(number)).toEqual("+12,345.6789");
+      });
+      it("with unit", () => {
+        expect(format.commas.unit("ETH").of(number)).toEqual("12,345.6789 ETH");
+      });
+      it("without trailing zeros", () => {
+        expect(format.commas.digits(6).of(number)).toEqual("12,345.678900");
+        expect(format.commas.digits(6).removeTrailingZero().of(number)).toEqual(
+          "12,345.6789"
+        );
+      });
+      it("with locale", () => {
+        expect(format.commas.locale("fr-FR").of(number)).toEqual(
+          "12\u202F345,6789"
+        );
+      });
+    });
+    describe("should properly format bigint in commas format", () => {
+      it("without option", () => {
+        expect(format.commas.of(bigint, decimals)).toEqual("12,345.6789");
+      });
+      it("with digits", () => {
+        expect(format.commas.digits(2).of(bigint, decimals)).toEqual(
+          "12,345.67"
+        );
+      });
+      it("with min", () => {
+        expect(format.commas.min(20000).of(bigint, decimals)).toEqual(
+          "< 20,000.0000"
+        );
+      });
+      it("with max", () => {
+        expect(format.commas.max(10000).of(bigint, decimals)).toEqual(
+          "> 10,000.0000"
+        );
+      });
+      it("with sign", () => {
+        expect(format.commas.sign().of(bigint, decimals)).toEqual(
+          "+12,345.6789"
+        );
+      });
+      it("with unit", () => {
+        expect(format.commas.unit("ETH").of(bigint, decimals)).toEqual(
+          "12,345.6789 ETH"
+        );
+      });
+      it("without trailing zeros", () => {
+        expect(format.commas.digits(6).of(bigint, decimals)).toEqual(
+          "12,345.678900"
+        );
+        expect(
+          format.commas.digits(6).removeTrailingZero().of(bigint, decimals)
+        ).toEqual("12,345.6789");
+      });
+      it("with locale", () => {
+        // the correct space in fr-FR is narrow no-break space (U+202F)
+        expect(format.commas.locale("fr-FR").of(bigint, decimals)).toEqual(
+          "12\u202F345,6789"
+        );
+      });
+    });
+  });
+  describe("percent", () => {
+    describe("should properly format number in percent format", () => {
+      it("without option", () => {
+        expect(format.percent.of(number)).toEqual("1234567.8900");
+      });
+      it("with digits", () => {
+        expect(format.percent.digits(1).of(number)).toEqual("1234567.8");
+      });
+      it("with min", () => {
+        expect(format.percent.min(20000).of(number)).toEqual("< 2000000.0000");
+      });
+      it("with max", () => {
+        expect(format.percent.max(10000).of(number)).toEqual("> 1000000.0000");
+      });
+      it("with sign", () => {
+        expect(format.percent.sign().of(number)).toEqual("+1234567.8900");
+      });
+      it("with unit", () => {
+        expect(format.percent.unit("%").of(number)).toEqual("1234567.8900%");
+      });
+      it("without trailing zeros", () => {
+        expect(format.percent.removeTrailingZero().of(number)).toEqual(
+          "1234567.89"
+        );
+      });
+      it("with locale", () => {
+        expect(format.percent.locale("fr-FR").of(number)).toEqual(
+          "1234567,8900"
+        );
+      });
+    });
+    describe("should properly format bigint in percent format", () => {
+      it("without option", () => {
+        expect(format.percent.of(bigint, decimals)).toEqual("1234567.8900");
+      });
+      it("with digits", () => {
+        expect(format.percent.digits(1).of(bigint, decimals)).toEqual(
+          "1234567.8"
+        );
+      });
+      it("with min", () => {
+        expect(format.percent.min(20000).of(bigint, decimals)).toEqual(
+          "< 2000000.0000"
+        );
+      });
+      it("with max", () => {
+        expect(format.percent.max(10000).of(bigint, decimals)).toEqual(
+          "> 1000000.0000"
+        );
+      });
+      it("with sign", () => {
+        expect(format.percent.sign().of(bigint, decimals)).toEqual(
+          "+1234567.8900"
+        );
+      });
+      it("with unit", () => {
+        expect(format.percent.unit("%").of(bigint, decimals)).toEqual(
+          "1234567.8900%"
+        );
+      });
+      it("without trailing zeros", () => {
+        expect(
+          format.percent.removeTrailingZero().of(bigint, decimals)
+        ).toEqual("1234567.89");
+      });
+      it("with locale", () => {
+        expect(format.percent.locale("fr-FR").of(bigint, decimals)).toEqual(
+          "1234567,8900"
+        );
+      });
+    });
+  });
+});