Skip to main content

okxWallet

A wallet configurator for OKX Wallet which allows integrating the wallet with React.

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

const okxWalletConfig = okxWallet(options);

options​

projectId (recommended)

Your project's unique identifier that can be obtained at cloud.walletconnect.com.

Defaults to a common thirdweb projectId. We recommend getting your own projectId at cloud.walletconnect.com when launching your project.

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

okxWallet(
  {
    projectId: "<PROJECT_ID>",
  },
);
recommended (optional)

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

okxWallet({
  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={[okxWallet()]} 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 okxWalletConfig = okxWallet();

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

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

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