From 234d1c37a89c4ba6f41823a94405b83360c3a193 Mon Sep 17 00:00:00 2001 From: Yashovardhan Agrawal Date: Mon, 18 Sep 2023 17:18:43 +0800 Subject: [PATCH 1/8] remove /docs/ --- docs/sdk/core-kit/sfa-react-native/install.mdx | 4 ++-- docs/sdk/pnp/react-native/install.mdx | 2 +- mlc_config.json | 8 -------- src/common/quickstart/_pnp-reactnative-bare.mdx | 6 +++--- src/common/quickstart/_pnp-reactnative-expo.mdx | 6 +++--- src/common/quickstart/_tkey-react-native.mdx | 9 ++++----- src/common/quickstart/_tkey-react.mdx | 4 ++-- src/common/sdk/pnp/web/_external-wallet-adapters.mdx | 2 +- src/pages/content-hub/guides/browser-extension.mdx | 2 +- src/pages/content-hub/guides/ios.mdx | 2 +- .../builder/android/stepContent/evmRPCFunctions.mdx | 2 +- .../builder/flutter/stepContent/evmRPCFunctions.mdx | 2 +- .../builder/ios/stepContent/evmRPCFunctions.mdx | 2 +- 13 files changed, 21 insertions(+), 30 deletions(-) diff --git a/docs/sdk/core-kit/sfa-react-native/install.mdx b/docs/sdk/core-kit/sfa-react-native/install.mdx index 711606192..611d56151 100644 --- 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/pnp/react-native/install.mdx b/docs/sdk/pnp/react-native/install.mdx index beea698f2..1fa178914 100644 --- 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/mlc_config.json b/mlc_config.json index 4bdd2a376..f1eb80e51 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -13,17 +13,9 @@ } ], "replacementPatterns": [ - { - "pattern": "^/docs/", - "replacement": "https://web3auth.io/" - }, { "pattern": "^/", "replacement": "https://web3auth.io/docs/" - }, - { - "pattern": "^./", - "replacement": "https://web3auth.io/docs/" } ], "ignorePatterns": [ diff --git a/src/common/quickstart/_pnp-reactnative-bare.mdx b/src/common/quickstart/_pnp-reactnative-bare.mdx index 449e4e409..37129b509 100644 --- a/src/common/quickstart/_pnp-reactnative-bare.mdx +++ b/src/common/quickstart/_pnp-reactnative-bare.mdx @@ -49,7 +49,7 @@ Once you're done initializing, just create a button that triggers the login for :::warning Please note that the v4 react-native-sdk has some breaking changes. For instance, `web3auth.login` is a void method, unlike the older versions of the -SDK. Please refer to the [migration guide](/docs/pnp/migration-guides/rn-v3-to-v4) for more. +SDK. Please refer to the [migration guide](/pnp/migration-guides/rn-v3-to-v4) for more. ::: @@ -86,8 +86,8 @@ To make use of the polyfilled modules while building the application, you need t :::info Expo Managed Workflow -You will have to create `metro.config.js` for Expo Managed Workflow, as it is not present by default. Also, note that polyfilling is not supported with -"Expo Go" app. It is compatible only with Custom Dev Client and EAS builds. +You will have to create `metro.config.js` for Expo Managed Workflow, as it is not present by default. Also, note that polyfilling is not supported +with "Expo Go" app. It is compatible only with Custom Dev Client and EAS builds. Please run `npx expo prebuild` to generate native code based on the version of expo a project has installed, before moving forward. diff --git a/src/common/quickstart/_pnp-reactnative-expo.mdx b/src/common/quickstart/_pnp-reactnative-expo.mdx index a94c908a1..a43ed604a 100644 --- a/src/common/quickstart/_pnp-reactnative-expo.mdx +++ b/src/common/quickstart/_pnp-reactnative-expo.mdx @@ -57,7 +57,7 @@ Once you're done initializing, just create a button that triggers the login for :::warning Please note that the v4 react-native-sdk has some breaking changes. For instance, `web3auth.login` is a void method, unlike the older versions of the -SDK. Please refer to the [migration guide](/docs/pnp/migration-guides/rn-v3-to-v4) for more +SDK. Please refer to the [migration guide](/pnp/migration-guides/rn-v3-to-v4) for more ::: @@ -94,8 +94,8 @@ To make use of the polyfilled modules while building the application, you need t :::info Expo Managed Workflow -You will have to create `metro.config.js` for Expo Managed Workflow, as it is not present by default. Also, note that polyfilling is not supported with -"Expo Go" app. It is compatible only with Custom Dev Client and EAS builds. +You will have to create `metro.config.js` for Expo Managed Workflow, as it is not present by default. Also, note that polyfilling is not supported +with "Expo Go" app. It is compatible only with Custom Dev Client and EAS builds. Please run `npx expo prebuild` to generate native code based on the version of expo a project has installed, before moving forward. diff --git a/src/common/quickstart/_tkey-react-native.mdx b/src/common/quickstart/_tkey-react-native.mdx index 23e23e079..d092c7c15 100644 --- a/src/common/quickstart/_tkey-react-native.mdx +++ b/src/common/quickstart/_tkey-react-native.mdx @@ -12,9 +12,8 @@ npm install --save @tkey/core @tkey/service-provider-base @tkey/storage-layer-to #### Additionally in this step, you need to configure your project to use these libraries. -- Checkout the - [CustomAuth SDK Configuration for React Native](/docs/sdk/core-kit/tkey-react-native/install#configuration-of-project-to-use-customauth-sdk) -- Learn about [polyfills for React Native](/docs/sdk/core-kit/tkey-react-native/install#bundler-polyfilling) +- Checkout the [CustomAuth SDK Configuration for React Native](/sdk/core-kit/tkey-react-native/install#configuration-of-project-to-use-customauth-sdk) +- Learn about [polyfills for React Native](/sdk/core-kit/tkey-react-native/install#bundler-polyfilling) ::: @@ -129,7 +128,7 @@ const triggerLogin = async () => { :::info - [What's a verifier?](/auth-provider-setup/verifiers) -- [How to create a auth0 verifier?](/docs/auth-provider-setup/federated-identity-providers) +- [How to create a auth0 verifier?](/auth-provider-setup/federated-identity-providers) ::: @@ -161,6 +160,6 @@ const initializeNewKey = async () => { :::warning This is set up the tKey in 2/2 flow, which means that the private will be lost once you log out of the app. To add more shares, make sure to use the -added modules and configure them as written in the [SDK Reference](/docs/sdk/core-kit/tkey-react-native/modules/) +added modules and configure them as written in the [SDK Reference](/sdk/core-kit/tkey-react-native/modules/) ::: diff --git a/src/common/quickstart/_tkey-react.mdx b/src/common/quickstart/_tkey-react.mdx index 3fa837d82..7512c5eca 100644 --- a/src/common/quickstart/_tkey-react.mdx +++ b/src/common/quickstart/_tkey-react.mdx @@ -102,7 +102,7 @@ const triggerLogin = async () => { :::info - [What's a verifier?](/auth-provider-setup/verifiers) -- [How to create a google verifier?](/docs/auth-provider-setup/social-providers/google) +- [How to create a google verifier?](/auth-provider-setup/social-providers/google) ::: @@ -147,6 +147,6 @@ const initializeNewKey = async () => { :::warning This is set up the tKey in 2/2 flow, which means that the private will be lost once you log out of the app. To add more shares, make sure to use the -added modules and configure them as written in the [SDK Reference](/docs/sdk/core-kit/tkey/modules/) +added modules and configure them as written in the [SDK Reference](/sdk/core-kit/tkey/modules/) ::: diff --git a/src/common/sdk/pnp/web/_external-wallet-adapters.mdx b/src/common/sdk/pnp/web/_external-wallet-adapters.mdx index 39df71d9a..f5a2c5418 100644 --- a/src/common/sdk/pnp/web/_external-wallet-adapters.mdx +++ b/src/common/sdk/pnp/web/_external-wallet-adapters.mdx @@ -5,7 +5,7 @@ To configure an adapter, create the instance of adapter by using its correspondi :::tip -Refer to the [Adapters documentation](/docs/sdk/pnp/web/adapters) to know more deeply about what adapters are available and how to configure them. +Refer to the [Adapters documentation](/sdk/pnp/web/adapters) to know more deeply about what adapters are available and how to configure them. ::: diff --git a/src/pages/content-hub/guides/browser-extension.mdx b/src/pages/content-hub/guides/browser-extension.mdx index 1d2f723e5..dbe92b0ec 100644 --- a/src/pages/content-hub/guides/browser-extension.mdx +++ b/src/pages/content-hub/guides/browser-extension.mdx @@ -53,7 +53,7 @@ the blockchain. ## How it works? We can integrate `@web3auth/no-modal` as well as `@web3auth/modal` to build a browser extension with Web3Auth. You can read more about both the SDKs -in the [SDKs](/docs/sdk/pnp/web) section. The login flow of the user is as follows: +in the [SDKs](/sdk/pnp/web) section. The login flow of the user is as follows: ![Web3Auth Core - Social Login Flow](/images/implicit-flow.svg) diff --git a/src/pages/content-hub/guides/ios.mdx b/src/pages/content-hub/guides/ios.mdx index 285eeba20..04875735e 100644 --- a/src/pages/content-hub/guides/ios.mdx +++ b/src/pages/content-hub/guides/ios.mdx @@ -132,7 +132,7 @@ let web3auth = Web3Auth(W3AInitParams( )) ``` -All the below code snippets are based on the above initialization. Please refer to the [Web3Auth ios SDK Reference](/docs/sdk/pnp/ios) for more +All the below code snippets are based on the above initialization. Please refer to the [Web3Auth ios SDK Reference](/sdk/pnp/ios) for more information. After creating a `Web3Auth` instance using one of the above methods, you can use the instance to call various methods. diff --git a/src/pages/integration-builder/builder/android/stepContent/evmRPCFunctions.mdx b/src/pages/integration-builder/builder/android/stepContent/evmRPCFunctions.mdx index ed2fac562..3aecf4052 100644 --- a/src/pages/integration-builder/builder/android/stepContent/evmRPCFunctions.mdx +++ b/src/pages/integration-builder/builder/android/stepContent/evmRPCFunctions.mdx @@ -8,6 +8,6 @@ While using the Web3Auth Android SDK, you get the private key and sessionId with :::info Connect any Blockchain -Refer to the [Blockchain Documentation](/docs/connect-blockchain/) to know more about how to make calls on any blockchain. +Refer to the [Blockchain Documentation](/connect-blockchain/) to know more about how to make calls on any blockchain. ::: diff --git a/src/pages/integration-builder/builder/flutter/stepContent/evmRPCFunctions.mdx b/src/pages/integration-builder/builder/flutter/stepContent/evmRPCFunctions.mdx index 115d591f7..15f4af720 100644 --- a/src/pages/integration-builder/builder/flutter/stepContent/evmRPCFunctions.mdx +++ b/src/pages/integration-builder/builder/flutter/stepContent/evmRPCFunctions.mdx @@ -8,6 +8,6 @@ While using the Web3Auth Flutter SDK, you get the private key within the user sc :::info Connect any Blockchain -Refer to the [Blockchain Documentation](/docs/connect-blockchain/) to know more about how to make calls on any blockchain. +Refer to the [Blockchain Documentation](/connect-blockchain/) to know more about how to make calls on any blockchain. ::: diff --git a/src/pages/integration-builder/builder/ios/stepContent/evmRPCFunctions.mdx b/src/pages/integration-builder/builder/ios/stepContent/evmRPCFunctions.mdx index f988a9fb2..c74228267 100644 --- a/src/pages/integration-builder/builder/ios/stepContent/evmRPCFunctions.mdx +++ b/src/pages/integration-builder/builder/ios/stepContent/evmRPCFunctions.mdx @@ -8,6 +8,6 @@ While using the Web3Auth iOS SDK, you get the private key and sessionId within t :::info Connect any Blockchain -Refer to the [Blockchain Documentation](/docs/connect-blockchain/) to know more about how to make calls on any blockchain. +Refer to the [Blockchain Documentation](/connect-blockchain/) to know more about how to make calls on any blockchain. ::: From 8c370ce8906399d05118929dd2540251b6d5ee85 Mon Sep 17 00:00:00 2001 From: Yashovardhan Agrawal Date: Mon, 18 Sep 2023 17:20:44 +0800 Subject: [PATCH 2/8] Update linkcheck.yml --- .github/workflows/linkcheck.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml index 8877d6aab..b89c9f26a 100644 --- 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" From d985f5beb039553dc47e4ea8ece93bdaed8649b6 Mon Sep 17 00:00:00 2001 From: Yashovardhan Agrawal Date: Mon, 18 Sep 2023 17:35:30 +0800 Subject: [PATCH 3/8] Update mlc_config.json --- mlc_config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mlc_config.json b/mlc_config.json index f1eb80e51..e78ba6ace 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -20,7 +20,7 @@ ], "ignorePatterns": [ { - "pattern": "^https://manage.auth0.com/" + "pattern": "https://manage.auth0.com/" } - ], + ] } From ef20fe7fc9bd60bfbd66d66afaf1b129eb0882aa Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Mon, 18 Sep 2023 18:23:22 +0800 Subject: [PATCH 4/8] fix broken links --- docs/connect-blockchain/arbitrum.mdx | 4 ++-- docs/connect-blockchain/optimism.mdx | 2 -- docs/connect-blockchain/xrpl.mdx | 2 +- docs/how-web3auth-works.mdx | 3 ++- docs/legal/cookie-policy.mdx | 12 +++++------ .../core-kit/mpc-core-kit/mpc-core-kit.mdx | 6 +++--- docs/sdk/core-kit/mpc-tkey-ios/install.mdx | 2 +- .../sdk/pnp/android/custom-authentication.mdx | 2 +- .../sdk/pnp/flutter/custom-authentication.mdx | 2 +- docs/sdk/pnp/ios/custom-authentication.mdx | 2 +- .../react-native/custom-authentication.mdx | 2 +- docs/sdk/pnp/unity/custom-authentication.mdx | 2 +- docs/sdk/pnp/unreal/custom-authentication.mdx | 2 +- docs/sdk/pnp/web/adapters/slope.mdx | 2 +- docs/sdk/pnp/web/adapters/solflare.mdx | 2 +- docs/sdk/pnp/web/adapters/torus-evm.mdx | 20 +++++++++---------- docs/sdk/pnp/web/adapters/torus-solana.mdx | 20 +++++++++---------- .../sdk/pnp/web/modal/show-wallet-connect.mdx | 2 +- .../pnp/web/no-modal/show-wallet-connect.mdx | 2 +- docs/troubleshooting/error-429.mdx | 2 +- docs/troubleshooting/metro-issues.mdx | 19 +++++++++--------- docs/troubleshooting/vite-issues.mdx | 3 +-- docs/troubleshooting/webpack-issues.mdx | 3 +-- mlc_config.json | 15 ++++++++++++++ src/common/quickstart/_tkey-react-native.mdx | 16 --------------- .../sdk/pnp/web/_openlogin-adapter-intro.mdx | 7 ++++--- src/pages/content-hub/guides/cognito.mdx | 3 ++- src/pages/content-hub/guides/discord.mdx | 2 +- src/pages/content-hub/guides/firebase.mdx | 3 ++- src/pages/content-hub/guides/mpc-core-kit.mdx | 6 +++--- .../guides/react-native-expo-auth0.mdx | 4 ++-- .../content-hub/guides/single-factor-auth.mdx | 4 ++-- src/pages/content-hub/guides/tkey-js-mpc.mdx | 4 ++-- .../content-hub/guides/tkey-swift-mpc.mdx | 2 +- .../builder/ios/stepContent/whitelabeling.mdx | 2 +- .../instantiateSDKWhitelabeled.mdx | 2 +- src/pages/ios-mpc.mdx | 2 +- 37 files changed, 93 insertions(+), 97 deletions(-) diff --git a/docs/connect-blockchain/arbitrum.mdx b/docs/connect-blockchain/arbitrum.mdx index de5c3803c..770dd5285 100644 --- 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 index 07c9fafe5..5f77b54f6 100644 --- 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 index 3a6bfb43e..4c1c7f267 100644 --- 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 index 8cae5ba55..9a65928c5 100644 --- 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) +Image working ### Core Kit SDKs diff --git a/docs/legal/cookie-policy.mdx b/docs/legal/cookie-policy.mdx index 5f84ae9a4..ce17cb847 100644 --- 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,13 +103,12 @@ 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/) +[EDAA](http://www.youronlinechoices.eu/) \(EU\), the [Network Advertising Initiative](https://thenai.org/) \(US\) and the +[Digital Advertising Alliance](https://youradchoices.com/control) \(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. 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 index 1b46573fb..572634420 100644 --- 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 index 4b96fcfe8..7efbe14d9 100644 --- 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/pnp/android/custom-authentication.mdx b/docs/sdk/pnp/android/custom-authentication.mdx index 5bd7bdb28..1615b5d0a 100644 --- 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 index 49ec31dfc..ee7f5e0bd 100644 --- 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 index d88223652..764af5ded 100644 --- 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 index a88500579..961061e25 100644 --- 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/unity/custom-authentication.mdx b/docs/sdk/pnp/unity/custom-authentication.mdx index 8645f1173..ef4c56af9 100644 --- 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 index 64939f9a7..f9fbbc11f 100644 --- 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 index c1fe26d0c..500af4bb9 100644 --- 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 index 7f074632f..b1e94e1c2 100644 --- 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 index 7aee3ee70..fad349960 100644 --- 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 -| Parameter | type | -| ------------------ | ----------------------------------------------------------------------- | -| `chainConfig` | `CustomChainConfig` | -| `adapterSettings` | [`TorusCtorArgs`](https://docs.tor.us/wallet/sdk/class) | -| `loginSettings` | [`LoginParams`](https://docs.tor.us/wallet/sdk/class) | -| `initParams` | [`Omit `](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 `](https://docs.tor.us/wallet/api-reference/class) | +| `clientId?` | `string` | +| `sessionTime?` | `number` | +| `web3AuthNetwork?` | `OPENLOGIN_NETWORK_TYPE` | ```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 index b82ccc23f..087dc5feb 100644 --- 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 -| 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`](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`](https://docs.tor.us/solana-wallet/api-reference/class) | +| `clientId?` | `string` | +| `sessionTime?` | `number` | +| `web3AuthNetwork?` | `OPENLOGIN_NETWORK_TYPE` | ```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 index da929fef8..3cc8c057b 100644 --- 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 index 2afe04609..70ad8b5f0 100644 --- 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 diff --git a/docs/troubleshooting/error-429.mdx b/docs/troubleshooting/error-429.mdx index 67b49439d..66d4e3087 100644 --- a/docs/troubleshooting/error-429.mdx +++ b/docs/troubleshooting/error-429.mdx @@ -14,7 +14,7 @@ The error might look something like this: Error 429 (Infura RPC Endpoint) - Troubleshoot In that case, we recommend you to pass on your own node server in the `rpcTarget` value while Instantiating Web3Auth, which can be easily created by -using a service like [Infura](https://infura.io/dashboard), [Quicknode](https://www.quicknode.com/endpoints) etc. +using a service like [Infura](https://app.infura.io/login), [Quicknode](https://www.quicknode.com/endpoints) etc. ## For EVM Based Chains diff --git a/docs/troubleshooting/metro-issues.mdx b/docs/troubleshooting/metro-issues.mdx index fb676cf43..885cc751b 100644 --- a/docs/troubleshooting/metro-issues.mdx +++ b/docs/troubleshooting/metro-issues.mdx @@ -8,15 +8,14 @@ description: "Bundler Polyfill Issues - React Native Metro | Documentation - Web import TabItem from "@theme/TabItem"; import Tabs from "@theme/Tabs"; -While setting up a new web3 project from scratch, you might face multiple issues with the bundler. This issue is caused because the core -packages like `eccrypto` have certain dependencies, which are not present within the build environment. For rectifying this, the go-to method has been -to just add the missing modules directly into the package, and edit the bundler configuration to take advantage of that. +While setting up a new web3 project from scratch, you might face multiple issues with the bundler. This issue is caused because the core packages like +`eccrypto` have certain dependencies, which are not present within the build environment. For rectifying this, the go-to method has been to just add +the missing modules directly into the package, and edit the bundler configuration to take advantage of that. -Although this method works, it increases the bundle size significantly. Causing slow loading speeds and a bad user experience. It is important to -note that these modules, even while the build fails, are still present within the browser environment. Many libraries like Web3Auth are written in a -way to take advantage of this fact. Hence, even if the build doesn't contain the polyfill, the library should still work as expected. However, -if you are using a library that does not take advantage of this fact, you might face issues while using the library. Checkout -[this tweet thread](https://twitter.com/ChaitanyaPotti/status/1658103946274111488) where we have explained further how this works in detail. +Although this method works, it increases the bundle size significantly. Causing slow loading speeds and a bad user experience. It is important to note +that these modules, even while the build fails, are still present within the browser environment. Many libraries like Web3Auth are written in a way to +take advantage of this fact. Hence, even if the build doesn't contain the polyfill, the library should still work as expected. However, if you are +using a library that does not take advantage of this fact, you might face issues while using the library. Hence, you need to be mindful of the fact that you only require certain node polyfills to be added to your project, while testing each of its functionalities. At the same time, you need to tell the bundler to ignore the missing modules, and not include them in the build. @@ -47,8 +46,8 @@ To make use of the polyfilled modules while building the application, you need t :::info Expo Managed Workflow -You will have to create `metro.config.js` for Expo Managed Workflow, as it is not present by default. Also, note that polyfilling is not supported with -"Expo Go" app. It is compatible only with Custom Dev Client and EAS builds. +You will have to create `metro.config.js` for Expo Managed Workflow, as it is not present by default. Also, note that polyfilling is not supported +with "Expo Go" app. It is compatible only with Custom Dev Client and EAS builds. Please run `npx expo prebuild` to generate native code based on the version of expo a project has installed, before moving forward. diff --git a/docs/troubleshooting/vite-issues.mdx b/docs/troubleshooting/vite-issues.mdx index b43bcfcef..fd6b048d9 100644 --- a/docs/troubleshooting/vite-issues.mdx +++ b/docs/troubleshooting/vite-issues.mdx @@ -12,8 +12,7 @@ to just add the missing modules directly into the package, and edit the bundler Although this method works, but it increases the bundle size significantly. Causing slow loading speeds and a bad user experience. It is important to note that these modules, even while the build fails, are still present within the browser environment. Many libraries like Web3Auth are written in a way so as to take advantage of this fact. Hence, even if the build doesn't contain the polyfill, the library should still work as expected. However, -if you are using a library which does not take advantage of this fact, you might face issues while using the library. Checkout -[this tweet thread](https://twitter.com/ChaitanyaPotti/status/1658103946274111488) where we have explained it further on how this works in detail. +if you are using a library which does not take advantage of this fact, you might face issues while using the library. Hence, you need to be mindful of the fact that you only require certain node polyfills to be added to your project, while testing each of it's functionalities. At the same time, you need to tell the bundler to ignore the missing modules, and not include them in the build. diff --git a/docs/troubleshooting/webpack-issues.mdx b/docs/troubleshooting/webpack-issues.mdx index d79df254a..037b41b5c 100644 --- a/docs/troubleshooting/webpack-issues.mdx +++ b/docs/troubleshooting/webpack-issues.mdx @@ -16,8 +16,7 @@ the package, and edit the bundler configuration to take advantage of that. Although this method works, it increases the bundle size significantly, causing slow loading speeds and a bad user experience. It is important to note that these modules, even while the build fails, are still present within the browser environment. Many libraries like Web3Auth are written in a way so as to take advantage of this fact. Hence, even if the build doesn't contain the polyfill, the library should still work as expected. However, if you -are using a library which does not take advantage of this fact, you might face issues while using the library. Check out -[this tweet thread](https://twitter.com/ChaitanyaPotti/status/1658103946274111488) where we have explained it further on how this works in detail. +are using a library which does not take advantage of this fact, you might face issues while using the library. Hence, you need to be mindful of the fact that you only require certain node polyfills to be added to your project, while testing each of it's functionalities. At the same time, you need to tell the bundler to ignore the missing modules, and not include them in the build. diff --git a/mlc_config.json b/mlc_config.json index e78ba6ace..8c93974ca 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -21,6 +21,21 @@ "ignorePatterns": [ { "pattern": "https://manage.auth0.com/" + }, + { + "pattern": "https://developer.android.com/studio/run" + }, + { + "pattern": "https://developer.android.com/studio/projects/create-project" + }, + { + "pattern": "https://github.com/Web3Auth/single-factor-auth-react-native" + }, + { + "pattern": "https://opensea.io" + }, + { + "pattern": "https://infura.io" } ] } diff --git a/src/common/quickstart/_tkey-react-native.mdx b/src/common/quickstart/_tkey-react-native.mdx index d092c7c15..def896ede 100644 --- a/src/common/quickstart/_tkey-react-native.mdx +++ b/src/common/quickstart/_tkey-react-native.mdx @@ -8,15 +8,6 @@ Install the Web3Auth's tKey JS & CustomAuth React Native packages in your React npm install --save @tkey/core @tkey/service-provider-base @tkey/storage-layer-torus @tkey/share-serialization @tkey/security-questions @tkey/share-transfer @torusresearch/customauth-react-native ``` -:::info - -#### Additionally in this step, you need to configure your project to use these libraries. - -- Checkout the [CustomAuth SDK Configuration for React Native](/sdk/core-kit/tkey-react-native/install#configuration-of-project-to-use-customauth-sdk) -- Learn about [polyfills for React Native](/sdk/core-kit/tkey-react-native/install#bundler-polyfilling) - -::: - ### 2. Get your Verifier details from the Web3Auth Dashboard Visit the [Web3Auth Dashboard](https://dashboard.web3auth.io) and create a new verifier. Use the verifier details in your project. @@ -156,10 +147,3 @@ const initializeNewKey = async () => { } }; ``` - -:::warning - -This is set up the tKey in 2/2 flow, which means that the private will be lost once you log out of the app. To add more shares, make sure to use the -added modules and configure them as written in the [SDK Reference](/sdk/core-kit/tkey-react-native/modules/) - -::: diff --git a/src/common/sdk/pnp/web/_openlogin-adapter-intro.mdx b/src/common/sdk/pnp/web/_openlogin-adapter-intro.mdx index 1924b7bc9..68db49175 100644 --- a/src/common/sdk/pnp/web/_openlogin-adapter-intro.mdx +++ b/src/common/sdk/pnp/web/_openlogin-adapter-intro.mdx @@ -2,7 +2,8 @@ import OpenloginWhiteLabelExample from "./_openlogin-whitelabel-example.mdx"; The default adapter of Web3Auth is the [`openlogin-adapter`](/sdk/pnp/web/adapters/openlogin). This adapter is a wrapper around the [`openlogin`](/sdk/pnp/web/adapters/openlogin) library from Web3Auth and enables the social login features. For customising features of the main -Web3Auth flow, like [Whitelabel](./whitelabel), [Custom Authentication](./custom-authentication), etc. you need to customise the Openlogin Adapter. +Web3Auth flow, like [Whitelabel](/pnp/features/whitelabel), [Custom Authentication](/pnp/features/custom-authentication), etc. you need to customise +the Openlogin Adapter. :::tip @@ -21,7 +22,7 @@ For customising the redirect screens while logging in and constructing the key, :::tip This is just one of the aspects of whitelabeling you can achieve with Web3Auth. To know more in depth about how you can Whitelabel your application -with Web3Auth, have a look at our [Whitelabeling SDK Reference](./whitelabel). +with Web3Auth, have a look at our [Whitelabeling SDK Reference](/pnp/features/whitelabel). ::: @@ -42,6 +43,6 @@ configure the `loginConfig` parameter in the `adapterSettings` of the `openlogin :::tip -Refer to the [Custom Authentication Documentation](./custom-authentication) for more information. +Refer to the [Custom Authentication Documentation](/pnp/features/custom-authentication) for more information. ::: diff --git a/src/pages/content-hub/guides/cognito.mdx b/src/pages/content-hub/guides/cognito.mdx index cc630405c..8566a480d 100644 --- a/src/pages/content-hub/guides/cognito.mdx +++ b/src/pages/content-hub/guides/cognito.mdx @@ -335,7 +335,8 @@ await web3auth.connectTo(WALLET_ADAPTERS.OPENLOGIN, { ## Example code Try our [Demo Application](https://demo-cognito.web3auth.io/) with Web3Auth & Cognito integration. It works for either Ethereum, Solana or Polygon. -The source code for the demo application is available [here](https://github.com/Web3Auth/Web3Auth/tree/master/demo/cognito-react-app). +The source code for the demo application is available +[here](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/modular-examples/cognito-react-modular-no-modal-example). The code for the application we developed in this guide can be found in the [Web3Auth Cognito Example](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/custom-authentication/cognito-react-no-modal-example). diff --git a/src/pages/content-hub/guides/discord.mdx b/src/pages/content-hub/guides/discord.mdx index c396d0633..e8d999826 100644 --- a/src/pages/content-hub/guides/discord.mdx +++ b/src/pages/content-hub/guides/discord.mdx @@ -57,7 +57,7 @@ When integrating Web3Auth with Discord Login the flow looks something like this: -- A [Discord Developer](https://dev.discord.tv/console/apps/create) account to be used as Login provider for Web3Auth Custom Authentication. +- A [Discord Developer](https://discord.com/developers/applications) account to be used as Login provider for Web3Auth Custom Authentication. ## Setup diff --git a/src/pages/content-hub/guides/firebase.mdx b/src/pages/content-hub/guides/firebase.mdx index 22e033f1c..1b72b2f05 100644 --- a/src/pages/content-hub/guides/firebase.mdx +++ b/src/pages/content-hub/guides/firebase.mdx @@ -260,7 +260,8 @@ await web3auth.logout(); ## Example code Try our [Demo Application](https://demo-firebase.web3auth.io/) with Web3Auth & Firebase integration. It works for either Ethereum, Solana or Polygon. -The source code for the demo application is available [here](https://github.com/Web3Auth/Web3Auth/tree/master/demo/firebase-react-app). +The source code for the demo application is available +[here](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/modular-examples/firebase-react-modular-no-modal-example). The code for the application we developed in this guide can be found in the [Web3Auth Firebase Example](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/custom-authentication/firebase-react-no-modal-example). diff --git a/src/pages/content-hub/guides/mpc-core-kit.mdx b/src/pages/content-hub/guides/mpc-core-kit.mdx index e225f51fb..995414fbe 100644 --- a/src/pages/content-hub/guides/mpc-core-kit.mdx +++ b/src/pages/content-hub/guides/mpc-core-kit.mdx @@ -60,9 +60,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/src/pages/content-hub/guides/react-native-expo-auth0.mdx b/src/pages/content-hub/guides/react-native-expo-auth0.mdx index acd039e55..f6d01bc67 100644 --- a/src/pages/content-hub/guides/react-native-expo-auth0.mdx +++ b/src/pages/content-hub/guides/react-native-expo-auth0.mdx @@ -31,7 +31,7 @@ This guide will cover the basics of how to use the Web3Auth React Native SDK in **Live Demo:** [Android](https://w3a.link/react-native-auth0-example) [iOS](https://w3a.link/react-native-auth0-ios-example) -Repository: https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/react-native/rn-expo-auth0-example +Repository: https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/react-native/rn-expo-example ## Quick Start @@ -284,7 +284,7 @@ blockchain you have selected here. ## Example code The code for the application we developed in this guide can be found in the -[Web3Auth React Native Example](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/react-native/rn-expo-auth0-example). Check it out and try +[Web3Auth React Native Example](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/react-native/rn-expo-example). Check it out and try running it locally yourself! ## Questions? diff --git a/src/pages/content-hub/guides/single-factor-auth.mdx b/src/pages/content-hub/guides/single-factor-auth.mdx index 4fc05c473..0ce089065 100644 --- a/src/pages/content-hub/guides/single-factor-auth.mdx +++ b/src/pages/content-hub/guides/single-factor-auth.mdx @@ -329,8 +329,8 @@ creating a verifier in web3auth's dashboard. Once the `connectTo` function resolves, it will return a blockchain provider the same as the one we got in login without MFA. We will use this blockchain provider to fetch the user's balance from the blockchain. -Refer to [this file](https://github.com/Web3Auth/web3auth-core-kit-examples//blob/main/web-no-modal-sdk/one-key-flow/src/loginWithMfa.ts) for login -without MFA flow. +Refer to [this file](https://github.com/Web3Auth/web3auth-core-kit-examples/blob/main/single-factor-auth-web/sfa-one-key-flow-example/src/App.tsx) for +login without MFA flow. :::info NOTE diff --git a/src/pages/content-hub/guides/tkey-js-mpc.mdx b/src/pages/content-hub/guides/tkey-js-mpc.mdx index d72e33ff1..44ea2ec12 100644 --- a/src/pages/content-hub/guides/tkey-js-mpc.mdx +++ b/src/pages/content-hub/guides/tkey-js-mpc.mdx @@ -18,7 +18,7 @@ import Image1 from "@site/static/images/tkey-mpc-flow.png"; title="Using Web3Auth tKey MPC SDK" description="Learn how to use Web3Auth tKey MPC SDK in your React Application." image="https://web3auth.io/docs/content-hub/guides/banners/tkey-mpc.png" - slug="/content-hub/guides/tkey-mpc" + slug="/content-hub/guides/tkey-js-mpc" /> This guide will help you make a react application using Web3Auth tKey MPC SDK, covering the basic functionality on how to use it. @@ -30,7 +30,7 @@ This guide will help you make a react application using Web3Auth tKey MPC SDK, c This is an advanced guide, meant for enterprise developers and contains multiple moving parts that might be difficult to understand. Please contact our team if you're looking to integrate this SDK, and we'll be happy to help you out. -For general integrations, [MPC Core Kit](./mpc-core-kit) is the best alternative to be used. +For general integrations, [MPC Core Kit](/sdk/core-kit/mpc-core-kit) is the best alternative to be used. ::: diff --git a/src/pages/content-hub/guides/tkey-swift-mpc.mdx b/src/pages/content-hub/guides/tkey-swift-mpc.mdx index 3fb8609b2..fe1cf0bea 100644 --- a/src/pages/content-hub/guides/tkey-swift-mpc.mdx +++ b/src/pages/content-hub/guides/tkey-swift-mpc.mdx @@ -64,7 +64,7 @@ cd mpc-ios-example 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/src/pages/integration-builder/builder/ios/stepContent/whitelabeling.mdx b/src/pages/integration-builder/builder/ios/stepContent/whitelabeling.mdx index 0c1aab897..1f281ffce 100644 --- a/src/pages/integration-builder/builder/ios/stepContent/whitelabeling.mdx +++ b/src/pages/integration-builder/builder/ios/stepContent/whitelabeling.mdx @@ -7,4 +7,4 @@ constructor as well as while configuring `Openlogin` adapter. Also you can change the visibility and order of methods appearing in Web3Auth modal by passing config in initParams. -For more info on whiteLabeling refer to this [section](/developing-with-web3auth/whitelabeling). +For more info on whiteLabeling refer to this [section](/pnp/features/whitelabel). diff --git a/src/pages/integration-builder/commonSteps/instantiateSDKWhitelabeled.mdx b/src/pages/integration-builder/commonSteps/instantiateSDKWhitelabeled.mdx index 53b26b135..51ca37eb3 100644 --- a/src/pages/integration-builder/commonSteps/instantiateSDKWhitelabeled.mdx +++ b/src/pages/integration-builder/commonSteps/instantiateSDKWhitelabeled.mdx @@ -27,7 +27,7 @@ helps you get ready for production deployment. ::: - For customising the UI for your modal, you can pass on the `uiConfig` parameter to the `Web3Auth` constructor. Know more about - [Whitelabeling Web3Auth](/pnp/features/whitelabeling) + [Whitelabeling Web3Auth](/pnp/features/whitelabel) :::tip SDK Reference diff --git a/src/pages/ios-mpc.mdx b/src/pages/ios-mpc.mdx index 7f36ba211..25973cd04 100644 --- a/src/pages/ios-mpc.mdx +++ b/src/pages/ios-mpc.mdx @@ -57,7 +57,7 @@ cd mpc-ios-example 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**. From 67ec6e14a21d8b2a32670075ba4380ba00852754 Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Mon, 18 Sep 2023 18:35:28 +0800 Subject: [PATCH 5/8] Fix more broken links --- docs/legal/cookie-policy.mdx | 7 +++---- mlc_config.json | 3 +++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/legal/cookie-policy.mdx b/docs/legal/cookie-policy.mdx index ce17cb847..832bcb48a 100644 --- a/docs/legal/cookie-policy.mdx +++ b/docs/legal/cookie-policy.mdx @@ -108,10 +108,9 @@ link \(if provided\), by using the means provided in the third party's privacy p 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://thenai.org/) \(US\) and the -[Digital Advertising Alliance](https://youradchoices.com/control) \(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. +[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/mlc_config.json b/mlc_config.json index 8c93974ca..0929ab7d3 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -36,6 +36,9 @@ }, { "pattern": "https://infura.io" + }, + { + "pattern": "https://app.infura.io/login" } ] } From 3d791c3aefaf347c70ee53c7dedfdfc338654f55 Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Tue, 19 Sep 2023 12:46:48 +0800 Subject: [PATCH 6/8] Update partners to customers --- src/theme/Footer/index.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/theme/Footer/index.tsx b/src/theme/Footer/index.tsx index abc27f6dc..53d563553 100644 --- a/src/theme/Footer/index.tsx +++ b/src/theme/Footer/index.tsx @@ -137,8 +137,8 @@ export default function FooterComponent(): JSX.Element {
From 8d7d1fb2071b8cfae8bb8390ee50d3f5c4a0185f Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Tue, 19 Sep 2023 12:58:38 +0800 Subject: [PATCH 7/8] Update mlc_config.json --- mlc_config.json | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/mlc_config.json b/mlc_config.json index 0929ab7d3..2db2c6af9 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -39,6 +39,15 @@ }, { "pattern": "https://app.infura.io/login" + }, + { + "pattern": "https://etherscan.io" + }, + { + "pattern": "https://goerli.etherscan.io" + }, + { + "pattern": "https://optimistic.etherscan.io" } ] } From 3193269e35cda626d0390da09cc90a6e2b10bedc Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Tue, 19 Sep 2023 14:36:42 +0800 Subject: [PATCH 8/8] Fix SEO related links --- docs/sdk/core-kit/sfa-flutter/authentication.mdx | 10 ++++++++-- .../core-kit/tkey-android/modules/share-transfer.mdx | 2 +- docs/sdk/core-kit/tkey/install.mdx | 2 +- docs/sdk/core-kit/tkey/intrinsic-flow.mdx | 2 +- src/pages/content-hub/guides/mpc-core-kit.mdx | 2 +- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/sdk/core-kit/sfa-flutter/authentication.mdx b/docs/sdk/core-kit/sfa-flutter/authentication.mdx index ac6d1ae89..b035a1c77 100644 --- 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"; + +:::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/tkey-android/modules/share-transfer.mdx b/docs/sdk/core-kit/tkey-android/modules/share-transfer.mdx index e245f12f0..9d521411e 100644 --- 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 index b53947b83..6f3844e56 100644 --- 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 index 6b13c2163..91e47b3a9 100644 --- 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/src/pages/content-hub/guides/mpc-core-kit.mdx b/src/pages/content-hub/guides/mpc-core-kit.mdx index 995414fbe..6492bf20f 100644 --- a/src/pages/content-hub/guides/mpc-core-kit.mdx +++ b/src/pages/content-hub/guides/mpc-core-kit.mdx @@ -16,7 +16,7 @@ import SEO from "@site/src/components/SEO"; title="Using Web3Auth MPC Core Kit SDK" description="Learn how to use the Web3Auth MPC Core Kit SDK in your React Application." image="https://web3auth.io/docs/content-hub/guides/banners/mpc.png" - slug="/content-hub/guides/mpc" + slug="/content-hub/guides/mpc-core-kit" /> This guide will help you make a react application using Web3Auth tKey MPC SDK, covering the basic functionality on how to use it.