-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
[Smart Accounts Kit] Add Embedded Wallets guide #2568
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d315f2b
add embedded wallet guide
AyushBherwani1998 40e38ee
fix path
AyushBherwani1998 4f14436
remove example for now
AyushBherwani1998 ad484e7
resolve conflicts
AyushBherwani1998 0c373d5
Apply suggestions from code review
AyushBherwani1998 fff2751
improve guide
AyushBherwani1998 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
122 changes: 122 additions & 0 deletions
122
smart-accounts-kit/guides/smart-accounts/signers/embedded-wallets.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| --- | ||
| description: Learn how to use MetaMask Embedded Wallets (Web3Auth) with MetaMask Smart Accounts. | ||
| sidebar_label: MetaMask Embedded Wallets | ||
| keywords: [web3auth, smart account, signer, metamask smart account] | ||
| --- | ||
|
|
||
| # Use MetaMask Embedded Wallets (Web3Auth) with MetaMask Smart Accounts | ||
|
|
||
| [MetaMask Embedded Wallets (Web3Auth)](/embedded-wallets/) provides a pluggable embedded wallet | ||
| infrastructure to simplify Web3 wallet integration and user onboarding. It supports social logins allowing | ||
| users to access Web3 applications through familiar authentication methods in under a minute. | ||
|
|
||
| MetaMask Smart Accounts is a signer agnostic implementation that allows you to use Embedded Wallets as a signer for MetaMask Smart Accounts. | ||
|
|
||
| :::info | ||
| This guide is targeted towards React and React-based frameworks. | ||
| ::: | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Install [Node.js](https://nodejs.org/en/blog/release/v18.18.0) v18 or later | ||
| - Install [Yarn](https://yarnpkg.com/), | ||
| [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), or another package manager | ||
| - A [Embedded Wallets (Web3Auth) Client ID](/embedded-wallets/dashboard) | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. Install dependencies | ||
|
|
||
| Install the [Smart Accounts Kit](https://www.npmjs.com/package/@metamask/smart-accounts-kit) and other dependencies in your project: | ||
|
|
||
| ```bash npm2yarn | ||
| npm install @metamask/smart-accounts-kit @web3auth/modal wagmi @tanstack/react-query viem | ||
| ``` | ||
|
|
||
| ### 2. Create the Web3Auth provider | ||
|
|
||
| Configure the `Web3AuthProvider` component to provide the Embedded Wallets context to your application. | ||
| You'll also use the `WagmiProvider` to integrate Embedded Wallets with Wagmi. | ||
| This connector enables you to use Wagmi hooks with Embedded Wallets. | ||
|
|
||
| Once you've created the `Web3AuthAppProvider`, wrap it at the root of your application so | ||
| that the rest of your application has access to the Embedded Wallets context. | ||
|
|
||
| For the advance configuration, see [Embedded Wallets guide](https://docs.metamask.io/embedded-wallets/sdk/react/advanced/). | ||
|
|
||
| <Tabs> | ||
| <TabItem value = "provider.ts"> | ||
|
|
||
| ```ts | ||
| import { QueryClient, QueryClientProvider } from "@tanstack/react-query"; | ||
| import { ReactNode } from "react"; | ||
| import { Web3AuthProvider } from "@web3auth/modal/react"; | ||
| import { WagmiProvider } from "@web3auth/modal/react/wagmi"; | ||
| import { web3authConfig } from "./config.ts"; | ||
|
|
||
| const queryClient = new QueryClient(); | ||
|
|
||
| export function Web3AuthAppProvider({ children }: { children: ReactNode }) { | ||
| return ( | ||
| <Web3AuthProvider config={web3authConfig}> | ||
| <QueryClientProvider client={queryClient}> | ||
| <WagmiProvider>{children}</WagmiProvider> | ||
| </QueryClientProvider> | ||
| </Web3AuthProvider> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem value = "config.ts"> | ||
|
|
||
| ```ts | ||
| import { WEB3AUTH_NETWORK_TYPE, Web3AuthOptions } from "@web3auth/modal"; | ||
|
|
||
| const web3AuthOptions: Web3AuthOptions = { | ||
| clientId: process.env.NEXT_PUBLIC_WEB3AUTH_CLIENT_ID as string, | ||
| web3AuthNetwork: process.env | ||
| .NEXT_PUBLIC_WEB3AUTH_NETWORK as WEB3AUTH_NETWORK_TYPE, | ||
| }; | ||
|
|
||
| export const web3authConfig = { | ||
| web3AuthOptions, | ||
| }; | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ### 3. Create a smart account | ||
|
|
||
| Once the user has connected their wallet, use the [Wallet Client](https://viem.sh/docs/clients/wallet) from Wagmi as the signer to create a | ||
| MetaMask smart account. | ||
|
|
||
| ```ts | ||
| import { Implementation, toMetaMaskSmartAccount } from "@metamask/smart-accounts-kit"; | ||
| import { useAccount, usePublicClient, useWalletClient } from "wagmi"; | ||
|
|
||
| const { address } = useAccount(); | ||
| const publicClient = usePublicClient(); | ||
| const { data: walletClient } = useWalletClient(); | ||
|
|
||
| // Additional check to make sure the Dyanmic wallet is connected | ||
| // and values are available. | ||
| if (!address || !walletClient || !publicClient ) { | ||
| // Handle the error case | ||
| } | ||
|
|
||
| const smartAccount = await toMetaMaskSmartAccount({ | ||
| client: publicClient, | ||
| implementation: Implementation.Hybrid, | ||
| deployParams: [address, [], [], []], | ||
| deploySalt: "0x", | ||
| signer: { walletClient }, | ||
| }); | ||
| ``` | ||
|
|
||
| ## Next steps | ||
|
|
||
| - See how to [send a user operations](../send-user-operation.md). | ||
| - To sponsor gas for end users, see how to [send a gasless transaction](../send-gasless-transaction.md). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there's a reason why you should choose our solution over a different embedded wallet solution, this may a place to promote.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would not prefer adding a section on why choose xyz in guides, I would prefer tutorial for that which can marketed. Also, anyone using Smart Accounts they must have already figured out what EW they want to use, because the first step towards development journey would be choosing a signer -> then thinking about using a smart account.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll keep this for an open discussion, and revisit once we know what's the best way to promote.