@mezo-org/passport 0.4.0-dev.5 → 0.4.0-dev.51

package/src/hooks/useGetCurrentAccount.ts

@@ -1,20 +1,60 @@
-import { useQuery, UseBaseQueryOptions } from "@tanstack/react-query"
-import { useAuthApiClient } from "./useAuthApiClient"
-import { QUERY_KEYS } from "./constants"
+import { UseBaseQueryOptions, useQuery } from "@tanstack/react-query"
 import { ONE_MINUTE_MS } from "../utils/time"
-import { GetCurrentAccountResponse } from "../api/auth"
+import { QUERY_KEYS } from "./constants"
+import { useAuthApiClient } from "./useAuthApiClient"
+import { usePortalApiClient } from "./usePortalApiClient"
+import type { GetCurrentAccountResponse } from "../api"
+
+type GetCurrentAccountResponseWithMats = GetCurrentAccountResponse & {
+  mats: {
+    totalMats: number
+  }
+}
 
 export function useGetCurrentAccount(
   queryOptions: Omit<
-    UseBaseQueryOptions<GetCurrentAccountResponse>,
+    UseBaseQueryOptions<GetCurrentAccountResponseWithMats>,
     "queryKey" | "queryFn"
   > = {},
 ) {
   const authApiClient = useAuthApiClient()
+  const portalApiClient = usePortalApiClient()
 
   return useQuery({
     queryKey: [QUERY_KEYS.ACCOUNT, QUERY_KEYS.CURRENT],
-    queryFn: () => authApiClient.getCurrentAccount(),
+    queryFn: async () => {
+      const currentAccount = await authApiClient.getCurrentAccount()
+      const linkedWallets = currentAccount?.linkedAccounts?.filter(
+        (account) => account.type === "wallet",
+      )
+      if (!linkedWallets || linkedWallets.length === 0) {
+        return {
+          ...currentAccount,
+          mats: {
+            totalMats: 0,
+          },
+        }
+      }
+
+      const addresses = linkedWallets.map(
+        (account) => account.btcAddress || account.evmAddress,
+      )
+      const mats = await Promise.all(
+        addresses.map((address) => portalApiClient.getPortalMats(address)),
+      )
+
+      const totalMats = mats.reduce(
+        (sumMats, currentMats) => sumMats + currentMats.totalMats,
+        0,
+      )
+
+      return {
+        ...currentAccount,
+        mats: {
+          totalMats,
+        },
+      }
+    },
     staleTime: ONE_MINUTE_MS,
     retry: 1,
     ...queryOptions,

package/src/hooks/useGetSession.ts

@@ -2,7 +2,7 @@ import { useQuery, UseBaseQueryOptions } from "@tanstack/react-query"
 import { useAuthApiClient } from "./useAuthApiClient"
 import { QUERY_KEYS } from "./constants"
 import { ONE_MINUTE_MS } from "../utils/time"
-import { GetSessionResponse } from "../api/auth"
+import type { GetSessionResponse } from "../api"
 
 export function useGetSession(
   code?: string,

package/src/hooks/useLinkAccount.ts

@@ -1,19 +1,32 @@
-import { useQueryClient, useMutation } from "@tanstack/react-query"
+import {
+  useQueryClient,
+  useMutation,
+  MutationOptions,
+  DefaultError,
+} from "@tanstack/react-query"
 import { useAuthApiClient } from "./useAuthApiClient"
-import { LinkAccountRequest } from "../api/auth"
+import type { LinkAccountRequest, LinkAccountResponse } from "../api"
 import { QUERY_KEYS } from "./constants"
 
-export function useLinkAccount(useMutationOptions = {}) {
+export function useLinkAccount(
+  mutationOptions: Omit<
+    MutationOptions<LinkAccountResponse, DefaultError, LinkAccountRequest>,
+    "mutationFn" | "mutationKey"
+  > = {},
+) {
   const queryClient = useQueryClient()
   const authApiClient = useAuthApiClient()
 
+  const { onSuccess: customOnSuccess, ...restMutationOptions } = mutationOptions
+
   const { mutate, mutateAsync, ...rest } = useMutation({
     mutationFn: (linkAccountRequest: LinkAccountRequest) =>
       authApiClient.linkAccount(linkAccountRequest),
-    onSuccess: () => {
+    onSuccess: (data, variables, context) => {
       queryClient.resetQueries({ queryKey: [QUERY_KEYS.ACCOUNT] })
+      if (customOnSuccess) customOnSuccess(data, variables, context)
     },
-    ...useMutationOptions,
+    ...restMutationOptions,
   })
 
   return { linkAccount: mutate, linkAccountAsync: mutateAsync, ...rest }

package/src/hooks/usePortalApiClient.ts

@@ -0,0 +1,6 @@
+import { usePassportContext } from "./usePassportContext"
+
+export function usePortalApiClient() {
+  const { portalApiClient } = usePassportContext()
+  return portalApiClient
+}

package/src/hooks/useRefreshPassport.ts

@@ -0,0 +1,56 @@
+import { useQueryClient } from "@tanstack/react-query"
+import { useCallback } from "react"
+import { useAccount, useBalance } from "wagmi"
+import { QUERY_KEYS } from "./constants"
+import { useInvalidateBorrowData } from "./useBorrowData"
+import { useInvalidateTokensBalances } from "./useTokensBalances"
+
+/**
+ * Hook to refresh the passport using query invalidation mechanism.
+ * By calling the refresh function, the latest data will be refetched as soon as possible.
+ *
+ * @example
+ * const { refreshCurrentAccount, refreshUsdConversion } = useRefreshPassport()
+ *
+ * // Call this function to refresh the current account
+ * const handlerefreshCurrentAccount = async () => {
+ *   await refreshCurrentAccount()
+ * }
+ */
+export function useRefreshPassport() {
+  const { address } = useAccount()
+  const queryClient = useQueryClient()
+  const { invalidateBorrowData } = useInvalidateBorrowData()
+  const { invalidateTokensBalances } = useInvalidateTokensBalances()
+  const { queryKey: nativeTokenQueryKey } = useBalance({ address })
+
+  const refreshCurrentAccount = useCallback(
+    () =>
+      queryClient.invalidateQueries({
+        queryKey: [QUERY_KEYS.ACCOUNT, QUERY_KEYS.CURRENT],
+      }),
+    [queryClient],
+  )
+
+  const refreshUsdConversion = useCallback(
+    () =>
+      queryClient.invalidateQueries({
+        queryKey: [QUERY_KEYS.ASSETS_USD_CONVERSION],
+      }),
+    [queryClient],
+  )
+
+  const refreshTokensBalances = useCallback(async () => {
+    await queryClient.invalidateQueries({
+      queryKey: nativeTokenQueryKey,
+    })
+    await invalidateTokensBalances()
+  }, [queryClient, nativeTokenQueryKey, invalidateTokensBalances])
+
+  return {
+    refreshCurrentAccount,
+    refreshUsdConversion,
+    refreshBorrowData: invalidateBorrowData,
+    refreshTokensBalances,
+  }
+}

package/src/hooks/useSignInWithDiscord.ts

@@ -1,19 +1,28 @@
-import { useMutation } from "@tanstack/react-query"
+import { MutationOptions, useMutation } from "@tanstack/react-query"
 import { useCreateSession } from "./useCreateSession"
 import { useEnsureNoSessionAndFetchNonce } from "./useEnsureNoSessionAndFetchNonce"
+import type { AuthenticationProviderRedirectResponse } from "../api"
 
-function useSignInWithDiscord() {
+function useSignInWithDiscord(
+  mutationOptions: Omit<
+    MutationOptions<AuthenticationProviderRedirectResponse>,
+    "mutationFn" | "mutationKey"
+  > = {},
+) {
   const { ensureNoSessionAndFetchNonce } = useEnsureNoSessionAndFetchNonce()
   const { createSessionAsync } = useCreateSession()
 
   const { mutate, mutateAsync, ...signInMutationRestParameters } = useMutation({
-    mutationFn: async () => {
+    mutationFn: async (): Promise<AuthenticationProviderRedirectResponse> => {
       await ensureNoSessionAndFetchNonce()
 
-      return createSessionAsync({
+      return (await createSessionAsync({
         type: "discord",
-      })
+      })) as AuthenticationProviderRedirectResponse
+      // ^ By passing type: "discord" we know for sure the return type is
+      // AuthenticationProviderRedirectResponse
     },
+    ...mutationOptions,
   })
 
   return {

package/src/hooks/useSignInWithWallet.ts

@@ -1,8 +1,15 @@
+import { MutationOptions } from "@tanstack/react-query"
 import { useAuthenticateWithWallet } from "./useAuthenticateWithWallet"
+import type { Session } from "../api"
 
-function useSignInWithWallet() {
+function useSignInWithWallet(
+  mutationOptions: Omit<
+    MutationOptions<Session>,
+    "mutationFn" | "mutationKey"
+  > = {},
+) {
   const { authenticateWithWallet, authenticateWithWalletAsync, ...rest } =
-    useAuthenticateWithWallet()
+    useAuthenticateWithWallet(false, mutationOptions)
 
   return {
     signInWithWallet: authenticateWithWallet,

package/src/hooks/useSignOut.ts

@@ -1,20 +1,34 @@
-import { useMutation, useQueryClient } from "@tanstack/react-query"
+import {
+  MutationOptions,
+  useMutation,
+  useQueryClient,
+} from "@tanstack/react-query"
 import { useAuthApiClient } from "./useAuthApiClient"
 import { QUERY_KEYS } from "./constants"
+import type { DeleteSessionResponse } from "../api"
 
-export function useSignOut(useMutationOptions = {}) {
+export function useSignOut(
+  mutationOptions: Omit<
+    MutationOptions<DeleteSessionResponse>,
+    "mutationFn" | "mutationKey"
+  > = {},
+) {
   const queryClient = useQueryClient()
   const authApiClient = useAuthApiClient()
 
+  const { onSuccess: customOnSuccess, ...restMutationOptions } = mutationOptions
+
   const { mutate, mutateAsync, ...rest } = useMutation({
     mutationFn: () => authApiClient.deleteSession(),
-    onSuccess: () => {
+    onSuccess: (data, variables, context) => {
       queryClient.resetQueries({ queryKey: [QUERY_KEYS.SESSION] })
       queryClient.resetQueries({
         queryKey: [QUERY_KEYS.ACCOUNT, QUERY_KEYS.CURRENT],
       })
+
+      if (customOnSuccess) customOnSuccess(data, variables, context)
     },
-    ...useMutationOptions,
+    ...restMutationOptions,
   })
 
   return { signOut: mutate, signOutAsync: mutateAsync, ...rest }

package/src/hooks/useSignUpWithWallet.ts

@@ -1,8 +1,15 @@
+import { MutationOptions } from "@tanstack/react-query"
 import { useAuthenticateWithWallet } from "./useAuthenticateWithWallet"
+import type { Session } from "../api"
 
-function useSignUpWithWallet() {
+function useSignUpWithWallet(
+  mutationOptions: Omit<
+    MutationOptions<Session>,
+    "mutationFn" | "mutationKey"
+  > = {},
+) {
   const { authenticateWithWallet, authenticateWithWalletAsync, ...rest } =
-    useAuthenticateWithWallet({ signUp: true })
+    useAuthenticateWithWallet(true, mutationOptions)
 
   return {
     signUpWithWallet: authenticateWithWallet,

package/src/hooks/useTokensBalances.ts

@@ -0,0 +1,187 @@
+import { useReadContracts } from "wagmi"
+import { useCallback, useMemo } from "react"
+import { Abi } from "viem"
+import { useQueryClient } from "@tanstack/react-query"
+import { usePassportContext } from "./usePassportContext"
+import {
+  mainnetTokenContracts,
+  testnetTokenContracts,
+  MezoChainToken,
+} from "../lib/contracts"
+import useWalletAccount from "./useWalletAccount"
+import { CHAIN_ID } from "../constants"
+
+// Wagmi handles typesafety with ABI const assertions. TypeScript doesn't
+// support importing JSON as const yet so types cannot be inferred from the
+// imported contract. As a workaround there is minimal ABI definition that can
+// be asserted types from.
+// Ref: https://wagmi.sh/core/typescript#const-assert-abis-typed-data
+
+const BALANCE_OF_ABI = [
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "account",
+        type: "address",
+      },
+    ],
+    name: "balanceOf",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+] as const satisfies Abi
+
+const BALANCE_TOKENS: MezoChainToken[] = [
+  "mcbBTC",
+  "mDAI",
+  "mFBTC",
+  "mSolvBTC",
+  "mswBTC",
+  "mT",
+  "mUSDC",
+  "mUSDe",
+  "mUSDT",
+  "mxSolvBTC",
+  "MUSD",
+]
+
+type UseMezoChainTokensBalancesOptions<T> = {
+  tokens?: T
+  queryOptions?: object
+}
+
+/**
+ * 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
+ *          fallback to all tokens if not provided.
+ * @param   options.queryOptions The query options to pass to the
+ *          `useReadContracts`
+ * @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"]
+ */
+export function useTokensBalances<T extends MezoChainToken[]>(
+  options: UseMezoChainTokensBalancesOptions<T> = {},
+) {
+  const { environment = "mainnet" } = usePassportContext()
+
+  const { accountAddress } = useWalletAccount()
+
+  const contractsMap = useMemo(() => {
+    const contracts =
+      environment === "mainnet" ? mainnetTokenContracts : testnetTokenContracts
+
+    const tokenContracts = Object.fromEntries(
+      Object.entries(contracts).filter(([key]) =>
+        BALANCE_TOKENS.includes(key as MezoChainToken),
+      ),
+    ) as typeof contracts
+
+    return tokenContracts
+  }, [environment])
+
+  const { tokens = Object.keys(contractsMap) as T, queryOptions = {} } = options
+
+  const contracts = useMemo(() => {
+    if (!accountAddress) return []
+
+    return tokens.map((token) => {
+      const { address } = contractsMap[token]
+
+      return {
+        address,
+        abi: BALANCE_OF_ABI,
+        functionName: "balanceOf",
+        args: [accountAddress],
+        chainId: CHAIN_ID[environment],
+      }
+    })
+  }, [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>,
+        ),
+      ...queryOptions,
+    },
+  })
+}
+
+/**
+ * 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"])
+ * (...)
+ * await invalidateTokenBalances()
+ */
+export function useInvalidateTokensBalances(tokens?: MezoChainToken[]) {
+  const queryClient = useQueryClient()
+
+  const { queryKey } = useTokensBalances({ tokens })
+
+  const invalidateTokensBalancesHandler = useCallback(
+    () => queryClient.invalidateQueries({ queryKey }),
+    [queryClient, queryKey],
+  )
+
+  return {
+    invalidateTokensBalances: invalidateTokensBalancesHandler,
+  }
+}
+
+/**
+ * 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"])
+ * (...)
+ * await resetTokenBalances()
+ */
+export function useResetTokensBalances(tokens?: MezoChainToken[]) {
+  const queryClient = useQueryClient()
+
+  const { queryKey } = useTokensBalances({ tokens })
+
+  const resetTokenBalancesHandler = useCallback(
+    () => queryClient.resetQueries({ queryKey }),
+    [queryClient, queryKey],
+  )
+
+  return {
+    resetTokenBalances: resetTokenBalancesHandler,
+  }
+}

package/src/hooks/useUpdateMezoId.ts

@@ -1,17 +1,32 @@
-import { useQueryClient, useMutation } from "@tanstack/react-query"
+import {
+  useQueryClient,
+  useMutation,
+  MutationOptions,
+  DefaultError,
+} from "@tanstack/react-query"
 import { useAuthApiClient } from "./useAuthApiClient"
 import { QUERY_KEYS } from "./constants"
+import type { UpdateMezoIdResponse } from "../api"
 
-export function useUpdateMezoId(useMutationOptions = {}) {
+export function useUpdateMezoId(
+  mutationOptions: Omit<
+    MutationOptions<UpdateMezoIdResponse, DefaultError, string>,
+    "mutationFn" | "mutationKey"
+  > = {},
+) {
   const queryClient = useQueryClient()
   const authApiClient = useAuthApiClient()
 
+  const { onSuccess: customOnSuccess, ...restMutationOptions } = mutationOptions
+
   const { mutate, mutateAsync, ...rest } = useMutation({
     mutationFn: (newMezoId: string) => authApiClient.updateMezoId(newMezoId),
-    onSuccess: () => {
+    onSuccess: (data, variables, context) => {
       queryClient.resetQueries({ queryKey: [QUERY_KEYS.ACCOUNT] })
+
+      if (customOnSuccess) customOnSuccess(data, variables, context)
     },
-    ...useMutationOptions,
+    ...restMutationOptions,
   })
 
   return { updateMezoId: mutate, updateMezoIdAsync: mutateAsync, ...rest }

package/src/hooks/useWalletAccount.ts

@@ -0,0 +1,55 @@
+import { OrangeKitBitcoinProvider } 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
+}
+
+type OrangeKitConnector = {
+  getBitcoinProvider: () => OrangeKitBitcoinProvider
+}
+
+export default function useWalletAccount(): UseWalletAccountReturn {
+  const { address: evmAddress, connector, chainId } = useAccount()
+
+  const networkFamily = useMemo(
+    () => (connector?.type !== "orangekit" ? "evm" : "bitcoin"),
+    [connector],
+  )
+
+  const { data: btcData } = useQuery({
+    queryKey: [connector?.id],
+    queryFn: async () => {
+      const bitcoinProvider = (
+        connector as unknown as OrangeKitConnector
+      ).getBitcoinProvider()
+
+      const address = await bitcoinProvider.getAddress()
+      const balance = await bitcoinProvider.getBalance()
+
+      return {
+        address,
+        balance,
+      }
+    },
+  })
+
+  const { address: btcAddress } = btcData || {}
+
+  return {
+    accountAddress: evmAddress,
+    walletAddress: btcAddress ?? evmAddress,
+    isConnected: networkFamily === "bitcoin" ? !!btcAddress : !!evmAddress,
+    networkFamily,
+    connector,
+    chainId,
+  } as const
+}

package/src/hooks/useWatchTransferEvents.ts

@@ -0,0 +1,74 @@
+import { useMemo } from "react"
+import { useAccount, useWatchContractEvent } from "wagmi"
+import {
+  mainnetTokenContracts,
+  MezoChainToken,
+  testnetTokenContracts,
+} from "../lib/contracts"
+import { usePassportContext } from "./usePassportContext"
+import { CHAIN_ID } from "../constants"
+import { useRefreshPassport } from "./useRefreshPassport"
+import { simpleWssMezoConfig } from "../config"
+
+function useWatchTransferEvents(token: MezoChainToken) {
+  const { address: userAddress } = useAccount()
+  const { environment = "mainnet" } = usePassportContext()
+  const { refreshTokensBalances, refreshBorrowData } = useRefreshPassport()
+
+  const contract = useMemo(() => {
+    const contracts =
+      environment === "mainnet" ? mainnetTokenContracts : testnetTokenContracts
+
+    return contracts[token]
+  }, [environment, token])
+
+  useWatchContractEvent({
+    address: contract.address,
+    abi: contract.abi,
+    eventName: "Transfer",
+    args: {
+      from: userAddress,
+    },
+    chainId: CHAIN_ID[environment],
+    enabled: !!userAddress,
+    config: simpleWssMezoConfig,
+    onLogs() {
+      console.log(`[${token}] Transfer from: ${userAddress}`)
+      refreshTokensBalances()
+      refreshBorrowData()
+    },
+  })
+
+  useWatchContractEvent({
+    address: contract.address,
+    abi: contract.abi,
+    eventName: "Transfer",
+    args: {
+      to: userAddress,
+    },
+    chainId: CHAIN_ID[environment],
+    enabled: !!userAddress,
+    config: simpleWssMezoConfig,
+    onLogs() {
+      console.log(`[${token}] Transfer to: ${userAddress}`)
+      refreshTokensBalances()
+      refreshBorrowData()
+    },
+  })
+}
+
+function useWatchTransferEventsForAllTokens() {
+  useWatchTransferEvents("mcbBTC")
+  useWatchTransferEvents("mDAI")
+  useWatchTransferEvents("mFBTC")
+  useWatchTransferEvents("mSolvBTC")
+  useWatchTransferEvents("mswBTC")
+  useWatchTransferEvents("mT")
+  useWatchTransferEvents("mUSDC")
+  useWatchTransferEvents("mUSDe")
+  useWatchTransferEvents("mUSDT")
+  useWatchTransferEvents("mxSolvBTC")
+  useWatchTransferEvents("MUSD")
+}
+
+export { useWatchTransferEvents, useWatchTransferEventsForAllTokens }

package/src/index.ts

@@ -1,4 +1,15 @@
-export * from "./config"
+export * from "./components"
+export {
+  defaultConfig,
+  unisatWalletMezoMainnet,
+  unisatWalletMezoTestnet,
+  okxWalletMezoMainnet,
+  okxWalletMezoTestnet,
+  xverseWalletMezoMainnet,
+  xverseWalletMezoTestnet,
+  getDefaultWallets,
+  getConfig,
+} from "./config"
 export * from "./constants"
 export * from "./hooks"
 export * from "./provider"