Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions embedded-wallets/dashboard/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions embedded-wallets/dashboard/whitelist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
77 changes: 0 additions & 77 deletions embedded-wallets/sdk/_common/_advanced-config-options.mdx

This file was deleted.

10 changes: 5 additions & 5 deletions embedded-wallets/sdk/android/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions embedded-wallets/sdk/android/advanced/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
10 changes: 5 additions & 5 deletions embedded-wallets/sdk/flutter/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions embedded-wallets/sdk/flutter/advanced/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
10 changes: 5 additions & 5 deletions embedded-wallets/sdk/ios/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions embedded-wallets/sdk/ios/advanced/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
14 changes: 7 additions & 7 deletions embedded-wallets/sdk/js/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down Expand Up @@ -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.

:::

Expand Down
79 changes: 77 additions & 2 deletions embedded-wallets/sdk/js/advanced/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -52,4 +51,80 @@ export class AppComponent {

<Web3AuthOptions />

<AdvancedConfigOptions />
## 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
Loading
Loading