diff --git a/docs/authentication/web3/okx-wallet.mdx b/docs/authentication/web3/okx-wallet.mdx new file mode 100644 index 0000000000..d9ed6d59e1 --- /dev/null +++ b/docs/authentication/web3/okx-wallet.mdx @@ -0,0 +1,46 @@ +--- +title: OKX Wallet +description: Learn how to set up Web3 authentication with OKX Wallet. +--- + + + - Use OKX Wallet to authenticate users with Web3 + + +Enabling [OKX Wallet](https://www.okx.com/web3/rewritethesystem) as a Web3 provider allows your users to sign in and sign up to your Clerk application with their OKX Wallet. + +## Enable OKX Wallet as a Web3 provider + +1. In the Clerk Dashboard, navigate to the [**Web3**](https://dashboard.clerk.com/last-active?path=user-authentication/web3) page. +1. From the list of web3 providers, enable **OKX Wallet**. + +## Test authentication + +The simplest way to test authentication is to visit your Clerk application's [Account Portal](/docs/customization/account-portal/overview), which is available for all Clerk applications out-of-the-box. + +1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page. +1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble: + - **For development** – `https://your-domain.accounts.dev/sign-in` + - **For production** – `https://accounts.your-domain.com/sign-in` +1. On the sign-in page, you should see **OKX Wallet** as an option. Use it to sign in with your OKX Wallet. + +## Collect additional user information during sign-up + +Web3 applications typically utilize a hexadecimal wallet address to identify users, which offers a high level of privacy. However, when bridging the gap between Web3 and Web2, it's often necessary to gather human-readable information about the user, such as their email address, phone number, or a username. + +To collect additional information about your user during sign-up: + +1. In the Clerk Dashboard, navigate to the [**Email, phone, username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) page. +1. On this page, toggle on attributes you wish to collect from your user during sign up. Select the settings icon next to an attribute to set it as **Required**. When set as **Required**, Clerk automatically prompts the user for this information after they authenticate with OKX Wallet. + +## Connect OKX Wallet to existing account + +Users can connect their OKX Wallet to their account at any time through their user profile page. You can configure your application to use the [Account Portal User Profile page](/docs/customization/account-portal/overview#user-profile) or the prebuilt [``](/docs/components/user/user-profile) component. diff --git a/docs/manifest.json b/docs/manifest.json index e64bec3ffd..bf646b0418 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -607,6 +607,10 @@ { "title": "Coinbase Wallet", "href": "/docs/authentication/web3/coinbase-wallet" + }, + { + "title": "OKX Wallet", + "href": "/docs/authentication/web3/okx-wallet" } ] ]