|
| 1 | +import { type UseQueryOptions, useQuery } from "@tanstack/react-query"; |
| 2 | +import type { JSX } from "react"; |
| 3 | +import { getChainMetadata } from "../../../../../chains/utils.js"; |
| 4 | +import type { ThirdwebClient } from "../../../../../client/client.js"; |
| 5 | +import { |
| 6 | + findIPFSCidFromUri, |
| 7 | + resolveScheme, |
| 8 | +} from "../../../../../utils/ipfs.js"; |
| 9 | +import { useChainContext } from "./provider.js"; |
| 10 | + |
| 11 | +/** |
| 12 | + * Props for the ChainIcon component |
| 13 | + * @chain |
| 14 | + * @component |
| 15 | + */ |
| 16 | +export interface ChainIconProps |
| 17 | + extends Omit<React.ImgHTMLAttributes<HTMLImageElement>, "src"> { |
| 18 | + /** |
| 19 | + * While marked as "optional", you should pass a ThirdwebClient to this prop |
| 20 | + * if you want to use your clientId for the chain icon |
| 21 | + * (since most chain icons are hosted on IPFS, loading them via thirdweb gateway will ensure better performance) |
| 22 | + */ |
| 23 | + client?: ThirdwebClient; |
| 24 | + /** |
| 25 | + * This prop can be a string or a (async) function that resolves to a string, representing the icon url of the chain |
| 26 | + * This is particularly useful if you already have a way to fetch the chain icon. |
| 27 | + */ |
| 28 | + iconResolver?: string | (() => string) | (() => Promise<string>); |
| 29 | + /** |
| 30 | + * This component will be shown while the avatar of the icon is being fetched |
| 31 | + * If not passed, the component will return `null`. |
| 32 | + * |
| 33 | + * You can pass a loading sign or spinner to this prop. |
| 34 | + * @example |
| 35 | + * ```tsx |
| 36 | + * <ChainIcon loadingComponent={<Spinner />} /> |
| 37 | + * ``` |
| 38 | + */ |
| 39 | + loadingComponent?: JSX.Element; |
| 40 | + /** |
| 41 | + * This component will be shown if the request for fetching the avatar is done |
| 42 | + * but could not retreive any result. |
| 43 | + * You can pass a dummy avatar/image to this prop. |
| 44 | + * |
| 45 | + * If not passed, the component will return `null` |
| 46 | + * |
| 47 | + * @example |
| 48 | + * ```tsx |
| 49 | + * <ChainIcon fallbackComponent={<DummyImage />} /> |
| 50 | + * ``` |
| 51 | + */ |
| 52 | + fallbackComponent?: JSX.Element; |
| 53 | + |
| 54 | + /** |
| 55 | + * Optional query options for `useQuery` |
| 56 | + */ |
| 57 | + queryOptions?: Omit<UseQueryOptions<string>, "queryFn" | "queryKey">; |
| 58 | +} |
| 59 | + |
| 60 | +/** |
| 61 | + * This component tries to resolve the icon of a given chain, then return an image. |
| 62 | + * @returns an <img /> with the src of the chain icon |
| 63 | + * |
| 64 | + * @example |
| 65 | + * ### Basic usage |
| 66 | + * ```tsx |
| 67 | + * import { ChainProvider, ChainIcon } from "thirdweb/react"; |
| 68 | + * |
| 69 | + * <ChainProvider chain={chain}> |
| 70 | + * <ChainIcon /> |
| 71 | + * </ChainProvider> |
| 72 | + * ``` |
| 73 | + * |
| 74 | + * Result: An <img /> component with the src of the icon |
| 75 | + * ```html |
| 76 | + * <img src="chain-icon.png" /> |
| 77 | + * ``` |
| 78 | + * |
| 79 | + * ### Override the icon with the `iconResolver` prop |
| 80 | + * If you already have the icon url, you can skip the network requests and pass it directly to the ChainIcon |
| 81 | + * ```tsx |
| 82 | + * <ChainIcon iconResolver="/ethereum-icon.png" /> |
| 83 | + * ``` |
| 84 | + * |
| 85 | + * You can also pass in your own custom (async) function that retrieves the icon url |
| 86 | + * ```tsx |
| 87 | + * const getIcon = async () => { |
| 88 | + * const icon = getIconFromCoinMarketCap(chainId, etc); |
| 89 | + * return icon; |
| 90 | + * }; |
| 91 | + * |
| 92 | + * <ChainIcon iconResolver={getIcon} /> |
| 93 | + * ``` |
| 94 | + * |
| 95 | + * ### Show a loading sign while the icon is being loaded |
| 96 | + * ```tsx |
| 97 | + * <ChainIcon loadingComponent={<Spinner />} /> |
| 98 | + * ``` |
| 99 | + * |
| 100 | + * ### Fallback to a dummy image if the chain icon fails to resolve |
| 101 | + * ```tsx |
| 102 | + * <ChainIcon fallbackComponent={<img src="blank-image.png" />} /> |
| 103 | + * ``` |
| 104 | + * |
| 105 | + * ### Usage with queryOptions |
| 106 | + * ChainIcon uses useQuery() from tanstack query internally. |
| 107 | + * It allows you to pass a custom queryOptions of your choice for more control of the internal fetching logic |
| 108 | + * ```tsx |
| 109 | + * <ChainIcon queryOptions={{ enabled: someLogic, retry: 3, }} /> |
| 110 | + * ``` |
| 111 | + * |
| 112 | + * @component |
| 113 | + * @chain |
| 114 | + * @beta |
| 115 | + */ |
| 116 | +export function ChainIcon({ |
| 117 | + iconResolver, |
| 118 | + loadingComponent, |
| 119 | + fallbackComponent, |
| 120 | + queryOptions, |
| 121 | + client, |
| 122 | + ...restProps |
| 123 | +}: ChainIconProps) { |
| 124 | + const { chain } = useChainContext(); |
| 125 | + const iconQuery = useQuery({ |
| 126 | + queryKey: ["_internal_chain_icon_", chain.id] as const, |
| 127 | + queryFn: async () => { |
| 128 | + if (typeof iconResolver === "string") { |
| 129 | + return iconResolver; |
| 130 | + } |
| 131 | + if (typeof iconResolver === "function") { |
| 132 | + return iconResolver(); |
| 133 | + } |
| 134 | + // Check if the chain object already has "icon" |
| 135 | + if (chain.icon?.url) { |
| 136 | + return chain.icon.url; |
| 137 | + } |
| 138 | + const possibleUrl = await getChainMetadata(chain).then( |
| 139 | + (data) => data.icon?.url, |
| 140 | + ); |
| 141 | + if (!possibleUrl) { |
| 142 | + throw new Error("Failed to resolve icon for chain"); |
| 143 | + } |
| 144 | + if (client) { |
| 145 | + return resolveScheme({ uri: possibleUrl, client }); |
| 146 | + } |
| 147 | + // If a thirdweb client is not passed, try to manually resolve the uri |
| 148 | + if (possibleUrl.startsWith("ipfs://")) { |
| 149 | + const cid = findIPFSCidFromUri(possibleUrl); |
| 150 | + if (!cid) { |
| 151 | + throw new Error(`Failed to resolve IPFS CID from ${possibleUrl}`); |
| 152 | + } |
| 153 | + return `https://ipfs.io/${cid}`; |
| 154 | + } |
| 155 | + return possibleUrl; |
| 156 | + }, |
| 157 | + ...queryOptions, |
| 158 | + }); |
| 159 | + |
| 160 | + if (iconQuery.isLoading) { |
| 161 | + return loadingComponent || null; |
| 162 | + } |
| 163 | + |
| 164 | + if (!iconQuery.data) { |
| 165 | + return fallbackComponent || null; |
| 166 | + } |
| 167 | + |
| 168 | + return <img src={iconQuery.data} {...restProps} alt={restProps.alt} />; |
| 169 | +} |
0 commit comments