JavaScript

Web3Modal SDK has support for Wagmi and Ethers v6. Choose one of these ethereum libraries to get started.

Installation

Wagmi v1

caution

Wagmi v2 support is currently in alpha.

npm

npm install @web3modal/wagmi@4.0.0-alpha.3 @wagmi/core @wagmi/connectors viem

Yarn

yarn add @web3modal/wagmi@4.0.0-alpha.3 @wagmi/core @wagmi/connectors viem

Bun

bun add @web3modal/wagmi@4.0.0-alpha.3 @wagmi/core @wagmi/connectors viem

pnpm

pnpm add @web3modal/wagmi@4.0.0-alpha.3 @wagmi/core @wagmi/connectors viem

Wagmi v2

npm

npm install @web3modal/wagmi@3.5.7 @wagmi/core@1.4.13 viem@1.21.4

Yarn

yarn add @web3modal/wagmi@3.5.7 @wagmi/core@1.4.13 viem@1.21.4

Bun

bun add @web3modal/wagmi@3.5.7 @wagmi/core@1.4.13 viem@1.21.4

pnpm

pnpm add @web3modal/wagmi@3.5.7 @wagmi/core@1.4.13 viem@1.21.4

Ethers

npm

npm install @web3modal/ethers5 ethers@5.7.2

Yarn

yarn add @web3modal/ethers5 ethers@5.7.2

Bun

bun add @web3modal/ethers5 ethers@5.7.2

pnpm

pnpm add @web3modal/ethers5 ethers@5.7.2

Ethers v5

npm

npm install @web3modal/ethers ethers

Yarn

yarn add @web3modal/ethers ethers

Bun

bun add @web3modal/ethers ethers

pnpm

pnpm add @web3modal/ethers ethers

Don't have a project ID?

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

Get started

Implementation

Wagmi v1

You can start Web3Modal configuration using either default or custom mode.

Default mode will implement WalletConnect, Browser Wallets (injected) and Coinbase options in addition to the WalletConnect's provider.

Default

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. Define constants
const projectId = 'YOUR_PROJECT_ID'

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

const chains = [mainnet, arbitrum]
export const config = defaultWagmiConfig({
  chains, // required
  projectId, // required
  metadata, // required
  enableWalletConnect: true, // Optional - true by default
  enableInjected: true, // Optional - true by default
  enableEIP6963: true, // Optional - true by default
  enableCoinbase: true, // Optional - true by default
  ...wagmiOptions // Optional - Override createConfig parameters
})

reconnect(config)

// 3. Create modal
const modal = createWeb3Modal({
  wagmiConfig: config,
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

Custom

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

import { createWeb3Modal } from '@web3modal/wagmi'

import { reconnect, http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
import { coinbaseWallet, walletConnect, injected } from '@wagmi/connectors'

// 1. Define constants
const projectId = 'YOUR_PROJECT_ID'

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

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http()
  },
  connectors: [
    walletConnect({ projectId, metadata, showQrModal: false }),
    injected({ shimDisconnect: true }),
    coinbaseWallet({
      appName: metadata.name,
      appLogoUrl: metadata.icons[0]
    })
  ]
})

reconnect(config)

const modal = createWeb3Modal({
  wagmiConfig: config,
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

Wagmi v2

You can start Web3Modal configuration using either default or custom mode.

Default mode will implement WalletConnect, Browser Wallets (injected) and Coinbase options in addition to Wagmi's public provider and WalletConnect's provider.

Default

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

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

import { mainnet, arbitrum } from 'viem/chains'

// 1. Define constants
const projectId = 'YOUR_PROJECT_ID'

// 2. Create wagmiConfig
const metadata = {
  name: 'Web3Modal',
  description: 'Web3Modal Example',
  url: 'https://web3modal.com',
  icons: ['https://avatars.githubusercontent.com/u/37784886']
}

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

const modal = createWeb3Modal({
  wagmiConfig: config,
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

Custom

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

import { createWeb3Modal, walletConnectProvider, EIP6963Connector } from '@web3modal/wagmi'

import { configureChains, createConfig } from '@wagmi/core'
import { mainnet } from 'viem/chains'
import { publicProvider } from '@wagmi/core/providers/public'
import { InjectedConnector } from '@wagmi/core'
import { CoinbaseWalletConnector } from '@wagmi/core/connectors/coinbaseWallet'
import { WalletConnectConnector } from '@wagmi/core/connectors/walletConnect'

// 1. Define constants
const projectId = 'YOUR_PROJECT_ID'

// 2. Configure wagmi client
const { chains, publicClient } = configureChains(
  [mainnet],
  [walletConnectProvider({ projectId }), publicProvider()]
)

const metadata = {
  name: 'Web3Modal',
  description: 'Web3Modal Example',
  url: 'https://web3modal.com',
  icons: ['https://avatars.githubusercontent.com/u/37784886']
}

const config = createConfig({
  autoConnect: true,
  connectors: [
    new WalletConnectConnector({ chains, options: { projectId, showQrModal: false, metadata } }),
    new EIP6963Connector({ chains }),
    new InjectedConnector({ chains, options: { shimDisconnect: true } }),
    new CoinbaseWalletConnector({ chains, options: { appName: metadata.name } })
  ],
  publicClient
})

const modal = createWeb3Modal({
  wagmiConfig: config,
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

note

The provided code utilizes Wagmi, a JavaScript library for wallet and provider connections, along with the Web3Modal library to create a wallet connection modal. It features various connectors:

1. WalletConnectConnector: Enables cross-device wallet connections using the WalletConnect protocol, adhering to EIP-1193.

2. EIP6963Connector: Connects to wallets supporting the EIP-6963 standard, an Ethereum wallet extension specification.

3. InjectedConnector: Interfaces with browser wallet injections, e.g., MetaMask.

4. CoinbaseWalletConnector: Specifically for Coinbase Wallet.

Additionally, there's a publicProvider for reading blockchain data through public nodes like Infura. The walletConnectProvider, which operates in a manner akin to the public provider but employs the Blockchain API, is additionally accessible. The WagmiConfig component shares wagmiConfig with child components.

Ethers

You can start Web3Modal configuration using either default or custom mode.

Default mode will implement WalletConnect, Browser Wallets (injected), EIP-6963 and Coinbase connectors.

Default

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

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

// 1. Get projectId
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 modal
const metadata = {
  name: 'My Website',
  description: 'My Website description',
  url: 'https://mywebsite.com', // origin must match your domain & subdomain
  icons: ['https://avatars.mywebsite.com/']
}

const modal = createWeb3Modal({
  ethersConfig: defaultConfig({ metadata }),
  chains: [mainnet],
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

Custom

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

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

// 1. Get projectId
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 modal
const metadata = {
  name: 'My Website',
  description: 'My Website description',
  url: 'https://mywebsite.com', // origin must match your domain & subdomain
  icons: ['https://avatars.mywebsite.com/']
}

const modal = createWeb3Modal({
  ethersConfig: defaultConfig({
    metadata,
    defaultChainId: 1,
    enableEIP6963: true,
    enableInjected: true,
    enableCoinbase: true,
    rpcUrl: '...' // used for the Coinbase SDK
  }),
  chains: [mainnet],
  enableAnalytics: true, // Optional - true by default
  projectId
})

Ethers v5

You can start Web3Modal configuration using either default or custom mode.

Default mode will implement WalletConnect, Browser Wallets (injected), EIP-6963 and Coinbase connectors.

Default

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

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

// 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 modal
const metadata = {
  name: 'My Website',
  description: 'My Website description',
  url: 'https://mywebsite.com', // origin must match your domain & subdomain
  icons: ['https://avatars.mywebsite.com/']
}

const modal = createWeb3Modal({
  ethersConfig: defaultConfig({ metadata }),
  chains: [mainnet],
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

Custom

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

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

// 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 modal
const metadata = {
  name: 'My Website',
  description: 'My Website description',
  url: 'https://mywebsite.com', // origin must match your domain & subdomain
  icons: ['https://avatars.mywebsite.com/']
}

const modal = createWeb3Modal({
  ethersConfig: defaultConfig({
    metadata,
    defaultChainId: 1,
    enableEIP6963: true,
    enableInjected: true,
    enableCoinbase: true,
    rpcUrl: '...' // used for the Coinbase SDK
  }),
  chains: [mainnet],
  projectId,
  enableAnalytics: true // Optional - defaults to your Cloud configuration
})

Trigger the modal

Wagmi v1

To open Web3Modal you can use our web components or build your own logic with Web3Modal actions

Components

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

Learn more about the Web3Modal web components here

note

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

Actions

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

Let's first add two html elements to display information to the user:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>HTML Example</title>
  </head>
  <body>
    <button id="btn">Connect</button>
    <span id="user"></span>
    <script type="module" src="main.js"></script>
  </body>
</html>

Following with our main.js file, we can now add the needed logic to open the modal and display information in the DOM:

//main.js
import { watchAccount, disconnect, getAccount } from '@wagmi/core'

function connect() {
  if (getAccount().isConnected) {
    disconnect()
  } else {
    modal.open()
  }
}

const btnEl = document.getElementById('btn')
const userEl = document.getElementById('user')

btnEl.addEventListener('click', connect)

// listening for account changes
watchAccount(wagmiConfig,
  {
    onChange(account) {
      userEl.innerText = account.address ?? ''
      if (account.isConnected) {
        btnEl.innerText = 'Disconnect'
      } else {
        btnEl.innerText = 'Connect'
      }
    }
  }

Learn more about the Web3Modal actions here

Wagmi v2

To open Web3Modal you can use our web components or build your own logic with Web3Modal actions

Components

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

Learn more about the Web3Modal web components here

note

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

Actions

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

Let's first add two html elements to display information to the user:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>HTML Example</title>
  </head>
  <body>
    <button id="btn">Connect</button>
    <span id="user"></span>
    <script type="module" src="main.js"></script>
  </body>
</html>

Following with our main.js file, we can now add the needed logic to open the modal and display information in the DOM:

//main.js
import { watchAccount, disconnect, getAccount } from '@wagmi/core'

function connect() {
  if (getAccount().isConnected) {
    disconnect()
  } else {
    modal.open()
  }
}

const btnEl = document.getElementById('btn')
const userEl = document.getElementById('user')

btnEl.addEventListener('click', connect)

// listening for account changes
watchAccount(account => {
  userEl.innerText = account.address ?? ''
  if (account.isConnected) {
    btnEl.innerText = 'Disconnect'
  } else {
    btnEl.innerText = 'Connect'
  }
})

Learn more about the Web3Modal actions here

Ethers

To open Web3Modal you can use our default web components or build your own logic with Web3Modal actions.

Components

  <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 Web3Modal web components here

note

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

actions

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.js 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 Web3Modal actions here

Ethers v5

To open Web3Modal you can use our default web components or build your own logic with Web3Modal actions.

Components

  <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 Web3Modal web components here

note

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

actions

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.js 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 Web3Modal actions here

Smart Contract Interaction

Wagmi v1

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.

Wagmi v2

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

const USDTAddress = '0x...'

const result = await readContract(wagmiConfig, {
  abi: USDTAbi,
  address: USDTAddress,
  functionName: 'totalSupply'
})

Read more about Wagmi actions for smart contract interaction here.

Ethers

import { ethers } from 'ethers'

const USDTAddress = '0x...'

// 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 (!walletProvider) throw Error('User disconnected')

  const ethersProvider = new ethers.providers.Web3Provider(walletProvider)
  const signer = await ethersProvider.getSigner()
  // The Contract object
  const USDTContract = new ethers.Contract(USDTAddress, USDTAbi, signer)
  const USDTBalance = await USDTContract.balanceOf(address)

  console.log(ethers.utils.formatUnits(USDTBalance, 18))
}

Ethers v5

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