nit

Web3Auth · Nov 14, 2023 · 2abc074 · 2abc074 · vercel · Nov 14, 2023
1 parent 26273df
commit 2abc074
Show file tree

Hide file tree

Showing 9 changed files with 60 additions and 60 deletions.
diff --git a/docs/pnp/migration-guides/ios-v6-to-v7.mdx b/docs/pnp/migration-guides/ios-v6-to-v7.mdx
@@ -19,7 +19,7 @@ import Web3Auth
 
 let web3auth = Web3Auth(W3AInitParams(
   clientId: "<your clientId>",
-  network: .MAINNET, // you can use .sapphire_devnet or .sapphire_mainnet
+  network: .mainnet, // you can use .sapphire_devnet or .sapphire_mainnet
   sdkUrl: ...,
   redirectUrl: ...,
 ))
@@ -107,8 +107,8 @@ web3Auth = await Web3Auth(
 
 #### change of `W3AInitParams` object
 
-The `Web3Auth` constructor takes an object called `W3AInitParams` as input. The below are the aviliable fields of the `W3AInitParams` object. With v7,
-additional 2 parameters, which are `MfaSettings` and `sessionTIme` can be set.
+The `Web3Auth` constructor takes an object called `W3AInitParams` as input. Below are the available fields of the `W3AInitParams` object. With v7,
+additional 2 parameters, which are `MfaSettings` and `sessionTime` can be set.
 
 <Tabs
   defaultValue="v7"
@@ -125,7 +125,7 @@ additional 2 parameters, which are `MfaSettings` and `sessionTIme` can be set.
 | `clientId`       | String                      | Yes       | Your Web3Auth project ID                                                                                                                      |
 | `network`        | Network                     | Yes       | Web3Auth Network to run the authentication on, either `.mainnet`,`.aqua`, `.testnet` or `.cyan`                                               |
 | `sdkUrl`         | URL                         | No        | Web3Auth sdk frontend to be used. This field is for advanced usage only and should not be changed.                                            |
-| `redirectUrl`    | String                      | No        | redirectUrl to be passed to the sdk frontend. This field is for advanced usage only and should not be changed.                                |
+| `redirectUrl`    | String                      | No        | redirectUrl to be passed to the SDK frontend. This field is for advanced usage only and should not be changed.                                |
 | `whiteLabel`     | W3AWhiteLabelData           | No        | A configuration optional object to customize UI, branding, and translations for your brand. Refer to the WhiteLabeling section for more info. |
 | `loginConfig`    | `[String : W3ALoginConfig]` | No        | A configuration optional object to customize login flow.                                                                                      |
 | `useCoreKitKey`  | `bool`                      | No        | Use CoreKit Key to get core kit key.                                                                                                          |
@@ -139,15 +139,15 @@ additional 2 parameters, which are `MfaSettings` and `sessionTIme` can be set.
 | ---------------- | --------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
 | `clientId`       | String                      | Yes       | Your Web3Auth project ID                                                                                                                      |
 | `network`        | Network                     | Yes       | Web3Auth Network to run the authentication on, either `.mainnet`,`.aqua`, `.testnet`, `.cyan`, or `.sapphire_devnet` or `.sapphire_mainnet`   |
-| `buildEnv`       | BuildEnv                    | No        | Obtion for auth service, `production`, `staging`, `testing` available                                                                         |
+| `buildEnv`       | BuildEnv                    | No        | Option for auth service, `production`, `staging`, `testing` available                                                                         |
 | `sdkUrl`         | URL                         | No        | Web3Auth sdk frontend to be used. This field is for advanced usage only and should not be changed.                                            |
 | `redirectUrl`    | String                      | No        | redirectUrl to be passed to the sdk frontend. This field is for advanced usage only and should not be changed.                                |
 | `whiteLabel`     | W3AWhiteLabelData           | No        | A configuration optional object to customize UI, branding, and translations for your brand. Refer to the WhiteLabeling section for more info. |
 | `loginConfig`    | `[String : W3ALoginConfig]` | No        | A configuration optional object to customize login flow.                                                                                      |
 | `useCoreKitKey`  | `bool`                      | No        | Use CoreKit Key to get core kit key.                                                                                                          |
 | `chainNamespace` | `ChainNamespace`            | No        | Chain Namespace [`eip155` and `solana`]                                                                                                       |
 | `MfaSettings`    | `MfaSettings`               | No        | Settings for Multi factor authentication                                                                                                      |
-| `sessionTIme`    | Int                         | No        | Session maintainance time                                                                                                                     |
+| `sessionTime`    | Int                         | No        | Session maintenance time                                                                                                                      |
 
 </TabItem>
 

diff --git a/docs/sdk/pnp/android/dapp-share.mdx b/docs/sdk/pnp/android/dapp-share.mdx
@@ -9,15 +9,15 @@ import AndroidResponse from "@site/src/common/sdk/pnp/_userinfo_response.mdx";
 
 ## Web3Auth Infrastructure at a glance
 
-If you go through the [Web3Auth infrastructure](/infrastructure/) you'll notice that to enable the non custodiality of Web3Auth, we
-split the private key into multiple parts, ie. `shares`. These shares are a part of the off chain multisig, where multiple shares are stored in
-different places and can be used to reconstruct the private key dynamically in the user's frontend application. For a glance at the structure of the
-shares, these are the following:
+If you go through the [Web3Auth infrastructure](/infrastructure/) you'll notice that to enable the non custodiality of Web3Auth, we split the private
+key into multiple parts, ie. `shares`. These shares are a part of the off chain multisig, where multiple shares are stored in different places and can
+be used to reconstruct the private key dynamically in the user's frontend application. For a glance at the structure of the shares, these are the
+following:
 
-1. **`ShareA` is stored on the user's device**: Implementation is device and system specific. For example, on mobile devices, the share could be
-   stored in device storage secured via biometrics.
-2. **`ShareB` is managed by a login service via node operators**: This share is further split amongst a network of nodes and retrieved via
+1. **`ShareA` is managed by a login service via node operators**: This share is further split amongst a network of nodes and retrieved via
    conventional authentication flows.
+2. **`ShareB` is stored on the user's device**: Implementation is device and system specific. For example, on mobile devices, the share could be
+   stored in device storage secured via biometrics.
 3. **`ShareC` is a recovery share**: An extra share to be kept by the user, possibly kept on a separate device, downloaded or based on user input with
    enough entropy (eg. password, security questions, hardware device etc.).
 
@@ -26,13 +26,13 @@ initial setup provides several benefits.
 
 ## The User Experience in Mobile Platforms
 
-The user experience in mobile platforms is very different from the web platforms. This is because the user has to be redirected to a browser where
+The user experience on mobile platforms is very different from the web platforms. This is because the user has to be redirected to a browser where
 they can login using their socials and then back to the app once they have been successfully authenticated. This user experience shifts the context
-between two applications, whereas in the web platforms, the context remains within the browser only.
+between two applications, whereas, in the web platforms, the context remains within the browser only.
 
-For the seamless login flow, we need to reconstruct the Shares `A` and `B`. `Share A` is managed by the login service and is provided on successful
-authentication. Whereas in web platforms, `Share B` is stored in the browser context. We can still store it in the browser context for mobile devices,
-but this has a few risks, like user accidently deleting browser data. This is a bigger problem in mobile devices since the user doesn't realise that
+For the seamless login flow, we need to reconstruct the Shares `A` and `B`. `Share B` is managed by the login service and is provided on successful
+authentication. Whereas in web platforms, `Share A` is stored in the browser context. We can still store it in the browser context for mobile devices,
+but this has a few risks like users accidentally deleting browser data. This is a bigger problem in mobile devices since the user doesn't realize that
 the browser is being used to login within the app and clearing the browser data can cause their logins to fail. Hence, to tackle this issue, Web3Auth
 issues a dApp Share, ie. a backup share that can be stored by the app developer directly within their application and used to reconstruct the private
 key after successful login by the user.

diff --git a/docs/sdk/pnp/ios/custom-authentication.mdx b/docs/sdk/pnp/ios/custom-authentication.mdx
@@ -8,8 +8,8 @@ description: "Web3Auth PnP iOS SDK - Using Custom Authentication | Documentation
 import TabItem from "@theme/TabItem";
 import Tabs from "@theme/Tabs";
 
-This is a document to use a custom login mechanism with the Web3Auth iOS SDK. For example, to login using your own custom JWT issuers like Auth0, AWS
-Cognito, or Firebase. You can add the your configuration to the `loginConfig` field of the `W3AInitParams` object.
+To use custom authentication (Using Social providers or Login providers like Auth0, AWS Cognito, Firebase etc. or even your own custom JWT login) with
+the Web3Auth Swift(iOS) SDK. You can add the configuration to the `loginConfig` field of the `Web3AuthOptions` object.
 
 The `loginConfig` field is a key value map. The key should be one of the `Web3AuthProvider` in its string form, and the value should be a
 `W3ALoginConfig` struct instance.
@@ -206,7 +206,7 @@ for enabling login. The `extraLoginOptions` accepts the following parameters:
 | `client_id`                 | `string`  | The Client ID found on your Auth0 Application settings page. **Use web3auth client id in case of custom JWT login.**                         |
 | `redirect_uri`              | `string`  | The default URL where Auth0 will redirect your browser to with the authentication result.                                                    |
 | `leeway`                    | `number`  | The value in seconds used to account for clock skew in JWT expirations.                                                                      |
-| `verifierIdField`           | `string`  | The field in jwt token which maps to verifier id.                                                                                            |
+| `verifierIdField`           | `string`  | The field in the jwt token that maps to the verifier id.                                                                                     |
 | `isVerifierIdCaseSensitive` | `boolean` | Whether the verifier id field is case sensitive. Defaults to `true`                                                                          |
 
 </TabItem>

diff --git a/docs/sdk/pnp/ios/dapp-share.mdx b/docs/sdk/pnp/ios/dapp-share.mdx
@@ -9,15 +9,15 @@ import IosResponse from "@site/src/common/sdk/pnp/_userinfo_response.mdx";
 
 ## Web3Auth Infrastructure at a glance
 
-If you go through the [Web3Auth infrastructure](/infrastructure/) you'll notice that to enable the non custodiality of Web3Auth, we
-split the private key into multiple parts, ie. `shares`. These shares are a part of the off chain multisig, where multiple shares are stored in
-different places and can be used to reconstruct the private key dynamically in the user's frontend application. For a glance at the structure of the
-shares, these are the following:
+If you go through the [Web3Auth infrastructure](/infrastructure/) you'll notice that to enable the non custodiality of Web3Auth, we split the private
+key into multiple parts, ie. `shares`. These shares are a part of the off chain multisig, where multiple shares are stored in different places and can
+be used to reconstruct the private key dynamically in the user's frontend application. For a glance at the structure of the shares, these are the
+following:
 
-1. **`ShareA` is stored on the user's device**: Implementation is device and system specific. For example, on mobile devices, the share could be
-   stored in device storage secured via biometrics.
-2. **`ShareB` is managed by a login service via node operators**: This share is further split amongst a network of nodes and retrieved via
+1. **`ShareA` is managed by a login service via node operators**: This share is further split amongst a network of nodes and retrieved via
    conventional authentication flows.
+2. **`ShareB` is stored on the user's device**: Implementation is device and system specific. For example, on mobile devices, the share could be
+   stored in device storage secured via biometrics.
 3. **`ShareC` is a recovery share**: An extra share to be kept by the user, possibly kept on a separate device, downloaded or based on user input with
    enough entropy (eg. password, security questions, hardware device etc.).
 
@@ -26,13 +26,13 @@ initial setup provides several benefits.
 
 ## The User Experience in Mobile Platforms
 
-The user experience in mobile platforms is very different from the web platforms. This is because the user has to be redirected to a browser where
+The user experience on mobile platforms is very different from the web platforms. This is because the user has to be redirected to a browser where
 they can login using their socials and then back to the app once they have been successfully authenticated. This user experience shifts the context
-between two applications, whereas in the web platforms, the context remains within the browser only.
+between two applications, whereas, in the web platforms, the context remains within the browser only.
 
-For the seamless login flow, we need to reconstruct the Shares `A` and `B`. `Share A` is managed by the login service and is provided on successful
-authentication. Whereas in web platforms, `Share B` is stored in the browser context. We can still store it in the browser context for mobile devices,
-but this has a few risks, like user accidently deleting browser data. This is a bigger problem in mobile devices since the user doesn't realise that
+For the seamless login flow, we need to reconstruct the Shares `A` and `B`. `Share B` is managed by the login service and is provided on successful
+authentication. Whereas in web platforms, `Share A` is stored in the browser context. We can still store it in the browser context for mobile devices,
+but this has a few risks like users accidentally deleting browser data. This is a bigger problem in mobile devices since the user doesn't realize that
 the browser is being used to login within the app and clearing the browser data can cause their logins to fail. Hence, to tackle this issue, Web3Auth
 issues a dApp Share, ie. a backup share that can be stored by the app developer directly within their application and used to reconstruct the private
 key after successful login by the user.