thirdweb 5.69.1-nightly-f368793375d099eec53569330af7a083e558e483-20241120000334 → 5.70.0-nightly-ecaa304a812188da3c81888bb52ca6064093c139-20241121000332

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

@@ -0,0 +1,75 @@
+import { createContext, useContext } from "react";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+
+/**
+ * Props for the <NFT> component
+ * @component
+ */
+export type NFTProviderProps = {
+  /**
+   * The NFT contract address. Accepts both ERC721 and ERC1155 contracts
+   */
+  contract: ThirdwebContract;
+  /**
+   * The tokenId whose info you want to display
+   */
+  tokenId: bigint;
+};
+
+/**
+ * @internal
+ */
+export const NFTProviderContext = /* @__PURE__ */ createContext<
+  NFTProviderProps | undefined
+>(undefined);
+
+/**
+ * @internal
+ */
+export function useNFTContext() {
+  const ctx = useContext(NFTProviderContext);
+  if (!ctx) {
+    throw new Error(
+      "NFTProviderContext not found. Make sure you are using NFTMedia, NFTDescription, etc. inside a <NFTProvider /> component",
+    );
+  }
+  return ctx;
+}
+
+/**
+ * A React context provider component that supplies NFT-related data to its child components.
+ *
+ * This component serves as a wrapper around the `NFTProviderContext.Provider` and passes
+ * the provided NFT data down to all of its child components through the context API.
+ *
+ *
+ * @param {React.PropsWithChildren<NFTProviderProps>} props - The props for the NFT provider
+ *
+ * @example
+ * ```tsx
+ * import { getContract } from "thirdweb";
+ * import { NFTProvider, NFTMedia, NFTDescription, NFTName } from "thirdweb/react";
+ *
+ * const contract = getContract({
+ *   address: "0x...",
+ *   chain: ethereum,
+ *   client: yourThirdwebClient,
+ * });
+ *
+ * <NFTProvider contract={contract} tokenId={0n}>
+ *    <NFTMedia />
+ *    <NFTDescription />
+ *    <NFTName />
+ * </NFTProvider>
+ * ```
+ * @component
+ * @nft
+ * @beta
+ */
+export function NFTProvider(props: React.PropsWithChildren<NFTProviderProps>) {
+  return (
+    <NFTProviderContext.Provider value={props}>
+      {props.children}
+    </NFTProviderContext.Provider>
+  );
+}

package/src/react/web/ui/prebuilt/Token/icon.tsx

@@ -0,0 +1,164 @@
+import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
+import type { JSX } from "react";
+import { getChainMetadata } from "../../../../../chains/utils.js";
+import { NATIVE_TOKEN_ADDRESS } from "../../../../../constants/addresses.js";
+import { getContract } from "../../../../../contract/contract.js";
+import { getContractMetadata } from "../../../../../extensions/common/read/getContractMetadata.js";
+import { resolveScheme } from "../../../../../utils/ipfs.js";
+import { useTokenContext } from "./provider.js";
+
+export interface TokenIconProps
+  extends Omit<React.ImgHTMLAttributes<HTMLImageElement>, "src"> {
+  /**
+   * This prop can be a string or a (async) function that resolves to a string, representing the icon url of the token
+   * This is particularly useful if you already have a way to fetch the token icon.
+   */
+  iconResolver?: string | (() => string) | (() => Promise<string>);
+  /**
+   * This component will be shown while the avatar of the icon is being fetched
+   * If not passed, the component will return `null`.
+   *
+   * You can pass a loading sign or spinner to this prop.
+   * @example
+   * ```tsx
+   * <TokenIcon loadingComponent={<Spinner />} />
+   * ```
+   */
+  loadingComponent?: JSX.Element;
+  /**
+   * This component will be shown if the request for fetching the avatar is done
+   * but could not retreive any result.
+   * You can pass a dummy avatar/image to this prop.
+   *
+   * If not passed, the component will return `null`
+   *
+   * @example
+   * ```tsx
+   * <TokenIcon fallbackComponent={<DummyImage />} />
+   * ```
+   */
+  fallbackComponent?: JSX.Element;
+
+  /**
+   * Optional query options for `useQuery`
+   */
+  queryOptions?: Omit<UseQueryOptions<string>, "queryFn" | "queryKey">;
+}
+
+/**
+ * This component tries to resolve the icon of a given token, then return an image.
+ * @returns an <img /> with the src of the token icon
+ *
+ * @example
+ * ### Basic usage
+ * ```tsx
+ * import { TokenProvider, TokenIcon } from "thirdweb/react";
+ *
+ * <TokenProvider address="0x-token-address" chain={chain} client={client}>
+ *   <TokenIcon />
+ * </TokenProvider>
+ * ```
+ *
+ * Result: An <img /> component with the src of the icon
+ * ```html
+ * <img src="token-icon.png" />
+ * ```
+ *
+ * ### Override the icon with the `iconResolver` prop
+ * If you already have the icon url, you can skip the network requests and pass it directly to the TokenIcon
+ * ```tsx
+ * <TokenIcon iconResolver="/usdc.png" />
+ * ```
+ *
+ * You can also pass in your own custom (async) function that retrieves the icon url
+ * ```tsx
+ * const getIcon = async () => {
+ *   const icon = getIconFromCoinMarketCap(tokenAddress, etc);
+ *   return icon;
+ * };
+ *
+ * <TokenIcon iconResolver={getIcon} />
+ * ```
+ *
+ * ### Show a loading sign while the icon is being loaded
+ * ```tsx
+ * <TokenIcon loadingComponent={<Spinner />} />
+ * ```
+ *
+ * ### Fallback to a dummy image if the token icon fails to resolve
+ * ```tsx
+ * <TokenIcon fallbackComponent={<img src="blank-image.png" />} />
+ * ```
+ *
+ * ### Usage with queryOptions
+ * TokenIcon uses useQuery() from tanstack query internally.
+ * It allows you to pass a custom queryOptions of your choice for more control of the internal fetching logic
+ * ```tsx
+ * <TokenIcon queryOptions={{ enabled: someLogic, retry: 3, }} />
+ * ```
+ *
+ * @component
+ * @token
+ * @beta
+ */
+export function TokenIcon({
+  iconResolver,
+  loadingComponent,
+  fallbackComponent,
+  queryOptions,
+  ...restProps
+}: TokenIconProps) {
+  const { address, client, chain } = useTokenContext();
+  const iconQuery = useQuery({
+    queryKey: ["_internal_token_icon_", chain.id, address] as const,
+    queryFn: async () => {
+      if (typeof iconResolver === "string") {
+        return iconResolver;
+      }
+      if (typeof iconResolver === "function") {
+        return iconResolver();
+      }
+      if (address.toLowerCase() === NATIVE_TOKEN_ADDRESS.toLowerCase()) {
+        const possibleUrl = await getChainMetadata(chain).then(
+          (data) => data.icon?.url,
+        );
+        if (!possibleUrl) {
+          throw new Error("Failed to resolve icon for native token");
+        }
+        return resolveScheme({ uri: possibleUrl, client });
+      }
+
+      // Try to get the icon from the contractURI
+      const contractMetadata = await getContractMetadata({
+        contract: getContract({
+          address,
+          chain,
+          client,
+        }),
+      });
+
+      if (
+        !contractMetadata.image ||
+        typeof contractMetadata.image !== "string"
+      ) {
+        throw new Error("Failed to resolve token icon from contract metadata");
+      }
+
+      return resolveScheme({
+        uri: contractMetadata.image,
+        client,
+      });
+    },
+    ...queryOptions,
+  });
+
+  if (iconQuery.isLoading) {
+    return loadingComponent || null;
+  }
+
+  if (!iconQuery.data) {
+    return fallbackComponent || null;
+  }
+
+  return <img src={iconQuery.data} alt={restProps.alt} />;
+}

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

@@ -0,0 +1,201 @@
+"use client";
+
+import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
+import type React from "react";
+import type { JSX } from "react";
+import { getChainMetadata } from "../../../../../chains/utils.js";
+import { NATIVE_TOKEN_ADDRESS } from "../../../../../constants/addresses.js";
+import { getContract } from "../../../../../contract/contract.js";
+import { getContractMetadata } from "../../../../../extensions/common/read/getContractMetadata.js";
+import { name } from "../../../../../extensions/common/read/name.js";
+import { useTokenContext } from "./provider.js";
+
+/**
+ * Props for the TokenName component
+ * @component
+ * @token
+ */
+export interface TokenNameProps
+  extends Omit<React.HTMLAttributes<HTMLSpanElement>, "children"> {
+  /**
+   * This prop can be a string or a (async) function that resolves to a string, representing the name of the token
+   * This is particularly useful if you already have a way to fetch the token name.
+   */
+  nameResolver?: string | (() => string) | (() => Promise<string>);
+  /**
+   * A function to format the name's display value
+   * Particularly useful to avoid overflowing-UI issues
+   *
+   * ```tsx
+   * <TokenName formatFn={(str: string) => doSomething()} />
+   * ```
+   */
+  formatFn?: (str: string) => string;
+  /**
+   * This component will be shown while the name of the token 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
+   * <TokenName loadingComponent={<Spinner />} />
+   * ```
+   */
+  loadingComponent?: JSX.Element;
+  /**
+   * This component will be shown if the name 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
+   * name was not fetched succesfully
+   * @example
+   * ```tsx
+   * <TokenName fallbackComponent={"Failed to load"}
+   * />
+   * ```
+   */
+  fallbackComponent?: JSX.Element;
+  /**
+   * Optional `useQuery` params
+   */
+  queryOptions?: Omit<UseQueryOptions<string>, "queryFn" | "queryKey">;
+}
+
+/**
+ * This component fetches then shows the name of a token. For ERC20 tokens, it calls the `name` function in the ERC20 contract.
+ * 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 { TokenProvider, TokenName } from "thirdweb/react";
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * <TokenProvider {...props}>
+ *   <TokenName  />
+ * </TokenProvider>
+ * ```
+ * Result:
+ * ```html
+ * <span>Ether</span>
+ * ```
+ *
+ * ### Custom name resolver
+ * By default TokenName will call the `name` method of the token contract.
+ * However if you have a different way to fetch the name, you can pass the function to the `nameResolver` prop.
+ * Note: nameResolver should either be a string or a function (async) that returns a string.
+ * ```tsx
+ * async function fetchNameMethod() {
+ *   // your own fetching logic
+ *   return "the token name";
+ * }
+ *
+ * <TokenName nameResolver={fetchNameMethod} />
+ * ```
+ *
+ * Alternatively you can also pass in a string directly:
+ * ```tsx
+ * <TokenName nameResolver="USD Coin Circle" />
+ * ```
+ *
+ *
+ * ### Format the name (capitalize, truncate, etc.)
+ * The TokenName component accepts a `formatFn` which takes in a string and outputs a string
+ * The function is used to modify the name of the token
+ *
+ * ```tsx
+ * const concatStr = (str: string):string => str + "Token"
+ *
+ * <TokenName formatFn={concatStr} />
+ * ```
+ *
+ * Result:
+ * ```html
+ * <span>Ether Token</span>
+ * ```
+ *
+ * ### Show a loading sign when the name is being fetched
+ * ```tsx
+ * import { TokenProvider, TokenName } from "thirdweb/react";
+ *
+ * <TokenProvider address="0x...">
+ *   <TokenName loadingComponent={<Spinner />} />
+ * </TokenProvider>
+ * ```
+ *
+ * ### Fallback to something when the name fails to resolve
+ * ```tsx
+ * <TokenProvider address="0x...">
+ *   <TokenName fallbackComponent={"Failed to load"} />
+ * </TokenProvider>
+ * ```
+ *
+ * ### 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
+ * <TokenName
+ *   queryOptions={{
+ *     enabled: isEnabled,
+ *     retry: 4,
+ *   }}
+ * />
+ * ```
+ *
+ * @component
+ * @token
+ * @beta
+ */
+export function TokenName({
+  nameResolver,
+  formatFn,
+  loadingComponent,
+  fallbackComponent,
+  queryOptions,
+  ...restProps
+}: TokenNameProps) {
+  const { address, client, chain } = useTokenContext();
+  const nameQuery = useQuery({
+    queryKey: ["_internal_token_name_", chain.id, address] as const,
+    queryFn: async () => {
+      if (typeof nameResolver === "string") {
+        return nameResolver;
+      }
+      if (typeof nameResolver === "function") {
+        return nameResolver();
+      }
+      if (address.toLowerCase() === NATIVE_TOKEN_ADDRESS.toLowerCase()) {
+        // Don't wanna use `getChainNativeCurrencyName` because it has some side effect (it catches error and defaults to "ETH")
+        return getChainMetadata(chain).then((data) => data.nativeCurrency.name);
+      }
+      // Try to fetch the name from both the `name()` function and the contract metadata
+      // then prioritize the `name()`
+      const contract = getContract({ address, client, chain });
+      const [_name, contractMetadata] = await Promise.all([
+        name({ contract }),
+        getContractMetadata({ contract }),
+      ]);
+      if (!_name && !contractMetadata.name) {
+        throw new Error(
+          "Failed to resolve name from both name() and contract metadata",
+        );
+      }
+
+      return _name || contractMetadata.name;
+    },
+    ...queryOptions,
+  });
+
+  if (nameQuery.isLoading) {
+    return loadingComponent || null;
+  }
+
+  if (!nameQuery.data) {
+    return fallbackComponent || null;
+  }
+
+  const displayValue = formatFn ? formatFn(nameQuery.data) : nameQuery.data;
+
+  return <span {...restProps}>{displayValue}</span>;
+}

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

@@ -0,0 +1,86 @@
+"use client";
+
+import type { Address } from "abitype";
+import type React from "react";
+import { createContext, useContext } from "react";
+import type { Chain } from "../../../../../chains/types.js";
+import type { ThirdwebClient } from "../../../../../client/client.js";
+
+/**
+ * Props for the <TokenProvider /> component
+ * @component
+ * @token
+ */
+export type TokenProviderProps = {
+  /**
+   * The token (ERC20) contract address
+   */
+  address: Address;
+  /**
+   * thirdweb Client
+   */
+  client: ThirdwebClient;
+  /**
+   * The chain (network) that the token is on
+   */
+  chain: Chain;
+};
+
+const TokenProviderContext = /* @__PURE__ */ createContext<
+  TokenProviderProps | undefined
+>(undefined);
+
+/**
+ * A React context provider component that supplies Token-related data to its child components.
+ *
+ * This component serves as a wrapper around the `TokenProviderContext.Provider` and passes
+ * the provided token data down to all of its child components through the context API.
+ *
+ * @example
+ * ### Basic usage
+ * ```tsx
+ * import { TokenProvider, TokenIcon, TokenName  } from "thirdweb/react";
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * <TokenProvider address="0x..." client={...} chain={ethereum}>
+ *   <TokenIcon />
+ *   <TokenName />
+ * </TokenProvider>
+ * ```
+ *
+ * ### This component also works with native token!
+ * ```tsx
+ * import { NATIVE_TOKEN_ADDRESS} from "thirdweb";
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * <TokenProvider address={NATIVE_TOKEN_ADDRESS} chain={ethereum} client={client}>
+ *   <TokenSymbol /> // "ETH"
+ * </TokenProvider>
+ * ```
+ *
+ * @component
+ * @token
+ * @beta
+ */
+export function TokenProvider(
+  props: React.PropsWithChildren<TokenProviderProps>,
+) {
+  return (
+    <TokenProviderContext.Provider value={props}>
+      {props.children}
+    </TokenProviderContext.Provider>
+  );
+}
+
+/**
+ * @internal
+ */
+export function useTokenContext() {
+  const ctx = useContext(TokenProviderContext);
+  if (!ctx) {
+    throw new Error(
+      "TokenProviderContext not found. Make sure you are using TokenName, TokenIcon, TokenSymbol etc. inside a <TokenProvider /> component",
+    );
+  }
+  return ctx;
+}