From 7454d20b2bbf2d822468e0c37d97e5797929c8d6 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Wed, 3 Dec 2025 15:24:22 +0000 Subject: [PATCH 1/3] style updates --- .../custom-connections/auth0.mdx | 4 +- .../custom-connections/aws-cognito.mdx | 2 +- .../custom-connections/custom-jwt.mdx | 6 +- .../custom-connections/firebase.mdx | 4 +- .../authentication/social-logins/discord.mdx | 2 +- .../authentication/social-logins/facebook.mdx | 4 +- .../authentication/social-logins/google.mdx | 2 +- .../authentication/social-logins/oauth.mdx | 18 +- .../authentication/social-logins/twitch.mdx | 2 +- embedded-wallets/connect-blockchain/README.md | 6 +- .../_initialize-web3auth-other-pnp.mdx | 2 +- .../_evm-interaction.mdx | 3 +- .../_solana-provider-setup.mdx | 2 +- .../connect-blockchain/evm/README.mdx | 4 +- .../connect-blockchain/other/xrpl.mdx | 6 +- .../connect-blockchain/solana/README.mdx | 6 +- .../connect-blockchain/solana/react.mdx | 10 +- .../connect-blockchain/solana/unity.mdx | 8 +- .../connect-blockchain/solana/vue.mdx | 8 +- embedded-wallets/dashboard/README.mdx | 55 ++--- .../dashboard/advanced/custom-chains.mdx | 8 +- .../dashboard/advanced/key-export.mdx | 155 +++++++------- .../dashboard/advanced/session-management.mdx | 196 ++++++++++-------- .../dashboard/advanced/test-accounts.mdx | 88 ++++---- .../dashboard/advanced/user-details.mdx | 54 ++--- embedded-wallets/dashboard/analytics.mdx | 4 +- embedded-wallets/dashboard/authentication.mdx | 36 ++-- .../dashboard/chains-and-networks.mdx | 20 +- embedded-wallets/dashboard/customization.mdx | 52 ++--- .../dashboard/project-settings.mdx | 131 ++++++------ .../dashboard/wallet-services.mdx | 45 ++-- embedded-wallets/dashboard/whitelist.mdx | 161 ++++++++------ 32 files changed, 577 insertions(+), 527 deletions(-) diff --git a/embedded-wallets/authentication/custom-connections/auth0.mdx b/embedded-wallets/authentication/custom-connections/auth0.mdx index 9b38dc52da3..e5b8859dfb3 100644 --- a/embedded-wallets/authentication/custom-connections/auth0.mdx +++ b/embedded-wallets/authentication/custom-connections/auth0.mdx @@ -112,7 +112,7 @@ Follow these steps to create an Auth0 connection: ## Usage -Since, the `Auth0 Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `Auth0 Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. @@ -140,7 +140,7 @@ In your activity, create a `Web3Auth` instance with your Web3Auth project's conf web3Auth = Web3Auth( Web3AuthOptions( context = this, - clientId = getString(R.string.web3auth_project_id), // pass over your Web3Auth Client ID from Developer Dashboard + clientId = getString(R.string.web3auth_project_id), // pass over your Web3Auth Client ID from Web3Auth Dashboard network = Network.SAPPHIRE_MAINNET redirectUrl = Uri.parse("{YOUR_APP_PACKAGE_NAME}://auth"), // your app's redirect URL // focus-start diff --git a/embedded-wallets/authentication/custom-connections/aws-cognito.mdx b/embedded-wallets/authentication/custom-connections/aws-cognito.mdx index b7b3e35e26d..3e4d0e14a81 100644 --- a/embedded-wallets/authentication/custom-connections/aws-cognito.mdx +++ b/embedded-wallets/authentication/custom-connections/aws-cognito.mdx @@ -71,7 +71,7 @@ Follow these steps to create a AWS Cognito connection: ## Usage -Since, the `AWS Cognito Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `AWS Cognito Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. diff --git a/embedded-wallets/authentication/custom-connections/custom-jwt.mdx b/embedded-wallets/authentication/custom-connections/custom-jwt.mdx index 7e5d9a84985..367be2fc5a1 100644 --- a/embedded-wallets/authentication/custom-connections/custom-jwt.mdx +++ b/embedded-wallets/authentication/custom-connections/custom-jwt.mdx @@ -65,7 +65,7 @@ Follow these steps to create a custom JWT connection: /> -## Create JWT +## Create a JWT To generate the JWT, developers may use a package of their choice. Web3Auth provides documentation and examples using both the `jsonwebtoken` and `jose` libraries. @@ -123,7 +123,7 @@ npm i jsonwebtoken npm i jose ``` -### Generate JWT +### Generate a JWT Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. diff --git a/embedded-wallets/authentication/custom-connections/firebase.mdx b/embedded-wallets/authentication/custom-connections/firebase.mdx index 2da918a032f..6a653220253 100644 --- a/embedded-wallets/authentication/custom-connections/firebase.mdx +++ b/embedded-wallets/authentication/custom-connections/firebase.mdx @@ -112,7 +112,7 @@ Follow these steps to create a Firebase connection: ## Usage -Since, the `Firebase Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `Firebase Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. @@ -130,7 +130,7 @@ In your activity, create a `Web3Auth` instance with your Web3Auth project's conf web3Auth = Web3Auth( Web3AuthOptions( context = this, - clientId = getString(R.string.web3auth_project_id), // pass over your Web3Auth Client ID from Developer Dashboard + clientId = getString(R.string.web3auth_project_id), // pass over your Web3Auth Client ID from Web3Auth Dashboard network = Network.SAPPHIRE_MAINNET redirectUrl = Uri.parse("{YOUR_APP_PACKAGE_NAME}://auth"), // your app's redirect URL // focus-start diff --git a/embedded-wallets/authentication/social-logins/discord.mdx b/embedded-wallets/authentication/social-logins/discord.mdx index be2de0718e1..f2dcb90a1f7 100644 --- a/embedded-wallets/authentication/social-logins/discord.mdx +++ b/embedded-wallets/authentication/social-logins/discord.mdx @@ -71,7 +71,7 @@ Follow these steps to create a Discord connection: ## Usage -Since, the `Discord Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `Discord Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. diff --git a/embedded-wallets/authentication/social-logins/facebook.mdx b/embedded-wallets/authentication/social-logins/facebook.mdx index b06ef9b03b1..5fa40fcbee5 100644 --- a/embedded-wallets/authentication/social-logins/facebook.mdx +++ b/embedded-wallets/authentication/social-logins/facebook.mdx @@ -76,10 +76,10 @@ Follow these steps to create a Facebook connection: ## Usage -Since, the `Facebook Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `Facebook Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. -### Implicit Login with Facebook +### Implicit login with Facebook diff --git a/embedded-wallets/authentication/social-logins/google.mdx b/embedded-wallets/authentication/social-logins/google.mdx index 51972f71b1d..4dbeaad145c 100644 --- a/embedded-wallets/authentication/social-logins/google.mdx +++ b/embedded-wallets/authentication/social-logins/google.mdx @@ -71,7 +71,7 @@ Follow these steps to create a Google connection: ## Usage -Since, the `Google Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `Google Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. diff --git a/embedded-wallets/authentication/social-logins/oauth.mdx b/embedded-wallets/authentication/social-logins/oauth.mdx index b02081b7f41..f67ae9f954d 100644 --- a/embedded-wallets/authentication/social-logins/oauth.mdx +++ b/embedded-wallets/authentication/social-logins/oauth.mdx @@ -34,7 +34,7 @@ To use this feature, please enable `X(Twitter)`, `Farcaster`, `Apple`, `GitHub`, ### Log in with X -> Don't forget to enable X(Twitter) on the Dashboard. +> Don't forget to enable X(Twitter) on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -63,7 +63,7 @@ function CustomConnectors() { ### Log in with Farcaster -> Don't forget to enable Farcaster on the Dashboard. +> Don't forget to enable Farcaster on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -92,7 +92,7 @@ function CustomConnectors() { ### Log in with Apple -> Don't forget to enable Apple on the Dashboard. +> Don't forget to enable Apple on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -121,7 +121,7 @@ function CustomConnectors() { ### Log in with GitHub -> Don't forget to enable GitHub on the Dashboard. +> Don't forget to enable GitHub on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -150,7 +150,7 @@ function CustomConnectors() { ### Log in with Reddit -> Don't forget to enable Reddit on the Dashboard. +> Don't forget to enable Reddit on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -179,7 +179,7 @@ function CustomConnectors() { ### Log in with Line -> Don't forget to enable Line on the Dashboard. +> Don't forget to enable Line on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -208,7 +208,7 @@ function CustomConnectors() { ### Log in with Kakao -> Don't forget to enable Kakao on the Dashboard. +> Don't forget to enable Kakao on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -237,7 +237,7 @@ function CustomConnectors() { ### Log in with LinkedIn -> Don't forget to enable LinkedIn on the Dashboard. +> Don't forget to enable LinkedIn on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' @@ -266,7 +266,7 @@ function CustomConnectors() { ### Log in with WeChat -> Don't forget to enable WeChat on the Dashboard. +> Don't forget to enable WeChat on the dashboard. ```tsx title="App.tsx" import { useWeb3AuthConnect } from '@web3auth/modal/react' diff --git a/embedded-wallets/authentication/social-logins/twitch.mdx b/embedded-wallets/authentication/social-logins/twitch.mdx index c1de7970a47..1b1d3443345 100644 --- a/embedded-wallets/authentication/social-logins/twitch.mdx +++ b/embedded-wallets/authentication/social-logins/twitch.mdx @@ -74,7 +74,7 @@ Follow these steps to create a Twitch connection: ## Usage -Since, the `Twitch Connection` details are available from Dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. +Since, the `Twitch Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`. > Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow. diff --git a/embedded-wallets/connect-blockchain/README.md b/embedded-wallets/connect-blockchain/README.md index 7f62cee73fa..edd99f471d4 100644 --- a/embedded-wallets/connect-blockchain/README.md +++ b/embedded-wallets/connect-blockchain/README.md @@ -24,15 +24,15 @@ The SDKs are now branded as MetaMask Embedded Wallet SDKs (formerly Web3Auth Plu ## Dashboard configuration -The Embedded Wallets Web SDK (`@web3auth/modal`) from v10 onwards does not need any additional setup on the code side for blockchain connections. All of it is handled on the Dashboard. We can use any chain from the extensive list of predefined chains and add more if we need. +The Embedded Wallets Web SDK (`@web3auth/modal`) from v10 onwards does not need any additional setup on the code side for blockchain connections. All of it is handled on the dashboard. We can use any chain from the extensive list of predefined chains and add more if we need. ![Chains on Dashboard](https://i.ibb.co/4nCD2GTJ/chains.gif) -## Reference Guides for Blockchain Connections +## Reference guides for blockchain connections You can check out the following guides we've written for certain blockchains. We have covered a wide variety of EVM and EVM Chains, supported by multiple Embedded Wallets providers. -### Non EVM Chain guides +### Non-EVM chain guides diff --git a/embedded-wallets/connect-blockchain/_initialize-web3auth-other-pnp.mdx b/embedded-wallets/connect-blockchain/_initialize-web3auth-other-pnp.mdx index 7ef55616057..8990f265342 100644 --- a/embedded-wallets/connect-blockchain/_initialize-web3auth-other-pnp.mdx +++ b/embedded-wallets/connect-blockchain/_initialize-web3auth-other-pnp.mdx @@ -1,5 +1,5 @@ Post v10 release, Web3Auth Web SDK does not need any additional setup on the code side for other -chains: everything is handled on the Dashboard. +chains: everything is handled on the dashboard. ```tsx import { Web3Auth, WEB3AUTH_NETWORK } from "@web3auth/modal"; diff --git a/embedded-wallets/connect-blockchain/_ios-connect-blockchain/_evm-interaction.mdx b/embedded-wallets/connect-blockchain/_ios-connect-blockchain/_evm-interaction.mdx index d63dea6b8d6..15942f915c9 100644 --- a/embedded-wallets/connect-blockchain/_ios-connect-blockchain/_evm-interaction.mdx +++ b/embedded-wallets/connect-blockchain/_ios-connect-blockchain/_evm-interaction.mdx @@ -7,7 +7,8 @@ import SendTransactionSnippet from './_evm-send-transaction.mdx' ## Prerequisites -This doc assumes you have already setup your project in Web3Auth Dashboard, and have integrated Web3Auth in your iOS app. If you haven't done that yet, you can learn how to [integrate Web3Auth in your iOS app](/embedded-wallets/sdk/ios/). +- Project is set up in the Web3Auth dashboard +- Web3Auth is [integrated in your iOS app](/embedded-wallets/sdk/ios/) ## Installation diff --git a/embedded-wallets/connect-blockchain/_solana-provider-setup.mdx b/embedded-wallets/connect-blockchain/_solana-provider-setup.mdx index 654f66fe3d3..1cb16edda22 100644 --- a/embedded-wallets/connect-blockchain/_solana-provider-setup.mdx +++ b/embedded-wallets/connect-blockchain/_solana-provider-setup.mdx @@ -46,7 +46,7 @@ import Tabs from "@theme/Tabs"; ### Initializing and instantiating the Web3Auth SDK Post V10 release, Web3Auth Web SDK does not need any additional setup on the code side for -Solana. All is handled on the Dashboard. +Solana. All is handled on the dashboard. ```tsx import { Web3Auth, WEB3AUTH_NETWORK } from "@web3auth/modal"; diff --git a/embedded-wallets/connect-blockchain/evm/README.mdx b/embedded-wallets/connect-blockchain/evm/README.mdx index 0928812c196..8bf2ff74f6f 100644 --- a/embedded-wallets/connect-blockchain/evm/README.mdx +++ b/embedded-wallets/connect-blockchain/evm/README.mdx @@ -18,10 +18,10 @@ You can check out the following guides we've written for selected blockchains. W ::::info -With Embedded Wallets v10 onward, chains are already added to the Dashboard. You can use any chain from the extensive list of predefined chains and add more if needed by toggling them on. See our guide to [add custom chains](/embedded-wallets/dashboard/chains-and-networks/#adding-custom-networks) for more details. +With Embedded Wallets v10 onward, chains are already added to the dashboard. You can use any chain from the extensive list of predefined chains and add more if needed by toggling them on. See our guide to [add custom chains](/embedded-wallets/dashboard/chains-and-networks/#adding-custom-networks) for more details. :::: -The Embedded Wallets Web SDK(`@web3auth/modal`) from v10 onward does not need any additional setup on the code side for blockchain connections. All of it is handled on the Dashboard. We can use any chain from the extensive list of predefined chains and add more if we need. +The Embedded Wallets Web SDK(`@web3auth/modal`) from v10 onward does not need any additional setup on the code side for blockchain connections. All of it is handled on the dashboard. We can use any chain from the extensive list of predefined chains and add more if we need. ![Chains on Dashboard](https://i.ibb.co/4nCD2GTJ/chains.gif) diff --git a/embedded-wallets/connect-blockchain/other/xrpl.mdx b/embedded-wallets/connect-blockchain/other/xrpl.mdx index 2c76aaf259f..1503d4507c5 100644 --- a/embedded-wallets/connect-blockchain/other/xrpl.mdx +++ b/embedded-wallets/connect-blockchain/other/xrpl.mdx @@ -82,7 +82,7 @@ npm install --save @web3auth/xrpl-provider ## Initializing provider Post V10 release, Web3Auth Web SDK does not need any additional setup on the code side for XRPL. -All is handled on the Dashboard. +All is handled on the dashboard. ```tsx import { Web3Auth, WEB3AUTH_NETWORK } from '@web3auth/modal' @@ -136,7 +136,7 @@ try { } ``` -## Sign Transaction +## Sign a transaction ```tsx try { @@ -196,7 +196,7 @@ try { } ``` -## Sign Message +## Sign a message ```tsx try { diff --git a/embedded-wallets/connect-blockchain/solana/README.mdx b/embedded-wallets/connect-blockchain/solana/README.mdx index 76c97e77fbb..88485974a75 100644 --- a/embedded-wallets/connect-blockchain/solana/README.mdx +++ b/embedded-wallets/connect-blockchain/solana/README.mdx @@ -16,7 +16,7 @@ The SDKs are now branded as MetaMask Embedded Wallet SDKs (formerly Web3Auth Plu :::: -## Platform Guides +## Platform guides You can check out the following guides we've written for Solana across platforms. @@ -89,10 +89,10 @@ export const Solana = [ :::::info -With Embedded Wallets v10 onwards, chains are already added to the Dashboard. You can use any chain from the extensive list of predefined chains and add more if needed by toggling them on. See our guide to [add custom chains](/embedded-wallets/dashboard/chains-and-networks/#adding-custom-networks) for more details. +With Embedded Wallets v10 onwards, chains are already added to the dashboard. You can use any chain from the extensive list of predefined chains and add more if needed by toggling them on. See our guide to [add custom chains](/embedded-wallets/dashboard/chains-and-networks/#adding-custom-networks) for more details. ::::: -The Embedded Wallets Web SDK(`@web3auth/modal`) from v10 onwards does not need any additional setup on the code side for blockchain connections. All of it is handled on the Dashboard. We can use any chain from the extensive list of predefined chains and add more if we need. +The Embedded Wallets Web SDK(`@web3auth/modal`) from v10 onwards does not need any additional setup on the code side for blockchain connections. All of it is handled on the dashboard. We can use any chain from the extensive list of predefined chains and add more if we need. ![Chains on Dashboard](https://i.ibb.co/4nCD2GTJ/chains.gif) diff --git a/embedded-wallets/connect-blockchain/solana/react.mdx b/embedded-wallets/connect-blockchain/solana/react.mdx index 68cece646d2..8c3beef626f 100644 --- a/embedded-wallets/connect-blockchain/solana/react.mdx +++ b/embedded-wallets/connect-blockchain/solana/react.mdx @@ -85,9 +85,9 @@ npm install @solana/web3.js | `useSignTransaction` | Sign a Solana transaction (without sending). | | `useSolanaWallet` | Access Solana wallet state and utilities. | -## Hook Usage Examples +## Hook usage examples -### Get Solana Wallet +### Get Solana wallet ```tsx import { useSolanaWallet } from '@web3auth/modal/react/solana' @@ -105,7 +105,7 @@ function SolanaWallet() { } ``` -### Sign Message +### Sign a message ```tsx import { useSignMessage } from '@web3auth/modal/react/solana' @@ -135,7 +135,7 @@ function SignMessage() { } ``` -### Sign Transaction +### Sign a transaction ```tsx import { useSignTransaction } from '@web3auth/modal/react/solana' @@ -174,7 +174,7 @@ function SignTransaction() { } ``` -### Sign and Send Transaction +### Sign and send a transaction ```tsx import { useSignAndSendTransaction } from '@web3auth/modal/react/solana' diff --git a/embedded-wallets/connect-blockchain/solana/unity.mdx b/embedded-wallets/connect-blockchain/solana/unity.mdx index 8eff42f3131..33bb31c50f2 100644 --- a/embedded-wallets/connect-blockchain/solana/unity.mdx +++ b/embedded-wallets/connect-blockchain/solana/unity.mdx @@ -100,7 +100,7 @@ public class SolanaIntegration : MonoBehaviour } ``` -## Get Ed25519 Private Key +## Get Ed25519 private key ```csharp // After successful Web3Auth login @@ -110,7 +110,7 @@ string ed25519PrivateKey = await web3auth.GetEd25519PrivKey(); byte[] privateKeyBytes = Convert.FromHexString(ed25519PrivateKey); ``` -## Create Solana Keypair +## Create a Solana keypair Using the Magicblock Solana Unity SDK, you can create a keypair from the private key: @@ -142,7 +142,7 @@ var balanceInSOL = balance.Result.Value / 1_000_000_000.0; // Convert lamports t Debug.Log($"Balance: {balanceInSOL} SOL"); ``` -## Sign Transaction +## Sign a transaction ```csharp using Solana.Unity.Rpc.Models; @@ -182,7 +182,7 @@ else } ``` -## Sign Message +## Sign a message ```csharp // Sign a message with the private key diff --git a/embedded-wallets/connect-blockchain/solana/vue.mdx b/embedded-wallets/connect-blockchain/solana/vue.mdx index df5651305fd..864ce19d9bf 100644 --- a/embedded-wallets/connect-blockchain/solana/vue.mdx +++ b/embedded-wallets/connect-blockchain/solana/vue.mdx @@ -85,9 +85,9 @@ npm install @solana/web3.js | `useSignTransaction` | Sign a Solana transaction (without sending). | | `useSolanaWallet` | Access Solana wallet state and utilities. | -## Composable Usage Examples +## Composable usage examples -### Get Solana Wallet +### Get Solana wallet ```vue