Merge branch 'master' into add-guide-multiple-chains

Author: rtomas

docs/features/wallet-pregeneration.mdx

@@ -6,41 +6,57 @@ description: "Wallet Pregeneration | Documentation - Web3Auth"
 
 import PregenerateWallet from "@site/src/components/PregenerateWallet";
 
-Pre-generated wallets are a strategic feature within Web3Auth, designed to streamline the onboarding process by allowing developers to create wallet
-addresses for users before their initial login. This feature offers flexibility in how and when you introduce users to wallet functionalities,
-enhancing the user experience and engagement.
+Pre-generated wallets are a strategic feature within Web3Auth, designed to streamline the onboarding
+process by allowing developers to create wallet addresses for users before their initial login. This
+feature offers flexibility in how and when you introduce users to wallet functionalities, enhancing
+the user experience and engagement.
 
 ## Capabilities of Pre-generated Wallets
 
-The ability to pre-generate wallets opens up a variety of use cases, making it easier to integrate Web3 features into your application's user journey:
+The ability to pre-generate wallets opens up a variety of use cases, making it easier to integrate
+Web3 features into your application's user journey:
 
-- **Early Wallet Creation:** Initiate wallet creation as part of the user invite or onboarding flow, even before the user has logged into your app for
-  the first time.
-- **Deferred Login Setup:** Delay the setup of wallet access management, such as OAuth login or passkeys, until the user is ready for their first
-  on-chain transaction, simplifying initial engagement.
-- **Wallet Prefunding:** Reward users with tokens for off-chain activities, allowing them to claim these rewards when they access their pre-generated
-  wallet.
+- **Early Wallet Creation:** Initiate wallet creation as part of the user invite or onboarding flow,
+  even before the user has logged into your app for the first time.
+- **Deferred Login Setup:** Delay the setup of wallet access management, such as OAuth login or
+  passkeys, until the user is ready for their first on-chain transaction, simplifying initial
+  engagement.
+- **Wallet Prefunding:** Reward users with tokens for off-chain activities, allowing them to claim
+  these rewards when they access their pre-generated wallet.
+
+:::note Minimum Scale plan required
+
+Access to Wallet Pregeneration is gated. You can use this feature in the development environment for
+free. The minimum [pricing plan](https://web3auth.io/pricing.html) to use this feature in a
+production environment is the **Scale Plan**.
+
+:::
 
 ## Utilizing the Pre-generated Wallet API
 
-Web3Auth provides a straightforward API to facilitate the creation of pre-generated wallets. You can integrate this API into your user signup flow,
-either after a user verifies their email or independently by supplying their email or unique identifier to the API.
+Web3Auth provides a straightforward API to facilitate the creation of pre-generated wallets. You can
+integrate this API into your user signup flow, either after a user verifies their email or
+independently by supplying their email or unique identifier to the API.
 
 :::warning
 
-This API only returns the Core Kit Key wallet addresses. To use the wallet addresses with the Web3Auth SDKs, you will need to either use the
-`useCoreKitKey` flag in our PnP SDKs or use any of our Core Kit SFA SDKs
+This API only returns the Core Kit Key wallet addresses. To use the wallet addresses with the
+Web3Auth SDKs, you will need to either use the `useCoreKitKey` flag in our PnP SDKs or use any of
+our Core Kit SFA SDKs
 
-Learn more about how [keys can change within different Web3Auth Products](/docs/troubleshooting/different-private-key#product)
+Learn more about how
+[keys can change within different Web3Auth Products](/docs/troubleshooting/different-private-key#product)
 
 :::
 
 ### Implementation Steps:
 
-1. **Identify Users:** Determine the unique identifier or email for the user within your system. This will be the `verifierId` used to create the
-   wallet.
-2. **API Call:** Use the provided API to submit the user's identifier. You'll need to specify parameters from the Web3Auth dashboard, specifically the
-   Verifier Name, Web3Auth Network, and Client Id.
-3. **Receive Wallet Address:** The API response will include the new wallet address, ready for use by the user upon their first login.
+1. **Identify Users:** Determine the unique identifier or email for the user within your system.
+   This will be the `verifierId` used to create the wallet.
+2. **API Call:** Use the provided API to submit the user's identifier. You'll need to specify
+   parameters from the Web3Auth dashboard, specifically the Verifier Name, Web3Auth Network, and
+   Client Id.
+3. **Receive Wallet Address:** The API response will include the new wallet address, ready for use
+   by the user upon their first login.
 
 <PregenerateWallet />

docs/features/whitelabel.mdx

@@ -6,65 +6,98 @@ description: "Whitelabeling Web3Auth | Documentation - Web3Auth"
 image: "images/docs-meta-cards/documentation-card.png"
 ---
 
-Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and cohesive user experience across their applications.
-Through customization of the user interface, branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
+Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and
+cohesive user experience across their applications. Through customization of the user interface,
+branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
 authentication flow aligns with your application's identity.
 
 #### Steps for Customization
 
-1. **Choose Your SDK:** Decide between Plug and Play or Core Kit SDKs based on your needs for customization and control.
-2. **Define Your Branding:** Customize the elements of the SDKs, such as modals, screens, and logos, to align with your branding guidelines.
-3. **Apply Translations:** Tailor the language and translations within the authentication flow to cater to your target audience.
+1. **Choose Your SDK:** Decide between Plug and Play or Core Kit SDKs based on your needs for
+   customization and control.
+2. **Define Your Branding:** Customize the elements of the SDKs, such as modals, screens, and logos,
+   to align with your branding guidelines.
+3. **Apply Translations:** Tailor the language and translations within the authentication flow to
+   cater to your target audience.
 
 ## Plug and Play SDKs Whitelabeling
 
-Web3Auth's Plug and Play SDKs provide extensive whitelabeling capabilities, allowing for a deep level of customization to ensure the user interface,
-branding, and translations perfectly match your application's needs. These SDKs support detailed customization, offering a seamless and cohesive user
-experience.
+Web3Auth's Plug and Play SDKs provide extensive whitelabeling capabilities, allowing for a deep
+level of customization to ensure the user interface, branding, and translations perfectly match your
+application's needs. These SDKs support detailed customization, offering a seamless and cohesive
+user experience.
 
-- **Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your application, ensuring a unified user experience that aligns
-  with your brand identity. Customize every aspect, from the modal appearance to the user flow, including MFA screens, to maintain consistency across
-  all user interactions.
+- **Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your
+  application, ensuring a unified user experience that aligns with your brand identity. Customize
+  every aspect, from the modal appearance to the user flow, including MFA screens, to maintain
+  consistency across all user interactions.
 
-- **Comprehensive Management:** With Web3Auth's whitelabeling options, you gain full control over the authentication experience, ensuring it is not
-  only branded but also intuitive for users. This approach minimizes the need for additional UI development and aligns closely with your application's
-  design principles.
+- **Comprehensive Management:** With Web3Auth's whitelabeling options, you gain full control over
+  the authentication experience, ensuring it is not only branded but also intuitive for users. This
+  approach minimizes the need for additional UI development and aligns closely with your
+  application's design principles.
 
-- **Customizable to Your Brand:** Tailor the Embedded Wallet UI to perfectly fit your application's aesthetics, reinforcing your brand with every user
-  interaction. Web3Auth allows for detailed branding customization, ensuring the wallet experience feels like an integral part of your app.
+- **Customizable to Your Brand:** Tailor the Embedded Wallet UI to perfectly fit your application's
+  aesthetics, reinforcing your brand with every user interaction. Web3Auth allows for detailed
+  branding customization, ensuring the wallet experience feels like an integral part of your app.
 
 ### Customization Examples
 
-- **Login Modal Customization:** Adapt the login modal's design to reflect your application's branding, from colors and logos to fonts and button
-  styles.
+- **Login Modal Customization:** Adapt the login modal's design to reflect your application's
+  branding, from colors and logos to fonts and button styles.
 
   ![Web3Auth Plug and Play Login Modal](/images/whitelabel/modal/whitelable-login-modal.gif)
 
-- **User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout the user authentication process, including the
-  transition between different authentication stages and support for both light and dark modes.
+- **User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout
+  the user authentication process, including the transition between different authentication stages
+  and support for both light and dark modes.
 
   ![Web3Auth - User Flow Screens](/images/whitelabel/user-flow-screens.gif)
 
+### NEW: Whitelabeling via the Dashboard:
+
+- From version `8.5.0`, **Web3Auth's Plug and Play SDKs** and **WalletServicesPlugin** offer
+  whitelabeling capabilities via the **Dashboard**, enabling developers to customize the
+  authentication modal, user interface, and translations to align with their application's branding
+  and user experience requirements.
+
+- **Customize the Authentication Modal:** Modify the appearance of the authentication modal,
+  including the primary color, application name, logo, and dark or light mode, to align with your
+  application's branding.
+
+- **Personalize the User Interface:** Tailor the Embedded Wallet UI to match your application's
+  design language, ensuring a seamless and cohesive user experience.
+
+- **Configure Language and Translations:** Customize the language and translations within the
+  authentication flow to cater to your target audience.
+
+![Web3Auth Whitelabeling Dashboard](/images/whitelabel/whitelabel-dashboard.gif)
+
 ## Core Kit SDKs Whitelabeling
 
-- **Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of Web3Auth's underlying mechanisms. Developers have the
-  freedom to design their authentication pages and flows, offering unparalleled customization.
-- **No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates the need for user redirection to `auth.web3auth.io`
-  for authentication, ensuring all processes are kept within your application's ecosystem.
+- **Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of
+  Web3Auth's underlying mechanisms. Developers have the freedom to design their authentication pages
+  and flows, offering unparalleled customization.
+- **No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates
+  the need for user redirection to `auth.web3auth.io` for authentication, ensuring all processes are
+  kept within your application's ecosystem.
 
 ## Wallet Services Whitelabeling
 
-- **Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the entire user interface, including logos, color schemes,
-  and visibility of specific sections, ensuring a branded experience throughout.
-- **Application Identity:** Tailor the appearance of wallet service components, such as chain logos and the dApp logo, to reinforce your application's
-  brand identity across all user interactions.
+- **Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the
+  entire user interface, including logos, color schemes, and visibility of specific sections,
+  ensuring a branded experience throughout.
+- **Application Identity:** Tailor the appearance of wallet service components, such as chain logos
+  and the dApp logo, to reinforce your application's brand identity across all user interactions.
 
 ## Language Customization and Localization (l10n)
 
-A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages, enhancing accessibility and user engagement
-across diverse demographics.
+A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages,
+enhancing accessibility and user engagement across diverse demographics.
 
-- **Multiple Languages Support:** Web3Auth supports localization for a variety of languages including English (en), Spanish (es), German (de), Chinese
-  (zh), Japanese (ja), Korean (ko), French (fr), Portuguese (pt), and Dutch (nl).
-- **Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository, inviting contributions from the community to add or
-  refine language support. [Contribute to Web3Auth Locales](https://github.com/Web3Auth/web3auth-locales).
+- **Multiple Languages Support:** Web3Auth supports localization for a variety of languages
+  including English (en), Spanish (es), German (de), Chinese (zh), Japanese (ja), Korean (ko),
+  French (fr), Portuguese (pt), and Dutch (nl).
+- **Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository,
+  inviting contributions from the community to add or refine language support.
+  [Contribute to Web3Auth Locales](https://github.com/Web3Auth/web3auth-locales).

docs/migration-guides/android-v7.3-to-v7.4.mdx

@@ -0,0 +1,49 @@
+---
+title: PnP Android SDK - v7.3 to v7.4
+displayed_sidebar: sdk
+description: "PnP Android SDK - v7.3 to v7.4 | Documentation - Web3Auth"
+sidebar_label: v7.3 to v7.4
+---
+
+import TabItem from "@theme/TabItem";
+import Tabs from "@theme/Tabs";
+
+# Migration Guide from v7.3 to v7.4 for Web3Auth PnP Android SDK
+
+## Overview
+
+This migration guide provides steps for upgrading from version 7.3(v7.3) to version 7.4(v7.4) of the
+Web3Auth PnP Android SDK. The guide outlines significant breaking change in `Web3AuthOptions`.
+
+## Changes in Detail
+
+### `Web3AuthOptions` changes
+
+From v7.4 onwards redirectUrl is a mandatory parameter in `Web3AuthOptions`.
+
+#### Before (v7.3)
+
+```kotlin title="Usage"
+val web3Auth = Web3Auth(
+  Web3AuthOptions(
+    context = this,
+    // Your Web3Auth Client ID from Developer Dashboard
+    clientId = getString(R.string.web3auth_project_id),
+    network = Network.MAINNET,
+  )
+)
+```
+
+#### After (v7.4)
+
+```kotlin title="Usage"
+val web3Auth = Web3Auth(
+  Web3AuthOptions(
+    context = this,
+    // Your Web3Auth Client ID from Developer Dashboard
+    clientId = getString(R.string.web3auth_project_id),
+    network = Network.MAINNET,
+    redirectUrl = Uri.parse("{YOUR_APP_PACKAGE_NAME}://auth")
+  )
+)
+```

docs/migration-guides/ios-v8.3-to-v8.4.mdx

@@ -0,0 +1,45 @@
+---
+title: PnP iOS SDK - v8.3 to v8.4
+displayed_sidebar: sdk
+description: "PnP iOS SDK - v8.3 to v8.4 | Documentation - Web3Auth"
+sidebar_label: v8.3 to v8.4
+---
+
+import TabItem from "@theme/TabItem";
+import Tabs from "@theme/Tabs";
+
+# Migration Guide from v8.3 to v8.4 for Web3Auth PnP iOS SDK
+
+## Overview
+
+This migration guide provides steps for upgrading from version 8.3(v8.3) to version 8.4(v8.4) of the
+Web3Auth PnP iOS SDK. The guide outlines significant breaking change in the `W3AInitParams`.
+
+## Changes in Detail
+
+### `W3AInitParams` changes
+
+From v8.4 onwards redirectUrl is a mandatory parameter in `W3AInitParams`.
+
+#### Before (v8.3)
+
+```swift title="Usage"
+import Web3Auth
+
+let web3auth = Web3Auth(W3AInitParams(
+  clientId: "<your clientId>",
+  network: .sapphire_mainnet,
+))
+```
+
+#### After (v8.4)
+
+```swift title="Usage"
+import Web3Auth
+
+let web3auth = Web3Auth(W3AInitParams(
+  clientId: "<your clientId>",
+  network: .sapphire_mainnet,
+  redirectUrl: "bundleId://auth"
+))
+```

docs/sdk/core-kit/sfa-web/initialize.mdx

@@ -39,24 +39,24 @@ This Web3Auth constructor takes an object with `Web3AuthOptions` as input.
 
 <Web3AuthOptions />
 
-#### Usage
+### Instantiating Provider
 
-<SFAInstanceExample />
+<InstantiatingProvider />
 
-## Instantiating Provider
+### Usage
 
-<InstantiatingProvider />
+<SFAInstanceExample />
 
 ## Initializing Web3Auth
 
 #### `init()`
 
 To complete the initialization process, we need to initialize the `Web3Auth` instance, which we
 named `web3auth`. This is achieved by calling the `init()` function of the previously created
-`web3auth` instance, using a **private key provider**.
+`web3auth` instance.
 
 ```javascript
-web3auth.init(privateKeyProvider);
+await web3auth.init();
 ```
 
 ## Example
@@ -84,8 +84,9 @@ const privateKeyProvider = new EthereumPrivateKeyProvider({
 const web3auth = new Web3Auth({
   clientId: "WEB3AUTH_CLIENT_ID", // Get your Client ID from the Web3Auth Dashboard
   web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET,
+  privateKeyProvider,
   usePnPKey: false, // By default, this SDK returns CoreKitKey by default.
 });
 
-web3auth.init(privateKeyProvider);
+await web3auth.init();
 ```

docs/sdk/core-kit/sfa-web/sfa-web.mdx

@@ -33,7 +33,7 @@ Key Share setup, which is fully non-custodial.
 
 :::
 
-#### This Documentation is based on the `7.4.0` SDK Version.
+#### This Documentation is based on the [`8.0.2`](https://github.com/Web3Auth/single-factor-auth-web/releases/tag/8.0.2) SDK Version.
 
 ## Requirements
 

docs/sdk/pnp/android/android.mdx

@@ -13,7 +13,7 @@ generated in a non-custodial way on successful user authentication. This authent
 achieved by using any social login options that Web3Auth supports or custom authentication flow of
 your choice.
 
-#### This Documentation is based on the `7.3.0` SDK Version.
+#### This Documentation is based on the `7.4.0` SDK Version.
 
 ## Requirements
 

docs/sdk/pnp/android/initialize.mdx

@@ -69,7 +69,7 @@ data class Web3AuthOptions(
     val clientId: String,
     val network: Network,
     var buildEnv: BuildEnv? = BuildEnv.PRODUCTION,
-    @Transient var redirectUrl: Uri? = null,
+    @Transient var redirectUrl: Uri,
     var sdkUrl: String = getSdkUrl(buildEnv),
     val whiteLabel: WhiteLabelData? = null,
     val loginConfig: HashMap<String, LoginConfigItem>? = null,