thirdweb 5.102.7-nightly-9f6c1a4820e37428dec6427cf77a12ab463f119d-20250616000412 → 5.103.0

package/src/react/web/ui/Bridge/CheckoutWidget.tsx

@@ -0,0 +1,484 @@
+"use client";
+
+import { useQuery } from "@tanstack/react-query";
+import type { Token } from "../../../../bridge/index.js";
+import type { Chain } from "../../../../chains/types.js";
+import type { ThirdwebClient } from "../../../../client/client.js";
+import { NATIVE_TOKEN_ADDRESS } from "../../../../constants/addresses.js";
+import { getToken } from "../../../../pay/convert/get-token.js";
+import { type Address, checksumAddress } from "../../../../utils/address.js";
+import { stringify } from "../../../../utils/json.js";
+import { toTokens } from "../../../../utils/units.js";
+import type { Wallet } from "../../../../wallets/interfaces/wallet.js";
+import type { SmartWalletOptions } from "../../../../wallets/smart/types.js";
+import type { AppMetadata } from "../../../../wallets/types.js";
+import type { WalletId } from "../../../../wallets/wallet-types.js";
+import { CustomThemeProvider } from "../../../core/design-system/CustomThemeProvider.js";
+import type { Theme } from "../../../core/design-system/index.js";
+import type { SiweAuthOptions } from "../../../core/hooks/auth/useSiweAuth.js";
+import type { ConnectButton_connectModalOptions } from "../../../core/hooks/connection/ConnectButtonProps.js";
+import type { SupportedTokens } from "../../../core/utils/defaultTokens.js";
+import { EmbedContainer } from "../ConnectWallet/Modal/ConnectEmbed.js";
+import { useConnectLocale } from "../ConnectWallet/locale/getConnectLocale.js";
+import { DynamicHeight } from "../components/DynamicHeight.js";
+import { Spinner } from "../components/Spinner.js";
+import type { LocaleId } from "../types.js";
+import { BridgeOrchestrator, type UIOptions } from "./BridgeOrchestrator.js";
+import { UnsupportedTokenScreen } from "./UnsupportedTokenScreen.js";
+
+export type CheckoutWidgetProps = {
+  supportedTokens?: SupportedTokens;
+  /**
+   * A client is the entry point to the thirdweb SDK.
+   * It is required for all other actions.
+   * You can create a client using the `createThirdwebClient` function. Refer to the [Creating a Client](https://portal.thirdweb.com/typescript/v5/client) documentation for more information.
+   *
+   * You must provide a `clientId` or `secretKey` in order to initialize a client. Pass `clientId` if you want for client-side usage and `secretKey` for server-side usage.
+   *
+   * ```tsx
+   * import { createThirdwebClient } from "thirdweb";
+   *
+   * const client = createThirdwebClient({
+   *  clientId: "<your_client_id>",
+   * })
+   * ```
+   */
+  client: ThirdwebClient;
+  /**
+   * By default - ConnectButton UI uses the `en-US` locale for english language users.
+   *
+   * You can customize the language used in the ConnectButton UI by setting the `locale` prop.
+   *
+   * Refer to the [`LocaleId`](https://portal.thirdweb.com/references/typescript/v5/LocaleId) type for supported locales.
+   */
+  locale?: LocaleId;
+  /**
+   * Set the theme for the `CheckoutWidget` component. By default it is set to `"dark"`
+   *
+   * theme can be set to either `"dark"`, `"light"` or a custom theme object.
+   * You can also import [`lightTheme`](https://portal.thirdweb.com/references/typescript/v5/lightTheme)
+   * or [`darkTheme`](https://portal.thirdweb.com/references/typescript/v5/darkTheme)
+   * functions from `thirdweb/react` to use the default themes as base and overrides parts of it.
+   * @example
+   * ```ts
+   * import { lightTheme } from "thirdweb/react";
+   *
+   * const customTheme = lightTheme({
+   *  colors: {
+   *    modalBg: 'red'
+   *  }
+   * })
+   *
+   * function Example() {
+   *  return <CheckoutWidget client={client} theme={customTheme} />
+   * }
+   * ```
+   */
+  theme?: "light" | "dark" | Theme;
+
+  /**
+   * Customize the options for "Connect" Button showing in the CheckoutWidget UI when the user is not connected to a wallet.
+   *
+   * Refer to the [`CheckoutWidgetConnectOptions`](https://portal.thirdweb.com/references/typescript/v5/CheckoutWidgetConnectOptions) type for more details.
+   */
+  connectOptions?: CheckoutWidgetConnectOptions;
+
+  /**
+   * All wallet IDs included in this array will be hidden from wallet selection when connected.
+   */
+  hiddenWallets?: WalletId[];
+
+  /**
+   * The wallet that should be pre-selected in the CheckoutWidget UI.
+   */
+  activeWallet?: Wallet;
+
+  style?: React.CSSProperties;
+
+  className?: string;
+
+  /**
+   * The chain the accepted token is on.
+   */
+  chain: Chain;
+
+  /**
+   * Address of the token to accept as payment. Leave undefined for the native token, or use 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE.
+   */
+  tokenAddress?: Address;
+
+  /**
+   * The price of the item **(in wei)**.
+   */
+  amount: bigint;
+
+  /**
+   * The wallet address or ENS funds will be paid to.
+   */
+  seller: Address;
+
+  /**
+   * The product name.
+   */
+  name?: string;
+
+  /**
+   * The product description.
+   */
+  description?: string;
+
+  /**
+   * The product image URL.
+   */
+  image?: string;
+
+  /**
+   * Whether the user or the seller pays the protocol fees. Defaults to the user.
+   */
+  feePayer?: "user" | "seller";
+
+  /**
+   * Preset fiat amounts to display in the UI. Defaults to [5, 10, 20].
+   */
+  presetOptions?: [number, number, number];
+
+  /**
+   * Arbitrary data to be included in the returned status and webhook events.
+   */
+  purchaseData?: Record<string, unknown>;
+
+  /**
+   * Callback triggered when the purchase is successful.
+   */
+  onSuccess?: () => void;
+
+  /**
+   * Callback triggered when the purchase encounters an error.
+   */
+  onError?: (error: Error) => void;
+
+  /**
+   * Callback triggered when the user cancels the purchase.
+   */
+  onCancel?: () => void;
+
+  /**
+   * @hidden
+   */
+  paymentLinkId?: string;
+};
+
+// Enhanced UIOptions to handle unsupported token state
+type UIOptionsResult =
+  | { type: "success"; data: UIOptions }
+  | {
+      type: "indexing_token";
+      token: Token;
+      chain: Chain;
+    }
+  | {
+      type: "unsupported_token";
+      tokenAddress: Address;
+      chain: Chain;
+    };
+
+/**
+ * Widget a prebuilt UI for purchasing a specific token.
+ *
+ * @param props - Props of type [`CheckoutWidgetProps`](https://portal.thirdweb.com/references/typescript/v5/CheckoutWidgetProps) to configure the CheckoutWidget component.
+ *
+ * @example
+ * ### Default configuration
+ *
+ * By default, the `CheckoutWidget` component will allows users to fund their wallets with crypto or fiat on any of the supported chains..
+ *
+ * ```tsx
+ * <CheckoutWidget
+ *   client={client}
+ *  />
+ * ```
+ *
+ * ### Enable/Disable payment methods
+ *
+ * You can use `disableOnramps` to prevent the use of onramps in the widget.
+ *
+ * ```tsx
+ * <CheckoutWidget
+ *   client={client}
+ *   disableOnramps
+ *  />
+ * ```
+ *
+ * ### Customize the UI
+ *
+ * You can customize the UI of the `CheckoutWidget` component by passing a custom theme object to the `theme` prop.
+ *
+ * ```tsx
+ * <CheckoutWidget
+ *   client={client}
+ *   theme={darkTheme({
+ *     colors: {
+ *       modalBg: "red",
+ *     },
+ *   })}
+ * />
+ * ```
+ *
+ * Refer to the [`Theme`](https://portal.thirdweb.com/references/typescript/v5/Theme) type for more details.
+ *
+ * ### Update the Title
+ *
+ * You can update the title of the widget by passing a `title` prop to the `CheckoutWidget` component.
+ *
+ * ```tsx
+ * <CheckoutWidget
+ *   client={client}
+ *   title="Checkout ETH"
+ * />
+ * ```
+ *
+ * ### Configure the wallet connection
+ *
+ * You can customize the wallet connection flow by passing a `connectOptions` object to the `CheckoutWidget` component.
+ *
+ * ```tsx
+ * <CheckoutWidget
+ *   client={client}
+ *   connectOptions={{
+ *     connectModal: {
+ *       size: 'compact',
+ *       title: "Sign in",
+ *     }
+ *   }}
+ * />
+ * ```
+ *
+ * Refer to the [`CheckoutWidgetConnectOptions`](https://portal.thirdweb.com/references/typescript/v5/CheckoutWidgetConnectOptions) type for more details.
+ *
+ * @bridge
+ * @beta
+ * @react
+ */
+export function CheckoutWidget(props: CheckoutWidgetProps) {
+  const localeQuery = useConnectLocale(props.locale || "en_US");
+  const theme = props.theme || "dark";
+
+  const bridgeDataQuery = useQuery({
+    queryKey: ["bridgeData", stringify(props)],
+    queryFn: async (): Promise<UIOptionsResult> => {
+      const token = await getToken(
+        props.client,
+        checksumAddress(props.tokenAddress || NATIVE_TOKEN_ADDRESS),
+        props.chain.id,
+      ).catch((err) =>
+        err.message.includes("not supported") ? undefined : Promise.reject(err),
+      );
+      if (!token) {
+        return {
+          type: "unsupported_token",
+          tokenAddress: checksumAddress(
+            props.tokenAddress || NATIVE_TOKEN_ADDRESS,
+          ),
+          chain: props.chain,
+        };
+      }
+      return {
+        type: "success",
+        data: {
+          mode: "direct_payment",
+          metadata: {
+            title: props.name,
+            image: props.image,
+            description: props.description,
+          },
+          paymentInfo: {
+            token,
+            amount: toTokens(props.amount, token.decimals),
+            sellerAddress: props.seller,
+            feePayer: props.feePayer === "seller" ? "receiver" : "sender", // User is sender, seller is receiver
+          },
+        },
+      };
+    },
+  });
+
+  let content = null;
+  if (!localeQuery.data || bridgeDataQuery.isLoading) {
+    content = (
+      <div
+        style={{
+          minHeight: "350px",
+          display: "flex",
+          justifyContent: "center",
+          alignItems: "center",
+        }}
+      >
+        <Spinner size="xl" color="secondaryText" />
+      </div>
+    );
+  } else if (bridgeDataQuery.data?.type === "unsupported_token") {
+    // Show unsupported token screen
+    content = <UnsupportedTokenScreen chain={bridgeDataQuery.data.chain} />;
+  } else if (bridgeDataQuery.data?.type === "success") {
+    // Show normal bridge orchestrator
+    content = (
+      <BridgeOrchestrator
+        client={props.client}
+        uiOptions={bridgeDataQuery.data.data}
+        connectOptions={props.connectOptions}
+        connectLocale={localeQuery.data}
+        purchaseData={props.purchaseData}
+        paymentLinkId={props.paymentLinkId}
+        onComplete={() => {
+          props.onSuccess?.();
+        }}
+        onError={(err: Error) => {
+          props.onError?.(err);
+        }}
+        onCancel={() => {
+          props.onCancel?.();
+        }}
+        presetOptions={props.presetOptions}
+        receiverAddress={props.seller}
+      />
+    );
+  }
+
+  return (
+    <CustomThemeProvider theme={theme}>
+      <EmbedContainer
+        modalSize="compact"
+        style={props.style}
+        className={props.className}
+      >
+        <DynamicHeight>{content}</DynamicHeight>
+      </EmbedContainer>
+    </CustomThemeProvider>
+  );
+}
+
+/**
+ * Connection options for the `CheckoutWidget` component
+ *
+ * @example
+ * ```tsx
+ * <CheckoutWidget client={client} connectOptions={{
+ *    connectModal: {
+ *      size: 'compact',
+ *      title: "Sign in",
+ *    }
+ *  }}
+ * />
+ * ```
+ */
+type CheckoutWidgetConnectOptions = {
+  /**
+   * Configurations for the `ConnectButton`'s Modal that is shown for connecting a wallet
+   * Refer to the [`ConnectButton_connectModalOptions`](https://portal.thirdweb.com/references/typescript/v5/ConnectButton_connectModalOptions) type for more details
+   */
+  connectModal?: ConnectButton_connectModalOptions;
+
+  /**
+   * Configure options for WalletConnect
+   *
+   * By default WalletConnect uses the thirdweb's default project id.
+   * Setting your own project id is recommended.
+   *
+   * You can create a project id by signing up on [walletconnect.com](https://walletconnect.com/)
+   */
+  walletConnect?: {
+    projectId?: string;
+  };
+
+  /**
+   * Enable Account abstraction for all wallets. This will connect to the users's smart account based on the connected personal wallet and the given options.
+   *
+   * This allows to sponsor gas fees for your user's transaction using the thirdweb account abstraction infrastructure.
+   *
+   */
+  accountAbstraction?: SmartWalletOptions;
+
+  /**
+   * Array of wallets to show in Connect Modal. If not provided, default wallets will be used.
+   */
+  wallets?: Wallet[];
+  /**
+   * When the user has connected their wallet to your site, this configuration determines whether or not you want to automatically connect to the last connected wallet when user visits your site again in the future.
+   *
+   * By default it is set to `{ timeout: 15000 }` meaning that autoConnect is enabled and if the autoConnection does not succeed within 15 seconds, it will be cancelled.
+   *
+   * If you want to disable autoConnect, set this prop to `false`.
+   *
+   * If you want to customize the timeout, you can assign an object with a `timeout` key to this prop.
+   * ```
+   */
+  autoConnect?:
+    | {
+        timeout: number;
+      }
+    | boolean;
+
+  /**
+   * Metadata of the app that will be passed to connected wallet. Setting this is highly recommended.
+   */
+  appMetadata?: AppMetadata;
+
+  /**
+   * The [`Chain`](https://portal.thirdweb.com/references/typescript/v5/Chain) object of the blockchain you want the wallet to connect to
+   *
+   * If a `chain` is not specified, Wallet will be connected to whatever is the default set in the wallet.
+   *
+   * If a `chain` is specified, Wallet will be prompted to switch to given chain after connection if it is not already connected to it.
+   * This ensures that the wallet is connected to the correct blockchain before interacting with your app.
+   *
+   * The `ConnectButton` also shows a "Switch Network" button until the wallet is connected to the specified chain. Clicking on the "Switch Network" button triggers the wallet to switch to the specified chain.
+   *
+   * You can create a `Chain` object using the [`defineChain`](https://portal.thirdweb.com/references/typescript/v5/defineChain) function.
+   * At minimum, you need to pass the `id` of the blockchain to `defineChain` function to create a `Chain` object.
+   * ```
+   */
+  chain?: Chain;
+
+  /**
+   * Array of chains that your app supports.
+   *
+   * This is only relevant if your app is a multi-chain app and works across multiple blockchains.
+   * If your app only works on a single blockchain, you should only specify the `chain` prop.
+   *
+   * Given list of chains will used in various ways:
+   * - They will be displayed in the network selector in the `ConnectButton`'s details modal post connection
+   * - They will be sent to wallet at the time of connection if the wallet supports requesting multiple chains ( example: WalletConnect ) so that users can switch between the chains post connection easily
+   *
+   * You can create a `Chain` object using the [`defineChain`](https://portal.thirdweb.com/references/typescript/v5/defineChain) function.
+   * At minimum, you need to pass the `id` of the blockchain to `defineChain` function to create a `Chain` object.
+   *
+   * ```tsx
+   * import { defineChain } from "thirdweb/react";
+   *
+   * const polygon = defineChain({
+   *   id: 137,
+   * });
+   * ```
+   */
+  chains?: Chain[];
+
+  /**
+   * Wallets to show as recommended in the `ConnectButton`'s Modal
+   */
+  recommendedWallets?: Wallet[];
+
+  /**
+   * By default, ConnectButton modal shows a "All Wallets" button that shows a list of 500+ wallets.
+   *
+   * You can disable this button by setting `showAllWallets` prop to `false`
+   */
+  showAllWallets?: boolean;
+
+  /**
+   * Enable SIWE (Sign in with Ethererum) by passing an object of type `SiweAuthOptions` to
+   * enforce the users to sign a message after connecting their wallet to authenticate themselves.
+   *
+   * Refer to the [`SiweAuthOptions`](https://portal.thirdweb.com/references/typescript/v5/SiweAuthOptions) for more details
+   */
+  auth?: SiweAuthOptions;
+};