If you’re using Cursor IDE (or another AI based IDE) to build a project with Reown AppKit, Reown provides a .mdc file that enhances your development experience. The reown-appkit.mdcfile here contains Cursor-specific rules and type hints for Reown AppKit.
To use it in your project:
Copy the reown-appkit.mdc file from this repository
Create a .cursor/rules folder in your project’s root directory (if it doesn’t exist)
Place the .mdc file in your project’s .cursor/rules folder
Reown offers a dedicated CLI to set up a minimal version of AppKit in the easiest and quickest way possible.
To do this, please run the command below.
npx @reown/appkit-cli
After running the command, you will be prompted to confirm the installation of the CLI. Upon your confirmation, the CLI will request the following details:
Project Name: Enter the name for your project.
Framework: Select your preferred framework or library. Currently, you have three options: React, Next.js, and Vue.
Network-Specific libraries: Choose whether you want to install Wagmi, Ethers, Solana, or Multichain (EVM + Solana).
After providing the project name and selecting your preferences, the CLI will install a minimal example of AppKit with your preferred blockchain library. The example will be pre-configured with a projectId that will only work on localhost.
To fully configure your project, please obtain a projectId from the Reown Cloud Dashboard and update your project accordingly.
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
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.comexport const projectId = process.env.NEXT_PUBLIC_PROJECT_IDif (!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
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.
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 queryClientconst queryClient = new QueryClient()if (!projectId) { throw new Error('Project ID is not defined')}// Set up metadataconst 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 modalconst 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
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
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.comexport const projectId = process.env.NEXT_PUBLIC_PROJECT_IDif (!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
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.
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 queryClientconst queryClient = new QueryClient()if (!projectId) { throw new Error('Project ID is not defined')}// Set up metadataconst 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 modalconst 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
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.
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.tsximport { createAppKit } from "@reown/appkit/react";import { SolanaAdapter } from "@reown/appkit-adapter-solana/react";import { solana, solanaTestnet, solanaDevnet } from "@reown/appkit/networks";// 0. Set up Solana Adapterconst solanaWeb3JsAdapter = new SolanaAdapter();// 1. Get projectId from https://cloud.reown.comconst projectId = "YOUR_PROJECT_ID";// 2. Create a metadata object - optionalconst 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 modalcreateAppKit({ adapters: [solanaWeb3JsAdapter], networks: [solana, solanaTestnet, solanaDevnet], metadata: metadata, projectId, features: { analytics: true, // Optional - defaults to your Cloud configuration },});export default function App() { return <YourApp />;}
AppKit Bitcoin provides a set of React components and hooks to easily connect Bitcoin 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.tsximport { createAppKit } from '@reown/appkit/react'import { BitcoinAdapter } from '@reown/appkit-adapter-bitcoin'import { bitcoin } from '@reown/appkit/networks'// 1. Get projectId from https://cloud.reown.comconst projectId = 'YOUR_PROJECT_ID'// 2. Set the networksconst networks = [bitcoin]// 3. Set up Bitcoin Adapterconst bitcoinAdapter = new BitcoinAdapter({ projectId})// 4. Create a metadata object - optionalconst metadata = { name: 'AppKit', description: 'AppKit Bitcoin Example', url: 'https://example.com', // origin must match your domain & subdomain icons: ['https://avatars.githubusercontent.com/u/179229932']}// 5. Create modalcreateAppKit({ adapters: [bitcoinAdapter], networks, metadata, projectId, features: { analytics: true // Optional - defaults to your Cloud configuration, email: false, socials: [] }})export default function App() { return <YourApp />}
export type SignMessageParams = { /** * The message to be signed */ message: string /** * The address to sign the message with */ address: string }
export type SignMessageParams = { /** * The message to be signed */ message: string /** * The address to sign the message with */ address: string }
export type SendTransferParams = { /** * The amount to be sent in satoshis */ amount: string /** * The address to send the transfer to */ recipient: string }
export type SignPSBTParams = { /** * The PSBT to be signed, string base64 encoded */ psbt: string signInputs: { /** * The address whose private key to use for signing. */ address: string /** * Specifies which input to sign */ index: number /** * Specifies which part(s) of the transaction the signature commits to */ sighashTypes: number[] }[] /** * If `true`, the PSBT will be broadcasted after signing. Default is `false`. */ broadcast?: boolean}
export type AccountAddress = { /** * Public address belonging to the account. */ address: string /** * Public key for the derivation path in hex, without 0x prefix */ publicKey?: string /** * The derivation path of the address e.g. "m/84'/0'/0'/0/0" */ path?: string /** * The purpose of the address */ purpose: 'payment' | 'ordinal' | 'stx' }
export type AccountAddress = { /** * Public address belonging to the account. */ address: string /** * Public key for the derivation path in hex, without 0x prefix */ publicKey?: string /** * The derivation path of the address e.g. "m/84'/0'/0'/0/0" */ path?: string /** * The purpose of the address */ purpose: 'payment' | 'ordinal' | 'stx' }
export type SignPSBTResponse = { /** * The signed PSBT, string base64 encoded */ psbt: string /** * The `string` transaction id of the broadcasted transaction or `undefined` if not broadcasted */ txid?: string }
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 <appkit-button> component.
Web components are global html elements that don’t require importing.
export default function ConnectButton() { return <appkit-button />}
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 <appkit-button> component.
Web components are global html elements that don’t require importing.
export default function ConnectButton() { return <appkit-button />}
To open AppKit you can use our default web components or build your own logic using AppKit hooks.
In this example we are going to use the <appkit-button> component.
Web components are global html elements that don’t require importing.
export default function ConnectButton() { return <appkit-button />}