Skip to main content

frameWallet

A wallet configurator for Frame Wallet which allows integrating the wallet with React

import { frameWallet } from "@thirdweb-dev/react";

const frameWalletConfig = frameWallet(options);
customize (optional)

frameWalletConfig contains the default config for metadata and UI. you can optionally choose to override the defaults to customize the wallet. Learn more about these configs

const frameWalletConfig = frameWallet({ ... });

// override metadata
frameWalletConfig.meta.name = "..."; // change the name
frameWalletConfig.meta.iconURL = "..."; // change the icon
frameWalletConfig.meta.urls = {
  // change urls to download the wallet on various platforms
  android: "https://...",
  ios: "https://...",
  chrome: "https://...",
  firefox: "https://...",
};

// override connection UI
frameWalletConfig.connectUI = FrameWalletConnectUI; // react component

// custom selection UI
frameWalletConfig.selectUI = FrameWalletSelectUI; // react component

// custom logic to check if the wallet is installed or not
frameWalletConfig.isInstalled = isFrameWalletInstalled; // function

Once the config is ready, you can use it with ConnectWallet component or useConnect hook as shown below

// add to ThirdwebProvider to add it in ConnectWallet's modal
<ThirdwebProvider supportedWallets={[frameWalletConfig]} clientId="your-client-id"/>;

// or use it with useConnect hook
const connect = useConnect();
connect(frameWalletConfig, { ... });

Options​

recommended (optional)

Show this wallet as "recommended" in the ConnectWallet Modal.

frameWallet({
  recommended: true,
});

Usage with ConnectWallet​

To allow users to connect to this wallet using the ConnectWallet component, you can add it to ThirdwebProvider's supportedWallets prop.

<ThirdwebProvider supportedWallets={[frameWallet()]} clientId="your-client-id">
  <YourApp />
</ThirdwebProvider>

Usage with useConnect​

you can use the useConnect hook to programmatically connect to the wallet without using the ConnectWallet component.

The wallet also needs to be added in ThirdwebProvider's supportedWallets if you want the wallet to auto-connect on next page load.

const frameWalletConfig = frameWallet();

function App() {
  const connect = useConnect();

  const handleConnect = async () => {
    await connect(frameWalletConfig, connectOptions);
  };

  return <div> ... </div>;
}

connectOptions​

{ chainId?: number } | undefined
chainId (optional)

If chainId is provided, wallet will be connected and immediately switch to network with given chainId.

Chain object corresponding to this chainId from @thirdweb-dev/chains package must be specified in ThirdwebProvider's supportedChains prop as shown below

import { Polygon } from "@thirdweb-dev/chains";
import { ThirdwebProvider } from "@thirdweb-dev/react";

export function YourApp() {
  return (
    <ThirdwebProvider supportedChains={[Polygon]} clientId="your-client-id">
      <App />
    </ThirdwebProvider>
  );
}