|
| 1 | +--- |
| 2 | +sidebar_label: Web3Auth SDK integration |
| 3 | +description: Quickstart guide for using MetaMask SDK and Web3Auth SDK. |
| 4 | +toc_max_heading_level: 2 |
| 5 | +--- |
| 6 | + |
| 7 | +# MetaMask SDK + Web3Auth SDK integration |
| 8 | + |
| 9 | +Get started with MetaMask SDK and [Web3Auth SDK](https://web3auth.io/docs/). |
| 10 | +You can set up the SDKs in the following ways: |
| 11 | + |
| 12 | +- [Quickstart template](#set-up-using-a-template) - Clone the template to set up a Next.js and Web3Auth dapp that uses MetaMask SDK. |
| 13 | +- [Manual setup](#set-up-manually) - Set up Web3Auth SDK in an existing dapp. |
| 14 | + |
| 15 | +<p align="center"> |
| 16 | + <img src={require("../_assets/quickstart-web3auth.png").default} alt="Web3Auth SDK Quickstart" width="450px" /> |
| 17 | +</p> |
| 18 | + |
| 19 | +Features include: |
| 20 | + |
| 21 | +- **MetaMask SDK built into Web3Auth** - Use MetaMask SDK features directly within the Web3Auth SDK. |
| 22 | +- **Web3Auth social login** - Enable users to sign in with an email or social media account. |
| 23 | +- **Wallet connection** - Connect to MetaMask wallet with enhanced features. |
| 24 | +- **Mobile experience** - Optimized for both desktop and mobile users. |
| 25 | +- **TypeScript support** - Full type safety and modern development experience. |
| 26 | +- **Next.js integration** - Built with Next.js 15 and App Router. |
| 27 | + |
| 28 | +## Prerequisites |
| 29 | + |
| 30 | +- [Node.js](https://nodejs.org/) version 19 or later installed. |
| 31 | +- A package manager installed. |
| 32 | + The examples in this quickstart use [pnpm](https://pnpm.io/installation). |
| 33 | +- [MetaMask](https://metamask.io/) installed in your browser or on mobile. |
| 34 | +- A [Web3Auth Client ID](https://web3auth.io/docs/dashboard/create-new-project#get-the-client-id). |
| 35 | + |
| 36 | +## Set up using a template |
| 37 | + |
| 38 | +1. Download the [MetaMask SDK + Web3Auth SDK template](https://github.com/MetaMask/metamask-web3auth): |
| 39 | + |
| 40 | + ```bash |
| 41 | + git clone https://github.com/MetaMask/metamask-web3auth |
| 42 | + ``` |
| 43 | + |
| 44 | +2. Navigate into the repository: |
| 45 | + |
| 46 | + ```bash |
| 47 | + cd metamask-web3auth |
| 48 | + ``` |
| 49 | + |
| 50 | +3. Install dependencies: |
| 51 | + |
| 52 | + ```bash |
| 53 | + pnpm install |
| 54 | + ``` |
| 55 | + |
| 56 | +4. Create a `.env.local` file: |
| 57 | + |
| 58 | + ```bash |
| 59 | + touch .env.local |
| 60 | + ``` |
| 61 | + |
| 62 | +5. In `.env.local`, add a `NEXT_PUBLIC_WEB3AUTH_CLIENT_ID` environment variable, replacing `<YOUR-CLIENT-ID>` with your Web3Auth Client ID: |
| 63 | + |
| 64 | + ```text title=".env.local" |
| 65 | + NEXT_PUBLIC_WEB3AUTH_CLIENT_ID=<YOUR-CLIENT-ID> |
| 66 | + ``` |
| 67 | + |
| 68 | +6. Run the project: |
| 69 | + |
| 70 | + ```bash |
| 71 | + pnpm dev |
| 72 | + ``` |
| 73 | + |
| 74 | +You've successfully set up MetaMask SDK and Web3Auth SDK. |
| 75 | +See how to [use the combined SDKs](#usage). |
| 76 | +
|
| 77 | +## Set up manually |
| 78 | +
|
| 79 | +### 1. Install dependencies |
| 80 | +
|
| 81 | +Install the SDK and the required dependencies to an existing project: |
| 82 | +
|
| 83 | +```bash |
| 84 | +pnpm i viem wagmi @tanstack/react-query @web3auth/modal@10 |
| 85 | +``` |
| 86 | +
|
| 87 | +### 2. Configure providers |
| 88 | +
|
| 89 | +Set up your providers in `app/providers.tsx`: |
| 90 | +
|
| 91 | +```typescript title="providers.tsx" |
| 92 | +"use client"; |
| 93 | +
|
| 94 | +import { QueryClient, QueryClientProvider } from "@tanstack/react-query"; |
| 95 | +import { type ReactNode, useState } from "react"; |
| 96 | +import { Web3AuthProvider } from "@web3auth/modal/react"; |
| 97 | +import { WagmiProvider } from "@web3auth/modal/react/wagmi"; |
| 98 | +
|
| 99 | +type Props = { |
| 100 | + children: ReactNode; |
| 101 | +}; |
| 102 | +
|
| 103 | +export function Providers({ children }: Props) { |
| 104 | + const [queryClient] = useState(() => new QueryClient()); |
| 105 | +
|
| 106 | + return ( |
| 107 | + <Web3AuthProvider |
| 108 | + config={{ |
| 109 | + web3AuthOptions: { |
| 110 | + clientId: process.env.NEXT_PUBLIC_WEB3AUTH_CLIENT_ID!, |
| 111 | + web3AuthNetwork: "sapphire_devnet" |
| 112 | + }, |
| 113 | + }} |
| 114 | + > |
| 115 | + <QueryClientProvider client={queryClient}> |
| 116 | + <WagmiProvider> |
| 117 | + <div className="container">{children}</div> |
| 118 | + </WagmiProvider> |
| 119 | + </QueryClientProvider> |
| 120 | + </Web3AuthProvider> |
| 121 | + ); |
| 122 | +} |
| 123 | +``` |
| 124 | +
|
| 125 | +### 3. Set up environment variables |
| 126 | +
|
| 127 | +Create a `.env.local` file. |
| 128 | +In `.env.local`, add a `NEXT_PUBLIC_WEB3AUTH_CLIENT_ID` environment variable, replacing `<YOUR-CLIENT-ID>` with your Web3Auth Client ID: |
| 129 | +
|
| 130 | +```text title=".env.local" |
| 131 | +NEXT_PUBLIC_WEB3AUTH_CLIENT_ID=<YOUR-CLIENT-ID> |
| 132 | +``` |
| 133 | +
|
| 134 | +You can now test your dapp by running `pnpm run dev`. |
| 135 | +
|
| 136 | +## Usage |
| 137 | +
|
| 138 | +### Connect or sign in |
| 139 | +
|
| 140 | +Use the `useWeb3AuthConnect` hook to enable users to connect or sign in to their wallet: |
| 141 | +
|
| 142 | +```typescript |
| 143 | +"use client"; |
| 144 | +
|
| 145 | +import { useWeb3AuthConnect } from "@web3auth/modal/react"; |
| 146 | +
|
| 147 | +export const Navbar = () => { |
| 148 | + const { connect } = useWeb3AuthConnect(); |
| 149 | +
|
| 150 | + return ( |
| 151 | + <nav> |
| 152 | + <button onClick={() => connect()}>Connect or Sign in</button>; |
| 153 | + </nav> |
| 154 | + ); |
| 155 | +}; |
| 156 | +``` |
| 157 | +
|
| 158 | +### Check wallet status |
| 159 | +
|
| 160 | +Use the `useAccount` hook from Wagmi to check the wallet status: |
| 161 | +
|
| 162 | +```typescript |
| 163 | +"use client"; |
| 164 | +
|
| 165 | +import { useAccount } from "wagmi"; |
| 166 | +
|
| 167 | +export const Hero = () => { |
| 168 | + const { address, isConnected } = useAccount(); |
| 169 | +
|
| 170 | + return ( |
| 171 | + <div> |
| 172 | + {isConnected ? <p>Connected: {address}</p> : <p>Not connected</p>} |
| 173 | + </div> |
| 174 | + ); |
| 175 | +}; |
| 176 | +``` |
| 177 | +
|
| 178 | +### Send a transaction |
| 179 | +
|
| 180 | +Use the `useSendTransaction` hook from Wagmi to send a transaction: |
| 181 | +
|
| 182 | +```typescript |
| 183 | +"use client"; |
| 184 | +
|
| 185 | +import { useSendTransaction } from "wagmi"; |
| 186 | +import { parseEther } from "viem"; |
| 187 | +
|
| 188 | +export const SendTransaction = () => { |
| 189 | + const { sendTransaction } = useSendTransaction(); |
| 190 | +
|
| 191 | + return ( |
| 192 | + <button |
| 193 | + onClick={() => |
| 194 | + sendTransaction({ |
| 195 | + to: "0xd2135CfB216b74109775236E36d4b433F1DF507B", |
| 196 | + value: parseEther("0.001"), |
| 197 | + }) |
| 198 | + } |
| 199 | + > |
| 200 | + Send transaction |
| 201 | + </button> |
| 202 | + ); |
| 203 | +}; |
| 204 | +``` |
0 commit comments