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

package/src/components/Dropdown/AccountAssets.tsx

@@ -0,0 +1,110 @@
+import {
+  Block,
+  LabelSmall,
+  ParagraphSmall,
+  useStyletron,
+} from "@mezo-org/mezo-clay"
+import React, { useMemo } from "react"
+import { CryptoAssetKey, getCryptoAsset } from "../../utils/cryptoAssets"
+import { formatUsd } from "../../utils/currency"
+
+type AccountAssetsProps = {
+  label: string | React.ReactNode
+  assets: {
+    type: CryptoAssetKey
+    decimals: number
+    balance: number
+    balanceInUsd: number
+  }[]
+}
+
+export default function AccountAssets(props: AccountAssetsProps) {
+  const { label, assets } = props
+
+  const [, theme] = useStyletron()
+
+  const assetsData = useMemo(
+    () =>
+      assets.map((token) => {
+        const { name, symbol, icon } = getCryptoAsset(token.type)
+
+        return {
+          ...token,
+          icon,
+          label: name,
+          symbol,
+        }
+      }),
+    [assets],
+  )
+
+  const labelContent =
+    typeof label === "string" ? (
+      <ParagraphSmall margin={0} color={theme.colors.gray800}>
+        {label}
+      </ParagraphSmall>
+    ) : (
+      label
+    )
+
+  if (assetsData.length === 0) {
+    return null
+  }
+
+  return (
+    <Block padding={`0 ${theme.sizing.scale500}`}>
+      <Block margin={`${theme.sizing.scale400} 0`}>{labelContent}</Block>
+
+      <Block
+        as="ul"
+        marginBottom={theme.sizing.scale600}
+        padding={0}
+        display="flex"
+        flexDirection="column"
+        overrides={{
+          Block: {
+            style: {
+              gap: theme.sizing.scale100,
+            },
+          },
+        }}
+      >
+        {assetsData.map((asset) => (
+          <Block
+            as="li"
+            key={`${asset.type}-${asset.balance}`}
+            display="flex"
+            justifyContent="space-between"
+            alignItems="center"
+            margin={`${theme.sizing.scale100} 0`}
+          >
+            <asset.icon
+              size={theme.sizing.scale800}
+              overrides={{
+                Svg: {
+                  style: {
+                    marginRight: theme.sizing.scale500,
+                  },
+                },
+              }}
+            />
+
+            <Block flex={1}>
+              <LabelSmall margin={0}>{asset.label}</LabelSmall>
+              <ParagraphSmall margin={0} color={theme.colors.gray500}>
+                {asset.symbol}
+              </ParagraphSmall>
+            </Block>
+
+            <Block display="flex" alignItems="end" flexDirection="column">
+              <LabelSmall margin={0}>{asset.balance}</LabelSmall>
+              <ParagraphSmall margin={0} color={theme.colors.gray500}>
+                {formatUsd(asset.balanceInUsd)}
+              </ParagraphSmall>
+            </Block>
+          </Block>
+        ))}
+      </Block>
+    </Block>
+  )
+}

package/src/components/Dropdown/AccountBalance.tsx

@@ -0,0 +1,38 @@
+import {
+  Block,
+  HeadingSmall,
+  ParagraphSmall,
+  useStyletron,
+} from "@mezo-org/mezo-clay"
+import React from "react"
+import { formatUsd } from "../../utils/currency"
+
+type AccountBalanceProps = {
+  amount: number
+}
+
+export default function AccountBalance(props: AccountBalanceProps) {
+  const { amount } = props
+
+  const formattedUsdBalance = formatUsd(amount)
+
+  const [, theme] = useStyletron()
+
+  return (
+    <Block
+      padding={theme.sizing.scale500}
+      overrides={{
+        Block: {
+          style: {
+            borderBottom: `1px solid ${theme.colors.backgroundPrimary}`,
+          },
+        },
+      }}
+    >
+      <ParagraphSmall margin={0} color={theme.colors.gray800}>
+        Available balance
+      </ParagraphSmall>
+      <HeadingSmall margin={0}>{formattedUsdBalance}</HeadingSmall>
+    </Block>
+  )
+}

package/src/components/Dropdown/ConnectedTrigger.tsx

@@ -0,0 +1,56 @@
+import { Block, ButtonProps, useStyletron } from "@mezo-org/mezo-clay"
+import React, { forwardRef, ReactNode } from "react"
+
+type ConnectedTriggerProps = Omit<ButtonProps, "children"> & {
+  avatar: ReactNode
+}
+
+const ConnectedTrigger = forwardRef<HTMLButtonElement, ConnectedTriggerProps>(
+  (props, ref) => {
+    const { onClick, avatar, ...restProps } = props
+
+    const [, theme] = useStyletron()
+
+    return (
+      <Block
+        as="button"
+        overrides={{
+          Block: {
+            props: { ref, ...restProps },
+            style: {
+              border: "none",
+              background: "none",
+              padding: 0,
+              margin: 0,
+              cursor: "pointer",
+            },
+          },
+        }}
+        onClick={onClick}
+      >
+        <Block
+          width={theme.sizing.scale950}
+          height={theme.sizing.scale950}
+          overrides={{
+            Block: {
+              style: {
+                borderRadius: "100%",
+                border: `2px solid ${theme.colors.contentPrimary}`,
+                boxSizing: "border-box",
+                overflow: "hidden",
+              },
+            },
+          }}
+        >
+          {typeof avatar === "string" ? (
+            <Block as="img" src={avatar} alt="" />
+          ) : (
+            avatar
+          )}
+        </Block>
+      </Block>
+    )
+  },
+)
+
+export default ConnectedTrigger

package/src/components/Dropdown/Content.tsx

@@ -0,0 +1,142 @@
+import {
+  Block,
+  Button,
+  LogOut01,
+  Mats,
+  ParagraphSmall,
+  useStyletron,
+} from "@mezo-org/mezo-clay"
+import React, { useCallback } from "react"
+import { useDisconnect } from "wagmi"
+import { useSignOut } from "../../hooks"
+import { DropdownData } from "../../hooks/useDropdownData"
+import AccountAddress from "./AccountAddress"
+import AccountAssets from "./AccountAssets"
+import AccountBalance from "./AccountBalance"
+import WelcomeBlock from "./WelcomeBlock"
+
+function MatsnetLabel() {
+  const [, theme] = useStyletron()
+  return (
+    <ParagraphSmall color={theme.colors.contentTertiary}>
+      <Mats
+        color="currentColor"
+        size={theme.sizing.scale400}
+        overrides={{
+          Svg: {
+            style: {
+              marginRight: theme.sizing.scale300,
+            },
+          },
+        }}
+      />
+      Matsnet Assets
+    </ParagraphSmall>
+  )
+}
+
+type DropdownContentProps = {
+  data: DropdownData
+}
+
+export default function DropdownContent(props: DropdownContentProps) {
+  const { data } = props
+
+  const [, theme] = useStyletron()
+
+  const {
+    mezoId,
+    address,
+    walletType,
+    totalBalanceInUsd,
+    formattedNativeAssets,
+    matsnet,
+  } = data
+
+  const { disconnect } = useDisconnect()
+  const { signOut } = useSignOut()
+
+  const handleLogOut = useCallback(() => {
+    signOut()
+    disconnect()
+  }, [signOut, disconnect])
+
+  return (
+    <Block
+      display="inline-flex"
+      flexDirection="column"
+      backgroundColor={theme.colors.backgroundPrimary}
+      padding={theme.sizing.scale500}
+      width="100%"
+      overrides={{
+        Block: {
+          style: {
+            boxSizing: "border-box",
+          },
+        },
+      }}
+    >
+      <WelcomeBlock mezoId={mezoId} matsBalance={matsnet.mats} />
+
+      <Block
+        display="flex"
+        flexDirection="column"
+        backgroundColor={theme.colors.backgroundSecondary}
+        overflow="hidden"
+        overrides={{
+          Block: { style: { borderRadius: theme.borders.radius300 } },
+        }}
+      >
+        <AccountAddress address={address} type={walletType} />
+
+        <AccountBalance amount={totalBalanceInUsd} />
+
+        <AccountAssets label="Assets" assets={formattedNativeAssets} />
+      </Block>
+
+      {matsnet.formattedAssets.length > 0 && (
+        <Block
+          marginTop={theme.sizing.scale600}
+          backgroundColor={theme.colors.backgroundSecondary}
+          overflow="hidden"
+          overrides={{
+            Block: { style: { borderRadius: theme.borders.radius300 } },
+          }}
+        >
+          <AccountAssets
+            label={<MatsnetLabel />}
+            assets={matsnet.formattedAssets}
+          />
+        </Block>
+      )}
+
+      <Block
+        marginTop={theme.sizing.scale700}
+        padding={`0 ${theme.sizing.scale100}`}
+      >
+        <Button
+          size="small"
+          kind="tertiary"
+          startEnhancer={<LogOut01 color="currentColor" size={12} />}
+          onClick={() => handleLogOut()}
+          overrides={{
+            Root: {
+              style: {
+                ":hover": {
+                  backgroundColor: theme.colors.backgroundSecondary,
+                  boxShadow: "none",
+                },
+                ":active": {
+                  backgroundColor: theme.colors.backgroundSecondary,
+                  color: theme.colors.contentPrimary,
+                },
+              },
+            },
+          }}
+        >
+          Log out
+        </Button>
+      </Block>
+    </Block>
+  )
+}

package/src/components/Dropdown/DisconnectedTrigger.tsx

@@ -0,0 +1,35 @@
+import { Button, ButtonProps, LogIn01, useStyletron } from "@mezo-org/mezo-clay"
+import React, { forwardRef } from "react"
+
+type DisconnectedTriggerProps = Omit<ButtonProps, "children"> & {
+  children: string
+}
+
+const DisconnectedTrigger = forwardRef<
+  HTMLButtonElement,
+  DisconnectedTriggerProps
+>((props, ref) => {
+  const { onClick, children, ...restProps } = props
+
+  const [, theme] = useStyletron()
+
+  return (
+    <Button
+      startEnhancer={
+        <LogIn01 color="currentColor" size={theme.sizing.scale600} />
+      }
+      overrides={{
+        Root: {
+          props: { ref, ...restProps },
+        },
+      }}
+      size="small"
+      shape="pill"
+      onClick={onClick}
+    >
+      {children}
+    </Button>
+  )
+})
+
+export default DisconnectedTrigger

package/src/components/Dropdown/Dropdown.tsx

@@ -0,0 +1,81 @@
+import {
+  StatefulPopover,
+  StatefulPopoverProps,
+  useStyletron,
+} from "@mezo-org/mezo-clay"
+import { useConnectModal } from "@rainbow-me/rainbowkit"
+import React from "react"
+import DefaultAvatar from "../../assets/DefaultAvatar"
+import useDropdownData, {
+  DropdownCryptoAsset,
+} from "../../hooks/useDropdownData"
+import useWalletAccount from "../../hooks/useWalletAccount"
+import ConnectedTrigger from "./ConnectedTrigger"
+import Content from "./Content"
+import DisconnectedTrigger from "./DisconnectedTrigger"
+
+export type DropdownProps = {
+  /** The callback to be called when the user clicks on the button in sign-in state */
+  onSignInClick?: () => void
+  /** The set of EVM native assets to be displayed in the dropdown */
+  evmNativeAssets?: DropdownCryptoAsset<"tbtc" | "wbtc">[]
+  /** The set of Matsnet assets to be displayed in the dropdown */
+  matsnetAssets?: DropdownCryptoAsset<"mbtc" | "musd">[]
+} & Omit<StatefulPopoverProps, "children" | "content">
+
+/**
+ * Passport Dropdown component that displays user's wallet and assets information.
+ * @param {DropdownProps} props - Component props.
+ * @returns {JSX.Element}
+ */
+export function Dropdown(props: DropdownProps) {
+  const {
+    placement = "bottomRight",
+    animateOutTime = 120,
+    onSignInClick,
+    evmNativeAssets,
+    matsnetAssets,
+    ...restProps
+  } = props
+
+  const [, theme] = useStyletron()
+
+  const dropdownData = useDropdownData({ evmNativeAssets, matsnetAssets })
+
+  const { openConnectModal } = useConnectModal()
+
+  const { isConnected } = useWalletAccount()
+
+  if (!dropdownData || !isConnected) {
+    return (
+      <DisconnectedTrigger
+        // If connect wallet flow is not provided it fallbacks to RainbowKit's
+        // connect modal
+        onClick={onSignInClick || openConnectModal}
+      >
+        Sign in
+      </DisconnectedTrigger>
+    )
+  }
+
+  return (
+    <StatefulPopover
+      content={<Content data={dropdownData} />}
+      placement={placement}
+      animateOutTime={animateOutTime}
+      overrides={{
+        Body: {
+          style: {
+            minWidth: "378px",
+            borderRadius: theme.borders.radius500,
+            boxShadow: theme.lighting.shadow500,
+            overflow: "hidden",
+          },
+        },
+      }}
+      {...restProps}
+    >
+      <ConnectedTrigger avatar={<DefaultAvatar />} />
+    </StatefulPopover>
+  )
+}

package/src/components/Dropdown/README.md

@@ -0,0 +1,46 @@
+# Passport Dropdown component
+
+This component is a layer of interaction with Passport API in form of Dropdown
+component. It allows to establish the session and interact with the API.
+
+## Props
+
+- `onSignInClick` (`() => void`) - The callback to be exected on trigger click
+  when the state is disconnected, it's optional since by default it triggers the
+  [Rainbow Kit's wallet connection modal](https://www.rainbowkit.com/docs/modal-hooks) -
+  **optional**
+- `evmNativeAssets` (`Asset<"tbtc" | "wbtc">[]`) - Array of Matsnet assets. -
+  **optional**
+- `matsnetAssets` (`Asset<"mbtc" | "musd">[]`) - Array of Matsnet assets. -
+  **optional**
+  ```ts
+  type Asset = {
+    type: "btc" | "tbtc" | "wbtc" | "mbtc" | "musd"
+    decimals: number
+    amount: {
+      token: bigint
+      usd: number
+    }
+  }
+  ```
+
+Besides that, component allows
+[Clay's `StatefulPopover` props](https://baseweb.design/components/popover/)
+excluding the `children` and `content`.
+
+## Overview
+
+The component has two distinguishable states - disconnected and connected. In
+disconnected state the component offers the trigger to initiate the connection
+flow. It can be fully customizable by providing your own one. As long as it's
+compliant with Wagmi/RainbowKit it will work. Component will automatically
+detect connected connector and change the state of component displaying the
+avatar thumbnail instead of button.
+
+Component has the following features:
+
+- displays wallet address that can be copied,
+- displays total balance in USD,
+- displays partial balances per asset with token amounts and USD conversions,
+- serves _Log out_ button which disconnects the wallet connector and closes
+  Passport API session.

package/src/components/Dropdown/WelcomeBlock.tsx

@@ -0,0 +1,92 @@
+import {
+  Block,
+  HeadingSmall,
+  LabelSmall,
+  Mats,
+  useStyletron,
+} from "@mezo-org/mezo-clay"
+import React from "react"
+import DefaultAvatar from "../../assets/DefaultAvatar"
+import { formatHumanReadableNumber } from "../../utils/numbers"
+
+const DOT_DELIMITER_REGEX = /(?=\.)/
+
+type WelcomeBlockProps = {
+  mezoId: string
+  matsBalance: number
+}
+
+export default function WelcomeBlock(props: WelcomeBlockProps) {
+  const { mezoId, matsBalance } = props
+
+  const [name, nameSuffix] = mezoId.split(DOT_DELIMITER_REGEX)
+  const [, theme] = useStyletron()
+
+  return (
+    <Block
+      display="flex"
+      alignItems="center"
+      padding={`${theme.sizing.scale600} 0`}
+      marginBottom={theme.sizing.scale300}
+      overrides={{
+        Block: {
+          style: {
+            gap: theme.sizing.scale600,
+          },
+        },
+      }}
+    >
+      <Block
+        as={DefaultAvatar}
+        width={theme.sizing.scale1200}
+        height={theme.sizing.scale1200}
+        overrides={{
+          Block: {
+            style: {
+              borderRadius: "100%",
+            },
+          },
+        }}
+      />
+
+      <Block
+        display="flex"
+        flexDirection="column"
+        overrides={{
+          Block: {
+            style: {
+              gap: theme.sizing.scale100,
+            },
+          },
+        }}
+      >
+        <HeadingSmall as="span">
+          <Block as="span">{name}</Block>
+          <Block as="span" color={theme.colors.gray500}>
+            {nameSuffix}
+          </Block>
+        </HeadingSmall>
+
+        <LabelSmall
+          display="flex"
+          alignItems="center"
+          margin={0}
+          color={theme.colors.contentTertiary}
+          overrides={{
+            Block: {
+              style: {
+                gap: theme.sizing.scale300,
+              },
+            },
+          }}
+        >
+          <Mats
+            color={theme.colors.contentPrimary}
+            size={theme.sizing.scale600}
+          />
+          {formatHumanReadableNumber(matsBalance, 0)}
+        </LabelSmall>
+      </Block>
+    </Block>
+  )
+}

package/src/components/Dropdown/index.ts

@@ -0,0 +1,2 @@
+export { Dropdown } from "./Dropdown"
+export type { DropdownProps } from "./Dropdown"

package/src/components/index.ts

@@ -0,0 +1 @@
+export { Dropdown, DropdownProps } from "./Dropdown"

package/src/hooks/constants.ts

@@ -2,4 +2,5 @@ export const QUERY_KEYS = {
   ACCOUNT: "account",
   SESSION: "session",
   CURRENT: "current",
+  ASSETS_USD_CONVERSION: "assetsUsdConversion",
 }

package/src/hooks/index.ts

@@ -6,7 +6,6 @@ export {
   useSubscribeToConnectorEvent,
   useSubscribeToWalletNetworkDoesNotMatchProviderChain,
 } from "@mezo-org/orangekit"
-export * from "./useCreateAccount"
 export * from "./useGetAccountByAddress"
 export * from "./useGetAccountByMezoId"
 export * from "./useGetCurrentAccount"
@@ -15,4 +14,5 @@ export * from "./useLinkAccount"
 export * from "./useSignInWithDiscord"
 export * from "./useSignInWithWallet"
 export * from "./useSignOut"
+export * from "./useSignUpWithWallet"
 export * from "./useUpdateMezoId"

package/src/hooks/useAssetsUSDConversion.ts

@@ -0,0 +1,31 @@
+import { UseBaseQueryOptions, useQuery } from "@tanstack/react-query"
+import { ONE_MINUTE_MS } from "../utils/time"
+import { QUERY_KEYS } from "./constants"
+import { usePortalApiClient } from "./usePortalApiClient"
+
+type AssetsUsdConversion = {
+  btcUsd: string
+  ethUsd: string
+}
+
+export function useAssetsUsdConversion(
+  useQueryOptions: Partial<UseBaseQueryOptions<AssetsUsdConversion>> = {},
+) {
+  const portalApiClient = usePortalApiClient()
+
+  return useQuery({
+    queryKey: [QUERY_KEYS.ASSETS_USD_CONVERSION],
+    queryFn: async () => {
+      const { currentUsdPerBtc, currentUsdPerEth } =
+        await portalApiClient.getPortalStatistics()
+
+      return {
+        btcUsd: currentUsdPerBtc,
+        ethUsd: currentUsdPerEth,
+      }
+    },
+    staleTime: 30 * ONE_MINUTE_MS,
+    retry: 1,
+    ...useQueryOptions,
+  })
+}