Vue

Introduction

AppKit has support for Wagmi, Ethers and @solana/web3.js on Solana. Choose one of these ethereum libraries or solana 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

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

Solana

npm

npm install @web3modal/solana/vue

Yarn

yarn add @web3modal/solana/vue

Bun

bun add @web3modal/solana/vue

pnpm

pnpm add @web3modal/solana/vue

Don't have a project ID?

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

Get started

Cloud Configuration

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

Implementation

Wagmi

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

info

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

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'
  import { reconnect } from '@wagmi/core'

  // 1. Define constants
  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]
  const config = defaultWagmiConfig({
    chains,
    projectId,
    metadata,
    ...wagmiOptions // Optional - Override createConfig parameters
  })

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

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

Ethers

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

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

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

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.

Ethers v5

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

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

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

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

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.

Solana

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

<script setup lang="ts">
import { createWeb3Modal, defaultSolanaConfig } from '@web3modal/solana/vue'
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: 'Web3Modal',
  description: 'Web3Modal Solana Example',
  url: 'https://web3modal.com', // origin must match your domain & subdomain
  icons: ['https://avatars.githubusercontent.com/u/37784886']
}

// 4. Create Solana config
const solanaConfig = defaultSolanaConfig({
  metadata,
  chains,
  projectId
})

// 5. Create a Web3Modal instance
createWeb3Modal({
  solanaConfig,
  chains,
  projectId,
  wallets: [
      // Solana wallet adapters (check Custom connectors for more info)
  ]
})

</script>

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

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.

Trigger the modal

Wagmi

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

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

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

Learn more about the AppKit web components here

Ethers

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

Web Components

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

Learn more about the AppKit 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

Ethers v5

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

Web Components

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

Learn more about the AppKit 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

Solana

To open Web3Modal you can use our web component or build your own button with the Web3Modal composables.

Web 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/solana/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

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

<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

Ethers can help us interact with wallets and smart contracts:

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

Solana

@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 { ref } from 'vue';
import {
  SystemProgram,
  PublicKey,
  Keypair,
  Transaction,
  TransactionInstruction,
  LAMPORTS_PER_SOL
} from '@solana/web3.js';
import { useWeb3ModalAccount, useWeb3ModalProvider } from '@web3modal/solana/react';

export default {
  setup() {
    const counterMessage = ref('');
    const { address, currentChain } = useWeb3ModalAccount();
    const { walletProvider, connection } = useWeb3ModalProvider();

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

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

    async function onIncrementCounter() {
      try {
        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');
        }

        counterMessage.value = `[alloc+increment] count is: ${counterAccount.count}`;
      } catch (error) {
        console.error(error);
        counterMessage.value = `Error: ${error.message}`;
      }
    }

    return {
      onIncrementCounter,
      counterMessage
    };
  }
};