Skip to content

Commit 180bdb3

Browse files
style alignment pass, proofs & edits (#2686)
* style alignment pass, proofs & edits * indentation fix * standardization round * sentence casing for navs * qa over prev * qa over prev * qa over prev * qa over prev * restore config to retrigger bot moaning * Update embedded-wallets/features/wallet-pregeneration.mdx Co-authored-by: Yashovardhan Agrawal <yashovardhan.agrawal@gmail.com> --------- Co-authored-by: Yashovardhan Agrawal <yashovardhan.agrawal@gmail.com>
1 parent b19c719 commit 180bdb3

168 files changed

Lines changed: 494 additions & 406 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

embedded-wallets/authentication/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The SDKs are now branded as MetaMask Embedded Wallet SDKs (formerly Web3Auth Plu
2121

2222
Embedded Wallets supports a wide range of authentication options, enabling developers to meet the needs of diverse user bases and platform requirements.
2323

24-
### Native email & SMS login
24+
### Native email and SMS login
2525

2626
Provides passwordless log in via one-time passcodes (OTP)/ magic links sent to the user's [email address](/embedded-wallets/authentication/basic-logins/email-passwordless) or [phone number](/embedded-wallets/authentication/basic-logins/sms-otp). This method is widely accessible and especially useful for onboarding users unfamiliar with Web3 or crypto wallets.
2727

embedded-wallets/authentication/basic-logins/email-passwordless.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Email Passwordless Login with Embedded Wallets
3-
sidebar_label: Email Passwordless
2+
title: Email passwordless Login with Embedded Wallets
3+
sidebar_label: Email passwordless
44
description: 'Email Passwordless Login with Embedded Wallets | Embedded Wallets'
55
---
66

@@ -29,7 +29,7 @@ Embedded Wallets provides built-in support for email and SMS-based authenticatio
2929

3030
To use this feature, developers must first enable **Email Passwordless** from the Social Connections section in the [dashboard](https://dashboard.web3auth.io).
3131

32-
> By default, Web3Auth uses its own pre-configured credentials for email login.
32+
By default, Web3Auth uses its own pre-configured credentials for email login.
3333

3434
:::
3535

@@ -96,4 +96,6 @@ const web3AuthContextConfig: Web3AuthContextConfig = {
9696
export default web3AuthContextConfig
9797
```
9898

99+
## Next steps
100+
99101
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.

embedded-wallets/authentication/basic-logins/external-wallets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: External Wallets Login with Embedded Wallets
3-
sidebar_label: External Wallets
2+
title: External wallets login with Embedded Wallets
3+
sidebar_label: External wallets
44
description: 'External Wallets Login with Embedded Wallets | Embedded Wallets'
55
---
66

embedded-wallets/authentication/basic-logins/sms-otp.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: SMS OTP Login with Embedded Wallets
2+
title: SMS OTP login with Embedded Wallets
33
sidebar_label: SMS OTP
44
description: 'SMS OTP Login with Embedded Wallets | Embedded Wallets'
55
---
@@ -28,7 +28,7 @@ Web3Auth provides built-in support for email and SMS-based authentication, allow
2828

2929
To use this feature, developers must first enable **SMS OTP** from the **Social Connections** section in the [dashboard](https://dashboard.web3auth.io).
3030

31-
> By default, Web3Auth uses its own pre-configured credentials for SMS OTP login.
31+
By default, Web3Auth uses its own pre-configured credentials for SMS OTP login.
3232

3333
:::
3434

@@ -95,5 +95,6 @@ const web3AuthContextConfig: Web3AuthContextConfig = {
9595

9696
export default web3AuthContextConfig
9797
```
98+
## Next steps
9899

99100
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.

embedded-wallets/authentication/custom-connections/auth0.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,13 @@ Follow these steps to create an Auth0 connection:
112112

113113
## Usage
114114

115-
Since, the `Auth0 Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
115+
Since the **Auth0 Connection** details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
116116

117-
> Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
117+
:::tip
118+
119+
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
120+
121+
:::
118122

119123
### Web
120124

embedded-wallets/authentication/custom-connections/aws-cognito.mdx

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Follow these steps to create a AWS Cognito connection:
4444

4545
1. Visit the [dashboard](https://dashboard.web3auth.io).
4646
1. Go to the **Custom Connections** section.
47-
1. Click on the **Settings** icon near the `AWS Cognito` connection.
48-
1. Enter the `Cognito Connection ID`.
49-
1. Paste `https://cognito-idp.{REGION}.amazonaws.com/{USER_POOL_ID}/.well-known/jwks.json` as `JWKS Endpoint`.
47+
1. Click on the **Settings** icon near the **AWS Cognito** connection.
48+
1. Enter the **Cognito Connection ID**.
49+
1. Paste `https://cognito-idp.{REGION}.amazonaws.com/{USER_POOL_ID}/.well-known/jwks.json` as **JWKS Endpoint**.
5050
1. Paste a sample JWT Token to auto populate the best **JWT validations** possible.
5151
1. Select the **JWT user identifier**: `email`, `sub` or `custom`.
5252
1. (Optional) Toggle the case sensitivity of **User Identifier**.
@@ -55,7 +55,11 @@ Follow these steps to create a AWS Cognito connection:
5555
1. Next, type aud as a field and `APP_CLIENT_ID` as a value.
5656
1. Click on the **Add Connection** button to save the settings.
5757

58-
> Note: Replace the `REGION`, `USER_POOL_ID` and `APP_CLIENT_ID` with your Cognito specific details.
58+
:::note
59+
60+
Replace the `REGION`, `USER_POOL_ID`, and `APP_CLIENT_ID` with your Cognito-specific details.
61+
62+
:::
5963

6064
<div style={{ display: 'flex', margin: '20px 0', justifyContent: 'center' }}>
6165
<img
@@ -71,9 +75,13 @@ Follow these steps to create a AWS Cognito connection:
7175

7276
## Usage
7377

74-
Since, the `AWS Cognito Connection` details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
78+
Since the **AWS Cognito Connection** details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
7579

76-
> Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
80+
:::tip
81+
82+
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
83+
84+
:::
7785

7886
### Log in with AWS Cognito
7987

embedded-wallets/authentication/custom-connections/custom-jwt.mdx

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ To use this feature, developers must go to the **Custom Connections** tab in the
4040

4141
Follow these steps to create a custom JWT connection:
4242

43-
1. Visit the [Embedded Wallets Dashboard](https://dashboard.web3auth.io).
43+
1. Visit the [Embedded Wallets dashboard](https://dashboard.web3auth.io).
4444
1. Go to the **Custom Connections** section.
4545
1. Click on the **Settings** icon near the **Custom Connection**.
46-
1. Enter the `Auth Connection ID`.
47-
1. Paste the `JWKS Endpoint`.
48-
1. Paste a sample `JWT Token` to auto populate the best **JWT validations** possible.
49-
1. Select the `JWT user identifier`: `email`, `sub` or `custom`.
46+
1. Enter the **Auth Connection ID**.
47+
1. Paste the **JWKS Endpoint**.
48+
1. Paste a sample **JWT Token** to auto populate the best **JWT validations** possible.
49+
1. Select the **JWT user identifier**: `email`, `sub` or `custom`.
5050
1. (Optional) Toggle the case sensitivity of `User Identifier`.
5151
1. Click on **Add Custom Validations** to add validations manually.
5252
1. Type iss as a field and `your-issuer` as a value.
@@ -223,7 +223,7 @@ const jwt = await new jose.SignJWT({ 'urn:example:claim': true })
223223
console.log(jwt)
224224

225225
// Verifying the JWT using Remote JWK Set.
226-
// This is just to show how the Verify works, look above to set-up custom jwt verifier on the Embedded Wallets Dashboard.
226+
// This is just to show how the Verify works, look above to set-up custom jwt verifier on the Embedded Wallets dashboard.
227227
// Check the steps below to see how once can generate the JWKS
228228
const JWKS = jose.createRemoteJWKSet(new URL('https://my-authz-server/.well-known/jwks.json'))
229229

@@ -247,17 +247,21 @@ Check out the [troubleshooting page](/embedded-wallets/troubleshooting/jwt-error
247247

248248
## Usage
249249

250-
Since, the **Custom Connection** details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
250+
Since the **Custom Connection** details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
251251

252-
> Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
252+
:::tip
253+
254+
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
255+
256+
:::
253257

254258
### Log in with JWT
255259

256260
<JwtLoginCustom />
257261

258262
## What are JWKS?
259263

260-
JWKS stands for JSON Web Key Set. It is a set of keys containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server and signed using the RS256 signing algorithm.
264+
JWKS stands for JSON Web Key Set. It's a set of keys containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server and signed using the RS256 signing algorithm.
261265

262266
### How to create JWKS?
263267

@@ -269,7 +273,7 @@ JWKS stands for JSON Web Key Set. It is a set of keys containing the public keys
269273

270274
- If you are using your own custom JWT, you will need to convert your PEM file to JWKS.
271275

272-
### How to convert PEM to JWKS?
276+
### How to convert PEM to JWKS
273277

274278
If you're using `jose` or `jsonwebtoken` library, you can use the following steps to convert your PEM file to JWKS.
275279

@@ -303,4 +307,4 @@ If you're using `jose` or `jsonwebtoken` library, you can use the following step
303307

304308
4. To complete the process, you need to save the output as a `.json` file, host it on your server, and make sure it's publicly accessible.
305309

306-
This will give you the `JWKS Endpoint`, which is required when setting up a **Custom JWT Verifier** on the Embedded Wallets Dashboard.
310+
This will give you the `JWKS Endpoint`, which is required when setting up a **Custom JWT Verifier** on the Embedded Wallets dashboard.

embedded-wallets/authentication/custom-connections/firebase.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,13 @@ Follow these steps to create a Firebase connection:
115115

116116
## Usage
117117

118-
Since, the **Firebase Connection** details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
118+
Since the **Firebase Connection** details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
119119

120-
> Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
120+
:::tip
121+
122+
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
123+
124+
:::
121125

122126
### Web
123127

embedded-wallets/authentication/group-connections.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Group Connections
3-
sidebar_label: Group Connections
2+
title: Group connections
3+
sidebar_label: Group connections
44
description: 'Group Connections | Embedded Wallets'
55
image: 'img/metamaskog.jpg'
66
---
@@ -17,7 +17,7 @@ import GroupConnectionAuth0Implicit from '../sdk/react/advanced/_custom-authenti
1717
import GroupConnectionAuth0JWT from '../sdk/react/advanced/_custom-authentication-snippets/_grouped_auth_jwt_auth0.mdx'
1818
import GroupModal from '../sdk/react/advanced/_custom-authentication-snippets/_grouped_modal_connections.mdx'
1919

20-
Group connections enable multiple login methods to be linked to the same on-chain user identity. This means that users logging in with different authentication providers (for example, **_Google and Email Passwordless_**) can still access the **same wallet address**—ensuring a unified user experience.
20+
Group connections enable multiple login methods to be linked to the same onchain user identity. This means that users logging in with different authentication providers (for example, **_Google and email passwordless_**) can still access the **same wallet address**—ensuring a unified user experience.
2121

2222
:::note
2323

@@ -80,9 +80,13 @@ Follow these steps:
8080

8181
## Usage
8282

83-
Since, the group connections details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
83+
Since the group connections details are available from the dashboard, developers don't need to pass any additional parameters to the `Web3AuthProvider`.
8484

85-
> Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
85+
:::tip
86+
87+
Follow our [quickstart](/quickstart/?product=EMBEDDED_WALLETS&walletAggregatorOnly=NO&framework=REACT&stepIndex=0) to set up the basic flow.
88+
89+
:::
8690

8791
<Tabs>
8892
<TabItem value="modal" label="Modal Connection">

embedded-wallets/authentication/id-token.mdx

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Web3Auth Identity Token
3-
sidebar_label: Web3Auth Identity Token
2+
title: Embedded Wallets identity token
3+
sidebar_label: Web3Auth identity token
44
image: 'img/metamaskog.jpg'
55
description: 'Identity Token | Embedded Wallets'
66
---
77

88
import TabItem from '@theme/TabItem'
99
import Tabs from '@theme/Tabs'
1010

11-
The **Identity Token** (ID Token) issued by Web3Auth is a JSON Web Token (JWT) that contains verified identity claims about the authenticated user. This token is signed using Web3Auth's private key and cannot be spoofed, allowing developers to trust the identity information presented by the client.
11+
The **Identity Token** (ID Token) issued by Embedded Wallets is a JSON Web Token (JWT) that contains verified identity claims about the authenticated user. This token is signed using Embedded Wallets' private key and cannot be spoofed, allowing developers to trust the identity information presented by the client.
1212

13-
Once a user successfully authenticates via Web3Auth, the platform issues an ID token which can then be used to authorize client-to-server requests or verify ownership of associated wallet addresses.
13+
Once a user successfully authenticates via Embedded Wallets, the platform issues an ID token which can then be used to authorize client-to-server requests or verify ownership of associated wallet addresses.
1414

1515
#### Purpose of the ID token
1616

@@ -22,7 +22,7 @@ When making a backend request from the frontend, the client must include this ID
2222

2323
## ID token format
2424

25-
Web3Auth tokens are ES256-signed JWTs containing various identity claims about the user.
25+
Embedded Wallets (previously Web3Auth) issues tokens as ES256-signed JWTs containing various identity claims about the user.
2626

2727
A sample decoded token is shown below:
2828

@@ -59,7 +59,7 @@ A sample decoded token is shown below:
5959

6060
:::warning NOTE
6161

62-
If the `Return user data in identity token` setting is disabled on the dashboard, personally identifiable information (PII) such as **email**, **name**, and **profileImage** will be omitted from the token.
62+
If the **Return user data in identity token** setting is disabled on the dashboard, personally identifiable information (PII) such as **email**, **name**, and **profileImage** will be omitted from the token.
6363

6464
:::
6565

@@ -373,7 +373,11 @@ try {
373373
}
374374
```
375375

376-
> The replace operation above ensures that any instances of '\n' in the stringified public key are replaced with actual newlines, per the PEM-encoded format.
376+
:::note
377+
378+
The replace operation above ensures that any instances of '\n' in the stringified public key are replaced with actual newlines, per the PEM-encoded format.
379+
380+
:::
377381

378382
</TabItem>
379383
</Tabs>
@@ -384,7 +388,7 @@ If the token is valid, the payload will contain identity claims (such as, userId
384388

385389
:::
386390

387-
## Things to remember
391+
## Troubleshooting
388392

389393
- The `iss` field in the token must be `https://api-auth.web3auth.io`.
390394
- The `aud` field must match your **Project Client ID**.

0 commit comments

Comments
 (0)