JavaScript

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.

Note

We recommend using Vite to get started with AppKit JavaScript.

Installation

Wagmi
Ethers
Ethers v5
Solana

npm
Yarn
Bun
pnpm

npm install @web3modal/wagmi @wagmi/core @wagmi/connectors viem

yarn add @web3modal/wagmi @wagmi/core @wagmi/connectors viem

bun add @web3modal/wagmi @wagmi/core @wagmi/connectors viem

pnpm add @web3modal/wagmi @wagmi/core @wagmi/connectors viem

npm
Yarn
Bun
pnpm

npm install @web3modal/ethers5 ethers@5.7.2

yarn add @web3modal/ethers5 ethers@5.7.2

bun add @web3modal/ethers5 ethers@5.7.2

pnpm add @web3modal/ethers5 ethers@5.7.2

npm
Yarn
Bun
pnpm

npm install @web3modal/ethers ethers

yarn add @web3modal/ethers ethers

bun add @web3modal/ethers ethers

pnpm add @web3modal/ethers ethers

npm
Yarn
Bun
pnpm

npm install @web3modal/solana

yarn add @web3modal/solana

bun add @web3modal/solana

pnpm add @web3modal/solana

Cloud Configuration

Create a new project on WalletConnect Cloud at https://cloud.walletconnect.com and obtain a new project ID.

Don't have a project ID?

Head over to WalletConnect Cloud and create a new project now!

Get started

Implementation

Wagmi
Ethers
Ethers v5
Solana

For a quick integration you can use defaultWagmiConfig function which wraps Wagmi's createConfig function with a predefined configuration. This includes WalletConnect, Coinbase and Injected connectors, and the Blockchain API as a transport

In your main.ts file set up the following configuration.

import { createWeb3Modal, defaultWagmiConfig } from '@web3modal/wagmi'

import { mainnet, arbitrum } from 'viem/chains'
import { reconnect } from '@wagmi/core'

// 1. Get a project ID at https://cloud.walletconnect.com
const projectId = 'YOUR_PROJECT_ID'

// 2. Create wagmiConfig
const metadata = {
  name: 'AppKit',
  description: 'AppKit Example',
  url: 'https://web3modal.com', // origin must match your domain & subdomain.
  icons: ['https://avatars.githubusercontent.com/u/37784886']
}

const chains = [mainnet, arbitrum] as const
export const config = defaultWagmiConfig({
  chains,
  projectId,
  metadata,
})
reconnect(config)

// 3. Create modal
const modal = createWeb3Modal({
  wagmiConfig: config,
  projectId,
})

In your main.ts file set up the following configuration.

import { createWeb3Modal, defaultConfig } from '@web3modal/ethers5'

// 1. Get projectId at https://cloud.walletconnect.com
const projectId = 'YOUR_PROJECT_ID'

// 2. Set chains
const mainnet = {
  chainId: 1,
  name: 'Ethereum',
  currency: 'ETH',
  explorerUrl: 'https://etherscan.io',
  rpcUrl: 'https://cloudflare-eth.com'
}

// 3. Create your application's metadata object
const metadata = {
  name: 'My Website',
  description: 'My Website description',
  url: 'https://mywebsite.com', // url must match your domain & subdomain
  icons: ['https://avatars.mywebsite.com/']
}

// 4. Create Ethers config
const ethersConfig = defaultConfig({
  /*Required*/
  metadata,

  /*Optional*/
  enableEIP6963: true, // true by default
  enableInjected: true, // true by default
  enableCoinbase: true, // true by default
  rpcUrl: '...', // used for the Coinbase SDK
  defaultChainId: 1 // used for the Coinbase SDK
})

// 5. Create a AppKit instance
const modal = createWeb3Modal({
  ethersConfig,
  chains: [mainnet],
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

IMPORTANT

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 your main.ts file set up the following configuration.

import { createWeb3Modal, defaultConfig } from '@web3modal/ethers'

// 1. Get projectId from https://cloud.walletconnect.com
const projectId = 'YOUR_PROJECT_ID'

// 2. Set chains
const mainnet = {
  chainId: 1,
  name: 'Ethereum',
  currency: 'ETH',
  explorerUrl: 'https://etherscan.io',
  rpcUrl: 'https://cloudflare-eth.com'
}

// 3. Create your application's metadata object
const metadata = {
  name: 'My Website',
  description: 'My Website description',
  url: 'https://mywebsite.com', // url must match your domain & subdomain
  icons: ['https://avatars.mywebsite.com/']
}

// 4. Create Ethers config
const ethersConfig = defaultConfig({
  /*Required*/
  metadata,

  /*Optional*/
  enableEIP6963: true, // true by default
  enableInjected: true, // true by default
  enableCoinbase: true, // true by default
  rpcUrl: '...', // used for the Coinbase SDK
  defaultChainId: 1 // used for the Coinbase SDK
})

// 5. Create a AppKit instance
const modal = createWeb3Modal({
  ethersConfig,
  chains: [mainnet],
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

IMPORTANT

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 is built on top of the AppKit library and provides a set of components and actions 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.

import { createWeb3Modal, defaultSolanaConfig } from '@web3modal/solana'
import { solana, solanaTestnet, solanaDevnet } from '@web3modal/solana/chains'

// 0. Setup chains
const chains = [solana, solanaTestnet, solanaDevnet]

// 1. Get projectId from https://cloud.walletconnect.com
const projectId = 'YOUR_PROJECT_ID'

// 2. Create solanaConfig
const metadata = {
  name: 'AppKit',
  description: 'AppKit Solana Example',
  url: 'https://web3modal.com', // origin must match your domain & subdomain
  icons: ['https://avatars.githubusercontent.com/u/37784886']
}

const solanaConfig = defaultSolanaConfig({
  metadata,
  chains,
  projectId
})

// 3. Create modal
const modal = createWeb3Modal({
  solanaConfig,
  chains,
  projectId,
  wallets: [
      // Solana wallet adapters (check Custom connectors for more info)
  ]
})

Wagmi
Ethers
Ethers v5
Solana

To open AppKit you can use our web component or build your own button with AppKit actions. In this example we are going to use the <w3m-button> component.

Web components are global html elements that don't require importing.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>HTML Example</title>
  </head>
  <body>
    <w3m-button></w3m-button>
    <script type="module" src="main.ts"></script>
  </body>
</html>

Learn more about the AppKit web components here

To open AppKit you can use our web component or build your own button with AppKit actions.

Web Component
actions

  <body>
    <div id="app">
      <w3m-button></w3m-button>
      <w3m-network-button> </w3m-network-button>
    </div>
    <script type="module" src="/src/main.js"></script>
  </body>
</html>

Learn more about the AppKit web components here

note

Web components are global html elements that don't require importing.

You can trigger the modal by calling the open function from a modal instance returned by createWeb3Modal.

Let's first add two html button elements into our index.html file:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>HTML Example</title>
  </head>
  <body>
    <button id="open-connect-modal">Open Modal</button>
    <button id="open-network-modal">Open Networks</button>
    <script type="module" src="main.js"></script>
  </body>
</html>

Following with our main.ts file, we can now add the needed logic to open the modal:

const openConnectModalBtn = document.getElementById('open-connect-modal')
const openNetworkModalBtn = document.getElementById('open-network-modal')

openConnectModalBtn.addEventListener('click', () => modal.open())
openNetworkModalBtn.addEventListener('click', () => modal.open({ view: 'Networks' }))

Learn more about the AppKit actions here

To open AppKit you can use our web component or build your own button with AppKit actions.

Web Component
actions

  <body>
    <div id="app">
      <w3m-button></w3m-button>
      <w3m-network-button> </w3m-network-button>
    </div>
    <script type="module" src="/src/main.js"></script>
  </body>
</html>

Learn more about the AppKit web components here

note

Web components are global html elements that don't require importing.

You can trigger the modal by calling the open function from a modal instance returned by createWeb3Modal.

Let's first add two html button elements into our index.html file:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>HTML Example</title>
  </head>
  <body>
    <button id="open-connect-modal">Open Modal</button>
    <button id="open-network-modal">Open Networks</button>
    <script type="module" src="main.js"></script>
  </body>
</html>

Following with our main.ts file, we can now add the needed logic to open the modal:

const openConnectModalBtn = document.getElementById('open-connect-modal')
const openNetworkModalBtn = document.getElementById('open-network-modal')

openConnectModalBtn.addEventListener('click', () => modal.open())
openNetworkModalBtn.addEventListener('click', () => modal.open({ view: 'Networks' }))

Learn more about the AppKit actions here

To open AppKit you can use our web component or build your own button with AppKit actions. In this example we are going to use the <w3m-button> component.

Web components are global html elements that don't require importing.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>HTML Example</title>
  </head>
  <body>
    <w3m-button></w3m-button>
    <script type="module" src="main.ts"></script>
  </body>
</html>

Learn more about the AppKit web components here

Smart Contract Interaction

Wagmi
Ethers
Solana

Wagmi actions can help us interact with wallets and smart contracts:

import { readContract } from '@wagmi/core'
import { USDTAbi } from '../abi/USDTAbi'

const USDTAddress = '0x...'

const data = readContract({
  address: USDTAddress,
  abi: USDTAbi,
  functionName: 'symbol'
})

Read more about Wagmi actions for smart contract interaction here.

Ethers can help us interact with wallets and smart contracts:

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)'
]

const walletProvider = modal.getWalletProvider()

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))
}

@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 { useWeb3ModalAccount, useWeb3ModalProvider } from '@web3modal/solana/react'

function deserializeCounterAccount(data) {
  if (data?.byteLength !== 8) {
    throw Error('Need exactly 8 bytes to deserialize counter')
  }

  return {
    count: Number(data[0])
  }
}

const { address, currentChain } = useWeb3ModalAccount()
const { walletProvider, connection } = useWeb3ModalProvider()

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 = SystemProgram.createAccount({
    fromPubkey: walletProvider.publicKey,
    newAccountPubkey: counter,
    lamports: await connection.getMinimumBalanceForRentExemption(COUNTER_ACCOUNT_SIZE),
    space: COUNTER_ACCOUNT_SIZE,
    programId: PROGRAM_ID
  })

  const incrementIx = 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}`);
}

JavaScript

Installation​

Cloud Configuration​

Don't have a project ID?

Implementation​

Trigger the modal​

Smart Contract Interaction​

Installation

Cloud Configuration

Implementation

Trigger the modal

Smart Contract Interaction