diff --git a/embedded-wallets/dashboard/README.mdx b/embedded-wallets/dashboard/README.mdx index bbe58f65152..dc146aed806 100644 --- a/embedded-wallets/dashboard/README.mdx +++ b/embedded-wallets/dashboard/README.mdx @@ -49,15 +49,15 @@ The project comes pre-configured with default connections, chains and networks t Once your project is created, you can configure various aspects of your integration through the dashboard: -- **[Project Settings](./project-settings)** - Basic project information, credentials, and token verification -- **[Whitelist Settings](./whitelist)** - Domain and URL authorization for enhanced security -- **[Advanced Project Settings](./advanced/session-management)** - Advanced configuration options - - **[Session Management](./advanced/session-management)** - Session duration and behavior - - **[Test Accounts](./advanced/test-accounts)** - Development testing environment - - **[User Details in ID Token](./advanced/user-details)** - JWT token user data configuration - - **[Key Export Settings](./advanced/key-export)** - Private key export permissions -- **[Chains and Networks](./chains-and-networks)** - Manage blockchain networks and custom chain configurations -- **[Authentication](./authentication)** - Configure login methods, social connections, and custom authentication -- **[Wallet Services](./wallet-services)** - Customize wallet UI and configure wallet features -- **[Customization](./customization)** - Brand your login flow and customize the user experience -- **[Analytics](./analytics)** - Monitor project usage and user engagement metrics +- **[Project Settings](./project-settings.mdx)** - Basic project information, credentials, and token verification +- **[Whitelist Settings](./whitelist.mdx)** - Domain and URL authorization for enhanced security +- **[Advanced Project Settings](./advanced/session-management.mdx)** - Advanced configuration options + - **[Session Management](./advanced/session-management.mdx)** - Session duration and behavior + - **[Test Accounts](./advanced/test-accounts.mdx)** - Development testing environment + - **[User Details in ID Token](./advanced/user-details.mdx)** - JWT token user data configuration + - **[Key Export Settings](./advanced/key-export.mdx)** - Private key export permissions +- **[Chains and Networks](./chains-and-networks.mdx)** - Manage blockchain networks and custom chain configurations +- **[Authentication](./authentication.mdx)** - Configure login methods, social connections, and custom authentication +- **[Wallet Services](./wallet-services.mdx)** - Customize wallet UI and configure wallet features +- **[Customization](./customization.mdx)** - Brand your login flow and customize the user experience +- **[Analytics](./analytics.mdx)** - Monitor project usage and user engagement metrics diff --git a/embedded-wallets/dashboard/whitelist.mdx b/embedded-wallets/dashboard/whitelist.mdx index 3896bd3290f..f6c6c0d9c08 100644 --- a/embedded-wallets/dashboard/whitelist.mdx +++ b/embedded-wallets/dashboard/whitelist.mdx @@ -302,6 +302,6 @@ https://*.api.myapp.com ## Next Steps -- **[Project Settings](../project-settings)** - Configure basic project information -- **[Advanced Project Settings](../advanced/session-management)** - Access advanced configuration options -- **[Session Management](../advanced/session-management)** - Control session duration and behavior +- **[Project Settings](./project-settings.mdx)** - Configure basic project information +- **[Advanced Project Settings](./advanced/session-management.mdx)** - Access advanced configuration options +- **[Session Management](./advanced/session-management.mdx)** - Control session duration and behavior diff --git a/embedded-wallets/sdk/_common/_advanced-config-options.mdx b/embedded-wallets/sdk/_common/_advanced-config-options.mdx deleted file mode 100644 index 62f1bf83c8c..00000000000 --- a/embedded-wallets/sdk/_common/_advanced-config-options.mdx +++ /dev/null @@ -1,77 +0,0 @@ -## Session Management - -Control how long users stay authenticated and how sessions persist. - -**Key Configuration Options:** - -- `sessionTime` - Session duration in seconds. Controls how long users remain authenticated before - needing to log in again. - - Minimum: 1 second (`1`). - - Maximum: 30 days (`86400 * 30`). - - Default: 7 days (`86400 * 7`). -- `storageType` - Storage location for authentication state. Options: - - `"local"`: Persists across browser tabs and browser restarts (localStorage) - - `"session"`: Persists only in current tab, cleared when tab closes (sessionStorage) - -```tsx -const web3AuthOptions = { - clientId: 'YOUR_WEB3AUTH_CLIENT_ID', // Pass your Web3Auth Client ID, ideally using an environment variable - web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET, - - // Session configuration - sessionTime: 86400 * 7, // 7 days (in seconds) - storageType: 'local', // 'local' (persistent across tabs) or 'session' (single tab only) -} -``` - -## Multi-Factor Authentication (MFA) - -Add additional security layers to protect user accounts with two-factor authentication. For detailed -configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) -section. - -**Key Configuration Options:** - -- `mfaSettings` - Configure MFA settings for different authentication flows -- `mfaLevel` - Control when users are prompted to set up MFA - -## Custom Authentication Methods - -Control the login options presented to your users and how they're displayed in the modal. For -detailed configuration options and implementation examples, see the -[Custom Authentication](./custom-authentication) section. - -**Key Configuration Options:** - -- `modalConfig` - Define which authentication methods are available and customize their appearance - -## UI Customization - -Create a seamless brand experience by customizing the Web3Auth Modal to match your application's -design. For complete customization options, refer to the -[Whitelabeling & UI Customization](./whitelabel) section. - -**Key Configuration Options:** - -- `uiConfig` - Personalize the modal's look and feel with custom colors, logos, themes, and more -- `modalConfig` - Control the visibility and arrangement of authentication options - -## Smart Accounts (Account Abstraction) - -Improve user experience with gasless transactions and advanced account features. Learn more in the -[Smart Accounts](./smart-accounts) documentation. - -**Key Configuration Options:** - -- `accountAbstractionConfig` - Fine-tune parameters for smart account implementation -- `useAAWithExternalWallet` - Enable account abstraction functionality even when users connect with - external wallets - -## Wallet Services - -Extend your application with enhanced wallet functionality. See the -[Wallet Services](./wallet-services) documentation for complete configuration options. - -**Key Configuration Options:** - -- `walletServicesConfig` - Integrate additional wallet services and features diff --git a/embedded-wallets/sdk/android/README.mdx b/embedded-wallets/sdk/android/README.mdx index 81ecb25290f..fa56ce6c0fa 100644 --- a/embedded-wallets/sdk/android/README.mdx +++ b/embedded-wallets/sdk/android/README.mdx @@ -53,7 +53,7 @@ dependencies { :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -209,10 +209,10 @@ initializeCF.whenComplete { _, error -> The Web3Auth Android SDK offers a rich set of advanced configuration options: -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices. :::tip diff --git a/embedded-wallets/sdk/android/advanced/README.mdx b/embedded-wallets/sdk/android/advanced/README.mdx index 8ba74620863..9d9e6209f8b 100644 --- a/embedded-wallets/sdk/android/advanced/README.mdx +++ b/embedded-wallets/sdk/android/advanced/README.mdx @@ -115,15 +115,15 @@ var web3Auth = Web3Auth( ## Custom Authentication Methods -Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section. +Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section. ## UI Customization -Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section. +Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section. ## Multi-Factor Authentication (MFA) -Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section. +Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section. **Key Configuration Options:** diff --git a/embedded-wallets/sdk/flutter/README.mdx b/embedded-wallets/sdk/flutter/README.mdx index ebfe3865827..45d46c32633 100644 --- a/embedded-wallets/sdk/flutter/README.mdx +++ b/embedded-wallets/sdk/flutter/README.mdx @@ -42,7 +42,7 @@ flutter pub add web3auth_flutter :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -239,10 +239,10 @@ If the API call to fetch the project configuration fails, the method will throw The Web3Auth Flutter SDK offers a rich set of advanced configuration options: -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices. :::tip diff --git a/embedded-wallets/sdk/flutter/advanced/README.mdx b/embedded-wallets/sdk/flutter/advanced/README.mdx index e4b6c6f7a0c..796145accee 100644 --- a/embedded-wallets/sdk/flutter/advanced/README.mdx +++ b/embedded-wallets/sdk/flutter/advanced/README.mdx @@ -143,15 +143,15 @@ await Web3AuthFlutter.init(Web3AuthOptions( ## Custom Authentication Methods -Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section. +Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section. ## UI Customization -Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section. +Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section. ## Multi-Factor Authentication (MFA) -Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section. +Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section. **Key Configuration Options:** diff --git a/embedded-wallets/sdk/ios/README.mdx b/embedded-wallets/sdk/ios/README.mdx index ab64e42a947..940de1d4043 100644 --- a/embedded-wallets/sdk/ios/README.mdx +++ b/embedded-wallets/sdk/ios/README.mdx @@ -52,7 +52,7 @@ pod 'Web3Auth', '~> 11.1.0' :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -133,10 +133,10 @@ func application(_ app: UIApplication, open url: URL, options: [UIApplication.Op The Web3Auth iOS SDK offers a rich set of advanced configuration options: -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices. :::tip diff --git a/embedded-wallets/sdk/ios/advanced/README.mdx b/embedded-wallets/sdk/ios/advanced/README.mdx index 49c2848aa66..9f3dc83dd5f 100644 --- a/embedded-wallets/sdk/ios/advanced/README.mdx +++ b/embedded-wallets/sdk/ios/advanced/README.mdx @@ -104,15 +104,15 @@ web3Auth = Web3Auth(W3AInitParams( ## Custom Authentication Methods -Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section. +Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section. ## UI Customization -Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section. +Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section. ## Multi-Factor Authentication (MFA) -Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section. +Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section. **Key Configuration Options:** diff --git a/embedded-wallets/sdk/js/README.mdx b/embedded-wallets/sdk/js/README.mdx index 8f093b1515b..9fa3325ea34 100644 --- a/embedded-wallets/sdk/js/README.mdx +++ b/embedded-wallets/sdk/js/README.mdx @@ -33,7 +33,7 @@ npm install --save @web3auth/modal :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -62,15 +62,15 @@ await web3auth.init() The Web3Auth Modal SDK offers a rich set of advanced configuration options: -- **[Smart Accounts](./advanced/smart-accounts)**: Configure account abstraction parameters. -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[Wallet Services](./advanced/wallet-services)**: Integrate additional wallet services. +- **[Smart Accounts](./advanced/smart-accounts.mdx)**: Configure account abstraction parameters. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[Wallet Services](./advanced/wallet-services.mdx)**: Integrate additional wallet services. :::tip -Head over to the [**Advanced Configuration**](./advanced) section to learn more about each configuration option. +Head over to the [**Advanced Configuration**](./advanced/README.mdx) section to learn more about each configuration option. ::: diff --git a/embedded-wallets/sdk/js/advanced/README.mdx b/embedded-wallets/sdk/js/advanced/README.mdx index d5df2d61ddc..cee4babe2e5 100644 --- a/embedded-wallets/sdk/js/advanced/README.mdx +++ b/embedded-wallets/sdk/js/advanced/README.mdx @@ -7,7 +7,6 @@ description: '@web3auth/modal Advanced Configuration | Embedded Wallets' import TabItem from '@theme/TabItem' import Tabs from '@theme/Tabs' import Web3AuthOptions from '../../_common/_web3auth-options.mdx' -import AdvancedConfigOptions from '../../_common/_advanced-config-options.mdx' # Advanced Configuration @@ -52,4 +51,80 @@ export class AppComponent { - +## Session Management + +Control how long users stay authenticated and how sessions persist. + +**Key Configuration Options:** + +- `sessionTime` - Session duration in seconds. Controls how long users remain authenticated before + needing to log in again. + - Minimum: 1 second (`1`). + - Maximum: 30 days (`86400 * 30`). + - Default: 7 days (`86400 * 7`). +- `storageType` - Storage location for authentication state. Options: + - `"local"`: Persists across browser tabs and browser restarts (localStorage) + - `"session"`: Persists only in current tab, cleared when tab closes (sessionStorage) + +```tsx +const web3AuthOptions = { + clientId: 'YOUR_WEB3AUTH_CLIENT_ID', // Pass your Web3Auth Client ID, ideally using an environment variable + web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET, + + // Session configuration + sessionTime: 86400 * 7, // 7 days (in seconds) + storageType: 'local', // 'local' (persistent across tabs) or 'session' (single tab only) +} +``` + +## Multi-Factor Authentication (MFA) + +Add additional security layers to protect user accounts with two-factor authentication. For detailed +configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) +section. + +**Key Configuration Options:** + +- `mfaSettings` - Configure MFA settings for different authentication flows +- `mfaLevel` - Control when users are prompted to set up MFA + +## Custom Authentication Methods + +Control the login options presented to your users and how they're displayed in the modal. For +detailed configuration options and implementation examples, see the +[Custom Authentication](./custom-authentication.mdx) section. + +**Key Configuration Options:** + +- `modalConfig` - Define which authentication methods are available and customize their appearance + +## UI Customization + +Create a seamless brand experience by customizing the Web3Auth Modal to match your application's +design. For complete customization options, refer to the +[Whitelabeling & UI Customization](./whitelabel.mdx) section. + +**Key Configuration Options:** + +- `uiConfig` - Personalize the modal's look and feel with custom colors, logos, themes, and more +- `modalConfig` - Control the visibility and arrangement of authentication options + +## Smart Accounts (Account Abstraction) + +Improve user experience with gasless transactions and advanced account features. Learn more in the +[Smart Accounts](./smart-accounts.mdx) documentation. + +**Key Configuration Options:** + +- `accountAbstractionConfig` - Fine-tune parameters for smart account implementation +- `useAAWithExternalWallet` - Enable account abstraction functionality even when users connect with + external wallets + +## Wallet Services + +Extend your application with enhanced wallet functionality. See the +[Wallet Services](./wallet-services.mdx) documentation for complete configuration options. + +**Key Configuration Options:** + +- `walletServicesConfig` - Integrate additional wallet services and features diff --git a/embedded-wallets/sdk/js/migration-guides/modal/v7-to-v10/README.mdx b/embedded-wallets/sdk/js/migration-guides/modal/v7-to-v10/README.mdx index d8a6f0d1974..022401db7c3 100644 --- a/embedded-wallets/sdk/js/migration-guides/modal/v7-to-v10/README.mdx +++ b/embedded-wallets/sdk/js/migration-guides/modal/v7-to-v10/README.mdx @@ -169,18 +169,18 @@ await web3auth.switchChain({ chainId: '0x1' }) // Switch chains (unchanged) For specific functionality migrations, refer to these supplementary guides: **External Wallet Adapters:** If you used external wallet adapters in v7, see the πŸ”Œ -**[External Wallet Adapters Migration Guide](./external-wallets)** for migrating +**[External Wallet Adapters Migration Guide](./external-wallets.mdx)** for migrating to automatic detection. **Wallet Services:** If you used the `@web3auth/wallet-services-plugin` in v7, see the πŸ› οΈ -**[Wallet Services Migration Guide](./wallet-services)** for migrating to the +**[Wallet Services Migration Guide](./wallet-services.mdx)** for migrating to the built-in integration. **Whitelabeling and UI Customization:** If you had whitelabeling configurations in v7, see the πŸ“‹ -**[Whitelabeling Migration Guide](./whitelabeling)** for detailed steps. +**[Whitelabeling Migration Guide](./whitelabeling.mdx)** for detailed steps. **Custom Authentication:** If you used custom verifiers in v7, see the πŸ” -**[Custom Authentication Migration Guide](./custom-authentication)** for +**[Custom Authentication Migration Guide](./custom-authentication.mdx)** for migrating to the new Connections system. ## Complete Migration Example diff --git a/embedded-wallets/sdk/js/migration-guides/modal/v8-to-v10/README.mdx b/embedded-wallets/sdk/js/migration-guides/modal/v8-to-v10/README.mdx index 9bf96504f61..bc2c8479e48 100644 --- a/embedded-wallets/sdk/js/migration-guides/modal/v8-to-v10/README.mdx +++ b/embedded-wallets/sdk/js/migration-guides/modal/v8-to-v10/README.mdx @@ -154,13 +154,13 @@ const userAuthInfo = await web3auth.getIdentityToken() const idToken = userAuthInfo.idToken ``` -**External Wallet Adapters:** If you used external wallet adapters (MetaMask, Phantom, Solflare, etc.) in v8, see the πŸ”Œ **[External Wallet Adapters Migration Guide](./external-wallets)** for migrating to the automatic detection system. +**External Wallet Adapters:** If you used external wallet adapters (MetaMask, Phantom, Solflare, etc.) in v8, see the πŸ”Œ **[External Wallet Adapters Migration Guide](./external-wallets.mdx)** for migrating to the automatic detection system. -**Wallet Services:** If you used the `@web3auth/wallet-services-plugin` in v8, see the πŸ› οΈ **[Wallet Services Migration Guide](./wallet-services)** for migrating to the built-in integration. +**Wallet Services:** If you used the `@web3auth/wallet-services-plugin` in v8, see the πŸ› οΈ **[Wallet Services Migration Guide](./wallet-services.mdx)** for migrating to the built-in integration. -**Whitelabeling and UI Customization:** If you had whitelabeling configurations in v8, see the πŸ“‹ **[Whitelabeling Migration Guide](./whitelabeling)** for detailed steps. +**Whitelabeling and UI Customization:** If you had whitelabeling configurations in v8, see the πŸ“‹ **[Whitelabeling Migration Guide](./whitelabeling.mdx)** for detailed steps. -**Custom Authentication:** If you used custom verifiers in v8, see the πŸ” **[Custom Authentication Migration Guide](./custom-authentication)** for migrating to the new Connections system. +**Custom Authentication:** If you used custom verifiers in v8, see the πŸ” **[Custom Authentication Migration Guide](./custom-authentication.mdx)** for migrating to the new Connections system. ## Complete Migration Example diff --git a/embedded-wallets/sdk/js/migration-guides/modal/v9-to-v10/README.mdx b/embedded-wallets/sdk/js/migration-guides/modal/v9-to-v10/README.mdx index 8705f33f2fd..1f7fe5b1cab 100644 --- a/embedded-wallets/sdk/js/migration-guides/modal/v9-to-v10/README.mdx +++ b/embedded-wallets/sdk/js/migration-guides/modal/v9-to-v10/README.mdx @@ -152,21 +152,22 @@ const userAuthInfo = await web3auth.getIdentityToken() // Returns { idToken: str const idToken = userAuthInfo.idToken ``` -**Wallet Services:** If you used the `@web3auth/wallet-services-plugin` in v9, see the πŸ› οΈ **[Wallet Services Migration Guide](./wallet-services)** for migrating to the built-in integration. +**Wallet Services:** If you used the `@web3auth/wallet-services-plugin` in v9, see the πŸ› οΈ **[Wallet Services Migration Guide](./wallet-services.mdx)** for migrating to the built-in integration. ## Additional Migration Guides For specific functionality or frameworks, refer to these dedicated migration guides: -**πŸ“‹ Whitelabeling and UI Customization:** If you had whitelabeling configurations (`uiConfig`, `modalConfig`, or `AuthAdapter` whitelabel settings) in v9, see the **[Whitelabeling Migration Guide](./whitelabeling)** for detailed steps. +**πŸ“‹ Whitelabeling and UI Customization:** If you had whitelabeling configurations (`uiConfig`, `modalConfig`, or `AuthAdapter` whitelabel settings) in v9, see the **[Whitelabeling Migration Guide](./whitelabeling.mdx)** for detailed steps. -**πŸ”§ Smart Account Functionality:** If you used Smart Accounts in v9 with `@web3auth/account-abstraction-provider`, see the **[Smart Account Migration Guide](./smart-accounts)** for the new dashboard-centric approach. +**πŸ”§ Smart Account Functionality:** If you used Smart Accounts in v9 with `@web3auth/account-abstraction-provider`, see the **[Smart Account Migration Guide](./smart-accounts.mdx)** for the new dashboard-centric approach. -**πŸ” Custom Authentication:** If you used custom verifiers or aggregate verifiers in v9, see the **[Custom Authentication Migration Guide](./custom-authentication)** for migrating to the new Connections system. +**πŸ” Custom Authentication:** If you used custom verifiers or aggregate verifiers in v9, see the **[Custom Authentication Migration Guide](./custom-authentication.mdx)** for migrating to the new Connections system. **βš›οΈ React & Vue Applications:** If you're using React or Vue with Web3Auth, see the framework-specific migration guides: -- [React Migration Guide](/embedded-wallets/sdk/react/migration-guides/modal-v9-to-v10-react) -- [Vue Migration Guide](/embedded-wallets/sdk/vue/migration-guides/modal-v9-to-v10-vue) + +- [React Migration Guide](../../../../react/migration-guides/modal-v9-to-v10-react.mdx) +- [Vue Migration Guide](../../../../vue/migration-guides/modal-v9-to-v10-vue.mdx) ## Further Reading diff --git a/embedded-wallets/sdk/react-native/README.mdx b/embedded-wallets/sdk/react-native/README.mdx index 07d843ccdd8..7037863ed83 100644 --- a/embedded-wallets/sdk/react-native/README.mdx +++ b/embedded-wallets/sdk/react-native/README.mdx @@ -85,7 +85,7 @@ npm install --save @toruslabs/react-native-web-browser react-native-encrypted-st :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -257,11 +257,11 @@ useEffect(() => { The Web3Auth React Native SDK offers a rich set of advanced configuration options: -- **[Account Abstraction](./advanced/smart-accounts)**: Configure smart account parameters. -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices. +- **[Account Abstraction](./advanced/smart-accounts.mdx)**: Configure smart account parameters. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices. :::tip @@ -394,4 +394,4 @@ const getSolanaAccount = async () => { While using Web3Auth in React Native, you may run into issues building. This issue occurs because some core packages like `eccrypto` have certain dependencies which are not present within the Metro build environment. -To solve this, please have a look at our troubleshooting page for [React Native Metro Bundler Issues](/embedded-wallets/troubleshooting/metro-issues) +To solve this, please have a look at our troubleshooting page for [React Native Metro Bundler Issues](../../troubleshooting/metro-issues.mdx) diff --git a/embedded-wallets/sdk/react-native/advanced/README.mdx b/embedded-wallets/sdk/react-native/advanced/README.mdx index e9511262a0c..0dc8ca6ceaf 100644 --- a/embedded-wallets/sdk/react-native/advanced/README.mdx +++ b/embedded-wallets/sdk/react-native/advanced/README.mdx @@ -129,16 +129,16 @@ const web3auth = new Web3Auth(WebBrowser, SecureStore, { ## Custom Authentication Methods -Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section. +Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section. ## UI Customization -Create a seamless brand experience by customizing the Web3Auth Login Screens to match your React Native application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section. +Create a seamless brand experience by customizing the Web3Auth Login Screens to match your React Native application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section. ## Multi-Factor Authentication (MFA) -Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section. +Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section. ## DApp Share -Share authentication sessions across different applications. For detailed configuration options and implementation examples, see the [DApp Share](./dapp-share) section. +Share authentication sessions across different applications. For detailed configuration options and implementation examples, see the [DApp Share](./dapp-share.mdx) section. diff --git a/embedded-wallets/sdk/react/README.mdx b/embedded-wallets/sdk/react/README.mdx index c53765acb47..def79b5d774 100644 --- a/embedded-wallets/sdk/react/README.mdx +++ b/embedded-wallets/sdk/react/README.mdx @@ -31,7 +31,7 @@ npm install --save @web3auth/modal :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -82,15 +82,15 @@ ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render( The Web3Auth Modal SDK offers a rich set of advanced configuration options: -- **[Smart Accounts](./advanced/smart-accounts)**: Configure account abstraction parameters. -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[Wallet Services](./advanced/wallet-services)**: Integrate additional wallet services. +- **[Smart Accounts](./advanced/smart-accounts.mdx)**: Configure account abstraction parameters. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[Wallet Services](./advanced/wallet-services.mdx)**: Integrate additional wallet services. :::tip -Head over to the [**Advanced Configuration**](./advanced) section to learn more about each configuration option. +Head over to the [**Advanced Configuration**](./advanced/README.mdx) section to learn more about each configuration option. ::: @@ -183,12 +183,12 @@ Web3Auth is blockchain agnostic, enabling integration with any blockchain networ Solana hooks are included natively within the `@web3auth/modal` package. No additional setup is requiredβ€”simply use the provided hooks to interact with Solana networks. -For detailed usage and examples, visit the [**Solana Hooks**](./solana-hooks) section. +For detailed usage and examples, visit the [**Solana Hooks**](./solana-hooks/README.mdx) section. ### Ethereum Integration Ethereum hooks are provided through the popular `wagmi` library, which works seamlessly with Web3Auth. This allows you to leverage a wide range of Ethereum hooks for account management, transactions, and more. -For implementation details and examples, refer to the [**Ethereum Hooks**](./ethereum-hooks) section. +For implementation details and examples, refer to the [**Ethereum Hooks**](./ethereum-hooks.mdx) section. diff --git a/embedded-wallets/sdk/react/advanced/README.mdx b/embedded-wallets/sdk/react/advanced/README.mdx index 2e64519c639..47274cacef0 100644 --- a/embedded-wallets/sdk/react/advanced/README.mdx +++ b/embedded-wallets/sdk/react/advanced/README.mdx @@ -7,7 +7,6 @@ description: '@web3auth/modal Advanced Configuration | Embedded Wallets' import TabItem from '@theme/TabItem' import Tabs from '@theme/Tabs' import Web3AuthOptions from '../../_common/_web3auth-options.mdx' -import AdvancedConfigOptions from '../../_common/_advanced-config-options.mdx' # Advanced Configuration @@ -38,4 +37,80 @@ const web3AuthContextConfig: Web3AuthContextConfig = { - +## Session Management + +Control how long users stay authenticated and how sessions persist. + +**Key Configuration Options:** + +- `sessionTime` - Session duration in seconds. Controls how long users remain authenticated before + needing to log in again. + - Minimum: 1 second (`1`). + - Maximum: 30 days (`86400 * 30`). + - Default: 7 days (`86400 * 7`). +- `storageType` - Storage location for authentication state. Options: + - `"local"`: Persists across browser tabs and browser restarts (localStorage) + - `"session"`: Persists only in current tab, cleared when tab closes (sessionStorage) + +```tsx +const web3AuthOptions = { + clientId: 'YOUR_WEB3AUTH_CLIENT_ID', // Pass your Web3Auth Client ID, ideally using an environment variable + web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET, + + // Session configuration + sessionTime: 86400 * 7, // 7 days (in seconds) + storageType: 'local', // 'local' (persistent across tabs) or 'session' (single tab only) +} +``` + +## Multi-Factor Authentication (MFA) + +Add additional security layers to protect user accounts with two-factor authentication. For detailed +configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) +section. + +**Key Configuration Options:** + +- `mfaSettings` - Configure MFA settings for different authentication flows +- `mfaLevel` - Control when users are prompted to set up MFA + +## Custom Authentication Methods + +Control the login options presented to your users and how they're displayed in the modal. For +detailed configuration options and implementation examples, see the +[Custom Authentication](./custom-authentication.mdx) section. + +**Key Configuration Options:** + +- `modalConfig` - Define which authentication methods are available and customize their appearance + +## UI Customization + +Create a seamless brand experience by customizing the Web3Auth Modal to match your application's +design. For complete customization options, refer to the +[Whitelabeling & UI Customization](./whitelabel.mdx) section. + +**Key Configuration Options:** + +- `uiConfig` - Personalize the modal's look and feel with custom colors, logos, themes, and more +- `modalConfig` - Control the visibility and arrangement of authentication options + +## Smart Accounts (Account Abstraction) + +Improve user experience with gasless transactions and advanced account features. Learn more in the +[Smart Accounts](./smart-accounts.mdx) documentation. + +**Key Configuration Options:** + +- `accountAbstractionConfig` - Fine-tune parameters for smart account implementation +- `useAAWithExternalWallet` - Enable account abstraction functionality even when users connect with + external wallets + +## Wallet Services + +Extend your application with enhanced wallet functionality. See the +[Wallet Services](./wallet-services.mdx) documentation for complete configuration options. + +**Key Configuration Options:** + +- `walletServicesConfig` - Integrate additional wallet services and features diff --git a/embedded-wallets/sdk/react/advanced/custom-authentication.mdx b/embedded-wallets/sdk/react/advanced/custom-authentication.mdx index ba1ea951b0d..2d0e50e1ebe 100644 --- a/embedded-wallets/sdk/react/advanced/custom-authentication.mdx +++ b/embedded-wallets/sdk/react/advanced/custom-authentication.mdx @@ -34,7 +34,7 @@ Custom Authentication is a way to authenticate users with your custom authentica :::info prerequisite -To enable this, you need to [Create a Connection](/embedded-wallets/dashboard/authentication) from the **Authentication** tab of your project from the [Web3Auth Developer Dashboard](https://dashboard.web3auth.io) with your desired configuration. +To enable this, you need to [Create a Connection](../../../dashboard/authentication.mdx) from the **Authentication** tab of your project from the [Web3Auth Developer Dashboard](https://dashboard.web3auth.io) with your desired configuration. ::: @@ -42,7 +42,7 @@ To configure a connection, you need to provide the particular details of the con :::tip -Visit the [Auth Provider Setup](/embedded-wallets/authentication) page to learn more about to setup the different configurations available for each connection. +Visit the [Auth Provider Setup](../../../authentication/README.mdx) page to learn more about to setup the different configurations available for each connection. ::: @@ -58,7 +58,7 @@ You can only configure implicit login via modal, for JWT based logins, you need For the modal custom authentication, you need to pass the `modalConfig` object to the `Web3AuthOptions` object within the constructor. -> **Read more about the `modalConfig` object in the [Whitelabel](../whitelabel) section.** +> **Read more about the `modalConfig` object in the [Whitelabel](./whitelabel.mdx) section.** ### Usage diff --git a/embedded-wallets/sdk/react/advanced/whitelabel.mdx b/embedded-wallets/sdk/react/advanced/whitelabel.mdx index 31f84f563b8..7d460bb7f33 100644 --- a/embedded-wallets/sdk/react/advanced/whitelabel.mdx +++ b/embedded-wallets/sdk/react/advanced/whitelabel.mdx @@ -248,4 +248,4 @@ export default web3AuthContextConfig For complete control over the authentication interface, you can bypass the Web3Auth modal entirely and use the `connectTo` function. This allows you to create custom buttons that connect directly to specific auth providers. -See the [Custom Authentication](../custom-authentication) section for detailed implementation instructions. +See the [Custom Authentication](./custom-authentication.mdx) section for detailed implementation instructions. diff --git a/embedded-wallets/sdk/unity/README.mdx b/embedded-wallets/sdk/unity/README.mdx index e520e44812f..1c0513e077f 100644 --- a/embedded-wallets/sdk/unity/README.mdx +++ b/embedded-wallets/sdk/unity/README.mdx @@ -45,7 +45,7 @@ To fix this problem you need to add the following line into the dependencies obj :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -140,10 +140,10 @@ private void onLogout() The Web3Auth Unity SDK offers a rich set of advanced configuration options: -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices. :::tip @@ -230,7 +230,7 @@ Web3Auth is blockchain agnostic, enabling integration with any blockchain networ :::tip -We recommend you use the [Nethereum Library](https://docs.nethereum.com/en/latest/unity3d-introduction/) for making the blockchain calls. You can check our documentation on how to integrate Nethereum it with Web3Auth [here](/embedded-wallets/connect-blockchain/evm/ethereum/unity). +We recommend you use the [Nethereum Library](https://docs.nethereum.com/en/latest/unity3d-introduction/) for making the blockchain calls. You can check our documentation on how to integrate Nethereum it with Web3Auth [here](../../connect-blockchain/evm/ethereum/unity.mdx). ::: diff --git a/embedded-wallets/sdk/unity/advanced/README.mdx b/embedded-wallets/sdk/unity/advanced/README.mdx index 3d55a32d10c..f5b29c6faa3 100644 --- a/embedded-wallets/sdk/unity/advanced/README.mdx +++ b/embedded-wallets/sdk/unity/advanced/README.mdx @@ -91,15 +91,15 @@ web3Auth.setOptions(new Web3AuthOptions(){ ## Custom Authentication Methods -Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section. +Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section. ## UI Customization -Create a seamless brand experience by customizing the Web3Auth Login Screens to match your Unity application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section. +Create a seamless brand experience by customizing the Web3Auth Login Screens to match your Unity application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section. ## Multi-Factor Authentication (MFA) -Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section. +Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section. **Key Configuration Options:** @@ -108,4 +108,4 @@ Add additional security layers to protect user accounts with two-factor authenti ## DApp Share -Share authentication sessions across different applications. For detailed configuration options and implementation examples, see the [DApp Share](./dapp-share) section. +Share authentication sessions across different applications. For detailed configuration options and implementation examples, see the [DApp Share](./dapp-share.mdx) section. diff --git a/embedded-wallets/sdk/unreal/README.mdx b/embedded-wallets/sdk/unreal/README.mdx index 6877c47e313..df940f89f7d 100644 --- a/embedded-wallets/sdk/unreal/README.mdx +++ b/embedded-wallets/sdk/unreal/README.mdx @@ -44,7 +44,7 @@ Download the [Unreal Package](https://github.com/Web3Auth/web3auth-unreal-sdk/re :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -128,9 +128,9 @@ void AYourGameMode::OnWeb3AuthLogout() The Web3Auth Unreal SDK offers a rich set of advanced configuration options: -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. :::tip diff --git a/embedded-wallets/sdk/unreal/advanced/README.mdx b/embedded-wallets/sdk/unreal/advanced/README.mdx index 7a59f72ca13..571ac1315b3 100644 --- a/embedded-wallets/sdk/unreal/advanced/README.mdx +++ b/embedded-wallets/sdk/unreal/advanced/README.mdx @@ -40,13 +40,13 @@ The Web3Auth Constructor takes an object with `FWeb3AuthOptions` as input. -| Parameter | Description | -| --- | --- | -| `ClientId` | Your Web3Auth Client ID from the [Dashboard](https://dashboard.web3auth.io/). It's a mandatory field of type `FString`. | -| `Network` | Web3Auth Network: `"sapphire_mainnet"`, `"sapphire_devnet"`, `"mainnet"`, `"cyan"`, `"aqua"` or `"testnet"`. Mandatory field of type `FString`. | -| `RedirectUrl` | URL that Web3Auth will redirect API responses upon successful authentication. It's a mandatory field of type `FString`. | -| `WhiteLabelOptions?` | WhiteLabel options for custom UI, branding, and translations. Takes `FWeb3AuthWhiteLabelOptions` as a value. | -| `SessionTime?` | Configure session management time in seconds. Default is 86400 seconds (1 day). Max 30 days. | +| Parameter | Description | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| `ClientId` | Your Web3Auth Client ID from the [Dashboard](https://dashboard.web3auth.io/). It's a mandatory field of type `FString`. | +| `Network` | Web3Auth Network: `"sapphire_mainnet"`, `"sapphire_devnet"`, `"mainnet"`, `"cyan"`, `"aqua"` or `"testnet"`. Mandatory field of type `FString`. | +| `RedirectUrl` | URL that Web3Auth will redirect API responses upon successful authentication. It's a mandatory field of type `FString`. | +| `WhiteLabelOptions?` | WhiteLabel options for custom UI, branding, and translations. Takes `FWeb3AuthWhiteLabelOptions` as a value. | +| `SessionTime?` | Configure session management time in seconds. Default is 86400 seconds (1 day). Max 30 days. | @@ -101,15 +101,15 @@ UWeb3AuthSDK::GetInstance()->Initialize(Options); ## Custom Authentication Methods -Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section. +Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section. ## UI Customization -Create a seamless brand experience by customizing the Web3Auth Login Screens to match your Unreal application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section. +Create a seamless brand experience by customizing the Web3Auth Login Screens to match your Unreal application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section. ## Multi-Factor Authentication (MFA) -Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section. +Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section. **Key Configuration Options:** diff --git a/embedded-wallets/sdk/vue/README.mdx b/embedded-wallets/sdk/vue/README.mdx index a399ac93030..8118ab928ce 100644 --- a/embedded-wallets/sdk/vue/README.mdx +++ b/embedded-wallets/sdk/vue/README.mdx @@ -33,7 +33,7 @@ npm install --save @web3auth/modal :::info -Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more. +Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more. ::: @@ -84,15 +84,15 @@ In your main component (e.g. `App.vue`), import the `Web3AuthProvider` component The Web3Auth Modal SDK offers a rich set of advanced configuration options: -- **[Smart Accounts](./advanced/smart-accounts)**: Configure account abstraction parameters. -- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods. -- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance. -- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA. -- **[Wallet Services](./advanced/wallet-services)**: Integrate additional wallet services. +- **[Smart Accounts](./advanced/smart-accounts.mdx)**: Configure account abstraction parameters. +- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods. +- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance. +- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA. +- **[Wallet Services](./advanced/wallet-services.mdx)**: Integrate additional wallet services. :::tip -Head over to the [**Advanced Configuration**](./advanced) section to learn more about each configuration option. +Head over to the [**Advanced Configuration**](./advanced/README.mdx) section to learn more about each configuration option. ::: @@ -185,12 +185,12 @@ Web3Auth is blockchain agnostic, enabling integration with any blockchain networ Solana composables are included natively within the `@web3auth/modal` package. No additional setup is requiredβ€”simply use the provided composables to interact with Solana networks. -For detailed usage and examples, visit the [**Solana Composables**](./solana-composables) section. +For detailed usage and examples, visit the [**Solana Composables**](./solana-composables/README.mdx) section. ### Ethereum Integration Ethereum composables are provided through the popular `wagmi` library, which works seamlessly with Web3Auth. This allows you to leverage a wide range of Ethereum composables for account management, transactions, and more. -For implementation details and examples, refer to the [**Ethereum Composables**](./ethereum-composables) section. +For implementation details and examples, refer to the [**Ethereum Composables**](./ethereum-composables.mdx) section. diff --git a/embedded-wallets/sdk/vue/advanced/README.mdx b/embedded-wallets/sdk/vue/advanced/README.mdx index d3f61803a9e..1083f675887 100644 --- a/embedded-wallets/sdk/vue/advanced/README.mdx +++ b/embedded-wallets/sdk/vue/advanced/README.mdx @@ -7,7 +7,6 @@ description: '@web3auth/modal Advanced Configuration | Embedded Wallets' import TabItem from '@theme/TabItem' import Tabs from '@theme/Tabs' import Web3AuthOptions from '../../_common/_web3auth-options.mdx' -import AdvancedConfigOptions from '../../_common/_advanced-config-options.mdx' # Advanced Configuration @@ -38,4 +37,80 @@ const web3AuthContextConfig: Web3AuthContextConfig = { - +## Session Management + +Control how long users stay authenticated and how sessions persist. + +**Key Configuration Options:** + +- `sessionTime` - Session duration in seconds. Controls how long users remain authenticated before + needing to log in again. + - Minimum: 1 second (`1`). + - Maximum: 30 days (`86400 * 30`). + - Default: 7 days (`86400 * 7`). +- `storageType` - Storage location for authentication state. Options: + - `"local"`: Persists across browser tabs and browser restarts (localStorage) + - `"session"`: Persists only in current tab, cleared when tab closes (sessionStorage) + +```tsx +const web3AuthOptions = { + clientId: 'YOUR_WEB3AUTH_CLIENT_ID', // Pass your Web3Auth Client ID, ideally using an environment variable + web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET, + + // Session configuration + sessionTime: 86400 * 7, // 7 days (in seconds) + storageType: 'local', // 'local' (persistent across tabs) or 'session' (single tab only) +} +``` + +## Multi-Factor Authentication (MFA) + +Add additional security layers to protect user accounts with two-factor authentication. For detailed +configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) +section. + +**Key Configuration Options:** + +- `mfaSettings` - Configure MFA settings for different authentication flows +- `mfaLevel` - Control when users are prompted to set up MFA + +## Custom Authentication Methods + +Control the login options presented to your users and how they're displayed in the modal. For +detailed configuration options and implementation examples, see the +[Custom Authentication](./custom-authentication.mdx) section. + +**Key Configuration Options:** + +- `modalConfig` - Define which authentication methods are available and customize their appearance + +## UI Customization + +Create a seamless brand experience by customizing the Web3Auth Modal to match your application's +design. For complete customization options, refer to the +[Whitelabeling & UI Customization](./whitelabel.mdx) section. + +**Key Configuration Options:** + +- `uiConfig` - Personalize the modal's look and feel with custom colors, logos, themes, and more +- `modalConfig` - Control the visibility and arrangement of authentication options + +## Smart Accounts (Account Abstraction) + +Improve user experience with gasless transactions and advanced account features. Learn more in the +[Smart Accounts](./smart-accounts.mdx) documentation. + +**Key Configuration Options:** + +- `accountAbstractionConfig` - Fine-tune parameters for smart account implementation +- `useAAWithExternalWallet` - Enable account abstraction functionality even when users connect with + external wallets + +## Wallet Services + +Extend your application with enhanced wallet functionality. See the +[Wallet Services](./wallet-services.mdx) documentation for complete configuration options. + +**Key Configuration Options:** + +- `walletServicesConfig` - Integrate additional wallet services and features diff --git a/embedded-wallets/sdk/vue/advanced/custom-authentication.mdx b/embedded-wallets/sdk/vue/advanced/custom-authentication.mdx index d6cd48f1cf6..3d8df5f41b3 100644 --- a/embedded-wallets/sdk/vue/advanced/custom-authentication.mdx +++ b/embedded-wallets/sdk/vue/advanced/custom-authentication.mdx @@ -18,7 +18,7 @@ Custom Authentication is a way to authenticate users with your custom authentica :::info prerequisite -To enable this, you need to [Create a Connection](/embedded-wallets/dashboard/authentication) from the **Authentication** tab of your project from the [Web3Auth Developer Dashboard](https://dashboard.web3auth.io) with your desired configuration. +To enable this, you need to [Create a Connection](../../../dashboard/authentication.mdx) from the **Authentication** tab of your project from the [Web3Auth Developer Dashboard](https://dashboard.web3auth.io) with your desired configuration. ::: @@ -26,7 +26,7 @@ To configure a connection, you need to provide the particular details of the con :::tip -Visit the [Auth Provider Setup](/embedded-wallets/authentication) page to learn more about to setup the different configurations available for each connection. +Visit the [Auth Provider Setup](../../../authentication/README.mdx) page to learn more about to setup the different configurations available for each connection. ::: @@ -42,7 +42,7 @@ You can only configure implicit login via modal, for JWT based logins, you need For the modal custom authentication, you need to pass the `modalConfig` object to the `Web3AuthOptions` object within the constructor. -> **Read more about the `modalConfig` object in the [Whitelabel](../whitelabel) section.** +> **Read more about the `modalConfig` object in the [Whitelabel](./whitelabel.mdx) section.** ### Usage diff --git a/embedded-wallets/sdk/vue/advanced/whitelabel.mdx b/embedded-wallets/sdk/vue/advanced/whitelabel.mdx index 487433e1a90..eebdf0b40b3 100644 --- a/embedded-wallets/sdk/vue/advanced/whitelabel.mdx +++ b/embedded-wallets/sdk/vue/advanced/whitelabel.mdx @@ -248,4 +248,4 @@ export default web3AuthContextConfig For complete control over the authentication interface, you can bypass the Web3Auth modal entirely and use the `connectTo` function. This allows you to create custom buttons that connect directly to specific auth providers. -See the [Custom Authentication](../custom-authentication) section for detailed implementation instructions. +See the [Custom Authentication](./custom-authentication.mdx) section for detailed implementation instructions. diff --git a/services/reference/arbitrum/json-rpc-methods/index.md b/services/reference/arbitrum/json-rpc-methods/index.md index 067d8f9e4b7..dc887f134b3 100644 --- a/services/reference/arbitrum/json-rpc-methods/index.md +++ b/services/reference/arbitrum/json-rpc-methods/index.md @@ -10,4 +10,4 @@ The standard Ethereum methods documented in this section are supported by Infura The Arbitrum API aims to be a superset of the Ethereum JSON-RPC specification and supports all the standard Ethereum JSON-RPC-APIs. -When interacting with the API, you can expect all the usual Ethereum JSON-RPC specification fields, [and some extra ones](https://developer.offchainlabs.com/docs/differences_overview#json-rpc-api) used to display information unique to Arbitrum. +When interacting with the API, you can expect all the usual Ethereum JSON-RPC specification fields, [and some extra ones](https://docs.arbitrum.io/build-decentralized-apps/arbitrum-vs-ethereum/rpc-methods) used to display information unique to Arbitrum.