Merge branch 'master' into migration-guide

Web3Auth · Sep 19, 2023 · e58fc31 · e58fc31
2 parents 8dec932 + 3193269
commit e58fc31
Show file tree

Hide file tree

Showing 54 changed files with 141 additions and 138 deletions.
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
@@ -10,4 +10,3 @@ jobs:
       - uses: gaurav-nelson/github-action-markdown-link-check@v1
         with:
           file-extension: .mdx
-          check-modified-files-only: "yes"
diff --git a/docs/connect-blockchain/arbitrum.mdx b/docs/connect-blockchain/arbitrum.mdx
@@ -53,7 +53,7 @@ Mainnet Block Explorer URL: https://arbiscan.io
 :::note
 
 Arbitrum One is in mainnet Beta, which currently includes administrative controls. Learn more
-[here](https://developer.offchainlabs.com/docs/mainnet#some-words-of-caution).
+[here](https://docs.arbitrum.io/mainnet-risks#some-words-of-caution).
 
 :::
 
@@ -275,7 +275,7 @@ Testnet Block Explorer URL: https://testnet.arbiscan.io
 :::note
 
 Arbitrum One is in mainnet Beta, which currently includes administrative controls. Learn more
-[here](https://developer.offchainlabs.com/docs/mainnet#some-words-of-caution).
+[here](https://docs.arbitrum.io/mainnet-risks#some-words-of-caution).
 
 :::
 

diff --git a/docs/connect-blockchain/optimism.mdx b/docs/connect-blockchain/optimism.mdx
@@ -263,8 +263,6 @@ const provider = new ethers.providers.Web3Provider(web3authProvider); // web3aut
 
 ### Testnet
 
-Testnet Block Explorer URL: https://kovan-optimistic.etherscan.io
-
 ```tsx
 /*
 Simply change the chainId field of `chainConfig` to `0x13881` (testnet)

diff --git a/docs/connect-blockchain/xrpl.mdx b/docs/connect-blockchain/xrpl.mdx
@@ -9,7 +9,7 @@ description: "Integrate Web3Auth with the XRPL Blockchain | Documentation - Web3
 
 import GetUserInfoSnippet from "@site/src/common/docs/_get-userinfo.mdx";
 
-The Web3Auth Web SDK offers a standard provider for accessing the user's private key on non-EVM chains like [XRPL](https://xrpl.com/). To enable a
+The Web3Auth Web SDK offers a standard provider for accessing the user's private key on non-EVM chains like [XRPL](https://xrpl.org/). To enable a
 wider range of blockchain actions, you can use the `XrplPrivateKeyProvider` from `@web3auth/xrpl-provider`. This will provide an xrplProvider that can
 be injected back into the Openlogin adapter, allowing you to perform actions such as retrieving account information, obtaining balances, signing and
 sending transactions, and reading from and writing to smart contracts. Here are some methods to help you quickly get started.

diff --git a/docs/how-web3auth-works.mdx b/docs/how-web3auth-works.mdx
@@ -6,6 +6,7 @@ description: "How Web3Auth Works? | Documentation - Web3Auth"
 ---
 
 import TkeyIntroduction from "@site/src/common/docs/_tkey-intro.mdx";
+import Web3AuthWorking from "@site/static/content-hub/web3auth-working.png";
 import KeyManagement from "@site/static/images/key-management.png";
 import PnPCoreKitFlow from "@site/static/images/pnp-core-kit-flow.png";
 import SFAInfra from "@site/static/images/sfa-infra.png";
@@ -44,7 +45,7 @@ Once the user starts the process:
 
 ##### Here's a diagram showing this process:
 
-![](@site/static/content-hub/web3auth-working.png)
+<img style={{ display: "block", maxHeight: "600px", margin: "20px auto" }} src={Web3AuthWorking} alt="Image working" />
 
 ### Core Kit SDKs
 

diff --git a/docs/legal/cookie-policy.mdx b/docs/legal/cookie-policy.mdx
@@ -5,9 +5,8 @@ description: "Cookie Policy | Documentation - Web3Auth"
 
 Latest update: 09 June 2022
 
-
-This cookie policy is only applicable to Torus website (https://tor.us) and Web3Auth's website (https://web3auth.io) not Torus wallet (https://app.tor.us). The Torus wallet does not use any
-cookies.
+This cookie policy is only applicable to Torus website (https://tor.us) and Web3Auth's website (https://web3auth.io) not Torus wallet
+(https://app.tor.us). The Torus wallet does not use any cookies.
 
 Cookies consist of portions of code installed in the browser that assist the Owner in providing the Service according to the purposes described. Some
 of the purposes for which Cookies are installed may also require the User's consent.
@@ -104,16 +103,14 @@ information about how to manage Cookies in the most commonly used browsers at th
 [Apple Safari](https://support.apple.com/guide/safari/manage-cookies-and-website-data-sfri11471/) and
 [Microsoft Internet Explorer](http://windows.microsoft.com/en-us/windows-vista/block-or-allow-cookies).
 
-With regard to Cookies installed by third parties, Users can manage their preferences and withdrawal of their consent by clicking the related opt-out
+With regard to Cookies installed by third parties, Users can manage their preferences and withdraw of their consent by clicking the related opt-out
 link \(if provided\), by using the means provided in the third party's privacy policy, or by contacting the third party.
 
 Notwithstanding the above, the Owner informs that Users may follow the instructions provided on the subsequently linked initiatives by the
-[EDAA](http://www.youronlinechoices.eu/) \(EU\), the
-[Network Advertising Initiative](https://www.networkadvertising.org/understanding-digital-advertising) \(US\) and the
-[Digital Advertising Alliance](https://www.aboutads.info/consumers/) \(US\), [DAAC](https://youradchoices.ca/understanding-online-advertising/)
-\(Canada\), [DDAI](http://www.ddai.info/optout) \(Japan\) or other similar services. Such initiatives allow Users to select their tracking preferences
-for most of the advertising tools. The Owner thus recommends that Users make use of these resources in addition to the information provided in this
-document.
+[EDAA](http://www.youronlinechoices.eu/) \(EU\), the [Network Advertising Initiative](https://thenai.org/) \(US\) and the
+[Digital Advertising Alliance](#) \(US\), [DAAC](https://youradchoices.ca/understanding-online-advertising/) \(Canada\),
+[DDAI](http://www.ddai.info/optout) \(Japan\) or other similar services. Such initiatives allow Users to select their tracking preferences for most of
+the advertising tools. The Owner thus recommends that Users make use of these resources in addition to the information provided in this document.
 
 ## Owner and Data Controller
 

diff --git a/docs/sdk/core-kit/mpc-core-kit/mpc-core-kit.mdx b/docs/sdk/core-kit/mpc-core-kit/mpc-core-kit.mdx
@@ -19,9 +19,9 @@ Web3Auth MPC Core Kit Web SDK is designed in a way to make it easier for you to
 possible for you to sign signatures. Hence, the 2/2 flow is allows you the same experience as a 2/3 or 2/4 flow. You can generate as many backup
 shares as you want, but internally, they will be copies of the device share.
 
-If you require the 2/3 flow for your application, you need to directly integrate the [tKey MPC SDK](/content-hub/guides/tkey-mpc). Here, there is one
-additional share which you can ask the user to safe gaurd, however the experience of using it will be the same. We are working on adding more features
-to this SDK and will be releasing them in the consecutive updates.
+If you require the 2/3 flow for your application, you need to directly integrate the [tKey MPC SDK](/content-hub/guides/tkey-js-mpc). Here, there is
+one additional share which you can ask the user to safe gaurd, however the experience of using it will be the same. We are working on adding more
+features to this SDK and will be releasing them in the consecutive updates.
 
 :::
 

diff --git a/docs/sdk/core-kit/mpc-tkey-ios/install.mdx b/docs/sdk/core-kit/mpc-tkey-ios/install.mdx
@@ -23,7 +23,7 @@ description: "Installing Web3Auth tKey MPC Swift SDK | Documentation - Web3Auth"
 
 1. When finished, Xcode will automatically begin resolving and downloading your dependencies in the background.
 
-### Add the [CustomAuth Swift SDK](https://github.com/torusresearch/customauth-swift-sdk/tree/alpha)
+### Add the [CustomAuth Swift SDK](https://github.com/torusresearch/customauth-swift-sdk/)
 
 1. In Xcode, with your app project open, navigate to **File > Add Packages**.
 

diff --git a/docs/sdk/core-kit/sfa-flutter/authentication.mdx b/docs/sdk/core-kit/sfa-flutter/authentication.mdx
@@ -1,10 +1,16 @@
 ---
-title: "Authentication in Core Kit SFA Android SDK"
+title: "Authentication in Core Kit SFA Flutter SDK"
 sidebar_label: "Authentication"
 displayed_sidebar: sdk
-description: "Web3Auth Core Kit Single Factor Auth Android SDK - Authentication | Documentation - Web3Auth"
+description: "Web3Auth Core Kit Single Factor Auth Flutter SDK - Authentication | Documentation - Web3Auth"
 ---
 
 import AuthenticationInSFA from "@site/src/common/sdk/core-kit/sfa/_auth_in_core_kit_sfa.mdx";
 
 <AuthenticationInSFA />
+
+:::note SDKs
+
+This is a documentation page for Web3Auth Core Kit Single Factor Auth Flutter SDK. To read about other SDKs visit the [SDKs](/sdk) section.
+
+:::
diff --git a/docs/sdk/core-kit/sfa-react-native/install.mdx b/docs/sdk/core-kit/sfa-react-native/install.mdx
@@ -25,8 +25,8 @@ such as push notifications, builds, and updates.
 
 Your Bare React Native app is entirely built on your machine. In this workflow, the developer has complete control, along with the complexity that
 comes with that. Configuration with `app.json` / `app.config.js` is mostly not supported in this context; instead, you will need to configure each
-native project directly with Swift/Kotlin native modules. Check out the [troubleshooting section](/docs/sdk/pnp/react-native/install#troubleshooting)
-for fixing common issues.
+native project directly with Swift/Kotlin native modules. Check out the [troubleshooting section](/sdk/pnp/react-native/install#troubleshooting) for
+fixing common issues.
 
 :::tip
 

diff --git a/docs/sdk/core-kit/tkey-android/modules/share-transfer.mdx b/docs/sdk/core-kit/tkey-android/modules/share-transfer.mdx
@@ -1,7 +1,7 @@
 ---
 title: Share Transfer Module
 displayed_sidebar: sdk
-description: "Core Kit tKey iOS SDK - Modules - Share Transfer Module  | Documentation - Web3Auth"
+description: "Core Kit tKey Android SDK - Modules - Share Transfer Module  | Documentation - Web3Auth"
 ---
 
 The SharetransferModule is an Android module that provides functions for requesting, approving and transfering a share to another device.

diff --git a/docs/sdk/core-kit/tkey/install.mdx b/docs/sdk/core-kit/tkey/install.mdx
@@ -2,7 +2,7 @@
 title: "Installing tKey JS SDK"
 sidebar_label: "Install"
 displayed_sidebar: sdk
-description: "Web3Auth Core Kit tKey SDK - Install  | Documentation - Web3Auth"
+description: "Web3Auth Core Kit tKey JS SDK - Install  | Documentation - Web3Auth"
 ---
 
 The tKey SDK contains multiple packages are needed to enable different functionalities of the tKey SDK. You can choose the packages you want to

diff --git a/docs/sdk/core-kit/tkey/intrinsic-flow.mdx b/docs/sdk/core-kit/tkey/intrinsic-flow.mdx
@@ -2,7 +2,7 @@
 title: Enabling Intrinsic Authentication Flow in tKey
 sidebar_label: Intrinsic Auth Flow
 displayed_sidebar: sdk
-description: "Web3Auth Core Kit tKey SDK - Install  | Documentation - Web3Auth"
+description: "Web3Auth Core Kit tKey SDK - Intrinsic Flow  | Documentation - Web3Auth"
 ---
 
 import TorusServiceProviderArg from "@site/src/common/sdk/core-kit/tkey/_service-provider-torus-arg.mdx";

diff --git a/docs/sdk/pnp/android/custom-authentication.mdx b/docs/sdk/pnp/android/custom-authentication.mdx
@@ -26,7 +26,7 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)**
 
 - dApp Share is only returned for the Custom verifiers.
 - Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See
-  **[MFA](/sdk/pnp/android/custom-authentication/mfa)** for more details.
+  **[MFA](/sdk/pnp/android/mfa)** for more details.
 
 :::
 

diff --git a/docs/sdk/pnp/flutter/custom-authentication.mdx b/docs/sdk/pnp/flutter/custom-authentication.mdx
@@ -26,7 +26,7 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)**
 
 - dApp Share is only returned for the Custom verifiers.
 - Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See
-  **[MFA](/sdk/pnp/flutter/custom-authentication/mfa)** for more details.
+  **[MFA](/sdk/pnp/flutter/mfa)** for more details.
 
 :::
 

diff --git a/docs/sdk/pnp/ios/custom-authentication.mdx b/docs/sdk/pnp/ios/custom-authentication.mdx
@@ -26,7 +26,7 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)**
 
 - dApp Share is only returned for the Custom verifiers.
 - Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `W3ALoginParams` during login. See
-  **[MFA](/sdk/pnp/ios/custom-authentication/mfa)** for more details.
+  **[MFA](/sdk/pnp/ios/mfa)** for more details.
 
 :::
 

diff --git a/docs/sdk/pnp/react-native/custom-authentication.mdx b/docs/sdk/pnp/react-native/custom-authentication.mdx
@@ -25,7 +25,7 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)**
 
 - dApp Share is only returned for the Custom verifiers.
 - Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See
-  **[MFA](/sdk/pnp/react-native/custom-authentication/mfa)** for more details.
+  **[MFA](/sdk/pnp/react-native/mfa)** for more details.
 
 :::
 

diff --git a/docs/sdk/pnp/react-native/install.mdx b/docs/sdk/pnp/react-native/install.mdx
@@ -25,7 +25,7 @@ such as push notifications, builds, and updates.
 
 Your Bare React Native app is entirely built on your machine. In this workflow, the developer has complete control, along with the complexity that
 comes with that. Configuration with `app.json` / `app.config.js` is mostly not supported in this context; instead, you will need to configure each
-native project directly with Swift/Kotlin native modules. Check out the [troubleshooting section](/docs/sdk/pnp/react-native/install#troubleshooting)
+native project directly with Swift/Kotlin native modules. Check out the [troubleshooting section](/sdk/pnp/react-native/install#troubleshooting)
 for fixing common issues.
 
 :::tip

diff --git a/docs/sdk/pnp/unity/custom-authentication.mdx b/docs/sdk/pnp/unity/custom-authentication.mdx
@@ -201,7 +201,7 @@ void Start()
 
 - dApp Share is only returned for the Custom Authentication verifiers.
 - Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See
-  **[MFA](/sdk/pnp/unity/custom-authentication/mfa)** for more details.
+  **[MFA](/sdk/pnp/unity/mfa)** for more details.
 
 :::
 

diff --git a/docs/sdk/pnp/unreal/custom-authentication.mdx b/docs/sdk/pnp/unreal/custom-authentication.mdx
@@ -187,6 +187,6 @@ enum class FTypeOfLogin : uint8
 - dApp Share is only returned for the Custom Authentication verifiers.
 - Also, 2FA should be enabled for the account using it.
 
-  Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](/sdk/pnp/unreal/custom-authentication/mfa)** for more details.
+  Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](/sdk/pnp/unreal/mfa)** for more details.
 
 :::
diff --git a/docs/sdk/pnp/web/adapters/slope.mdx b/docs/sdk/pnp/web/adapters/slope.mdx
@@ -12,7 +12,7 @@ import Tabs from "@theme/Tabs";
 
 ## [`@web3auth/slope-adapter`](https://npmjs.com/package/@web3auth/slope-adapter)
 
-Slope adapter allows you to connect with slope wallet. You can read more about slope wallet here.(https://docs.slope.app/).
+Slope adapter allows you to connect with slope wallet. You can read more about slope wallet here.(https://developers.slope.so/).
 
 ## Basic Details
 

diff --git a/docs/sdk/pnp/web/adapters/solflare.mdx b/docs/sdk/pnp/web/adapters/solflare.mdx
@@ -12,7 +12,7 @@ import Tabs from "@theme/Tabs";
 
 ## [`@web3auth/solflare-adapter`](https://npmjs.com/package/@web3auth/solflare-adapter)
 
-Solflare adapter allows you to connect with solflare wallet. You can read more about solflare wallet here.(https://docs.solflare.app/).
+Solflare adapter allows you to connect with solflare wallet. You can read more about solflare wallet here.(https://docs.solflare.com/solflare/).
 
 ## Basic Details
 

diff --git a/docs/sdk/pnp/web/adapters/torus-evm.mdx b/docs/sdk/pnp/web/adapters/torus-evm.mdx
@@ -45,22 +45,22 @@ npm install --save @web3auth/torus-evm-adapter
 
 <TabItem value="table">
 
-| Parameter          | type                                                                    |
-| ------------------ | ----------------------------------------------------------------------- |
-| `chainConfig`      | `CustomChainConfig`                                                     |
-| `adapterSettings`  | [`TorusCtorArgs`](https://docs.tor.us/wallet/sdk/class)                 |
-| `loginSettings`    | [`LoginParams`](https://docs.tor.us/wallet/sdk/class)                   |
-| `initParams`       | [`Omit <TorusParams, "network">`](https://docs.tor.us/wallet/sdk/class) |
-| `clientId?`        | `string`                                                                |
-| `sessionTime?`     | `number`                                                                |
-| `web3AuthNetwork?` | `OPENLOGIN_NETWORK_TYPE`                                                |
+| Parameter          | type                                                                              |
+| ------------------ | --------------------------------------------------------------------------------- |
+| `chainConfig`      | `CustomChainConfig`                                                               |
+| `adapterSettings`  | [`TorusCtorArgs`](https://docs.tor.us/wallet/api-reference/class)                 |
+| `loginSettings`    | [`LoginParams`](https://docs.tor.us/wallet/api-reference/class)                   |
+| `initParams`       | [`Omit <TorusParams, "network">`](https://docs.tor.us/wallet/api-reference/class) |
+| `clientId?`        | `string`                                                                          |
+| `sessionTime?`     | `number`                                                                          |
+| `web3AuthNetwork?` | `OPENLOGIN_NETWORK_TYPE`                                                          |
 
 </TabItem>
 
 <TabItem value="interface">
 
 ```tsx
-// refer to https://docs.tor.us/wallet/sdk/class to know more about interface field types
+// refer to https://docs.tor.us/wallet/api-reference/class to know more about interface field types
 interface TorusWalletOptions {
   adapterSettings?: TorusCtorArgs;
   loginSettings?: LoginParams;

diff --git a/docs/sdk/pnp/web/adapters/torus-solana.mdx b/docs/sdk/pnp/web/adapters/torus-solana.mdx
@@ -45,22 +45,22 @@ npm install --save @web3auth/torus-solana-adapter
 
 <TabItem value="table">
 
-| Parameter          | type                                                                          |
-| ------------------ | ----------------------------------------------------------------------------- |
-| `chainConfig`      | `CustomChainConfig`                                                           |
-| `adapterSettings`  | [`TorusCtorArgs`](https://docs.tor.us/solana-wallet/sdk/class)                |
-| `loginSettings`    | [`LoginParams`](https://docs.tor.us/solana-wallet/sdk/class)                  |
-| `initParams`       | [`Omit<TorusParams, "network">`](https://docs.tor.us/solana-wallet/sdk/class) |
-| `clientId?`        | `string`                                                                      |
-| `sessionTime?`     | `number`                                                                      |
-| `web3AuthNetwork?` | `OPENLOGIN_NETWORK_TYPE`                                                      |
+| Parameter          | type                                                                                    |
+| ------------------ | --------------------------------------------------------------------------------------- |
+| `chainConfig`      | `CustomChainConfig`                                                                     |
+| `adapterSettings`  | [`TorusCtorArgs`](https://docs.tor.us/solana-wallet/api-reference/class)                |
+| `loginSettings`    | [`LoginParams`](https://docs.tor.us/solana-wallet/api-reference/class)                  |
+| `initParams`       | [`Omit<TorusParams, "network">`](https://docs.tor.us/solana-wallet/api-reference/class) |
+| `clientId?`        | `string`                                                                                |
+| `sessionTime?`     | `number`                                                                                |
+| `web3AuthNetwork?` | `OPENLOGIN_NETWORK_TYPE`                                                                |
 
 </TabItem>
 
 <TabItem value="interface">
 
 ```tsx
-// refer to https://docs.tor.us/solana-wallet/sdk/class to know more about interface field types
+// refer to https://docs.tor.us/solana-wallet/api-reference/class to know more about interface field types
 interface SolanaWalletOptions {
   adapterSettings?: TorusCtorArgs;
   loginSettings?: LoginParams;

diff --git a/docs/sdk/pnp/web/modal/show-wallet-connect.mdx b/docs/sdk/pnp/web/modal/show-wallet-connect.mdx
@@ -9,7 +9,7 @@ import ShowWCScanner from "@site/src/common/sdk/pnp/web/_plugin-showwcscanner.md
 
 For enabling interoperability with Wallet Connect, ie. connecting your W3A generated wallet to other dApps which have Wallet Connect integration, you
 can use the `showWalletConnectScanner()` method. This method uses the Wallet Connect `copy and paste` flow, in which you can directly copy the QR Code
-details from a dApp like [OpenSea](https://opensea.io/) and paste in it your shown modal.
+details from a dApp like [OpenSea](https://opensea.io) and paste in it your shown modal.
 
 :::info
 

diff --git a/docs/sdk/pnp/web/no-modal/show-wallet-connect.mdx b/docs/sdk/pnp/web/no-modal/show-wallet-connect.mdx
@@ -9,7 +9,7 @@ import ShowWCScanner from "@site/src/common/sdk/pnp/web/_plugin-showwcscanner.md
 
 For enabling interoperability with Wallet Connect, ie. connecting your W3A generated wallet to other dApps which have Wallet Connect integration, you
 can use the `showWalletConnectScanner()` method. This method uses the Wallet Connect `copy and paste` flow, in which you can directly copy the QR Code
-details from a dApp like [OpenSea](https://opensea.io/) and paste in it your shown modal.
+details from a dApp like [OpenSea](https://opensea.io) and paste in it your shown modal.
 
 :::info