Skip to content

Commit

Permalink
fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
shahbaz17 committed Sep 18, 2023
1 parent d985f5b commit ef20fe7
Show file tree
Hide file tree
Showing 37 changed files with 93 additions and 97 deletions.
4 changes: 2 additions & 2 deletions docs/connect-blockchain/arbitrum.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).

:::

Expand Down Expand Up @@ -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).

:::

Expand Down
2 changes: 0 additions & 2 deletions docs/connect-blockchain/optimism.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/connect-blockchain/xrpl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion docs/how-web3auth-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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

Expand Down
12 changes: 5 additions & 7 deletions docs/legal/cookie-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/core-kit/mpc-core-kit/mpc-core-kit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-kit/mpc-tkey-ios/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/android/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/flutter/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/ios/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/react-native/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/unity/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/unreal/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
2 changes: 1 addition & 1 deletion docs/sdk/pnp/web/adapters/slope.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/web/adapters/solflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
20 changes: 10 additions & 10 deletions docs/sdk/pnp/web/adapters/torus-evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
20 changes: 10 additions & 10 deletions docs/sdk/pnp/web/adapters/torus-solana.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/web/modal/show-wallet-connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/web/no-modal/show-wallet-connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/error-429.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The error might look something like this:
<img style={{ display: "block", maxHeight: "400px", marginBottom: "20px" }} src={Error429} alt="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

Expand Down
19 changes: 9 additions & 10 deletions docs/troubleshooting/metro-issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
Loading

0 comments on commit ef20fe7

Please sign in to comment.