@mezo-org/passport 0.4.0-dev.4 → 0.4.0-dev.42

package/src/utils/cryptoAssets.test.ts

@@ -0,0 +1,79 @@
+import { BitcoinCircle, EthCircle, MUsdCircle02 } from "@mezo-org/mezo-clay"
+import {
+  CryptoAssetKey,
+  getCryptoAsset,
+  isBitcoinLikeCryptoAsset,
+  isUsdLikeCryptoAsset,
+} from "./cryptoAssets"
+
+// FIXME: Test fails if run in full suite (pnpm test) but works when run in isolation (pnpm test cryptoAssets)
+
+describe("getCryptoAsset", () => {
+  it("returns the correct asset for 'BTC (mBTC)'", () => {
+    const asset = getCryptoAsset("BTC")
+    expect(asset.name).toBe("Bitcoin")
+    expect(asset.symbol).toBe("BTC")
+    expect(asset.decimals).toBe(18)
+    expect(asset.icon).toBe(BitcoinCircle)
+  })
+
+  it("returns the correct asset for 'ETH'", () => {
+    const asset = getCryptoAsset("ETH")
+    expect(asset.name).toBe("Ethereum")
+    expect(asset.symbol).toBe("ETH")
+    expect(asset.decimals).toBe(18)
+    expect(asset.icon).toBe(EthCircle)
+  })
+
+  it("returns the correct asset for 'MUSD'", () => {
+    const asset = getCryptoAsset("MUSD")
+    expect(asset.name).toBe("MUSD")
+    expect(asset.symbol).toBe("MUSD")
+    expect(asset.decimals).toBe(18)
+    expect(asset.icon).toBe(MUsdCircle02)
+  })
+})
+
+describe("isBitcoinLikeCryptoAsset", () => {
+  const cases = [
+    { input: "mcbBTC", expected: true },
+    { input: "mDAI", expected: false },
+    { input: "mFBTC", expected: true },
+    { input: "mSolvBTC", expected: true },
+    { input: "mswBTC", expected: true },
+    { input: "mT", expected: false },
+    { input: "mUSDC", expected: false },
+    { input: "mUSDe", expected: false },
+    { input: "mUSDT", expected: false },
+    { input: "mxSolvBTC", expected: true },
+    { input: "MUSD", expected: false },
+  ]
+
+  cases.forEach(({ input, expected }) => {
+    it(`returns ${expected} for ${input}`, () => {
+      expect(isBitcoinLikeCryptoAsset(input as CryptoAssetKey)).toBe(expected)
+    })
+  })
+})
+
+describe("isUsdLikeCryptoAsset", () => {
+  const cases = [
+    { input: "mcbBTC", expected: false },
+    { input: "mDAI", expected: true },
+    { input: "mFBTC", expected: false },
+    { input: "mSolvBTC", expected: false },
+    { input: "mswBTC", expected: false },
+    { input: "mT", expected: false },
+    { input: "mUSDC", expected: true },
+    { input: "mUSDe", expected: true },
+    { input: "mUSDT", expected: true },
+    { input: "mxSolvBTC", expected: false },
+    { input: "MUSD", expected: true },
+  ]
+
+  cases.forEach(({ input, expected }) => {
+    it(`returns ${expected} for ${input}`, () => {
+      expect(isUsdLikeCryptoAsset(input as CryptoAssetKey)).toBe(expected)
+    })
+  })
+})

package/src/utils/cryptoAssets.ts

@@ -0,0 +1,173 @@
+import {
+  BitcoinCircle,
+  EthCircle,
+  IconProps,
+  MUsdCircle02,
+  Cryptocurrency04,
+} from "@mezo-org/mezo-clay"
+import { FC } from "react"
+import { MezoChainToken } from "../lib/contracts"
+import { formatUsd } from "./currency"
+import {
+  fromFixedPointToString,
+  fromFixedPoint,
+  fromFloatToBigInt,
+} from "./numbers"
+
+export type CryptoAssetKey = MezoChainToken | "BTC" | "ETH"
+
+export type CryptoAsset = {
+  name: string
+  symbol: string
+  icon: FC<IconProps>
+  decimals: number
+}
+
+// TODO: Add actual icons for the assets
+
+const CRYPTO_ASSETS: Record<CryptoAssetKey, CryptoAsset> = {
+  BTC: {
+    name: "Bitcoin",
+    symbol: "BTC",
+    icon: BitcoinCircle,
+    decimals: 18,
+  },
+  ETH: {
+    name: "Ethereum",
+    symbol: "ETH",
+    icon: EthCircle,
+    decimals: 18,
+  },
+  MUSD: {
+    name: "MUSD",
+    symbol: "MUSD",
+    icon: MUsdCircle02,
+    decimals: 18,
+  },
+  mDAI: {
+    name: "mDAI",
+    symbol: "mDAI",
+    icon: Cryptocurrency04,
+    decimals: 18,
+  },
+  mFBTC: {
+    name: "mFBTC",
+    symbol: "mFBTC",
+    icon: BitcoinCircle,
+    decimals: 8,
+  },
+  mcbBTC: {
+    name: "mcbBTC",
+    symbol: "mcbBTC",
+    icon: BitcoinCircle,
+    decimals: 8,
+  },
+  mSolvBTC: {
+    name: "mSolvBTC",
+    symbol: "mSolvBTC",
+    icon: BitcoinCircle,
+    decimals: 18,
+  },
+  mswBTC: {
+    name: "mswBTC",
+    symbol: "mswBTC",
+    icon: BitcoinCircle,
+    decimals: 8,
+  },
+  mT: {
+    name: "mT",
+    symbol: "mT",
+    icon: Cryptocurrency04,
+    decimals: 18,
+  },
+  mUSDC: {
+    name: "mUSDC",
+    symbol: "mUSDC",
+    icon: Cryptocurrency04,
+    decimals: 6,
+  },
+  mUSDe: {
+    name: "mUSDe",
+    symbol: "mUSDe",
+    icon: Cryptocurrency04,
+    decimals: 18,
+  },
+  mUSDT: {
+    name: "mUSDT",
+    symbol: "mUSDT",
+    icon: Cryptocurrency04,
+    decimals: 6,
+  },
+  mxSolvBTC: {
+    name: "mxSolvBTC",
+    symbol: "mxSolvBTC",
+    icon: BitcoinCircle,
+    decimals: 18,
+  },
+}
+
+/**
+ * Gets details of given crypto asset
+ * @param key The key of crypto asset
+ * @returns The crypto asset details
+ */
+export function getCryptoAsset(key: CryptoAssetKey) {
+  return CRYPTO_ASSETS[key]
+}
+
+/**
+ * Checks if given crypto asset is Bitcoin-like
+ * @param key The key of crypto asset
+ * @returns True if crypto asset is Bitcoin-like
+ */
+export function isBitcoinLikeCryptoAsset(key: CryptoAssetKey) {
+  return /(btc)/i.test(key)
+}
+
+/**
+ * Checks if given crypto asset is USD-like
+ * @param key The key of crypto asset
+ * @returns True if crypto asset is USD-like
+ */
+export function isUsdLikeCryptoAsset(key: CryptoAssetKey) {
+  return /(usd|dai)/i.test(key)
+}
+
+/**
+ * Formats crypto asset to balance details (balance in USD and decimals)
+ * @param type The type of crypto asset
+ * @param balance The balance of crypto asset
+ * @param usdConversionRate The USD conversion rate
+ * @returns The balance details
+ */
+export function mapCryptoAssetToDetails(
+  type: CryptoAssetKey,
+  balance: bigint,
+  usdConversionRate: number,
+) {
+  const { decimals } = getCryptoAsset(type)
+
+  const formattedBalance = fromFixedPointToString(
+    balance,
+    decimals,
+    isUsdLikeCryptoAsset(type) ? 2 : 4,
+  )
+
+  const usdBalance = fromFixedPoint(
+    // Native BigInt constructor doesn't support floating point numbers.
+    balance * fromFloatToBigInt(usdConversionRate, 0),
+    decimals,
+  )
+
+  const formattedUsdBalance = formatUsd(usdBalance)
+
+  return {
+    type,
+    rawBalance: balance,
+    formattedBalance,
+    usdBalance,
+    formattedUsdBalance,
+  }
+}
+
+export type DetailedCryptoAsset = ReturnType<typeof mapCryptoAssetToDetails>

package/src/utils/currency.test.ts

@@ -0,0 +1,38 @@
+import { formatCurrency, formatUsd } from "./currency"
+
+describe("formatCurrency", () => {
+  it("formats a number as currency with default options", () => {
+    const result = formatCurrency(1234.5, { currency: "EUR" })
+    expect(result).toBe("€1,234.50")
+  })
+
+  it("respects minimumFractionDigits (min = 3, max = 3)", () => {
+    const result = formatCurrency(1.2, {
+      currency: "USD",
+      minimumFractionDigits: 3,
+      maximumFractionDigits: 3,
+    })
+    expect(result).toBe("$1.200")
+  })
+
+  it("respects maximumFractionDigits (min = 0, max = 1)", () => {
+    const result = formatCurrency(1.234567, {
+      currency: "USD",
+      minimumFractionDigits: 0,
+      maximumFractionDigits: 1,
+    })
+    expect(result).toBe("$1.2")
+  })
+})
+
+describe("formatUsd", () => {
+  it("formats a number as USD", () => {
+    const result = formatUsd(99.99)
+    expect(result).toBe("$99.99")
+  })
+
+  it("formats zero", () => {
+    const result = formatUsd(0)
+    expect(result).toBe("$0.00")
+  })
+})

package/src/utils/currency.ts

@@ -0,0 +1,32 @@
+const DEFAULT_FORMAT_OPTIONS: Intl.NumberFormatOptions = {
+  style: "currency",
+  minimumFractionDigits: 2,
+  maximumFractionDigits: 2,
+}
+
+/**
+ * Formats a number as a currency
+ * @param value The value to format
+ * @param options The options to pass to the formatter
+ * @returns The formatted currency
+ */
+export function formatCurrency(
+  value: number,
+  options: Omit<Intl.NumberFormatOptions, "style"> = {},
+): string {
+  const formatter = new Intl.NumberFormat("en-US", {
+    ...DEFAULT_FORMAT_OPTIONS,
+    ...options,
+  })
+
+  return formatter.format(value)
+}
+
+/**
+ * Formats a number as a USD currency
+ * @param value The value to format
+ * @returns The formatted currency
+ */
+export function formatUsd(value: number): string {
+  return formatCurrency(value, { currency: "USD" })
+}

package/src/utils/numbers.test.ts

@@ -0,0 +1,220 @@
+import {
+  formatNumberToCompactString,
+  fromFixedPoint,
+  roundUpNumber,
+  formatNumberToLocaleString,
+  fromFixedPointToString,
+} from "./numbers"
+
+describe("formatNumberToCompactString", () => {
+  it("formats number less than 1000 with decimals", () => {
+    expect(formatNumberToCompactString(123.456789, 2)).toBe("123.46")
+  })
+
+  it("formats thousands with K", () => {
+    expect(formatNumberToCompactString(12_345, 2)).toBe("12.35K")
+  })
+
+  it("formats millions with M", () => {
+    expect(formatNumberToCompactString(12_345_678, 2)).toBe("12.35M")
+  })
+
+  it("formats billions with B", () => {
+    expect(formatNumberToCompactString(12_345_678_901, 2)).toBe("12.35B")
+  })
+
+  it("formats trillions with T", () => {
+    expect(formatNumberToCompactString(12_345_678_901_234, 2)).toBe("12.35T")
+  })
+
+  it("formats bigint as readable number", () => {
+    expect(formatNumberToCompactString(1234567890123456789n, 2)).toBe(
+      "1,234,567.89T",
+    )
+  })
+
+  it("caps at > 1000T for huge numbers", () => {
+    const hugeNumber = 10 ** 18 // 1e18
+    expect(formatNumberToCompactString(hugeNumber, 2)).toBe("1,000,000T")
+  })
+
+  it("formats numbers with trailing zeros correctly", () => {
+    expect(formatNumberToCompactString(1_000, 2)).toBe("1K")
+  })
+})
+
+describe("roundUpNumber", () => {
+  it("rounds up to 2 decimals", () => {
+    expect(roundUpNumber(1.234)).toBe(1.24)
+  })
+
+  it("rounds up to 3 decimals", () => {
+    expect(roundUpNumber(9.87654, 3)).toBe(9.877)
+  })
+
+  it("rounds up exact decimal", () => {
+    expect(roundUpNumber(2.5, 1)).toBe(2.5)
+  })
+})
+
+describe("fromFixedPoint", () => {
+  it("converts fixed point with 18 decimals to float", () => {
+    const raw = 1234567890000000000n // 1.23456789 ETH in 18 decimals
+    expect(fromFixedPoint(raw, 18)).toBe(1.2345)
+  })
+
+  it("converts with truncation to 2 decimals", () => {
+    const raw = 987654321000000000n // ~0.987654321 ETH
+    expect(fromFixedPoint(raw, 18, 2)).toBe(0.98)
+  })
+
+  it("handles large fixedPoint decimals", () => {
+    const raw = 1_000_000_000_000_000_000_000_000n // 1M with 6 decimals
+    expect(fromFixedPoint(raw, 6, 2)).toBe(1000000000000000000)
+  })
+})
+
+describe("formatNumberToLocaleString", () => {
+  it("formats zero with 0 decimals", () => {
+    expect(formatNumberToLocaleString(0, 0)).toBe("0")
+  })
+
+  it("formats zero with >0 decimals", () => {
+    expect(formatNumberToLocaleString(0, 2)).toBe("0.00")
+    expect(formatNumberToLocaleString(0, 4)).toBe("0.0000")
+  })
+
+  it("formats small decimal number", () => {
+    expect(formatNumberToLocaleString(0.123456, 2)).toBe("0.12")
+    expect(formatNumberToLocaleString(0.123456, 4)).toBe("0.1235")
+  })
+
+  it("formats number just above 1", () => {
+    expect(formatNumberToLocaleString(1.000001, 3)).toBe("1.000")
+    expect(formatNumberToLocaleString(1.234567, 2)).toBe("1.23")
+  })
+
+  it("formats whole number", () => {
+    expect(formatNumberToLocaleString(1234, 0)).toBe("1,234")
+    expect(formatNumberToLocaleString(1000, 2)).toBe("1,000.00")
+  })
+
+  it("formats number with trailing decimal zeroes", () => {
+    expect(formatNumberToLocaleString(10.1, 3)).toBe("10.100")
+    expect(formatNumberToLocaleString(5.0, 2)).toBe("5.00")
+  })
+
+  it("formats string input", () => {
+    expect(formatNumberToLocaleString("123.456", 2)).toBe("123.46")
+    expect(formatNumberToLocaleString("0.00123", 4)).toBe("0.0012")
+  })
+
+  it("formats negative number", () => {
+    expect(formatNumberToLocaleString(-123.456, 2)).toBe("-123.46")
+    expect(formatNumberToLocaleString("-0.00999", 3)).toBe("-0.010")
+  })
+
+  it("formats large number with commas", () => {
+    expect(formatNumberToLocaleString(12345678.9, 2)).toBe("12,345,678.90")
+  })
+
+  it("handles max decimals safely", () => {
+    expect(formatNumberToLocaleString(1.123456789, 8)).toBe("1.12345679")
+    expect(formatNumberToLocaleString("0.000000000000000001", 18)).toBe(
+      "0.000000000000000001",
+    )
+  })
+
+  it("defaults to 0 decimals if not passed", () => {
+    expect(formatNumberToLocaleString(1234.567)).toBe("1,235") // rounds up by default
+  })
+})
+
+describe("fromFixedPointToString", () => {
+  const toFixedPoint = (num: number) => BigInt(Math.round(num * 1e18))
+
+  const cases = [
+    { input: 2.0, expected: "2.000" },
+    { input: 2.009, expected: "2.009" },
+    { input: 2.01, expected: "2.010" },
+    { input: 2.015, expected: "2.016" },
+    { input: 2.05, expected: "2.050" },
+    { input: 2.09, expected: "2.090" },
+  ]
+
+  describe("withRoundUp: true", () => {
+    cases.forEach(({ input, expected }) => {
+      it(`formats ${input} → ${expected}`, () => {
+        const fixed = toFixedPoint(input)
+        expect(fromFixedPointToString(fixed, 18, 3, true)).toBe(expected)
+      })
+    })
+  })
+
+  describe("withRoundUp: false", () => {
+    const noRoundCases = [
+      { input: 2.0099, expected: "2.009" },
+      { input: 2.0159, expected: "2.015" },
+      { input: 2.0101, expected: "2.010" },
+      { input: 2.0199, expected: "2.019" },
+    ]
+
+    noRoundCases.forEach(({ input, expected }) => {
+      it(`formats ${input} → ${expected} (no rounding)`, () => {
+        const fixed = toFixedPoint(input)
+        expect(fromFixedPointToString(fixed, 18, 3, false)).toBe(expected)
+      })
+    })
+  })
+
+  describe("zero handling", () => {
+    it("formats 0 → 0.000 (3 decimals)", () => {
+      expect(fromFixedPointToString(0n, 18, 3)).toBe("0.000")
+    })
+
+    it("formats 0 → 0.0000 (4 decimals)", () => {
+      expect(fromFixedPointToString(0n, 18, 4)).toBe("0.0000")
+    })
+  })
+
+  describe("very small numbers below display threshold", () => {
+    it("returns <0.0001 for small number (3 decimals)", () => {
+      const small = BigInt(123) // ~1.23e-16
+      expect(fromFixedPointToString(small, 18, 4)).toBe("<0.0001")
+    })
+
+    it("returns <0.01 for small number with only 2 decimals", () => {
+      const tiny = BigInt(9999999999999) // <0.01
+      expect(fromFixedPointToString(tiny, 18, 2)).toBe("<0.01")
+    })
+  })
+
+  describe("input types", () => {
+    it("accepts bigint", () => {
+      const amount = 2100000000000000000n
+      expect(fromFixedPointToString(amount, 18, 3)).toBe("2.100")
+    })
+
+    it("accepts string", () => {
+      expect(fromFixedPointToString("2000000000000000000", 18, 3)).toBe("2.000")
+    })
+
+    it("accepts number", () => {
+      expect(fromFixedPointToString(Number("1000000000000000000"), 18, 3)).toBe(
+        "1.000",
+      )
+    })
+  })
+
+  describe("high values", () => {
+    it("formats 1_000_000.123456789 correctly", () => {
+      const big = toFixedPoint(1_000_000.123456789)
+      expect(fromFixedPointToString(big, 18, 6)).toBe("1,000,000.123456")
+    })
+
+    it("formats 1e12 ETH", () => {
+      const big = BigInt("1000000000000000000000000000000")
+      expect(fromFixedPointToString(big, 18, 2)).toBe("1,000,000,000,000.00")
+    })
+  })
+})