Vue

Introduction

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

Installation

Wagmi

npm

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

Yarn

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

Bun

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

pnpm

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

Wagmi v1

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

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 App.vue file set up the following configuration.

<script setup>
  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]
  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
  })

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

<template> // Rest of your app ... </template>

Custom

In your App.vue file set up the following configuration.

<script setup lang="ts">
  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)
  // 3. Create modal
  createWeb3Modal({
    wagmiConfig: config,
    projectId,
    enableAnalytics: true // Optional - defaults to your Cloud configuration
  })
</script>

<template> // Rest of your app ... </template>

info

If you're using Nuxt, you can set wagmi's ssr option to true and call the reconnect function after your application mounts.

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 Wagmi's public provider and WalletConnect's provider.

Default

In your App.vue file set up the following configuration.

<script setup>
  import { createWeb3Modal, defaultWagmiConfig } from '@web3modal/wagmi/vue'
  import { mainnet, arbitrum } from 'viem/chains'

  // 1. Get projectId at https://cloud.walletconnect.com
  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 wagmiConfig = defaultWagmiConfig({ chains, projectId, metadata })

  // 3. Create modal
  createWeb3Modal({
    wagmiConfig,
    projectId,
    chains,
    enableAnalytics: true // Optional - defaults to your Cloud configuration
  })
</script>

<template> // Rest of your app ... </template>

Custom

In your App.vue file set up the following configuration.

<script setup lang="ts">
  import { createWeb3Modal } from '@web3modal/wagmi/vue'
  import { 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 wagmiConfig = 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
  })

  // 3. Create modal
  createWeb3Modal({
    wagmiConfig,
    projectId,
    chains,
    enableAnalytics: true // Optional - defaults to your Cloud configuration
  })
</script>

<template> // Rest of your app ... </template>

note

The provided code utilizes Wagmi, a Vue 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 App.vue file set up the following configuration.

<script setup>
  import { createWeb3Modal, defaultConfig } from '@web3modal/ethers5/vue'

  // 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/']
  }

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

<template> // Rest of your app ... </template>

Custom

In your App.vue file set up the following configuration.

<script setup lang="ts">
  import { createWeb3Modal, defaultConfig } from '@web3modal/ethers5/vue'

  // 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/']
  }

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

<template> // Rest of your app ... </template>

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 App.vue file set up the following configuration.

<script setup>
  import { createWeb3Modal, defaultConfig } from '@web3modal/ethers/vue'

  // 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/']
  }

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

<template> // Rest of your app ... </template>

Custom

In your App.vue file set up the following configuration.

<script setup lang="ts">
  import { createWeb3Modal, defaultConfig } from '@web3modal/ethers/vue'

  // 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/']
  }

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

<template> // Rest of your app ... </template>

Trigger the modal

Wagmi

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

Components

<template>
  <w3m-button />
</template>

Learn more about the Web3Modal web components here

note

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

Composables

You can trigger the modal by calling the open method from useWeb3Modal composable.

<script setup lang="ts">
  import { useWeb3Modal } from '@web3modal/wagmi/vue'
  // 4. Use modal composable
  const modal = useWeb3Modal()
</script>

<template>
  <button @click="modal.open()">Open Connect Modal</button>
  <button @click="modal.open({ view: 'Networks' })">Open Network Modal</button>
</template>

Learn more about the Web3Modal composables here

Wagmi v1

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

Components

<template>
  <w3m-button />
</template>

Learn more about the Web3Modal web components here

note

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

Composables

You can trigger the modal by calling the open method from useWeb3Modal composable.

<script setup lang="ts">
  import { useWeb3Modal } from '@web3modal/wagmi/vue'
  // 4. Use modal composable
  const modal = useWeb3Modal()
</script>

<template>
  <button @click="modal.open()">Open Connect Modal</button>
  <button @click="modal.open({ view: 'Networks' })">Open Network Modal</button>
</template>

Learn more about the Web3Modal composables here

Ethers

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

Components

<template>
  <w3m-button />
</template>

Learn more about the Web3Modal web components here

note

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

Composables

You can trigger the modal by calling the open method from useWeb3Modal composable.

<script setup lang="ts">
  import { useWeb3Modal } from '@web3modal/ethers5/vue'
  // 4. Use modal composable
  const modal = useWeb3Modal()
</script>

<template>
  <button @click="modal.open()">Open Connect Modal</button>
  <button @click="modal.open({ view: 'Networks' })">Open Network Modal</button>
</template>

Learn more about the Web3Modal composables here

Ethers v5

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

Components

<template>
  <w3m-button />
</template>

Learn more about the Web3Modal web components here

note

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

Composables

You can trigger the modal by calling the open method from useWeb3Modal composable.

<script setup lang="ts">
  import { useWeb3Modal } from '@web3modal/ethers/vue'
  // 4. Use modal composable
  const modal = useWeb3Modal()
</script>

<template>
  <button @click="modal.open()">Open Connect Modal</button>
  <button @click="modal.open({ view: 'Networks' })">Open Network Modal</button>
</template>

Learn more about the Web3Modal composables here

Smart Contract Interaction

Wagmi

<script setup lang="ts">
  import { readContract } from '@wagmi/core'
  import { USDTAbi } from '../abi/USDTAbi'

  const USDTAddress = '0x...'

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

Read more about Wagmi actions for smart contract interaction here.

Wagmi v1

<script setup lang="ts">
  import { readContract } from '@wagmi/core'
  import { USDTAbi } from '../abi/USDTAbi'

  const USDTAddress = '0x...'

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

Read more about Wagmi actions for smart contract interaction here.

Ethers

<script setup lang="ts">
  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))
  }
</script>

Ethers v5

<script setup lang="ts">
  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))
  }
</script>