Skip to content

Commit

Permalink
Merge branch 'master' into docs-update-v7
Browse files Browse the repository at this point in the history
  • Loading branch information
shahbaz17 authored Sep 18, 2023
2 parents 5dcf089 + 39f9001 commit 1c5192e
Show file tree
Hide file tree
Showing 64 changed files with 171 additions and 177 deletions.
1 change: 0 additions & 1 deletion .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ jobs:
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
file-extension: .mdx
check-modified-files-only: "yes"
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
12 changes: 6 additions & 6 deletions docs/connect-blockchain/ethereum/ethereum.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,37 +19,37 @@ export const Ethereum = [
key: "web",
title: "Web",
icon: "logo-js.png",
path: "./web",
path: "/connect-blockchain/ethereum/web",
},
{
key: "android",
title: "Android (Kotlin)",
icon: "logo-android.png",
path: "./android",
path: "/connect-blockchain/ethereum/android",
},
{
key: "apple",
title: "iOS (Swift)",
icon: "logo-apple.png",
path: "./ios",
path: "/connect-blockchain/ethereum/ios",
},
{
key: "flutter",
title: "Flutter",
icon: "logo-flutter.png",
path: "./flutter",
path: "/connect-blockchain/ethereum/flutter",
},
{
key: "react-native",
title: "React Native",
icon: "logo-react.png",
path: "./react-native",
path: "/connect-blockchain/ethereum/react-native",
},
{
key: "unity",
title: "Unity",
icon: "logo-unity.png",
path: "./unity",
path: "/connect-blockchain/ethereum/unity",
},
],
},
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
17 changes: 7 additions & 10 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,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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import Tabs from "@theme/Tabs";

Currently Web3Auth supports two types of users :-

1. Users who login using [Social Logins or Email Passwordless](./social-login-users).
2. Users who login using [External Wallets](./external-wallets).
1. Users who login using [Social Logins or Email Passwordless](/pnp/features/server-side-verification/social-login-users).
2. Users who login using [External Wallets](/pnp/features/server-side-verification/external-wallets).

As a dApp you might want to authenticate a Web3Auth user in your backend. Generally the authentication happens in Frontend, but for the backend
authentication we will use a JWT Token(`idToken`).
Expand Down
6 changes: 3 additions & 3 deletions docs/pnp/features/whitelabel/whitelabel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ offerings.
You can do whitelabelling across `Web3Auth Plug and Play Modal`, `User Flow Screens` via `Openlogin Adapter` and `Mobile SDKs`, and
`Torus & Solana Wallet UI` instances.

- [Web3Auth Plug and Play Login Modal](./login-modal)
- [Web3Auth Plug and Play Login Modal](/pnp/features/whitelabel/login-modal)

![Web3Auth Plug and Play Login Modal](/images/whitelabel/modal/whitelable-login-modal.gif)

- [User Flow Screens](./user-flow-screens)
- [User Flow Screens](/pnp/features/whitelabel/user-flow-screens)

![Web3Auth - User Flow Screens](/images/whitelabel/user-flow-screens.gif)

- [Torus & Solana Wallet UI](./torus-wallet-plugin)
- [Torus & Solana Wallet UI](/pnp/features/whitelabel/torus-wallet-plugin)
4 changes: 2 additions & 2 deletions docs/product-fit/product-fit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We've divided the questions into the following categories:

:::tip

Read More about integrating [Web3Auth in Wallets](./web3auth-for-wallets/).
Read More about integrating [Web3Auth in Wallets](/product-fit/web3auth-for-wallets/).

:::

Expand All @@ -48,7 +48,7 @@ We've divided the questions into the following categories:

:::tip

Read More about integrating [Web3Auth in dApps](./web3auth-for-dapps/).
Read More about integrating [Web3Auth in dApps](/product-fit/web3auth-for-dapps/).

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/core-kit/mpc-core-kit/initialize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ useEffect(() => {
:::note
For the popup flow, the service worker is needed to handle it properly. Please have a look at the [installation page](./install) to know how to set up
the service worker for your application.
For the popup flow, the service worker is needed to handle it properly. Please have a look at the
[installation page](/sdk/core-kit/mpc-core-kit/install) to know how to set up the service worker for your application.
:::
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/core-kit/mpc-core-kit/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ where login was initiated.

- Using service worker is required only in the popup flow.

- Service worker is needed if you are using `popup` uxMode within your [Service Provider configuration](./initialize#configuring-service-provider).
- Service worker is needed if you are using `popup` uxMode within your
[Service Provider configuration](/sdk/core-kit/mpc-core-kit/initialize#configuring-service-provider).

- For browsers where service workers are not supported, or in the case you wish to not use service workers, create and serve redirect page (i.e
`redirect.html` file).
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
6 changes: 3 additions & 3 deletions docs/sdk/core-kit/mpc-core-kit/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To login a user in the Web3Auth MPC Core Kit SDK, you need to call `connect()` f

:::tip

Checkout the [Authentication Section](./authentication) to know more about the `loginParams` object.
Checkout the [Authentication Section](/sdk/core-kit/mpc-core-kit/authentication) to know more about the `loginParams` object.

:::

Expand Down Expand Up @@ -120,8 +120,8 @@ useEffect(() => {
:::note
For the popup flow, the service worker is needed to handle it properly. Please have a look at the [installation page](./install) to know how to set up
the service worker for your application.
For the popup flow, the service worker is needed to handle it properly. Please have a look at the
[installation page](/sdk/core-kit/mpc-core-kit/install) to know how to set up the service worker for your application.
:::
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
4 changes: 2 additions & 2 deletions docs/sdk/core-kit/sfa-react-native/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/core-kit/tkey-android/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,12 @@ activity.appKey.deleteShare(shareIndex, result -> {});
## Using Modules for Further Operations

To perform advanced operations and manipulate keys, tKey offers modules that can be utilized. As previously stated in the
[initialization](/docs/sdk/core-kit/tkey-android/initialize) section, modules need to be configured beforehand to function properly with tKey. After
[initialization](/sdk/core-kit/tkey-android/initialize) section, modules need to be configured beforehand to function properly with tKey. After
configuration, the respective module's instance is accessible within your tKey instance and can be utilized for additional operations.

:::info Modules

Please visit the [**Modules**](/docs/sdk/core-kit/tkey-android/modules) section to view a comprehensive list of available modules and their respective
Please visit the [**Modules**](/sdk/core-kit/tkey-android/modules) section to view a comprehensive list of available modules and their respective
functions.

:::
7 changes: 4 additions & 3 deletions docs/sdk/core-kit/tkey-ios/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -570,12 +570,13 @@ let shareStore = try! await threshold_key.delete_share(share_index: idx)
## Using Modules for Further Operations

To perform advanced operations and manipulate keys, tKey offers modules that can be utilized. As previously stated in the
[initialization](./initialize) section, modules need to be configured beforehand to function properly with tKey. After configuration, the respective
module's instance is accessible within your tKey instance and can be utilized for additional operations.
[initialization](/sdk/core-kit/tkey-ios/initialize) section, modules need to be configured beforehand to function properly with tKey. After
configuration, the respective module's instance is accessible within your tKey instance and can be utilized for additional operations.

:::info Modules

Please visit the [**Modules**](./modules) section to view a comprehensive list of available modules and their respective functions.
Please visit the [**Modules**](/sdk/core-kit/tkey-ios/modules) section to view a comprehensive list of available modules and their respective
functions.

:::

Expand Down
6 changes: 4 additions & 2 deletions docs/sdk/core-kit/tkey/intrinsic-flow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,11 @@ where login was initiated.

:::tip

- Using service worker is optional, but highly recommended. You can skip it by passing `skipSw` param while [initialising tKey](./initialize).
- Using service worker is optional, but highly recommended. You can skip it by passing `skipSw` param while
[initialising tKey](/sdk/core-kit/tkey/initialize).

- Service worker is needed if you are using `popup` uxMode within your [Service Provider configuration](./initialize#configuring-service-provider).
- Service worker is needed if you are using `popup` uxMode within your
[Service Provider configuration](/sdk/core-kit/tkey/initialize#configuring-service-provider).

- For browsers where service workers are not supported, or in the case you wish to not use service workers, create and serve redirect page (i.e
`redirect.html` file).
Expand Down
16 changes: 8 additions & 8 deletions docs/sdk/core-kit/tkey/tkey.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,17 @@ The **Storage Layer** refers to the Metadata Storage, which is used to store the

### Modules

[**Modules**](./modules) are the various functionalities that can be added to the tKey SDK, tkey enhance the storage and usage of different shares
generated in a way it is most suitable for your project.
[**Modules**](/sdk/core-kit/tkey/modules) are the various functionalities that can be added to the tKey SDK, tkey enhance the storage and usage of
different shares generated in a way it is most suitable for your project.

We have 3 types of modules available right now:

- [**Default Modules**](./modules/#default-modules): Modules needed for the basic operations of the tKey SDK.
- [**Storage Modules**](./modules/#storage-modules): Storage Modules are used to store the tKey shares in the user's device storage.
- [**Recovery Modules**](./modules/#recovery-modules): Recovery Modules are used to recover the tKey shares in the case user doesn't have access to
their device/storage or needs additional security.
- [**Additional Modules**](./modules/#additional-modules): These modules provide extra capability to the tKey SDK, like importing user's existing
private keys or seedphrases.
- [**Default Modules**](/sdk/core-kit/tkey/modules/#default-modules): Modules needed for the basic operations of the tKey SDK.
- [**Storage Modules**](/sdk/core-kit/tkey/modules/#storage-modules): Storage Modules are used to store the tKey shares in the user's device storage.
- [**Recovery Modules**](/sdk/core-kit/tkey/modules/#recovery-modules): Recovery Modules are used to recover the tKey shares in the case user doesn't
have access to their device/storage or needs additional security.
- [**Additional Modules**](/sdk/core-kit/tkey/modules/#additional-modules): These modules provide extra capability to the tKey SDK, like importing
user's existing private keys or seedphrases.

### Threshold

Expand Down
7 changes: 4 additions & 3 deletions docs/sdk/core-kit/tkey/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,13 @@ console.log("Share has been deleted", shareStore);
## Using Modules

For making advanced operations on tKey and to manipulate the keys, you can use the modules provided by tKey. As mentioned in the
[initialisation](./initialize) section, you need to configure the modules beforehand to make it work with tKey. Once that is done, the instance of the
respective module is available within your tKey instance and can be used for further operations.
[initialisation](/sdk/core-kit/tkey/initialize) section, you need to configure the modules beforehand to make it work with tKey. Once that is done,
the instance of the respective module is available within your tKey instance and can be used for further operations.

:::tip

Checkout the [Modules](./modules) section where we have listed all the available modules alongside the functions that can be used within them.
Checkout the [Modules](/sdk/core-kit/tkey/modules) section where we have listed all the available modules alongside the functions that can be used
within them.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/android/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)**
:::info using dapp share

- 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](./mfa)**
for more details.
- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See
**[MFA](/sdk/pnp/android/mfa)** for more details.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/flutter/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)**
:::info using dapp share

- 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](./mfa)**
for more details.
- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See
**[MFA](/sdk/pnp/flutter/mfa)** for more details.

:::

Expand Down
Loading

0 comments on commit 1c5192e

Please sign in to comment.