WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 799d40a

Browse files
shahbaz17shahbaz17
authored
Merge pull request #664 from Web3Auth/docs-restructure-unity
Unity improve docs
2 parents 6d7384d + 758b3f1 commit 799d40a

File tree

9 files changed

+115
-87
lines changed

9 files changed

+115
-87
lines changed

‎docs/sdk/pnp/unity/custom-authentication.mdx‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ description: "Web3Auth PnP Unity SDK - Using Custom Authentication | Documentati
88
import TabItem from "@theme/TabItem";
99
import Tabs from "@theme/Tabs";
1010

11-
Custom Authentication is a way to authenticate users with your own custom authentication service. For example, while authenticating with Google, you
12-
have the ability to use your own Google Client ID and Dashboard to authenticate users directly. To login using your own custom JWT issuers like Auth0,
13-
AWS Cognito, or Firebase, you can add the your configuration to the `loginConfig` field of the `Web3AuthOptions` class.
11+
Custom Authentication is a way to authenticate users usign your own custom authentication service. For example, while authenticating with Google, you
12+
can use your own Google Client ID and Dashboard to authenticate users directly. To login with your own custom JWT issuers like Auth0, AWS Cognito, or
13+
Firebase, you can add the your configuration to the `loginConfig` field of the `Web3AuthOptions` class.
1414

15-
The `loginConfig` field is a key value map. The key should be one of the `Web3AuthProvider` in its string form, and the value should be a
15+
The `loginConfig` field is a key-value map. The key should be one of the `Web3AuthProvider` in its string form, and the value should be a
1616
`LoginConfigItem` struct instance.
1717

1818
First, configure your own verifier in the Web3Auth Dashboard to use custom authentication.
1919

2020
:::tip
2121

22-
Check out how to create [Custom Verifier](/auth-provider-setup/verifiers) on Web3Auth Dashboard.
22+
Check out how to create a [Custom Verifier](/auth-provider-setup/verifiers) on Web3Auth Dashboard.
2323

2424
:::
2525

@@ -28,7 +28,7 @@ Then, you should specify the details of your verifier in the `LoginConfigItem` s
2828
:::note
2929

3030
This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this SDK in a production environment is the **Growth
31-
Plan**. You can use this feature in the development environment for free.
31+
Plan**. You can use this feature for free in the development environment.
3232

3333
:::
3434

@@ -46,21 +46,21 @@ Plan**. You can use this feature in the development environment for free.
4646

4747
<TabItem value="table">
4848

49-
| Parameter | Description |
50-
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51-
| `verifier` | The name of the verifier that you have registered on the Web3Auth Dashboard. It's a mandatory field, and accepts `string` as a value. |
52-
| `typeOfLogin` | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose `google`, a Google sign-in flow will be used. If you choose `jwt`, you should be providing your own JWT token, no sign-in flow will be presented. It's a mandatory field, and accepts `TypeOfLogin` as a value. |
53-
| `clientId` | Client id provided by your login provider used for custom verifier. e.g. Google's Client ID or Web3Auth's client Id if using 'jwt' as TypeOfLogin. It's a mandatory field, and accepts `string` as a value. |
54-
| `name?` | Display name for the verifier. If null, the default name is used. It accepts `string` as a value. |
55-
| `description?` | Description for the button. If provided, it renders as a full length button. else, icon button. It accepts `string` as a value. |
56-
| `verifierSubIdentifier?` | The field in JWT token which maps to verifier id. Please make sure you selected correct JWT verifier id in the developer dashboard. It accepts `string` as a value. |
57-
| `logoHover?` | Logo to be shown on mouse hover. It accepts `string` as a value. |
58-
| `logoLight?` | Light logo for dark background. It accepts `string` as a value. |
59-
| `logoDark?` | Dark logo for light background. It accepts `string` as a value. |
60-
| `mainOption?` | Show login button on the main list. It accepts `bool` as a value. Default value is false. |
61-
| `showOnModal?` | Whether to show the login button on modal or not. Default value is true. |
62-
| `showOnDesktop?` | Whether to show the login button on desktop. Default value is true. |
63-
| `showOnMobile?` | Whether to show the login button on mobile. Default value is true. |
49+
| Parameter | Description |
50+
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51+
| `verifier` | The name of the verifier that you have registered on the Web3Auth Dashboard. It's a mandatory field, and accepts `string` as a value. |
52+
| `typeOfLogin` | Type of login for this verifier, this value will affect the login flow that is adapted. For example, if you choose `google`, a Google sign-in flow will be used. If you choose `jwt`, you should provide your own JWT token, no sign-in flow will be presented. It's a mandatory field, and accepts `TypeOfLogin` as a value. |
53+
| `clientId` | Client id provided by your login provider used for custom verifier. e.g. Google's Client ID or Web3Auth's client Id if using 'jwt' as TypeOfLogin. It's a mandatory field, and accepts `string` as a value. |
54+
| `name?` | Display name for the verifier. If null, the default name is used. It accepts `string` as a value. |
55+
| `description?` | Description for the button. If provided, it renders as a full length button. else, icon button. It accepts `string` as a value. |
56+
| `verifierSubIdentifier?` | The field in JWT token which maps to verifier id. Please make sure you selected correct JWT verifier id in the developer dashboard. It accepts `string` as a value. |
57+
| `logoHover?` | Logo to be shown on mouse hover. It accepts `string` as a value. |
58+
| `logoLight?` | Light logo for dark background. It accepts `string` as a value. |
59+
| `logoDark?` | Dark logo for light background. It accepts `string` as a value. |
60+
| `mainOption?` | Show login button on the main list. It accepts `bool` as a value. Default value is false. |
61+
| `showOnModal?` | Whether to show the login button on modal or not. Default value is true. |
62+
| `showOnDesktop?` | Whether to show the login button on desktop. Default value is true. |
63+
| `showOnMobile?` | Whether to show the login button on mobile. Default value is true. |
6464

6565
</TabItem>
6666

‎docs/sdk/pnp/unity/dapp-share.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ import UnityResponse from "@site/src/common/sdk/pnp/unity/_response.mdx";
99

1010
## Web3Auth Infrastructure at a glance
1111

12-
If you go through the [Web3Auth infrastructure](/infrastructure/) you'll notice that to enable the non custodiality of Web3Auth, we split the private
13-
key into multiple parts, ie. `shares`. These shares are a part of the off chain multisig, where multiple shares are stored in different places and can
14-
be used to reconstruct the private key dynamically in the user's frontend application. For a glance at the structure of the shares, these are the
12+
If you go through the [Web3Auth infrastructure](/infrastructure/), you'll notice that to enable the non custodiality of Web3Auth, we split the private
13+
key into multiple parts, called `shares`. These shares are a part of the off-chain multisig, where multiple shares are stored in different places and
14+
can be used to reconstruct the private key dynamically in the user's frontend application. For a glance at the structure of the shares, these are the
1515
following:
1616

17-
1. **`ShareA` is stored on the user's device**: Implementation is device and system specific. For example, on mobile devices, the share could be
17+
1. **`ShareA` is stored on the user's device**: The Implementation is device and system specific. For example, on mobile devices, the share could be
1818
stored in device storage secured via biometrics.
1919
2. **`ShareB` is managed by a login service via node operators**: This share is further split amongst a network of nodes and retrieved via
2020
conventional authentication flows.
21-
3. **`ShareC` is a recovery share**: An extra share to be kept by the user, possibly kept on a separate device, downloaded or based on user input with
22-
enough entropy (eg. password, security questions, hardware device etc.).
21+
3. **`ShareC` is a recovery share**: An extra share to be kept by the user, possibly stored on a separate device, downloaded or based on user input
22+
with enough entropy (eg. password, security questions, hardware device etc.).
2323

2424
Similar to existing 2FA systems, a user needs to prove ownership of at least 2 out of 3 (2/3) shares, in order to retrieve their private key. This
2525
initial setup provides several benefits.
@@ -42,13 +42,13 @@ reconstruct the private key after successful login by the user.
4242
Web3Auth issues a dApp Share, ie. a backup share that can be stored by the app developer directly within their application and used to reconstruct the
4343
private key after successful login by the user.
4444

45-
After a successful login from a user, the user details are returned as a response to the application in mobile devices.
45+
After a successful login from a user, the user details are returned as a response to the application on mobile devices.
4646

4747
### Sample Response in Unity
4848

4949
<UnityResponse />
5050

51-
If you notice, the reponses has a field called `dappShare` which is a 24 words seed phrase that can be used to reconstruct the private key. This
51+
If you notice, the response has a field called `dappShare` which is a 24 words seed phrase that can be used to reconstruct the private key. This
5252
`dappShare` is a suplement to the `Share A` and represents half of the private key. The application can store the dApp share in their own application
5353
local storage safely.
5454

@@ -58,9 +58,9 @@ login function.
5858

5959
:::note
6060

61-
One major thing to note here is that the `dappShare` is only available for custom verifiers and not the standard web3auth verifiers. This is done to
62-
make sure that an application only has access to the corresponding share to the private key of their application's user. Hence, to use dApp Share, one
63-
has to use the custom authentication feature of Web3Auth. Also, the dApp Share is only returned to users who have enabled 2FA to their account.
61+
One major thing to note here is that the `dappShare` is only available for custom verifiers and not in the standard Web3auth verifiers. This is done
62+
to make sure that an application only has access to the corresponding share to the private key of their application's user. Hence, to use dApp Share,
63+
one has to use the custom authentication feature of Web3Auth. Also, the dApp Share is only returned to users who have enabled 2FA to their account.
6464

6565
:::
6666

0 commit comments

Comments
 (0)