Skip to content

Commit a85132b

Browse files
authored
Merge branch 'master' into mpc-core-kit-swift
2 parents 160585d + a71472e commit a85132b

File tree

74 files changed

+3356
-186
lines changed

Some content is hidden

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

74 files changed

+3356
-186
lines changed

docs/features/wallet-pregeneration.mdx

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,57 @@ description: "Wallet Pregeneration | Documentation - Web3Auth"
66

77
import PregenerateWallet from "@site/src/components/PregenerateWallet";
88

9-
Pre-generated wallets are a strategic feature within Web3Auth, designed to streamline the onboarding process by allowing developers to create wallet
10-
addresses for users before their initial login. This feature offers flexibility in how and when you introduce users to wallet functionalities,
11-
enhancing the user experience and engagement.
9+
Pre-generated wallets are a strategic feature within Web3Auth, designed to streamline the onboarding
10+
process by allowing developers to create wallet addresses for users before their initial login. This
11+
feature offers flexibility in how and when you introduce users to wallet functionalities, enhancing
12+
the user experience and engagement.
1213

1314
## Capabilities of Pre-generated Wallets
1415

15-
The ability to pre-generate wallets opens up a variety of use cases, making it easier to integrate Web3 features into your application's user journey:
16+
The ability to pre-generate wallets opens up a variety of use cases, making it easier to integrate
17+
Web3 features into your application's user journey:
1618

17-
- **Early Wallet Creation:** Initiate wallet creation as part of the user invite or onboarding flow, even before the user has logged into your app for
18-
the first time.
19-
- **Deferred Login Setup:** Delay the setup of wallet access management, such as OAuth login or passkeys, until the user is ready for their first
20-
on-chain transaction, simplifying initial engagement.
21-
- **Wallet Prefunding:** Reward users with tokens for off-chain activities, allowing them to claim these rewards when they access their pre-generated
22-
wallet.
19+
- **Early Wallet Creation:** Initiate wallet creation as part of the user invite or onboarding flow,
20+
even before the user has logged into your app for the first time.
21+
- **Deferred Login Setup:** Delay the setup of wallet access management, such as OAuth login or
22+
passkeys, until the user is ready for their first on-chain transaction, simplifying initial
23+
engagement.
24+
- **Wallet Prefunding:** Reward users with tokens for off-chain activities, allowing them to claim
25+
these rewards when they access their pre-generated wallet.
26+
27+
:::note Minimum Scale plan required
28+
29+
Access to Wallet Pregeneration is gated. You can use this feature in the development environment for
30+
free. The minimum [pricing plan](https://web3auth.io/pricing.html) to use this feature in a
31+
production environment is the **Scale Plan**.
32+
33+
:::
2334

2435
## Utilizing the Pre-generated Wallet API
2536

26-
Web3Auth provides a straightforward API to facilitate the creation of pre-generated wallets. You can integrate this API into your user signup flow,
27-
either after a user verifies their email or independently by supplying their email or unique identifier to the API.
37+
Web3Auth provides a straightforward API to facilitate the creation of pre-generated wallets. You can
38+
integrate this API into your user signup flow, either after a user verifies their email or
39+
independently by supplying their email or unique identifier to the API.
2840

2941
:::warning
3042

31-
This API only returns the Core Kit Key wallet addresses. To use the wallet addresses with the Web3Auth SDKs, you will need to either use the
32-
`useCoreKitKey` flag in our PnP SDKs or use any of our Core Kit SFA SDKs
43+
This API only returns the Core Kit Key wallet addresses. To use the wallet addresses with the
44+
Web3Auth SDKs, you will need to either use the `useCoreKitKey` flag in our PnP SDKs or use any of
45+
our Core Kit SFA SDKs
3346

34-
Learn more about how [keys can change within different Web3Auth Products](/docs/troubleshooting/different-private-key#product)
47+
Learn more about how
48+
[keys can change within different Web3Auth Products](/docs/troubleshooting/different-private-key#product)
3549

3650
:::
3751

3852
### Implementation Steps:
3953

40-
1. **Identify Users:** Determine the unique identifier or email for the user within your system. This will be the `verifierId` used to create the
41-
wallet.
42-
2. **API Call:** Use the provided API to submit the user's identifier. You'll need to specify parameters from the Web3Auth dashboard, specifically the
43-
Verifier Name, Web3Auth Network, and Client Id.
44-
3. **Receive Wallet Address:** The API response will include the new wallet address, ready for use by the user upon their first login.
54+
1. **Identify Users:** Determine the unique identifier or email for the user within your system.
55+
This will be the `verifierId` used to create the wallet.
56+
2. **API Call:** Use the provided API to submit the user's identifier. You'll need to specify
57+
parameters from the Web3Auth dashboard, specifically the Verifier Name, Web3Auth Network, and
58+
Client Id.
59+
3. **Receive Wallet Address:** The API response will include the new wallet address, ready for use
60+
by the user upon their first login.
4561

4662
<PregenerateWallet />

docs/features/whitelabel.mdx

Lines changed: 67 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,98 @@ description: "Whitelabeling Web3Auth | Documentation - Web3Auth"
66
image: "images/docs-meta-cards/documentation-card.png"
77
---
88

9-
Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and cohesive user experience across their applications.
10-
Through customization of the user interface, branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
9+
Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and
10+
cohesive user experience across their applications. Through customization of the user interface,
11+
branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
1112
authentication flow aligns with your application's identity.
1213

1314
#### Steps for Customization
1415

15-
1. **Choose Your SDK:** Decide between Plug and Play or Core Kit SDKs based on your needs for customization and control.
16-
2. **Define Your Branding:** Customize the elements of the SDKs, such as modals, screens, and logos, to align with your branding guidelines.
17-
3. **Apply Translations:** Tailor the language and translations within the authentication flow to cater to your target audience.
16+
1. **Choose Your SDK:** Decide between Plug and Play or Core Kit SDKs based on your needs for
17+
customization and control.
18+
2. **Define Your Branding:** Customize the elements of the SDKs, such as modals, screens, and logos,
19+
to align with your branding guidelines.
20+
3. **Apply Translations:** Tailor the language and translations within the authentication flow to
21+
cater to your target audience.
1822

1923
## Plug and Play SDKs Whitelabeling
2024

21-
Web3Auth's Plug and Play SDKs provide extensive whitelabeling capabilities, allowing for a deep level of customization to ensure the user interface,
22-
branding, and translations perfectly match your application's needs. These SDKs support detailed customization, offering a seamless and cohesive user
23-
experience.
25+
Web3Auth's Plug and Play SDKs provide extensive whitelabeling capabilities, allowing for a deep
26+
level of customization to ensure the user interface, branding, and translations perfectly match your
27+
application's needs. These SDKs support detailed customization, offering a seamless and cohesive
28+
user experience.
2429

25-
- **Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your application, ensuring a unified user experience that aligns
26-
with your brand identity. Customize every aspect, from the modal appearance to the user flow, including MFA screens, to maintain consistency across
27-
all user interactions.
30+
- **Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your
31+
application, ensuring a unified user experience that aligns with your brand identity. Customize
32+
every aspect, from the modal appearance to the user flow, including MFA screens, to maintain
33+
consistency across all user interactions.
2834

29-
- **Comprehensive Management:** With Web3Auth's whitelabeling options, you gain full control over the authentication experience, ensuring it is not
30-
only branded but also intuitive for users. This approach minimizes the need for additional UI development and aligns closely with your application's
31-
design principles.
35+
- **Comprehensive Management:** With Web3Auth's whitelabeling options, you gain full control over
36+
the authentication experience, ensuring it is not only branded but also intuitive for users. This
37+
approach minimizes the need for additional UI development and aligns closely with your
38+
application's design principles.
3239

33-
- **Customizable to Your Brand:** Tailor the Embedded Wallet UI to perfectly fit your application's aesthetics, reinforcing your brand with every user
34-
interaction. Web3Auth allows for detailed branding customization, ensuring the wallet experience feels like an integral part of your app.
40+
- **Customizable to Your Brand:** Tailor the Embedded Wallet UI to perfectly fit your application's
41+
aesthetics, reinforcing your brand with every user interaction. Web3Auth allows for detailed
42+
branding customization, ensuring the wallet experience feels like an integral part of your app.
3543

3644
### Customization Examples
3745

38-
- **Login Modal Customization:** Adapt the login modal's design to reflect your application's branding, from colors and logos to fonts and button
39-
styles.
46+
- **Login Modal Customization:** Adapt the login modal's design to reflect your application's
47+
branding, from colors and logos to fonts and button styles.
4048

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

43-
- **User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout the user authentication process, including the
44-
transition between different authentication stages and support for both light and dark modes.
51+
- **User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout
52+
the user authentication process, including the transition between different authentication stages
53+
and support for both light and dark modes.
4554

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

57+
### NEW: Whitelabeling via the Dashboard:
58+
59+
- From version `8.5.0`, **Web3Auth's Plug and Play SDKs** and **WalletServicesPlugin** offer
60+
whitelabeling capabilities via the **Dashboard**, enabling developers to customize the
61+
authentication modal, user interface, and translations to align with their application's branding
62+
and user experience requirements.
63+
64+
- **Customize the Authentication Modal:** Modify the appearance of the authentication modal,
65+
including the primary color, application name, logo, and dark or light mode, to align with your
66+
application's branding.
67+
68+
- **Personalize the User Interface:** Tailor the Embedded Wallet UI to match your application's
69+
design language, ensuring a seamless and cohesive user experience.
70+
71+
- **Configure Language and Translations:** Customize the language and translations within the
72+
authentication flow to cater to your target audience.
73+
74+
![Web3Auth Whitelabeling Dashboard](/images/whitelabel/whitelabel-dashboard.gif)
75+
4876
## Core Kit SDKs Whitelabeling
4977

50-
- **Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of Web3Auth's underlying mechanisms. Developers have the
51-
freedom to design their authentication pages and flows, offering unparalleled customization.
52-
- **No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates the need for user redirection to `auth.web3auth.io`
53-
for authentication, ensuring all processes are kept within your application's ecosystem.
78+
- **Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of
79+
Web3Auth's underlying mechanisms. Developers have the freedom to design their authentication pages
80+
and flows, offering unparalleled customization.
81+
- **No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates
82+
the need for user redirection to `auth.web3auth.io` for authentication, ensuring all processes are
83+
kept within your application's ecosystem.
5484

5585
## Wallet Services Whitelabeling
5686

57-
- **Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the entire user interface, including logos, color schemes,
58-
and visibility of specific sections, ensuring a branded experience throughout.
59-
- **Application Identity:** Tailor the appearance of wallet service components, such as chain logos and the dApp logo, to reinforce your application's
60-
brand identity across all user interactions.
87+
- **Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the
88+
entire user interface, including logos, color schemes, and visibility of specific sections,
89+
ensuring a branded experience throughout.
90+
- **Application Identity:** Tailor the appearance of wallet service components, such as chain logos
91+
and the dApp logo, to reinforce your application's brand identity across all user interactions.
6192

6293
## Language Customization and Localization (l10n)
6394

64-
A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages, enhancing accessibility and user engagement
65-
across diverse demographics.
95+
A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages,
96+
enhancing accessibility and user engagement across diverse demographics.
6697

67-
- **Multiple Languages Support:** Web3Auth supports localization for a variety of languages including English (en), Spanish (es), German (de), Chinese
68-
(zh), Japanese (ja), Korean (ko), French (fr), Portuguese (pt), and Dutch (nl).
69-
- **Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository, inviting contributions from the community to add or
70-
refine language support. [Contribute to Web3Auth Locales](https://github.com/Web3Auth/web3auth-locales).
98+
- **Multiple Languages Support:** Web3Auth supports localization for a variety of languages
99+
including English (en), Spanish (es), German (de), Chinese (zh), Japanese (ja), Korean (ko),
100+
French (fr), Portuguese (pt), and Dutch (nl).
101+
- **Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository,
102+
inviting contributions from the community to add or refine language support.
103+
[Contribute to Web3Auth Locales](https://github.com/Web3Auth/web3auth-locales).

0 commit comments

Comments
 (0)