@mezo-org/passport 0.4.0-dev.81 → 0.4.0-dev.83

package/src/hooks/useBorrowData.ts

@@ -1,6 +1,7 @@
-import { useAccount, useReadContracts } from "wagmi"
+import { useReadContracts } from "wagmi"
 import { useCallback, useMemo } from "react"
 import { useQueryClient } from "@tanstack/react-query"
+import { formatUnits } from "viem"
 import { ONE_MINUTE_MS } from "../utils/time"
 import {
   mainnetBorrowContracts,
@@ -8,7 +9,12 @@ import {
 } from "../lib/contracts"
 import { usePassportContext } from "./usePassportContext"
 import { CHAIN_ID } from "../constants"
-import { bigIntMax } from "../utils/numbers"
+import { bigIntMax, normalizePrecision } from "../utils/numbers"
+import useWalletAccount from "./useWalletAccount"
+import { getAsset } from "../utils/assets"
+import { convertToUsd } from "../utils/currency"
+
+const DEBT_AND_COLL_PRECISION = 18
 
 // Wagmi handles typesafety with ABI const assertions. TypeScript doesn't
 // support importing JSON as const yet so types cannot be inferred from the
@@ -79,6 +85,22 @@ const BORROWER_OPERATIONS_ABI = [
   },
 ] as const
 
+const PRICE_FEED_ABI = [
+  {
+    inputs: [],
+    name: "fetchPrice",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+] as const
+
 /**
  * Query hook for getting borrow data. Returns collateral and trove debt for the
  * connected account, based on it's evm address.
@@ -86,18 +108,20 @@ const BORROWER_OPERATIONS_ABI = [
  */
 export function useBorrowData(queryOptions = {}) {
   const { environment = "mainnet" } = usePassportContext()
-  const { address } = useAccount()
+  const { data: walletAccountData } = useWalletAccount()
 
   const contractAddress = useMemo(() => {
     if (environment === "mainnet") {
       return {
         troveManager: mainnetBorrowContracts.TroveManager.address,
         borrowerOperations: mainnetBorrowContracts.BorrowerOperations.address,
+        priceFeed: mainnetBorrowContracts.PriceFeed.address,
       }
     }
     return {
       troveManager: testnetBorrowContracts.TroveManager.address,
       borrowerOperations: testnetBorrowContracts.BorrowerOperations.address,
+      priceFeed: testnetBorrowContracts.PriceFeed.address,
     }
   }, [environment])
 
@@ -109,36 +133,71 @@ export function useBorrowData(queryOptions = {}) {
         abi: TROVE_MANAGER_ABI,
         address: contractAddress.troveManager,
         functionName: "getEntireDebtAndColl",
-        args: [address || "0x"],
+        args: walletAccountData
+          ? [walletAccountData.accountAddress]
+          : undefined,
         chainId,
       },
       {
         abi: BORROWER_OPERATIONS_ABI,
         address: contractAddress.borrowerOperations,
         functionName: "MUSD_GAS_COMPENSATION",
-        args: [],
+        chainId,
+      },
+      {
+        abi: PRICE_FEED_ABI,
+        address: contractAddress.priceFeed,
+        functionName: "fetchPrice",
         chainId,
       },
     ],
     query: {
-      enabled: !!address,
+      enabled: !!walletAccountData,
       staleTime: 5 * ONE_MINUTE_MS,
       retry: 1,
       select: (data) => {
-        if (!data || data.some((item) => !item.result)) return undefined
+        if (!data || data.some((item) => !item.result))
+          throw new Error("No borrow data available")
 
-        const [collateral, principal, interest] = data[0].result!
+        const [rawCollateral, principal, interest] = data[0].result!
         const gasCompensation = data[1].result!
+        const collateralPrice = data[2].result!
+
+        const btcDetails = getAsset("BTC")
+
+        const collateral = {
+          value: rawCollateral,
+          decimals: btcDetails.decimals,
+          symbol: btcDetails.symbol,
+          formatted: formatUnits(rawCollateral, DEBT_AND_COLL_PRECISION),
+          usd: convertToUsd(
+            rawCollateral,
+            DEBT_AND_COLL_PRECISION,
+            collateralPrice,
+            DEBT_AND_COLL_PRECISION,
+          ),
+        }
 
-        const troveDebt = bigIntMax(
-          principal + interest - gasCompensation,
+        const debtInUsdValue = bigIntMax(
+          normalizePrecision(
+            principal + interest - gasCompensation,
+            DEBT_AND_COLL_PRECISION,
+          ),
           0n, // Ensure that debt is not negative
         )
+        const formattedDebtInUsd = formatUnits(
+          debtInUsdValue,
+          DEBT_AND_COLL_PRECISION,
+        )
+
+        const debtInUsd = {
+          value: debtInUsdValue,
+          formatted: formattedDebtInUsd,
+        }
 
         return {
           collateral,
-          // Principal includes gas compensation value which is not
-          troveDebt,
+          debtInUsd,
         }
       },
       ...queryOptions,

package/src/hooks/useCreateAccount.ts

@@ -18,7 +18,7 @@ export function useCreateAccount(
 ) {
   const queryClient = useQueryClient()
   const authApiClient = useAuthApiClient()
-  const { connector } = useWalletAccount()
+  const walletAccount = useWalletAccount()
 
   const { onSuccess: customOnSuccess, ...restMutationOptions } = mutationOptions
 
@@ -27,12 +27,13 @@ export function useCreateAccount(
       createAccountMutationFnParameters: CreateAccountRequest,
     ) => {
       if (createAccountMutationFnParameters.type === "wallet") {
-        if (!connector) {
+        if (!walletAccount.data?.connector) {
           throw new Error("Connector not defined.")
         }
 
-        const bitcoinPublicKey =
-          await getBitcoinPublicKeyFromConnector(connector)
+        const bitcoinPublicKey = await getBitcoinPublicKeyFromConnector(
+          walletAccount.data.connector,
+        )
 
         // Creating bitcoin mezo account
         if (bitcoinPublicKey) {

package/src/hooks/useGetCurrentAccount.ts

@@ -24,16 +24,15 @@ export function useGetCurrentAccount(
     queryKey: [QUERY_KEYS.ACCOUNT, QUERY_KEYS.CURRENT],
     queryFn: async () => {
       const currentAccount = await authApiClient.getCurrentAccount()
+      if (!currentAccount) {
+        throw new Error("No current account found")
+      }
+
       const linkedWallets = currentAccount?.linkedAccounts?.filter(
         (account) => account.type === "wallet",
       )
       if (!linkedWallets || linkedWallets.length === 0) {
-        return {
-          ...currentAccount,
-          mats: {
-            totalMats: 0,
-          },
-        }
+        throw new Error("No linked wallets found for the current account")
       }
 
       const addresses = linkedWallets.map(
@@ -42,7 +41,6 @@ export function useGetCurrentAccount(
       const mats = await Promise.all(
         addresses.map((address) => portalApiClient.getPortalMats(address)),
       )
-
       const totalMats = mats.reduce(
         (sumMats, currentMats) => sumMats + currentMats.totalMats,
         0,

package/src/hooks/useLinkAccount.ts

@@ -26,7 +26,7 @@ export function useLinkAccount(
 ) {
   const queryClient = useQueryClient()
   const authApiClient = useAuthApiClient()
-  const { connector } = useWalletAccount()
+  const walletAccount = useWalletAccount()
 
   const { onSuccess: customOnSuccess, ...restMutationOptions } = mutationOptions
 
@@ -35,12 +35,13 @@ export function useLinkAccount(
       linkAccountMutationFnParameters: LinkAccountMutationFnParameters,
     ) => {
       if (linkAccountMutationFnParameters.type === "wallet") {
-        if (!connector) {
+        if (!walletAccount.data?.connector) {
           throw new Error("Connector not defined.")
         }
 
-        const bitcoinPublicKey =
-          await getBitcoinPublicKeyFromConnector(connector)
+        const bitcoinPublicKey = await getBitcoinPublicKeyFromConnector(
+          walletAccount.data.connector,
+        )
 
         // Linking bitcoin account
         if (bitcoinPublicKey) {

package/src/hooks/useTokensBalances.ts

@@ -1,15 +1,26 @@
-import { useReadContracts } from "wagmi"
-import { useCallback, useMemo } from "react"
-import { Abi } from "viem"
-import { useQueryClient } from "@tanstack/react-query"
-import { usePassportContext } from "./usePassportContext"
+import { useConfig } from "wagmi"
+import { Abi, formatUnits } from "viem"
+import {
+  useQuery,
+  useQueryClient,
+  UseQueryOptions,
+} from "@tanstack/react-query"
+import { getBalance, readContracts } from "wagmi/actions"
 import {
   mainnetTokenContracts,
-  testnetTokenContracts,
   MezoChainToken,
+  testnetTokenContracts,
 } from "../lib/contracts"
 import useWalletAccount from "./useWalletAccount"
+import {
+  getAsset,
+  isBitcoinLikeCryptoAsset,
+  isTTokenCryptoAsset,
+} from "../utils/assets"
+import { convertToUsd } from "../utils/currency"
 import { CHAIN_ID } from "../constants"
+import { useAssetsConversionRates } from "./useAssetsConversionRates"
+import { normalizePrecision } from "../utils/numbers"
 
 // Wagmi handles typesafety with ABI const assertions. TypeScript doesn't
 // support importing JSON as const yet so types cannot be inferred from the
@@ -17,7 +28,7 @@ import { CHAIN_ID } from "../constants"
 // be asserted types from.
 // Ref: https://wagmi.sh/core/typescript#const-assert-abis-typed-data
 
-const BALANCE_OF_ABI = [
+export const BALANCE_OF_ABI = [
   {
     inputs: [
       {
@@ -53,11 +64,27 @@ const BALANCE_TOKENS: MezoChainToken[] = [
   "MUSD",
 ]
 
-type UseMezoChainTokensBalancesOptions<T> = {
+type UseMezoChainTokensBalancesOptions<T extends MezoChainToken[]> = {
   tokens?: T
-  queryOptions?: object
+  queryOptions?: Omit<
+    UseQueryOptions<Record<T[number], TokenBalance>>,
+    "queryKey" | "queryFn" | "select" | "enabled"
+  >
 }
 
+export type TokenBalance = {
+  decimals: number
+  formatted: string
+  symbol: string
+  value: bigint
+  usd: {
+    value: bigint
+    formatted: string
+  }
+}
+
+const TOKEN_BALANCES_QUERY_KEY = "passport.tokenBalances"
+
 /**
  * Hook to get the balance of a list of tokens for the current account
  * @param   options.tokens The list of tokens to get the balance for. It will
@@ -67,93 +94,150 @@ type UseMezoChainTokensBalancesOptions<T> = {
  * @returns Tanstack's `useQuery` returnings with balance of tokens for the
  *          current account in form of typesafe object with token names as keys
  *          and balances as values.
- * @dev     In case of error data fallbacks to `0n`. To determine if an error
- *          occurred, check the `isError` property.
  * @example
  * const mezoTokensBalance = useTokensBalances({
  *   tokens: ["mT", "mxSolvBTC"],
  * })
- * console.log(mezoTokensBalance?.data.mT) // Eg. 0n
- * console.log(Object.keys(mezoTokensBalance?.data)) // ["mT", "mxSolvBTC"]
+ * // Assuming the status is "success"
+ * console.log(mezoTokensBalance.data.mT) // Eg. { value: 0n ... }
+ * console.log(Object.keys(mezoTokensBalance.data)) // ["mT", "mxSolvBTC"]
  */
 export function useTokensBalances<T extends MezoChainToken[]>(
   options: UseMezoChainTokensBalancesOptions<T> = {},
 ) {
-  const { environment = "mainnet" } = usePassportContext()
+  const { tokens = BALANCE_TOKENS, ...restQueryOptions } = options
 
-  const { accountAddress } = useWalletAccount()
+  const { data: walletAccountData } = useWalletAccount()
 
-  const contractsMap = useMemo(() => {
-    const contracts =
-      environment === "mainnet" ? mainnetTokenContracts : testnetTokenContracts
+  const config = useConfig()
 
-    const tokenContracts = Object.fromEntries(
-      Object.entries(contracts).filter(([key]) =>
-        BALANCE_TOKENS.includes(key as MezoChainToken),
-      ),
-    ) as typeof contracts
+  const { data: conversionRatesData } = useAssetsConversionRates()
 
-    return tokenContracts
-  }, [environment])
+  return useQuery({
+    queryKey: [
+      TOKEN_BALANCES_QUERY_KEY,
+      walletAccountData?.accountAddress,
+      options.tokens,
+    ],
+    enabled: !!walletAccountData?.accountAddress && !!conversionRatesData,
+    queryFn: async () => {
+      const isMainnet = config.state.chainId === CHAIN_ID.mainnet
+      const contractsMap = isMainnet
+        ? mainnetTokenContracts
+        : testnetTokenContracts
 
-  const { tokens = Object.keys(contractsMap) as T, queryOptions = {} } = options
+      const accountAddress = walletAccountData?.accountAddress
 
-  const contracts = useMemo(() => {
-    if (!accountAddress) return []
+      if (!accountAddress) {
+        throw new Error("Account address is not available.")
+      }
 
-    return tokens.map((token) => {
-      const { address } = contractsMap[token]
+      const tokenContracts = tokens.map((token) => {
+        const { address } = contractsMap[token]
+        return {
+          address,
+          abi: BALANCE_OF_ABI,
+          functionName: "balanceOf" as const,
+          args: [accountAddress],
+          chainId: config.state.chainId,
+        }
+      })
 
-      return {
-        address,
-        abi: BALANCE_OF_ABI,
-        functionName: "balanceOf",
-        args: [accountAddress],
-        chainId: CHAIN_ID[environment],
+      return Promise.all([
+        getBalance(config, { address: accountAddress }),
+        readContracts(config, {
+          contracts: tokenContracts,
+        }),
+      ])
+    },
+    select: (data) => {
+      const [btcBalance, tokensBalancesData] = data
+      if (!conversionRatesData) {
+        throw new Error("Conversion rates data is not available.")
       }
-    })
-  }, [accountAddress, tokens, contractsMap, environment])
-
-  return useReadContracts({
-    contracts,
-    query: {
-      select: (data) =>
-        data.reduce(
-          (acc, item) => {
-            const token = tokens[data.indexOf(item)]
-
-            return {
-              ...acc,
-              [token]: item.result ?? 0n,
-            }
-          },
-          {} as Record<T[number], bigint>,
+
+      const parsedBtcBalance = {
+        ...btcBalance,
+        symbol: getAsset("BTC").symbol,
+        usd: convertToUsd(
+          btcBalance.value,
+          btcBalance.decimals,
+          conversionRatesData.rates.BTC,
+          conversionRatesData.decimals,
         ),
-      ...queryOptions,
+      }
+
+      const parsedTokensBalances = tokensBalancesData.map((item, index) => {
+        const token = tokens[index]
+        const { decimals, symbol } = getAsset(token)
+
+        if (item.status === "failure") {
+          throw new Error(
+            `Failed to fetch balance of ${token} for ${walletAccountData?.accountAddress}.`,
+          )
+        }
+
+        const tokenBalance: Omit<TokenBalance, "usd"> = {
+          value: item.result,
+          decimals,
+          symbol,
+          formatted: formatUnits(item.result, decimals),
+        }
+
+        let usd = {
+          value: normalizePrecision(
+            tokenBalance.value,
+            tokenBalance.decimals,
+            conversionRatesData.decimals,
+          ),
+          formatted: formatUnits(tokenBalance.value, tokenBalance.decimals),
+        }
+        if (isBitcoinLikeCryptoAsset(tokenBalance.symbol)) {
+          usd = convertToUsd(
+            tokenBalance.value,
+            tokenBalance.decimals,
+            conversionRatesData.rates.BTC,
+            conversionRatesData.decimals,
+          )
+        }
+        if (isTTokenCryptoAsset(tokenBalance.symbol)) {
+          usd = convertToUsd(
+            tokenBalance.value,
+            tokenBalance.decimals,
+            conversionRatesData.rates.mT,
+            conversionRatesData.decimals,
+          )
+        }
+
+        return { ...tokenBalance, usd }
+      })
+
+      return [parsedBtcBalance, ...parsedTokensBalances].reduce(
+        (acc, token) => ({
+          ...acc,
+          [token.symbol]: token,
+        }),
+        {} as Record<T[number] | "BTC", TokenBalance>,
+      )
     },
+    ...restQueryOptions,
   })
 }
 
 /**
  * Hook for invalidating current user's token balances. Can be used to
  * invalidate the balances manually, which forces the data to be re-fetched.
- * @param tokens The list of tokens (as string arrays) for which we want to
- * invalidate query for.
  * @returns Function `invalidateTokenBalances` that invalidates token balances
  * @example
- * const { invalidateTokenBalances } = useInvalidateTokensBalances(["mT", "mUSD"])
+ * const { invalidateTokenBalances } = useInvalidateTokensBalances()
  * (...)
  * await invalidateTokenBalances()
  */
-export function useInvalidateTokensBalances(tokens?: MezoChainToken[]) {
+export function useInvalidateTokensBalances() {
   const queryClient = useQueryClient()
 
-  const { queryKey } = useTokensBalances({ tokens })
-
-  const invalidateTokensBalancesHandler = useCallback(
-    () => queryClient.invalidateQueries({ queryKey }),
-    [queryClient, queryKey],
-  )
+  const invalidateTokensBalancesHandler = () =>
+    queryClient.invalidateQueries({ queryKey: [TOKEN_BALANCES_QUERY_KEY] })
 
   return {
     invalidateTokensBalances: invalidateTokensBalancesHandler,
@@ -163,23 +247,17 @@ export function useInvalidateTokensBalances(tokens?: MezoChainToken[]) {
 /**
  * Hook for resetting current user's token balances. Can be used to reset the
  * balances manually, which forces the data to be re-fetched.
- * @param tokens The list of tokens (as string arrays) for which we want to
- * reset query for.
  * @returns Function `resetTokenBalances` that invalidates token balances
  * @example
- * const { resetTokenBalances } = useResetTokensBalances(["mT", "mUSD"])
+ * const { resetTokenBalances } = useResetTokensBalances()
  * (...)
  * await resetTokenBalances()
  */
-export function useResetTokensBalances(tokens?: MezoChainToken[]) {
+export function useResetTokensBalances() {
   const queryClient = useQueryClient()
 
-  const { queryKey } = useTokensBalances({ tokens })
-
-  const resetTokenBalancesHandler = useCallback(
-    () => queryClient.resetQueries({ queryKey }),
-    [queryClient, queryKey],
-  )
+  const resetTokenBalancesHandler = () =>
+    queryClient.resetQueries({ queryKey: [TOKEN_BALANCES_QUERY_KEY] })
 
   return {
     resetTokenBalances: resetTokenBalancesHandler,

package/src/hooks/useWalletAccount.ts

@@ -1,51 +1,42 @@
 import { OrangeKitConnector } from "@mezo-org/orangekit"
 import { useQuery } from "@tanstack/react-query"
-import { useMemo } from "react"
-import { Address } from "viem"
 import { Connector, useAccount } from "wagmi"
 
-type UseWalletAccountReturn = {
-  accountAddress?: Address
-  walletAddress?: string
-  isConnected: boolean
-  networkFamily: "bitcoin" | "evm"
-  connector?: Connector
-  chainId?: number
-}
+export const WALLET_ACCOUNT_QUERY_KEY = "passport.walletAccount"
+
+const getBitcoinProviderFromConnector = (connector: Connector) =>
+  connector.type === "orangekit"
+    ? (connector as unknown as OrangeKitConnector)?.getBitcoinProvider()
+    : undefined
 
-export default function useWalletAccount(): UseWalletAccountReturn {
-  const { address: evmAddress, connector, chainId } = useAccount()
+// TODO: Rename to `usePassportAccount`
 
-  const networkFamily = useMemo(
-    () => (connector?.type !== "orangekit" ? "evm" : "bitcoin"),
-    [connector],
-  )
+export default function useWalletAccount() {
+  const { address: evmAddress, connector, chainId, isConnected } = useAccount()
 
-  const { data: btcData } = useQuery({
-    queryKey: [connector?.id],
+  return useQuery({
+    queryKey: [WALLET_ACCOUNT_QUERY_KEY, evmAddress, chainId],
+    enabled: !!evmAddress,
     queryFn: async () => {
-      const bitcoinProvider = (
-        connector as unknown as OrangeKitConnector
-      ).getBitcoinProvider()
+      if (!evmAddress || !connector || !chainId) {
+        throw new Error("Failed to retrieve wallet account information")
+      }
 
-      const address = await bitcoinProvider.getAddress()
-      const balance = await bitcoinProvider.getBalance()
+      const bitcoinProvider = getBitcoinProviderFromConnector(connector)
+      const btcAddress = await bitcoinProvider?.getAddress()
+
+      const walletAddress = btcAddress ?? evmAddress
+      const networkFamily: "evm" | "bitcoin" =
+        connector.type !== "orangekit" ? "evm" : "bitcoin"
 
       return {
-        address,
-        balance,
+        accountAddress: evmAddress,
+        walletAddress,
+        isConnected,
+        networkFamily,
+        connector,
+        chainId,
       }
     },
   })
-
-  const { address: btcAddress } = btcData || {}
-
-  return {
-    accountAddress: evmAddress,
-    walletAddress: btcAddress ?? evmAddress,
-    isConnected: networkFamily === "bitcoin" ? !!btcAddress : !!evmAddress,
-    networkFamily,
-    connector,
-    chainId,
-  } as const
 }

package/src/index.ts

@@ -9,7 +9,6 @@ export {
   xverseWalletMezoTestnet,
   getDefaultWallets,
   getConfig,
-  safeWalletConnectWallet,
 } from "./config"
 export * from "./constants"
 export * from "./hooks"

package/src/lib/contracts/index.ts

@@ -25,6 +25,8 @@ import xsolvbtcTestnet from "@mezo-org/mezod-contracts/deployments/testnet/mxSol
 import musdTestnet from "@mezo-org/musd-contracts/deployments/matsnet/MUSD.json"
 import troveManagerTestnet from "@mezo-org/musd-contracts/deployments/matsnet/TroveManager.json"
 import borrowerOperationsTestnet from "@mezo-org/musd-contracts/deployments/matsnet/BorrowerOperations.json"
+import priceFeed from "@mezo-org/musd-contracts/deployments/mainnet/PriceFeed.json"
+import priceFeedTestnet from "@mezo-org/musd-contracts/deployments/matsnet/PriceFeed.json"
 
 import { Abi, Address } from "viem"
 
@@ -41,7 +43,10 @@ export type MezoChainToken =
   | "mxSolvBTC"
   | "MUSD"
 
-export type MezoBorrowContract = "TroveManager" | "BorrowerOperations"
+export type MezoBorrowContract =
+  | "TroveManager"
+  | "BorrowerOperations"
+  | "PriceFeed"
 
 type ContractsMap<K extends string> = Record<
   K,
@@ -82,11 +87,13 @@ export const mainnetTokenContracts = {
 export const mainnetBorrowContracts = {
   TroveManager: troveManagerMainnet,
   BorrowerOperations: borrowerOperationsMainnet,
+  PriceFeed: priceFeed,
 } as unknown as ContractsMap<MezoBorrowContract>
 
 export const testnetBorrowContracts = {
   TroveManager: troveManagerTestnet,
   BorrowerOperations: borrowerOperationsTestnet,
+  PriceFeed: priceFeedTestnet,
 } as unknown as ContractsMap<MezoBorrowContract>
 
 export { default as priceOracleContract } from "./priceOracle"