Skip to content

Commit 6a97319

Browse files
m4sterbunnyyashovardhan
m4sterbunny
and
yashovardhan
authored
2483 e embedded wallets pass (#2614)
* style updates * fixes for cursor touching data outside scope * fixes for cursor touching data outside scope * fixes for cursor touching data outside scope * rmvs more cursor false positives and aligns docs to mm style * rmvs more cursor false positives and aligns docs to mm style * rmvs more cursor false positives and aligns docs to mm style * rmvs more cursor false positives and aligns docs to mm style * adds links from overview to docs pages and puts unused snippet into play * links user from table to docs * rmvs more cursor false positives and aligns docs to mm style * rmvs more cursor false positives and aligns docs to mm style * further alignment with mm style * further alignment with mm style * further alignment with mm style & fix for build * further alignment with mm style * Update embedded-wallets/sdk/_common/_configure-paymaster-context.mdx * Update embedded-wallets/sdk/_common/_configure-paymaster-context.mdx * reverts updates to comment txt and fixes ,, instances * Reverted edits to comments and qa over prev * Update formatting * Apply suggestion from @m4sterbunny * fixes following review * tag along from other review --------- Co-authored-by: Yashovardhan Agrawal <21066442+yashovardhan@users.noreply.github.com>
1 parent 030b812 commit 6a97319

208 files changed

Lines changed: 2599 additions & 2551 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/sdk/_common/_auth-adapter-settings.mdx‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ import Tabs from "@theme/Tabs";
1212

1313
| Variable | Description |
1414
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15-
| `clientId` | The unique identifier for your application. Obtain this by registering your dapp in the [Web3Auth Dashboard](https://dashboard.web3auth.io) |
15+
| `clientId` | The unique identifier for your application. Obtain this by registering your dapp in the [Embedded Wallets dashboard](https://dashboard.web3auth.io) |
1616
| `network` | The Web3Auth Network to be used. |
1717
| `buildEnv` | This parameter will be used to change the build environment of auth sdk, mainly for testing purposes. default is `production`. |
1818
| `redirectUrl` | The URL where users will be redirected after login. |
1919
| `uxMode` | Two uxModes supported are:- `'popup'`: In this uxMode, a popup will be shown to user for login. Use `'redirect'`: In this uxMode, user will be redirected to a new window tab for login. Use of `'redirect'` mode is recommended in browsers where popups might get blocked. |
20-
| `replaceUrlOnRedirect` | replaceUrlOnRedirect removes the params from the redirected url after login |
21-
| `originData` | originData is used to verify the origin of dapp by iframe. You don't have to pass originData explicitly if you have registered your dapp at [developer dashboard](https://dashboard.web3auth.io). originData contains a signature of dapp's origin url which is generated using project's secret. |
20+
| `replaceUrlOnRedirect` | replaceUrlOnRedirect removes the params from the redirected URL after login |
21+
| `originData` | originData is used to verify the origin of dapp by iframe. You don't have to pass originData explicitly if you have registered your dapp at [developer dashboard](https://dashboard.web3auth.io). originData contains a signature of dapp's origin URL which is generated using project's secret. |
2222
| `loginConfig` | loginConfig enables you to pass your own login verifiers configuration for various loginProviders. loginConfig is key value map where each key should be a valid loginProvider and value should be custom configuration for that loginProvider. You can deploy your own verifiers from [developer dashboard](https://dashboard.web3auth.io) to use here. |
2323
| `whiteLabel` | options for whitelabling default auth modal screens. |
24-
| `storageServerUrl` | Specify a custom storage server url |
24+
| `storageServerUrl` | Specify a custom storage server URL |
2525
| `storageKey` | setting to "local" will persist social login session across browser tabs. |
2626
| `sessionTime` | This is the sessionTime for the login session |
2727
| `mfaSettings` | This parameter will be used to enable mfa factors and set priority on UI listing. List of factors available `deviceShareFactor` \| `backUpShareFactor` \| `socialBackupFactor` \| `passwordFactor` \| `passkeysFactor` \| `authenticatorFactor` |
@@ -38,7 +38,7 @@ adapterSettings?: MakeOptional<AuthOptions, "clientId" | "network"> & {
3838

3939
export type AuthOptions = {
4040
/**
41-
* You can get your clientId/projectId by registering your
41+
* You can get your clientID/projectID by registering your
4242
* dapp on {@link "https://dashboard.web3auth.io"| developer dashboard}
4343
*/
4444
clientId: string;
@@ -52,10 +52,10 @@ export type AuthOptions = {
5252
*/
5353
buildEnv?: BUILD_ENV_TYPE;
5454
/**
55-
* redirectUrl is the dapp's url where user will be redirected after login.
55+
* redirectUrl is the dapp's URL where user will be redirected after login.
5656
*
5757
* @remarks
58-
* Register this url at {@link "https://dashboard.web3auth.io"| developer dashboard}
58+
* Register this URL at {@link "https://dashboard.web3auth.io"| developer dashboard}
5959
* else initialization will give error.
6060
*/
6161
redirectUrl?: string;
@@ -71,7 +71,7 @@ export type AuthOptions = {
7171
*/
7272
uxMode?: UX_MODE_TYPE;
7373
/**
74-
* replaceUrlOnRedirect removes the params from the redirected url after login
74+
* replaceUrlOnRedirect removes the params from the redirected URL after login
7575
*
7676
* @defaultValue true
7777
*/
@@ -84,7 +84,7 @@ export type AuthOptions = {
8484
* You don't have to pass originData explicitly if you have registered your dapp at
8585
* {@link "https://dashboard.web3auth.io"| developer dashboard}.
8686
*
87-
* originData contains a signature of dapp's origin url which is generated using
87+
* originData contains a signature of dapp's origin URL which is generated using
8888
* project's secret.
8989
*/
9090
originData?: OriginData;
@@ -128,7 +128,7 @@ export type AuthOptions = {
128128
*/
129129
whiteLabel?: WhiteLabelData;
130130
/**
131-
* Specify a custom storage server url
131+
* Specify a custom storage server URL
132132
* @defaultValue https://session.web3auth.io
133133
* @internal
134134
*/
@@ -186,7 +186,7 @@ export type LoginConfig = Record<string, {
186186
*/
187187
description?: string;
188188
/**
189-
* Custom client_id. If not provided, we use the default for auth app
189+
* Custom client ID. If not provided, we use the default for auth app
190190
*/
191191
clientId?: string;
192192
verifierSubIdentifier?: string;
@@ -225,7 +225,7 @@ export type LoginConfig = Record<string, {
225225
*/
226226
showOnSocialBackupFactor?: boolean;
227227
/**
228-
* Custom jwt parameters to configure the login. Useful for Auth0 configuration
228+
* Custom JWT parameters to configure the login. Useful for Auth0 configuration
229229
*/
230230
jwtParameters?: JwtParameters;
231231
}>;
@@ -236,7 +236,7 @@ export type WhiteLabelData = {
236236
*/
237237
appName?: string;
238238
/**
239-
* App url
239+
* App URL
240240
*/
241241
appUrl?: string;
242242
/**
@@ -281,7 +281,7 @@ export type WhiteLabelData = {
281281
theme?: WHITE_LABEL_THEME;
282282
/**
283283
* Language specific link for terms and conditions on torus-website. See (examples/vue-app) to configure
284-
* e.g.
284+
* for example
285285
* tncLink: {
286286
* en: "http://example.com/tnc/en",
287287
* ja: "http://example.com/tnc/ja",
@@ -290,7 +290,7 @@ export type WhiteLabelData = {
290290
tncLink?: Partial<Record<LANGUAGE_TYPE, string>>;
291291
/**
292292
* Language specific link for privacy policy on torus-website. See (examples/vue-app) to configure
293-
* e.g.
293+
* for example
294294
* privacyPolicy: {
295295
* en: "http://example.com/tnc/en",
296296
* ja: "http://example.com/tnc/ja",

‎embedded-wallets/sdk/_common/_auth-login-settings.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ import Tabs from "@theme/Tabs";
1515
| `loginProvider` | Sets the OAuth login method to be used. You can use any of the valid loginProvider from the supported list.<br /><br /> The list of available options: `google`, `facebook`, `reddit`, `discord`, `twitch`, `apple`, `line`, `github`, `kakao`, `linkedin`, `twitter`, `weibo`, `wechat`, `email_passwordless`, `sms_passwordless`, `jwt` |
1616
| `mfaLevel?` | You can set the `mfaLevel` to customize when mfa screen should be shown to user. It currently accepts 4 values: <ul><li> **`'default'`** Setting mfa level to `default` will present mfa screen to user on every third login. </li><li> **`'optional'`** Setting mfa level to `default` will present mfa screen to user on every login but user can skip it. </li><li> **`'mandatory'`** Setting mfa level to `mandatory` will make it mandatory for user to setup mfa after login. </li><li> **`'none'`** Setting mfa level to `none` will make the user skip the mfa setup screen</li></ul> |
1717
| `extraLoginOptions?` | This can be used to pass standard oauth login options to loginProvider. For ex: you will have to pass `login_hint` as user's email or phone number and `domain` as your app domain in `extraLoginOptions` while using `email_passwordless` or `sms_passwordless` loginProvider. It accepts `ExtraLoginOptions` as a value. |
18-
| `dappShare?` | Custom logins can get a dApp share returned to them post successful login. This is useful if the dapps want to use this share to allow users to login seamlessly. `dappShare` is a 24 word seed phrase. It accepts `string` as a value. |
19-
| `curve?` | This curve will be used to determine the public key encoded in the jwt token which returned in `getUserInfo` function after user login. You can use that public key from jwt token as a unique user identifier in your backend. <ul><li>`'secp256k1'`: secp256k1 based pub key is added as a wallet public key in jwt token to use.</li><li>`'ed25519'`: ed25519 based pub key is added as a wallet public key in jwt token to use.</li></ul> Note: This parameter won't change format of private key returned by auth. Private key returned by auth is always `secp256k1`. It accepts `SUPPORTED_KEY_CURVES_TYPE` as a value. |
20-
| `appState?` | Any custom state you wish to pass along. This will be returned to you post redirect. Use this to store data that you want to be available to the dApp after login. It accepts `string` as a value. |
18+
| `dappShare?` | Custom logins can get a dapp share returned to them post successful login. This is useful if the dapps want to use this share to allow users to login seamlessly. `dappShare` is a 24 word seed phrase. It accepts `string` as a value. |
19+
| `curve?` | This curve will be used to determine the public key encoded in the JWT token which returned in `getUserInfo` function after user login. You can use that public key from JWT token as a unique user identifier in your backend. <ul><li>`'secp256k1'`: secp256k1 based pub key is added as a wallet public key in JWT token to use.</li><li>`'ed25519'`: ed25519 based pub key is added as a wallet public key in JWT token to use.</li></ul> Note: This parameter won't change format of private key returned by auth. Private key returned by auth is always `secp256k1`. It accepts `SUPPORTED_KEY_CURVES_TYPE` as a value. |
20+
| `appState?` | Any custom state you wish to pass along. This will be returned to you post redirect. Use this to store data that you want to be available to the dapp after login. It accepts `string` as a value. |
2121
| `redirectUrl?` | App's URL where user will be redirected after login. Register this URL in the [developer dashboard](https://dashboard.web3auth.io), else initialization will give error. It accepts `string` as a value. |
2222

2323
</TabItem>

‎embedded-wallets/sdk/_common/_chain-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export type CustomChainConfig = {
6262
*/
6363
rpcTarget: string;
6464
/**
65-
* web socket target Url for the chain
65+
* web socket target url for the chain
6666
*/
6767
wsTarget?: string;
6868
/**

‎embedded-wallets/sdk/_common/_configure-paymaster-context.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
You can send additional metadata in the paymaster context to supply whatever information the
2-
Paymaster needs to process user operations. For instance, you might include the type of Paymaster
3-
(e.g., a Sponsored Paymaster versus an ERC-20-based Paymaster), references to specific tokens used
2+
Paymaster needs to process user operations. For instance, you might include the type of paymaster
3+
(for example, a sponsored paymaster versus an ERC-20-based paymaster), references to specific tokens used
44
for gas sponsorship, custom gas policies or limits, and any other parameters relevant to your
55
sponsorship logic.
66

‎embedded-wallets/sdk/_common/_ios-allowlist.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- Go to [Web3Auth Developer Dashboard](https://dashboard.web3auth.io), and create or open an
1+
- Go to the [Embedded Wallets dashboard](https://dashboard.web3auth.io), and create or open an
22
existing Web3Auth project.
3-
- Allowlist `{SCHEME}://{YOUR_APP_PACKAGE_NAME}` in the developer dashboard. This step is mandatory
4-
for the redirect to work.
3+
- Allowlist `{SCHEME}://{YOUR_APP_PACKAGE_NAME}` in the dashboard. This step is mandatory for the redirect to work.
4+

‎embedded-wallets/sdk/_common/_sdk-troubleshooting-intro.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
## Troubleshooting
22

3-
### Bundler Issues: Missing Dependencies
3+
### Bundler issues: missing dependencies
44

55
You might encounter errors related to missing dependencies in the browser environment:
66

77
- `Buffer is not defined`
88
- `process is not defined`
99
- Other Node.js-specific modules missing errors
1010

11-
These Node.js dependencies need to be polyfilled in your application. We've prepared detailed troubleshooting guides for popular bundlers:
11+
These Node.js dependencies need to be polyfilled in your application. See the detailed troubleshooting guides for popular bundlers:
1212

1313
- **[Vite Troubleshooting Guide](/embedded-wallets/troubleshooting/vite-issues)**
1414
- **[Svelte Troubleshooting Guide](/embedded-wallets/troubleshooting/svelte-issues)**
1515
- **[Nuxt Troubleshooting Guide](/embedded-wallets/troubleshooting/nuxt-issues)**
1616
- **[Webpack 5 Troubleshooting Guide](/embedded-wallets/troubleshooting/webpack-issues)**
1717

18-
### JWT Errors
18+
### JWT errors
1919

20-
When using Custom Authentication, you may encounter JWT errors:
20+
When using custom authentication, you may encounter JWT errors:
2121

22-
- [**Invalid JWT Verifiers ID field**](/embedded-wallets/troubleshooting/jwt-errors#invalid-jwt-verifiers-id-field)
22+
- [**Invalid JWT verifiers ID field**](/embedded-wallets/troubleshooting/jwt-errors#invalid-jwt-verifiers-id-field)
2323
- [**Failed to verify JWS signature**](/embedded-wallets/troubleshooting/jwt-errors#failed-to-verify-jws-signature)
24-
- [**Duplicate Token**](/embedded-wallets/troubleshooting/jwt-errors#duplicate-token)
25-
- [**Expired Token**](/embedded-wallets/troubleshooting/jwt-errors#expired-token)
26-
- [**Mismatch JWT Validation field**](/embedded-wallets/troubleshooting/jwt-errors#mismatch-jwt-validation-field)
24+
- [**Duplicate token**](/embedded-wallets/troubleshooting/jwt-errors#duplicate-token)
25+
- [**Expired token**](/embedded-wallets/troubleshooting/jwt-errors#expired-token)
26+
- [**Mismatch JWT validation field**](/embedded-wallets/troubleshooting/jwt-errors#mismatch-jwt-validation-field)

0 commit comments

Comments
 (0)