thirdweb 5.69.0 → 5.70.0-nightly-ecaa304a812188da3c81888bb52ca6064093c139-20241121000332

package/src/react/web/ui/prebuilt/Account/balance.tsx

@@ -0,0 +1,202 @@
+"use client";
+
+import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
+import type React from "react";
+import type { JSX } from "react";
+import type { Chain } from "../../../../../chains/types.js";
+import { useActiveWalletChain } from "../../../../../react/core/hooks/wallets/useActiveWalletChain.js";
+import {
+  type GetWalletBalanceResult,
+  getWalletBalance,
+} from "../../../../../wallets/utils/getWalletBalance.js";
+import { useAccountContext } from "./provider.js";
+
+/**
+ * Props for the AccountBalance component
+ * @component
+ * @account
+ */
+export interface AccountBalanceProps
+  extends Omit<React.HTMLAttributes<HTMLSpanElement>, "children"> {
+  /**
+   * The network to fetch balance on
+   * If not passed, the component will use the current chain that the wallet is connected to (`useActiveWalletChain()`)
+   */
+  chain?: Chain;
+  /**
+   * By default this component will fetch the balance for the native token on a given chain
+   * If you want to fetch balance for an ERC20 token, use the `tokenAddress` props
+   */
+  tokenAddress?: string;
+  /**
+   * A function to format the balance's display value
+   * use this function to transform the balance display value like round up the number
+   * Particularly useful to avoid overflowing-UI issues
+   */
+  formatFn?: (num: number) => number;
+  /**
+   * This component will be shown while the balance of the account is being fetched
+   * If not passed, the component will return `null`.
+   *
+   * You can/should pass a loading sign or spinner to this prop.
+   * @example
+   * ```tsx
+   * <AccountBalance
+   *   chain={ethereum}
+   *   loadingComponent={<Spinner />}
+   * />
+   * ```
+   */
+  loadingComponent?: JSX.Element;
+  /**
+   * This component will be shown if the balance fails to be retreived
+   * If not passed, the component will return `null`.
+   *
+   * You can/should pass a descriptive text/component to this prop, indicating that the
+   * balance was not fetched succesfully
+   * @example
+   * ```tsx
+   * <AccountBalance
+   *   chain={nonExistentChain}
+   *   fallbackComponent={"Failed to load"}
+   * />
+   * ```
+   */
+  fallbackComponent?: JSX.Element;
+  /**
+   * Optional `useQuery` params
+   */
+  queryOptions?: Omit<
+    UseQueryOptions<GetWalletBalanceResult>,
+    "queryFn" | "queryKey"
+  >;
+}
+
+/**
+ * This component fetches and shows the balance of the wallet address on a given chain.
+ * It inherits all the attributes of a HTML <span> component, hence you can style it just like how you would style a normal <span>
+ *
+ *
+ * @example
+ * ### Basic usage
+ * ```tsx
+ * import { AccountProvider, AccountBalance } from "thirdweb/react";
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * <AccountProvider address="0x...">
+ *   <AccountBalance chain={ethereum} />
+ * </AccountProvider>
+ * ```
+ * Result:
+ * ```html
+ * <span>1.091435 ETH</span>
+ * ```
+ *
+ *
+ * ### Format the balance (round up, shorten etc.)
+ * The AccountBalance component accepts a `formatFn` which takes in a number and outputs a number
+ * The function is used to modify the display value of the wallet balance
+ *
+ * ```tsx
+ * const roundTo1Decimal = (num: number):number => Math.round(num * 10) / 10;
+ *
+ * <AccountBalance formatFn={roundTo1Decimal} />
+ * ```
+ *
+ * Result:
+ * ```html
+ * <span>1.1 ETH</span>
+ * ```
+ *
+ * ### Show a loading sign when the balance is being fetched
+ * ```tsx
+ * import { AccountProvider, AccountBalance } from "thirdweb/react";
+ *
+ * <AccountProvider address="0x...">
+ *   <AccountBalance
+ *     chain={ethereum}
+ *     loadingComponent={<Spinner />}
+ *   />
+ * </AccountProvider>
+ * ```
+ *
+ * ### Fallback to something when the balance fails to resolve
+ * ```tsx
+ * <AccountProvider address="0x...">
+ *   <AccountBalance
+ *     chain={nonExistentChain}
+ *     fallbackComponent={"Failed to load"}
+ *   />
+ * </AccountProvider>
+ * ```
+ *
+ * ### Custom query options for useQuery
+ * This component uses `@tanstack-query`'s useQuery internally.
+ * You can use the `queryOptions` prop for more fine-grained control
+ * ```tsx
+ * <AccountBalance
+ *   queryOptions={{
+ *     enabled: isEnabled,
+ *     retry: 4,
+ *   }}
+ * />
+ * ```
+ *
+ * @component
+ * @account
+ * @beta
+ */
+export function AccountBalance({
+  chain,
+  tokenAddress,
+  formatFn,
+  loadingComponent,
+  fallbackComponent,
+  queryOptions,
+  ...restProps
+}: AccountBalanceProps) {
+  const { address, client } = useAccountContext();
+  const walletChain = useActiveWalletChain();
+  const chainToLoad = chain || walletChain;
+  const balanceQuery = useQuery({
+    queryKey: [
+      "walletBalance",
+      chainToLoad?.id || -1,
+      address || "0x0",
+      { tokenAddress },
+    ] as const,
+    queryFn: async () => {
+      if (!chainToLoad) {
+        throw new Error("chain is required");
+      }
+      if (!client) {
+        throw new Error("client is required");
+      }
+      return getWalletBalance({
+        chain: chainToLoad,
+        client,
+        address,
+        tokenAddress,
+      });
+    },
+    ...queryOptions,
+  });
+
+  if (balanceQuery.isLoading) {
+    return loadingComponent || null;
+  }
+
+  if (!balanceQuery.data) {
+    return fallbackComponent || null;
+  }
+
+  const displayValue = formatFn
+    ? formatFn(Number(balanceQuery.data.displayValue))
+    : balanceQuery.data.displayValue;
+
+  return (
+    <span {...restProps}>
+      {displayValue} {balanceQuery.data.symbol}
+    </span>
+  );
+}

package/src/react/web/ui/prebuilt/Account/blobbie.tsx

@@ -0,0 +1,12 @@
+import { Blobbie, type BlobbieProps } from "../../ConnectWallet/Blobbie.js";
+import { useAccountContext } from "./provider.js";
+
+/**
+ * A wrapper for the Blobbie component
+ * @param props BlobbieProps
+ * @beta
+ */
+export function AccountBlobbie(props: Omit<BlobbieProps, "address">) {
+  const { address } = useAccountContext();
+  return <Blobbie {...props} address={address} />;
+}

package/src/react/web/ui/prebuilt/Account/name.test.tsx

@@ -0,0 +1,62 @@
+import { describe, expect, it } from "vitest";
+import { render, screen, waitFor } from "~test/react-render.js";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { AccountName } from "./name.js";
+import { AccountProvider } from "./provider.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)("AccountName component", () => {
+  it("should return the correct social name", () => {
+    render(
+      <AccountProvider
+        address="0x12345674b599ce99958242b3D3741e7b01841DF3"
+        client={TEST_CLIENT}
+      >
+        <AccountName />
+      </AccountProvider>,
+    );
+    waitFor(() =>
+      expect(
+        screen.getByText("kien-ngo", {
+          exact: true,
+          selector: "span",
+        }),
+      ).toBeInTheDocument(),
+    );
+  });
+
+  it("should return the correct FORMATTED social name", () => {
+    render(
+      <AccountProvider
+        address="0x12345674b599ce99958242b3D3741e7b01841DF3"
+        client={TEST_CLIENT}
+      >
+        <AccountName formatFn={(str: string) => `${str}-formatted`} />
+      </AccountProvider>,
+    );
+    waitFor(() =>
+      expect(
+        screen.getByText("kien-ngo-formatted", {
+          exact: true,
+          selector: "span",
+        }),
+      ).toBeInTheDocument(),
+    );
+  });
+
+  it("should fallback properly when fail to resolve social name", () => {
+    render(
+      <AccountProvider address="invalid-wallet-address" client={TEST_CLIENT}>
+        <AccountName fallbackComponent={<span>oops</span>} />
+      </AccountProvider>,
+    );
+
+    waitFor(() =>
+      expect(
+        screen.getByText("oops", {
+          exact: true,
+          selector: "span",
+        }),
+      ).toBeInTheDocument(),
+    );
+  });
+});

package/src/react/web/ui/prebuilt/Account/name.tsx

@@ -0,0 +1,175 @@
+"use client";
+
+import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
+import type React from "react";
+import type { JSX } from "react";
+import {
+  type ResolveNameOptions,
+  resolveName,
+} from "../../../../../extensions/ens/resolve-name.js";
+import { getSocialProfiles } from "../../../../../social/profiles.js";
+import type { SocialProfile } from "../../../../../social/types.js";
+import { useAccountContext } from "./provider.js";
+
+/**
+ * Props for the AccountName component
+ * @component
+ * @account
+ */
+export interface AccountNameProps
+  extends Omit<React.HTMLAttributes<HTMLSpanElement>, "children">,
+    Omit<ResolveNameOptions, "client" | "address"> {
+  /**
+   * A function used to transform (format) the name of the account.
+   * it should take in a string and output a string.
+   *
+   * This function is particularly useful
+   */
+  formatFn?: (str: string) => string;
+  /**
+   * Use this prop to prioritize the social profile that you want to display
+   * This is useful for a wallet containing multiple social profiles
+   */
+  socialType?: SocialProfile["type"];
+  /**
+   * This component will be shown while the name of the account is being fetched
+   * If not passed, the component will return `null`.
+   *
+   * You can pass a loading sign or spinner to this prop.
+   * @example
+   * ```tsx
+   * <AccountName loadingComponent={<Spinner />} />
+   * ```
+   */
+  loadingComponent?: JSX.Element;
+  /**
+   * This component will be shown if the request for fetching the name is done but could not retreive any result.
+   * You can pass the wallet address as the fallback option if that's the case.
+   *
+   * If not passed, the component will return `null`
+   *
+   * @example
+   * ```tsx
+   * <AccountName fallbackComponent={"0x1234....3f3f"} />
+   * ```
+   */
+  fallbackComponent?: JSX.Element;
+  /**
+   * Optional `useQuery` params
+   */
+  queryOptions?: Omit<UseQueryOptions<string>, "queryKey" | "queryFn">;
+}
+
+/**
+ * This component is used to display the name of the account.
+ * A "name" in this context is the username, or account of the social profiles that the wallet may have.
+ * In case a name is not found or failed to resolve, you can always fallback to displaying the wallet address instead by using the `fallbackComponent` prop.
+ *
+ * This component inherits all attribute of a native HTML <span> element, so you can style it just like how you would style a <span>.
+ *
+ * @param props
+ * @returns A `<span>` containing the name of the account
+ * ```html
+ * <span>{name}</span>
+ * ```
+ *
+ * @example
+ * ### Basic usage
+ * ```tsx
+ * import { AccountProvider, AccountName } from "thirdweb/react";
+ *
+ * <AccountProvider address="0x1234...3f3f" client={client}>
+ *   <AccountName />
+ * </AccountProvider>
+ * ```
+ *
+ * ### Show wallet address while social name is being loaded
+ * ```tsx
+ * <AccountName
+ *   loadingComponent={<AccountAddress />}
+ * />
+ * ```
+ *
+ *
+ * ### Fallback to showing wallet address if fail to resolve social name
+ * ```tsx
+ * <AccountName
+ *   fallbackComponent={<AccountAddress />}
+ * />
+ * ```
+ *
+ * ### Transform the account name using `formatFn` prop
+ * ```tsx
+ * import { isAddress, shortenAddress } from "thirdweb/utils";
+ * import { AccountProvider, AccountName } from "thirdweb/react";
+ *
+ * // Let's say we want the name to be capitalized without using CSS
+ * const formatName = (name: string) => name.toUpperCase();
+ *
+ * return <AccountName formatFn={formatName} />
+ * ```
+ *
+ *
+ * ### Custom query options for useQuery
+ * This component uses `@tanstack-query`'s useQuery internally.
+ * You can use the `queryOptions` prop for more fine-grained control
+ * ```tsx
+ * <AccountName
+ *   queryOptions={{
+ *     enabled: isEnabled,
+ *     retry: 3
+ *   }}
+ * />
+ * ```
+ *
+ * @component
+ * @account
+ * @beta
+ */
+export function AccountName({
+  resolverAddress,
+  resolverChain,
+  socialType,
+  formatFn,
+  queryOptions,
+  loadingComponent,
+  fallbackComponent,
+  ...restProps
+}: AccountNameProps) {
+  const { address, client } = useAccountContext();
+  const nameQuery = useQuery({
+    queryKey: ["account-name", address],
+    queryFn: async () => {
+      const [socialData, ensName] = await Promise.all([
+        getSocialProfiles({ address, client }),
+        resolveName({
+          client,
+          address,
+          resolverAddress,
+          resolverChain,
+        }),
+      ]);
+
+      const name =
+        socialData?.filter(
+          (p) => p.name && (socialType ? p.type === socialType : true),
+        )[0]?.name || ensName;
+
+      if (!name) {
+        throw new Error("Failed to resolve account name");
+      }
+      return formatFn ? formatFn(name) : name;
+    },
+    ...queryOptions,
+  });
+
+  if (nameQuery.isLoading) {
+    return loadingComponent || null;
+  }
+
+  if (!nameQuery.data) {
+    return fallbackComponent || null;
+  }
+
+  return <span {...restProps}>{nameQuery.data}</span>;
+}

package/src/react/web/ui/prebuilt/Account/provider.test.tsx

@@ -0,0 +1,38 @@
+import { describe, expect, it } from "vitest";
+import { render, screen } from "~test/react-render.js";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { AccountAddress } from "./address.js";
+import { AccountProvider } from "./provider.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)("AccountProvider component", () => {
+  it("should render children correctly", () => {
+    render(
+      <AccountProvider
+        address="0x12345674b599ce99958242b3D3741e7b01841DF3"
+        client={TEST_CLIENT}
+      >
+        <div>Child Component</div>
+      </AccountProvider>,
+    );
+
+    expect(screen.getByText("Child Component")).toBeInTheDocument();
+  });
+
+  it("should pass the address correctly to the children props", () => {
+    render(
+      <AccountProvider
+        address="0x12345674b599ce99958242b3D3741e7b01841DF3"
+        client={TEST_CLIENT}
+      >
+        <AccountAddress />
+      </AccountProvider>,
+    );
+
+    expect(
+      screen.getByText("0x12345674b599ce99958242b3D3741e7b01841DF3", {
+        exact: true,
+        selector: "span",
+      }),
+    ).toBeInTheDocument();
+  });
+});

package/src/react/web/ui/prebuilt/Account/provider.tsx

@@ -0,0 +1,69 @@
+"use client";
+import type { Address } from "abitype";
+import type React from "react";
+import { createContext, useContext } from "react";
+import type { ThirdwebClient } from "../../../../../client/client.js";
+
+/**
+ * Props for the <AccountProvider /> component
+ * @component
+ * @account
+ */
+export type AccountProviderProps = {
+  /**
+   * The user's wallet address
+   */
+  address: Address;
+  /**
+   * thirdweb Client
+   */
+  client: ThirdwebClient;
+};
+
+const AccountProviderContext = /* @__PURE__ */ createContext<
+  AccountProviderProps | undefined
+>(undefined);
+
+/**
+ * A React context provider component that supplies Account-related data to its child components.
+ *
+ * This component serves as a wrapper around the `AccountProviderContext.Provider` and passes
+ * the provided account data down to all of its child components through the context API.
+ *
+ * @example
+ * ```tsx
+ * import { AccountProvider, AccountAvatar, AccountName, AccountAddress  } from "thirdweb/react";
+ *
+ * <AccountProvider>
+ *   <AccountAvatar />
+ *   <AccountName />
+ *   <AccountAddress />
+ * </AccountProvider>
+ * ```
+ *
+ * @component
+ * @account
+ * @beta
+ */
+export function AccountProvider(
+  props: React.PropsWithChildren<AccountProviderProps>,
+) {
+  return (
+    <AccountProviderContext.Provider value={props}>
+      {props.children}
+    </AccountProviderContext.Provider>
+  );
+}
+
+/**
+ * @internal
+ */
+export function useAccountContext() {
+  const ctx = useContext(AccountProviderContext);
+  if (!ctx) {
+    throw new Error(
+      "AccountProviderContext not found. Make sure you are using AccountName, AccountAvatar, etc. inside an <AccountProvider /> component",
+    );
+  }
+  return ctx;
+}

package/src/react/web/ui/prebuilt/NFT/NFT.test.tsx

@@ -2,7 +2,10 @@ import { useContext } from "react";
 import { describe, expect, it } from "vitest";
 import { render, screen, waitFor } from "~test/react-render.js";
 import { DOODLES_CONTRACT } from "~test/test-contracts.js";
-import { NFT, NFTProviderContext, getNFTInfo } from "./NFT.js";
+import { getNFTInfo } from "./hooks.js";
+import { NFTMedia } from "./media.js";
+import { NFTName } from "./name.js";
+import { NFTProvider, NFTProviderContext } from "./provider.js";
 
 describe.runIf(process.env.TW_SECRET_KEY)("NFT prebuilt component", () => {
   it("should fetch the NFT metadata", async () => {
@@ -42,9 +45,9 @@ describe.runIf(process.env.TW_SECRET_KEY)("NFT prebuilt component", () => {
 
   it("should render children correctly", () => {
     render(
-      <NFT contract={DOODLES_CONTRACT} tokenId={0n}>
+      <NFTProvider contract={DOODLES_CONTRACT} tokenId={0n}>
         <div>Child Component</div>
-      </NFT>,
+      </NFTProvider>,
     );
 
     expect(screen.getByText("Child Component")).toBeInTheDocument();
@@ -64,9 +67,9 @@ describe.runIf(process.env.TW_SECRET_KEY)("NFT prebuilt component", () => {
       );
     }
     render(
-      <NFT contract={DOODLES_CONTRACT} tokenId={0n}>
+      <NFTProvider contract={DOODLES_CONTRACT} tokenId={0n}>
         <NFTConsumer />
-      </NFT>,
+      </NFTProvider>,
     );
 
     expect(screen.getByText(/Contract:/)).toBeInTheDocument();
@@ -75,9 +78,9 @@ describe.runIf(process.env.TW_SECRET_KEY)("NFT prebuilt component", () => {
 
   it("should render the NFT image", () => {
     render(
-      <NFT contract={DOODLES_CONTRACT} tokenId={0n}>
-        <NFT.Media />
-      </NFT>,
+      <NFTProvider contract={DOODLES_CONTRACT} tokenId={0n}>
+        <NFTMedia />
+      </NFTProvider>,
     );
 
     waitFor(() => expect(screen.getByRole("img")).toBeInTheDocument());
@@ -85,9 +88,9 @@ describe.runIf(process.env.TW_SECRET_KEY)("NFT prebuilt component", () => {
 
   it("should render the NFT name", () => {
     render(
-      <NFT contract={DOODLES_CONTRACT} tokenId={1n}>
-        <NFT.Name />
-      </NFT>,
+      <NFTProvider contract={DOODLES_CONTRACT} tokenId={1n}>
+        <NFTName />
+      </NFTProvider>,
     );
 
     waitFor(() => expect(screen.getByText("Doodle #1")).toBeInTheDocument());
@@ -95,9 +98,9 @@ describe.runIf(process.env.TW_SECRET_KEY)("NFT prebuilt component", () => {
 
   it("should render the NFT description", () => {
     render(
-      <NFT contract={DOODLES_CONTRACT} tokenId={1n}>
-        <NFT.Name />
-      </NFT>,
+      <NFTProvider contract={DOODLES_CONTRACT} tokenId={1n}>
+        <NFTName />
+      </NFTProvider>,
     );
 
     waitFor(() =>