Merge branch 'master' into android-playground-guide

Author: AyushBherwani1998

docs/auth-provider-setup/aggregate-verifier.mdx

@@ -6,41 +6,58 @@ description: "Creating Aggregate Verifier on the Web3Auth Dashboard | Documentat
 image: "images/docs-meta-cards/documentation-card.png"
 ---
 
-Developers can create `Aggregate Multiple Provider` from the Web3Auth Dashboard by combining multiple login methods to create a verifier to get the
-same address for their user regardless of their login providers. For example, combining a `Google` and `Email Passwordless` login or `Google` and
-`GitHub` via Auth0 to access the same address for your user. These login methods should share the same Verifier ID, e.g., `email`; Such verifiers are
-called `Single ID Verifiers`.
+Developers can create `Aggregate Multiple Provider` from the Web3Auth Dashboard by combining
+multiple login methods to create a verifier to get the same address for their user regardless of
+their login providers. For example, combining a `Google` and `Email Passwordless` login or `Google`
+and `GitHub` via Auth0 to access the same address for your user. These login methods should share
+the same Verifier ID, e.g., `email`; Such verifiers are called `Single ID Verifiers`.
+
+:::note MINIMUM GROWTH PLAN REQUIRED
+
+Access to creating a verifier is gated, hence creating an aggregate verifier requires a minimum
+[Growth Plan](https://web3auth.io/pricing.html). You can use this feature for projects on
+`sapphire_devnet` for free.
+
+:::
 
 ### Set up an Aggregate Verifier
 
-1. Create an aggregate verifier for your application by selecting `Aggregate Multiple Providers` as the Login provider from the login providers.
+1. Create an aggregate verifier for your application by selecting `Aggregate Multiple Providers` as
+   the Login provider from the login providers.
    ![Login Providers list on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate.png)
 2. Click on `Add Sub Verifiers` to add a new sub-verifier.
    ![Add first sub-verifier on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate-add-sub.png)
-3. Select any social login provider from the list to start with. Here we're selecting `Google`. Paste the **Client ID** from the Google App to the
-   `Client ID` field and click on `Add Sub Verifiers`.
+3. Select any social login provider from the list to start with. Here we're selecting `Google`.
+   Paste the **Client ID** from the Google App to the `Client ID` field and click on
+   `Add Sub Verifiers`.
    ![Select Google from Login Providers list on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate-google.png)
 4. Next, create the second sub-verifier. Click on `Add Sub Verifiers` to add a new sub-verifier.
-5. Select `Auth0` on the dropdown or choose `Custom Providers` from the radio buttons. We're selecting `Auth0` in this example.
+5. Select `Auth0` on the dropdown or choose `Custom Providers` from the radio buttons. We're
+   selecting `Auth0` in this example.
    ![Auth0 as sub verifier on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate-add-second-sub.png)
-6. Select the `Authentication Type` based on your application need on the dropdown. We're selecting `GitHub` in this example.
+6. Select the `Authentication Type` based on your application need on the dropdown. We're selecting
+   `GitHub` in this example.
    ![Create Aggregate Verifiier on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate-auth0-github.png)
-7. Select `Email` as the **JWT Verifier ID** and enter the `Auth0 Client ID` and `Auth0 Domain` from your Auth0 application. See how to create a new
-   Auth0 application [here](https://auth0.com/docs/quickstart/webapp/).
+7. Select `Email` as the **JWT Verifier ID** and enter the `Auth0 Client ID` and `Auth0 Domain` from
+   your Auth0 application. See how to create a new Auth0 application
+   [here](https://auth0.com/docs/quickstart/webapp/).
 
    ![Create GitHub Sub Verifiier on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate-auth0-github-filled.png)
    ![Domain and Client ID from Auth0 Dashboard](/dashboard/verifiers/aggregate-verifier/av-a0-github.png)
 
    :::info NOTE
 
-   1. Add the [GitHub Social Connection](https://marketplace.auth0.com/integrations/github-social-connection) to your Auth0 application.
-   2. One has to request an email from the user while setting up the GitHub Social Connection on the Auth0 Dashboard.
+   1. Add the
+      [GitHub Social Connection](https://marketplace.auth0.com/integrations/github-social-connection)
+      to your Auth0 application.
+   2. One has to request an email from the user while setting up the GitHub Social Connection on the
+      Auth0 Dashboard.
       ![Request Email address for GitHub Social connection](/dashboard/verifiers/aggregate-verifier/av-a0-github-email.png)
 
    :::
 
-8. Similarly, create a third sub-verifier for `Email Passwordless` via Auth0. Follow the above steps from 5 to 8, and select `Email Passwordless` in
-   place of `GitHub`.
+8. Similarly, create a third sub-verifier for `Email Passwordless` via Auth0. Follow the above steps
+   from 5 to 8, and select `Email Passwordless` in place of `GitHub`.
    ![Create Email Passwordless Sub Verifiier on Web3Auth Dashboard](/images/dashboard/create-verifier-aggregate-auth0-email-passwordless-filled.png)
 9. Finally, click on `Create` to deploy the verifier.
 
@@ -57,7 +74,8 @@ import { Web3AuthNoModal } from "@web3auth/no-modal";
 import { OpenloginAdapter } from "@web3auth/openlogin-adapter";
 import { EthereumPrivateKeyProvider } from "@web3auth/ethereum-provider";
 
-const clientId = "BPi5PB_UiIZ-cPz1GtV5i1I2iOSOHuimiXBI0e-Oe_u6X3oVAbCiAZOTEBtTXw4tsluTITPqA8zMsfxIKMjiqNQ";
+const clientId =
+  "BPi5PB_UiIZ-cPz1GtV5i1I2iOSOHuimiXBI0e-Oe_u6X3oVAbCiAZOTEBtTXw4tsluTITPqA8zMsfxIKMjiqNQ";
 // get it from https://dashboard.web3auth.io by creating a Plug n Play project.
 
 const chainConfig = {

docs/auth-provider-setup/byo-jwt-provider.mdx

@@ -5,18 +5,30 @@ description: "Bring your own custom JWT Provider | Documentation - Web3Auth"
 image: "images/docs-meta-cards/documentation-card.png"
 ---
 
-You can incorporate your login providers by utilizing one of the custom login schemes, including RSA or ECDSA signatures. By doing so, your users can
-continue using your current login providers or your custom authentication scheme.
+You can incorporate your login providers by utilizing one of the custom login schemes, including RSA
+or ECDSA signatures. By doing so, your users can continue using your current login providers or your
+custom authentication scheme.
+
+:::note Minimum Growth plan required
+
+Access to Custom Authentication with your own custom JWT Provider is gated. The minimum
+[pricing plan](https://web3auth.io/pricing.html) to create custom
+[verifiers](/auth-provider-setup/verifiers) is the **Growth Plan**. However, you can use this
+feature for projects on `sapphire_devnet` for free.
+
+:::
 
 :::info
 
-Custom JWT authentication is only supported with [`Web3Auth Plug and Play No Modal SDK`](/sdk/pnp/web/no-modal/) since the Web3Auth PnP Modal SDK will
-only help you configure the social logins within the Modal UI.
+Custom JWT authentication is only supported with
+[`Web3Auth Plug and Play No Modal SDK`](/sdk/pnp/web/no-modal/) since the Web3Auth PnP Modal SDK
+will only help you configure the social logins within the Modal UI.
 
 :::
 
-For signing the JWT, your application must follow the JWT specification and use the private key corresponding to the JWKS. And the public keys of the
-JWT should be exposed through an endpoint, which is used by Web3Auth to verify the JWT.
+For signing the JWT, your application must follow the JWT specification and use the private key
+corresponding to the JWKS. And the public keys of the JWT should be exposed through an endpoint,
+which is used by Web3Auth to verify the JWT.
 
 :::warning Facing issue with JWT?
 
@@ -30,8 +42,9 @@ Check out [**this troubleshooting page to fix those.**](/troubleshooting/jwt-err
 
 To create a custom verifier for your JWT Providers, you'll need
 
-1. **JWT Verifier ID**: JWT Verifier ID is the unique identifier to publicly represent a user on a verifier. e.g: `sub`, `email`, or even a custom
-   field of your JWT payload that is unique in your system for each user.
+1. **JWT Verifier ID**: JWT Verifier ID is the unique identifier to publicly represent a user on a
+   verifier. e.g: `sub`, `email`, or even a custom field of your JWT payload that is unique in your
+   system for each user.
 
 2. **JWK Endpoint**: An endpoint containing the JWKS used for signing the JWT.
 
@@ -60,24 +73,26 @@ To create a custom verifier for your JWT Providers, you'll need
 
    :::
 
-   You can add up to 3 validation fields, including any claims like `aud`, `sub`, `iss`, `email_verified` etc. These are the claims against which a
-   JWT is validated.
+   You can add up to 3 validation fields, including any claims like `aud`, `sub`, `iss`,
+   `email_verified` etc. These are the claims against which a JWT is validated.
 
    Here are a couple of examples to be used in validation:
 
-   - Token Audience ( `aud` ): The "aud" (audience) claim identifies the recipients for which the JWT is intended. Each principal intended to process
-     the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in
-     the "aud" claim when this claim is present, then the JWT will be rejected. The `aud` value is a case-sensitive string containing a StringOrURI
-     value. The interpretation of audience values is generally application-specific.
+   - Token Audience ( `aud` ): The "aud" (audience) claim identifies the recipients for which the
+     JWT is intended. Each principal intended to process the JWT MUST identify itself with a value
+     in the audience claim. If the principal processing the claim does not identify itself with a
+     value in the "aud" claim when this claim is present, then the JWT will be rejected. The `aud`
+     value is a case-sensitive string containing a StringOrURI value. The interpretation of audience
+     values is generally application-specific.
 
-   - Token Issuer ( `iss` ): The issuing authority of the token. The `iss` value is a case-sensitive string containing a StringOrURI value. Use of
-     this claim is OPTIONAL.
+   - Token Issuer ( `iss` ): The issuing authority of the token. The `iss` value is a case-sensitive
+     string containing a StringOrURI value. Use of this claim is OPTIONAL.
 
-   - Token Subject ( `sub` ): The subject of the token. The `sub` value is a case-sensitive string containing a StringOrURI value. Use of this claim
-     is OPTIONAL.
+   - Token Subject ( `sub` ): The subject of the token. The `sub` value is a case-sensitive string
+     containing a StringOrURI value. Use of this claim is OPTIONAL.
 
-   - Token Email Verified ( `email_verified` ): The email verified claim is a boolean value that indicates whether the email address has been
-     verified.
+   - Token Email Verified ( `email_verified` ): The email verified claim is a boolean value that
+     indicates whether the email address has been verified.
 
 ## Using `jsonwebtoken` to generate JWT
 
@@ -184,7 +199,8 @@ console.log(token);
 
 </Tabs>
 
-See [this](#filled-custom-jwt-verifier) to set up the custom jwt verifier using the above JWT data on the Web3Auth Dashboard.
+See [this](#filled-custom-jwt-verifier) to set up the custom jwt verifier using the above JWT data
+on the Web3Auth Dashboard.
 
 ### Login with JWT (idToken - jsonwebtoken)
 
@@ -269,7 +285,8 @@ console.log(protectedHeader);
 console.log(payload);
 ```
 
-See [this](#filled-custom-jwt-verifier) to set up the custom jwt verifier using the above JWT data on the Web3Auth Dashboard.
+See [this](#filled-custom-jwt-verifier) to set up the custom jwt verifier using the above JWT data
+on the Web3Auth Dashboard.
 
 ### Login with JWT (idToken - jose)
 
@@ -321,8 +338,9 @@ await web3auth.connectTo(WALLET_ADAPTERS.OPENLOGIN, {
 
 `jwks-rsa - Passport Example`
 
-The `jwks-rsa` library provides a small helper that makes it easy to configure `passport-jwt` with the `RS256` algorithm. Using `passportJwtSecret`
-you can generate a secret provider that will provide the right signing key to `passport-jwt` based on the `kid` in the JWT header.
+The `jwks-rsa` library provides a small helper that makes it easy to configure `passport-jwt` with
+the `RS256` algorithm. Using `passportJwtSecret` you can generate a secret provider that will
+provide the right signing key to `passport-jwt` based on the `kid` in the JWT header.
 
 ```tsx
 // Step 1. npm init -y && npm install passport-jwt
@@ -359,7 +377,8 @@ passport.use(
 app.use(passport.initialize());
 ```
 
-See [this](#filled-custom-jwt-verifier) to set up the custom jwt verifier using the above JWT data on the Web3Auth Dashboard.
+See [this](#filled-custom-jwt-verifier) to set up the custom jwt verifier using the above JWT data
+on the Web3Auth Dashboard.
 
 ### Login with JWT (idToken - passport-jwt)
 
@@ -417,12 +436,14 @@ await web3auth.connectTo(WALLET_ADAPTERS.OPENLOGIN, {
 
 ## What are JWKS?
 
-JWKS stands for JSON Web Key Set. It is a set of keys containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the
-authorization server and signed using the RS256 signing algorithm.
+JWKS stands for JSON Web Key Set. It is a set of keys containing the public keys that should be used
+to verify any JSON Web Token (JWT) issued by the authorization server and signed using the RS256
+signing algorithm.
 
 ### How to create JWKS?
 
-- Most of the login providers that support JWT-based login will provide you this URL, such as Firebase, Google, Auth0, AWS Cognito etc.
+- Most of the login providers that support JWT-based login will provide you this URL, such as
+  Firebase, Google, Auth0, AWS Cognito etc.
 
   - Firebase: `https://www.googleapis.com/service_accounts/v1/jwk/{your-project-id}`
   - Auth0: `https://{your-domain}/.well-known/jwks.json`
@@ -433,7 +454,8 @@ authorization server and signed using the RS256 signing algorithm.
 
 ### How to convert PEM to JWKS?
 
-If you're using `jose` or `jsonwebtoken` library, you can use the following steps to convert your PEM file to JWKS.
+If you're using `jose` or `jsonwebtoken` library, you can use the following steps to convert your
+PEM file to JWKS.
 
 1. Create a Private Key using openssl.
 
@@ -464,6 +486,8 @@ If you're using `jose` or `jsonwebtoken` library, you can use the following step
 
      ![JWKS Convert Tool](https://web3auth.io/community/uploads/default/optimized/2X/3/3e58a3b7378b9778b0b2d646ec2a3cf47c56ee5e_2_690x448.jpeg)
 
-4. To complete the process, you need to save the output as a `.json` file, host it on your server, and make sure it's publicly accessible.
+4. To complete the process, you need to save the output as a `.json` file, host it on your server,
+   and make sure it's publicly accessible.
 
-   This will give you the `JWKS Endpoint`, which is required when setting up a `Custom JWT Verifier` on the Web3Auth Dashboard.
+   This will give you the `JWKS Endpoint`, which is required when setting up a `Custom JWT Verifier`
+   on the Web3Auth Dashboard.

docs/dashboard-setup/setup-custom-authentication.mdx

@@ -5,30 +5,44 @@ displayed_sidebar: resources
 description: "Setup Custom Authentication | Documentation - Web3Auth"
 ---
 
-The Custom Authentication section of the Web3Auth dashboard is where you can create a new verifier. This verifier allows you to implement custom
-authentication within your application, providing additional security and flexibility for your users. By creating a Custom Authentication Verifier,
+The Custom Authentication section of the Web3Auth dashboard is where you can create a new verifier.
+This verifier allows you to implement custom authentication within your application, providing
+additional security and flexibility for your users. By creating a Custom Authentication Verifier,
 you can tailor your authentication process to the unique needs of your project and its users.
 
+:::note Minimum Growth plan required
+
+Access to Custom Authentication is gated. The minimum
+[pricing plan](https://web3auth.io/pricing.html) to create custom
+[verifiers](/auth-provider-setup/verifiers) is the **Growth Plan**. However, you can use this
+feature for projects on `sapphire_devnet` for free.
+
+:::
+
 But before understanding about custom authentication, let us see **What is a Verifier?**
 
 #### What is a Verifier?
 
-A verifier is a piece of information about the OAuth provider being used by the application, which is queried by web3auth auth network nodes from a
-smart contract deployed on the Ethereum blockchain to verify the JWT token.
+A verifier is a piece of information about the OAuth provider being used by the application, which
+is queried by web3auth auth network nodes from a smart contract deployed on the Ethereum blockchain
+to verify the JWT token.
 
 There are two types of `Verifiers` at Web3Auth:
 
-1. `Default Verifiers`: These are the verifiers associated with OAuth providers(Google, Facebook, Apple etc.) which are owned and managed by
-   Web3Auth's account.
-2. `Custom Verifiers`: If you want to manage your OAuth providers(Google, Facebook, Apple etc.) yourself or to use some Federated Identity Providers
-   like Auth0, Firebase, AWS Cognito, Okta etc., or even your Custom JWT Authentication, you'll need to create a verifier under a project on the
-   Web3Auth's dashboard.
+1. `Default Verifiers`: These are the verifiers associated with OAuth providers(Google, Facebook,
+   Apple etc.) which are owned and managed by Web3Auth's account.
+2. `Custom Verifiers`: If you want to manage your OAuth providers(Google, Facebook, Apple etc.)
+   yourself or to use some Federated Identity Providers like Auth0, Firebase, AWS Cognito, Okta
+   etc., or even your Custom JWT Authentication, you'll need to create a verifier under a project on
+   the Web3Auth's dashboard.
 
-For users to be able to log in using your custom authentication flow, you will need to use a Custom Verifier. The Wallet that is generated for each
-user is specific to a verifier. Verifier scripts determine the access structure to your users' wallets, and the set of Verifier scripts you choose
+For users to be able to log in using your custom authentication flow, you will need to use a Custom
+Verifier. The Wallet that is generated for each user is specific to a verifier. Verifier scripts
+determine the access structure to your users' wallets, and the set of Verifier scripts you choose
 will determine which logins your application will ultimately use.
 
-You can read more about verifiers [in this GitHub discussion](https://github.com/orgs/Web3Auth/discussions/427#discussioncomment-3442052).
+You can read more about verifiers
+[in this GitHub discussion](https://github.com/orgs/Web3Auth/discussions/427#discussioncomment-3442052).
 
 The `Custom Authentication` tab of a project looks something like this:
 
@@ -46,7 +60,8 @@ To create a verifier, you need to input the following details:
 
 ### Verifier identifier
 
-The identifier for your verifier. You'll need this while initializing the `Web3Auth`/`Web3AuthNoModal` SDK for setting up the custom authentication.
+The identifier for your verifier. You'll need this while initializing the
+`Web3Auth`/`Web3AuthNoModal` SDK for setting up the custom authentication.
 
 ### Choose a Login Provider
 
@@ -65,4 +80,5 @@ The following is the list we have on our Dashboard:
 3. Aggregate Multiple Providers
    - [Aggregate Verifier](/auth-provider-setup/aggregate-verifier)
 
-If something you're looking for is not available in the list, choose `Custom Provider` and provide the JWT details.
+If something you're looking for is not available in the list, choose `Custom Provider` and provide
+the JWT details.