Next.js
AppKit has support for Wagmi and Ethers v6 on Ethereum and @solana/web3.js on Solana. Choose one of these Ethereum Libraries or 'Solana' to get started.
These steps are specific to Next.js app router. For other React frameworks read the React documentation.
Installation
- Wagmi
- Ethers
- Ethers v5
- Solana
- npm
- Yarn
- Bun
- pnpm
npm install @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
yarn add @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
bun add @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
pnpm add @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
- npm
- Yarn
- Bun
- pnpm
npm install @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
yarn add @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
bun add @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
pnpm add @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
- npm
- Yarn
- Bun
- pnpm
npm install @reown/appkit @reown/appkit-adapter-ethers ethers
yarn add @reown/appkit @reown/appkit-adapter-ethers ethers
bun add @reown/appkit @reown/appkit-adapter-ethers ethers
pnpm add @reown/appkit @reown/appkit-adapter-ethers ethers
- npm
- Yarn
- Bun
- pnpm
npm install @reown/appkit @reown/appkit-adapter-solana @solana/wallet-adapter-wallets
yarn add @reown/appkit @reown/appkit-adapter-solana @solana/wallet-adapter-wallets
bun add @reown/appkit @reown/appkit-adapter-solana @solana/wallet-adapter-wallets
pnpm add @reown/appkit @reown/appkit-adapter-solana @solana/wallet-adapter-wallets
Cloud Configuration
Create a new project on Reown Cloud at https://cloud.reown.com and obtain a new project ID.
Don't have a project ID?
Head over to Reown Cloud and create a new project now!
Implementation
- Wagmi
- Ethers
- Ethers v5
- Solana
For a quick integration, you can use the createAppKit
function with a unified configuration. This automatically applies the predefined configurations for different adapters like Wagmi, Ethers, or Solana, so you no longer need to manually configure each one individually. Simply pass the common parameters such as projectId, chains, metadata, etc., and the function will handle the adapter-specific configurations under the hood.
This includes WalletConnect, Coinbase and Injected connectors, and the Blockchain API as a transport
Wagmi config
Create a new file for your Wagmi configuration, since we are going to be calling this function on the client and the server it cannot live inside a file with the 'use client' directive.
For this example we will create a file called config/index.tsx
outside our app directory and set up the following configuration
import { cookieStorage, createStorage, http } from '@wagmi/core'
import { WagmiAdapter } from '@reown/appkit-adapter-wagmi'
import { mainnet, arbitrum } from '@reown/appkit/networks'
// Get projectId from https://cloud.reown.com
export const projectId = process.env.NEXT_PUBLIC_PROJECT_ID
if (!projectId) {
throw new Error('Project ID is not defined')
}
export const networks = [mainnet, arbitrum]
//Set up the Wagmi Adapter (Config)
export const wagmiAdapter = new WagmiAdapter({
storage: createStorage({
storage: cookieStorage
}),
ssr: true,
projectId,
networks
})
export const config = wagmiAdapter.wagmiConfig
Importing networks
Reown AppKit use Viem networks under the hood, which provide a wide variety of networks for EVM chains. You can find all the networks supported by Viem within the @reown/appkit/networks
path.
import { createAppKit } from '@reown/appkit'
import { mainnet, arbitrum, base, scroll, polygon } from '@reown/appkit/networks'
Looking to add a custom network? Check out the custom networks section.
SSR and Hydration
- Using cookies is completely optional and by default Wagmi will use
localStorage
instead if thestorage
param is not defined. - The
ssr
flag will delay the hydration of the Wagmi's store to avoid hydration mismatch errors.
Context Provider
Let's create now a context provider that will wrap our application and initialized AppKit (createAppKit
needs to be called inside a Next Client Component file).
In this example we will create a file called context/index.tsx
outside our app directory and set up the following configuration
'use client'
import { wagmiAdapter, projectId } from '@/config'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { createAppKit } from '@reown/appkit/react'
import { mainnet, arbitrum } from '@reown/appkit/networks'
import React, { type ReactNode } from 'react'
import { cookieToInitialState, WagmiProvider, type Config } from 'wagmi'
// Set up queryClient
const queryClient = new QueryClient()
if (!projectId) {
throw new Error('Project ID is not defined')
}
// Set up metadata
const metadata = {
name: 'appkit-example',
description: 'AppKit Example',
url: 'https://appkitexampleapp.com', // origin must match your domain & subdomain
icons: ['https://avatars.githubusercontent.com/u/179229932']
}
// Create the modal
const modal = createAppKit({
adapters: [wagmiAdapter],
projectId,
networks: [mainnet, arbitrum],
defaultNetwork: mainnet,
metadata: metadata,
features: {
analytics: true // Optional - defaults to your Cloud configuration
}
})
function ContextProvider({ children, cookies }: { children: ReactNode; cookies: string | null }) {
const initialState = cookieToInitialState(wagmiAdapter.wagmiConfig as Config, cookies)
return (
<WagmiProvider config={wagmiAdapter.wagmiConfig as Config} initialState={initialState}>
<QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
</WagmiProvider>
)
}
export default ContextProvider
Layout
Next, in our app/layout.tsx
file, we will import our ContextProvider
component and call the Wagmi's function cookieToInitialState
.
The initialState
returned by cookieToInitialState
, contains the optimistic values that will populate the Wagmi's store both on the server and client.
import type { Metadata } from 'next'
import { Inter } from 'next/font/google'
import './globals.css'
const inter = Inter({ subsets: ['latin'] })
import { headers } from 'next/headers' // added
import ContextProvider from '@/context'
export const metadata: Metadata = {
title: 'AppKit Example App',
description: 'Powered by Reown'
}
export default function RootLayout({
children
}: Readonly<{
children: React.ReactNode
}>) {
const cookies = headers().get('cookie')
return (
<html lang="en">
<body className={inter.className}>
<ContextProvider cookies={cookies}>{children}</ContextProvider>
</body>
</html>
)
}
In this example we will create a new file called context/web3modal.tsx
outside our app directory and set up the following configuration
'use client'
import { createAppKit } from '@reown/appkit/react'
import { Ethers5Adapter } from '@reown/appkit-adapter-ethers5'
import { mainnet, arbitrum } from '@reown/appkit/networks'
// 1. Get projectId at https://cloud.reown.com
const projectId = 'YOUR_PROJECT_ID'
// 2. Create a metadata object
const metadata = {
name: 'My Website',
description: 'My Website description',
url: 'https://mywebsite.com', // origin must match your domain & subdomain
icons: ['https://avatars.mywebsite.com/']
}
// 3. Create the AppKit instance
createAppKit({
adapters: [new Ethers5Adapter()],
metadata: metadata,
networks: [mainnet, arbitrum],
projectId,
features: {
analytics: true // Optional - defaults to your Cloud configuration
}
})
export function AppKit() {
return (
<YourApp /> //make sure you have configured the <w3m-button> inside
)
}
Next, in your app/layout.tsx
or app/layout.jsx
file, import the custom Web3Modal component.
import './globals.css'
import { AppKit } from '../context/web3modal'
export const metadata = {
title: 'AppKit',
description: 'AppKit Example'
}
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>
<AppKit>{children}</AppKit>
</body>
</html>
)
}
Make sure that the url
from the metadata
matches your domain and subdomain. This will later be used by the Verify API to tell wallets if your application has been verified or not.
In this example we will create a new file called context/web3modal.tsx
outside our app directory and set up the following configuration
'use client'
import { createAppKit } from '@reown/appkit/react'
import { EthersAdapter } from '@reown/appkit-adapter-ethers'
import { mainnet, arbitrum } from '@reown/appkit/networks'
// 1. Get projectId at https://cloud.reown.com
const projectId = 'YOUR_PROJECT_ID'
// 2. Create a metadata object
const metadata = {
name: 'My Website',
description: 'My Website description',
url: 'https://mywebsite.com', // origin must match your domain & subdomain
icons: ['https://avatars.mywebsite.com/']
}
// 3. Create the AppKit instance
createAppKit({
adapters: [new EthersAdapter()],
metadata,
networks: [mainnet, arbitrum],
projectId,
features: {
analytics: true // Optional - defaults to your Cloud configuration
}
})
export function AppKit() {
return (
<YourApp /> //make sure you have configured the <w3m-button> inside
)
}
Next, in your app/layout.tsx
or app/layout.jsx
file, import the custom AppKit component.
import './globals.css'
import { AppKit } from '../context/web3modal'
export const metadata = {
title: 'AppKit',
description: 'AppKit Example'
}
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>
<AppKit>{children}</AppKit>
</body>
</html>
)
}
Make sure that the url
from the metadata
matches your domain and subdomain. This will later be used by the Verify API to tell wallets if your application has been verified or not.
AppKit Solana provides a set of React components and hooks to easily connect Solana wallets with your application.
On top of your app set up the following configuration, making sure that all functions are called outside any React component to avoid unwanted rerenders.
// App.tsx
import { createAppKit } from '@reown/appkit/react'
import { SolanaAdapter } from '@reown/appkit-adapter-solana/react'
import { solana, solanaTestnet, solanaDevnet } from '@reown/appkit/networks'
import { PhantomWalletAdapter, SolflareWalletAdapter } from '@solana/wallet-adapter-wallets'
// 0. Set up Solana Adapter
const solanaWeb3JsAdapter = new SolanaAdapter({
wallets: [new PhantomWalletAdapter(), new SolflareWalletAdapter()]
})
// 1. Get projectId from https://cloud.reown.com
const projectId = 'YOUR_PROJECT_ID'
// 2. Create a metadata object - optional
const metadata = {
name: 'AppKit',
description: 'AppKit Solana Example',
url: 'https://example.com', // origin must match your domain & subdomain
icons: ['https://avatars.githubusercontent.com/u/179229932']
}
// 3. Create modal
createAppKit({
adapters: [solanaWeb3JsAdapter],
networks: [solana, solanaTestnet, solanaDevnet],
metadata: metadata,
projectId,
features: {
analytics: true // Optional - defaults to your Cloud configuration
}
})
export default function App() {
return <YourApp />
}
Trigger the modal
- Wagmi
- Ethers
- Ethers v5
- Solana
To open AppKit you can use our web component or build your own button with AppKit hooks.
In this example we are going to use the <w3m-button>
component.
Web components are global html elements that don't require importing.
export default function ConnectButton() {
return <w3m-button />
}
Learn more about the AppKit web components here
To open AppKit you can use our web component or build your own button with AppKit hooks.
- Web Component
- Hooks
export default function ConnectButton() {
return <w3m-button />
}
Learn more about the AppKit web components here
Web components are global html elements that don't require importing.
You can trigger the modal by calling the open
function from useAppKit
hook.
import { useAppKit } from '@reown/appkit/react'
export default function ConnectButton() {
// 4. Use modal hook
const { open } = useAppKit()
return (
<>
<button onClick={() => open()}>Open Connect Modal</button>
<button onClick={() => open({ view: 'Networks' })}>Open Network Modal</button>
</>
)
}
Learn more about the AppKit hooks here
To open AppKit you can use our web component or build your own button with AppKit hooks.
- Web Component
- Hooks
export default function ConnectButton() {
return <w3m-button />
}
Learn more about the AppKit web components here
Web components are global html elements that don't require importing.
You can trigger the modal by calling the open
function from useAppKit
hook.
import { useAppKit } from '@reown/appkit/react'
export default function ConnectButton() {
// 4. Use modal hook
const { open } = useAppKit()
return (
<>
<button onClick={() => open()}>Open Connect Modal</button>
<button onClick={() => open({ view: 'Networks' })}>Open Network Modal</button>
</>
)
}
Learn more about the AppKit hooks here
To open AppKit you can use our default web components or build your own logic using AppKit hooks.
- Components
- Hooks
export default function ConnectButton() {
return <w3m-button />
}
Learn more about the AppKit web components here
Web components are global html elements that don't require importing.
You can trigger the modal by calling the open
function from useAppKit
hook.
import { useAppKit } from '@reown/appkit/react'
export default function ConnectButton() {
// 4. Use modal hook
const { open } = useAppKit()
return (
<>
<button onClick={() => open()}>Open Connect Modal</button>
<button onClick={() => open({ view: 'Networks' })}>Open Network Modal</button>
</>
)
}
Learn more about the AppKit hooks here
Smart Contract Interaction
- Wagmi
- Ethers
- Solana
Wagmi hooks can help us interact with wallets and smart contracts:
import { useReadContract } from 'wagmi'
import { USDTAbi } from '../abi/USDTAbi'
const USDTAddress = '0x...'
function App() {
const result = useReadContract({
abi: USDTAbi,
address: USDTAddress,
functionName: 'totalSupply'
})
}
Read more about Wagmi hooks for smart contract interaction here.
Ethers can help us interact with wallets and smart contracts:
import { useAppKitProvider, useAppKitAccount } from "@reown/appkit/react"
import { BrowserProvider, Contract, formatUnits } from 'ethers'
const USDTAddress = '0x617f3112bf5397D0467D315cC709EF968D9ba546'
// The ERC-20 Contract ABI, which is a common contract interface
// for tokens (this is the Human-Readable ABI format)
const USDTAbi = [
'function name() view returns (string)',
'function symbol() view returns (string)',
'function balanceOf(address) view returns (uint)',
'function transfer(address to, uint amount)',
'event Transfer(address indexed from, address indexed to, uint amount)'
]
function Components() {
const { address, chainId, isConnected } = useAppKitAccount()
const { walletProvider } = useAppKitProvider()
async function getBalance() {
if (!isConnected) throw Error('User disconnected')
const ethersProvider = new BrowserProvider(walletProvider)
const signer = await ethersProvider.getSigner()
// The Contract object
const USDTContract = new Contract(USDTAddress, USDTAbi, signer)
const USDTBalance = await USDTContract.balanceOf(address)
console.log(formatUnits(USDTBalance, 18))
}
return <button onClick={getBalance}>Get User Balance</button>
}
@Solana/web3.js library allows for seamless interaction with wallets and smart contracts on the Solana blockchain.
For a practical example of how it works, you can refer to this demo app.
import {
SystemProgram,
PublicKey,
Keypair,
Transaction,
TransactionInstruction,
LAMPORTS_PER_SOL
} from '@solana/web3.js'
import { useAppKitAccount, useAppKitProvider } from '@reown/appkit/react'
function deserializeCounterAccount(data?: Buffer): { count: number } {
if (data?.byteLength !== 8) {
throw Error('Need exactly 8 bytes to deserialize counter')
}
return {
count: Number(data[0])
}
}
const { address, currentChain } = useAppKitAccount()
const { walletProvider, connection } = useAppKitProvider()
async function onIncrementCounter() {
const PROGRAM_ID = new PublicKey('Cb5aXEgXptKqHHWLifvXu5BeAuVLjojQ5ypq6CfQj1hy')
const counterKeypair = Keypair.generate()
const counter = counterKeypair.publicKey
const balance = await connection.getBalance(walletProvider.publicKey)
if (balance < LAMPORTS_PER_SOL / 100) {
throw Error('Not enough SOL in wallet')
}
const COUNTER_ACCOUNT_SIZE = 8
const allocIx: TransactionInstruction = SystemProgram.createAccount({
fromPubkey: walletProvider.publicKey,
newAccountPubkey: counter,
lamports: await connection.getMinimumBalanceForRentExemption(COUNTER_ACCOUNT_SIZE),
space: COUNTER_ACCOUNT_SIZE,
programId: PROGRAM_ID
})
const incrementIx: TransactionInstruction = new TransactionInstruction({
programId: PROGRAM_ID,
keys: [
{
pubkey: counter,
isSigner: false,
isWritable: true
}
],
data: Buffer.from([0x0])
})
const tx = new Transaction().add(allocIx).add(incrementIx)
tx.feePayer = walletProvider.publicKey
tx.recentBlockhash = (await connection.getLatestBlockhash('confirmed')).blockhash
await walletProvider.signAndSendTransaction(tx, [counterKeypair])
const counterAccountInfo = await connection.getAccountInfo(counter, {
commitment: 'confirmed'
})
if (!counterAccountInfo) {
throw new Error('Expected counter account to have been created')
}
const counterAccount = deserializeCounterAccount(counterAccountInfo?.data)
if (counterAccount.count !== 1) {
throw new Error('Expected count to have been 1')
}
console.log(`[alloc+increment] count is: ${counterAccount.count}`);
}
Extra configuration
Next.js relies on SSR. This means some specific steps are required to make Web3Modal work properly.
- Add the following code in the
next.config.js
file
// Path: next.config.js
const nextConfig = {
webpack: config => {
config.externals.push('pino-pretty', 'lokijs', 'encoding')
return config
}
}