Installation - Reown Docs

Introduction#

AppKit has support for Wagmi and Ethers v6 on Ethereum, @solana/web3.js on Solana, Bitcoin, TON and TRON. Choose one of these to get started.

Installation#

Try installing AppKit Skills to get AI-assisted guidance. Your AI coding assistant can help you set up, build, and debug your AppKit integration.

To install AppKit Skills, run the following command in your terminal:

npx skills add https://github.com/reown-com/skills --skill appkit --agent '*'

After installation, you can ask your AI assistant for help with AppKit setup, implementation, and troubleshooting.

Custom Installation#

Warning

AppKit is only compatible with wagmi 2.x. Ensure you are using a compatible version.

npm install @reown/appkit @reown/appkit-adapter-wagmi @tanstack/vue-query @wagmi/vue viem

npm install @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2

npm install @reown/appkit @reown/appkit-adapter-ethers ethers

npm install @reown/appkit @reown/appkit-adapter-solana

npm install @reown/appkit @reown/appkit-adapter-bitcoin

npm install @reown/appkit @reown/appkit-adapter-ton

npm install @reown/appkit @reown/appkit-adapter-tron

Don't have a project ID?

Head over to Reown Dashboard and create a new project.

Cloud Configuration#

Create a new project on Reown Dashboard and obtain a new project ID.

Implementation#

wagmi Example

Check the Vue wagmi example

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

Note

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 lang="ts" setup>  import { createAppKit } from '@reown/appkit/vue'  import { arbitrum, mainnet, type AppKitNetwork } from '@reown/appkit/networks'  import { WagmiAdapter } from '@reown/appkit-adapter-wagmi'  // 1. Get projectId from https://dashboard.reown.com  const projectId = 'YOUR_PROJECT_ID'  // 2. Create a metadata object  const metadata = {    name: 'AppKit',    description: 'AppKit Example',    url: 'https://example.com', // origin must match your domain & subdomain    icons: ['https://avatars.githubusercontent.com/u/179229932']  }  // 3. Set the networks  const networks: [AppKitNetwork, ...AppKitNetwork[]] = [mainnet, polygon, base]  // 4. Create Wagmi Adapter  const wagmiAdapter = new WagmiAdapter({    networks,    projectId  })  // 5. Create the modal  const modal = createAppKit({    adapters: [wagmiAdapter],    networks,    projectId,    metadata,    features: {      analytics: true // Optional - defaults to your Cloud configuration    }  })</script><template> // Rest of your app ... </template>

Importing networks#

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/vue'import { mainnet, arbitrum, base, scroll, polygon } from '@reown/appkit/networks'

Note

Looking to add a custom network? Check out the custom networks section.

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

<script setup lang="ts">  import { createAppKit, useAppKit } from "@reown/appkit/vue";  import { Ethers5Adapter } from "@reown/appkit-adapter-ethers5";  import { mainnet, arbitrum } from "@reown/appkit/networks";  // 1. Get projectId at https://dashboard.reown.com  const projectId = "YOUR_PROJECT_ID";  function getBlockchainApiRpcUrl(chainId) {    return `https://rpc.walletconnect.org/v1/?chainId=eip155:${chainId}&projectId=${projectId}`;  }  // 2. 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/"],  };  // 3. Create a AppKit instance  createAppKit({    adapters: [new Ethers5Adapter()],    networks: [mainnet, arbitrum],    projectId,    features: {      analytics: true, // Optional - defaults to your Cloud configuration    },  });  // 4. Use modal composable  const modal = useAppKit();</script><template> // Rest of your app ... </template>

Warning

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 Example

Check the Vue ethers example

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

<script setup lang="ts">  import { createAppKit, useAppKit } from "@reown/appkit/vue";  import { EthersAdapter } from "@reown/appkit-adapter-ethers";  import { mainnet, arbitrum } from "@reown/appkit/networks";  // 1. Get projectId from https://dashboard.reown.com  const projectId = "YOUR_PROJECT_ID";  // 2. 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/"],  };  // 3. Create a AppKit instance  createAppKit({    adapters: [new EthersAdapter()],    networks: [mainnet, arbitrum],    metadata,    projectId,    features: {      analytics: true, // Optional - defaults to your Cloud configuration    },  });  // 4. Use modal composable  const modal = useAppKit();</script><template> // Rest of your app ... </template>

Warning

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.

Warning

MetaMask does not currently support WalletConnect connections on Solana. The MetaMask team is working on adding this feature. In the meantime, we recommend using other wallets that support Solana. You can find the complete list of supported wallets on WalletGuide.

Solana Example

Check the Vue Solana example

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

<script setup lang="ts">  import { createAppKit, useAppKit } from "@reown/appkit-solana/vue";  import { SolanaAdapter } from "@reown/appkit-adapter-solana/vue";  import { solana, solanaTestnet, solanaDevnet } from "@reown/appkit/networks";  // 1. Get projectId from https://dashboard.reown.com  const projectId = "YOUR_PROJECT_ID";  // 2. Set up metadata  const 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. Set up Solana Adapter  const solanaWeb3JsAdapter = new SolanaAdapter();  // 4. Create modal  createAppKit({    adapters: [solanaWeb3JsAdapter],    metadata,    networks: [solana, solanaTestnet, solanaDevnet],    projectId  });</script><template> // Rest of your app ... </template>

Warning

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.

Bitcoin Example

Check the Vue Bitcoin example

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.

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

<script setup lang="ts">import { createAppKit } from '@reown/appkit/react'import { BitcoinAdapter } from '@reown/appkit-adapter-bitcoin'import { bitcoin, bitcoinTestnet, bitcoinSignet } from '@reown/appkit/networks'// 1. Get projectId from https://dashboard.reown.comconst projectId = 'YOUR_PROJECT_ID'// 2. Set the networksconst networks = [bitcoin, bitcoinTestnet, bitcoinSignet]// 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: []  }})</script><template> // Rest of your app ... </template>

Bitcoin Provider Interface#

export interface BitcoinConnector extends ChainAdapterConnector, Provider {  getAccountAddresses(): Promise<BitcoinConnector.AccountAddress[]>;  signMessage(params: BitcoinConnector.SignMessageParams): Promise<string>;  sendTransfer(params: BitcoinConnector.SendTransferParams): Promise<string>;  signPSBT(    params: BitcoinConnector.SignPSBTParams  ): Promise<BitcoinConnector.SignPSBTResponse>;}

Parameters#

  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}

Responses#

  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  }

TON Example

Check the Vue TON example

AppKit TON provides a set of Vue components and composables to easily connect TON wallets with your application.

On top of your app set up the following configuration, making sure that all functions are called outside any Vue component to avoid unwanted rerenders.

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

<script setup lang="ts">import { createAppKit } from '@reown/appkit/vue'import { TonAdapter } from '@reown/appkit-adapter-ton'import { ton, tonTestnet } from '@reown/appkit/networks'// 1. Get projectId from https://dashboard.reown.comconst projectId = 'YOUR_PROJECT_ID'// 2. Set the networksconst networks = [ton, tonTestnet]// 3. Set up TON Adapterconst tonAdapter = new TonAdapter({  projectId})// 4. Create a metadata object - optionalconst metadata = {  name: 'AppKit',  description: 'AppKit TON Example',  url: 'https://example.com', // origin must match your domain & subdomain  icons: ['https://avatars.githubusercontent.com/u/179229932']}// 5. Create modalcreateAppKit({  adapters: [tonAdapter],  networks,  metadata,  projectId,  features: {    analytics: true // Optional - defaults to your Cloud configuration,    email: false,    socials: []  }})</script><template> // Rest of your app ... </template>

AppKit TRON provides a set of Vue components and composables to easily connect TRON wallets with your application.

On top of your app set up the following configuration, making sure that all functions are called outside any Vue component to avoid unwanted rerenders.

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

<script setup lang="ts">import { createAppKit } from '@reown/appkit/vue'import { TronAdapter } from '@reown/appkit-adapter-tron'import { tronMainnet } from '@reown/appkit/networks'// Import wallet adapters you want to supportimport { TronLinkAdapter } from '@tronweb3/tronwallet-adapter-tronlink'// 1. Get projectId from https://dashboard.reown.comconst projectId = 'YOUR_PROJECT_ID'// 2. Set the networksconst networks = [tronMainnet]// 3. Set up TRON Adapter with wallet adaptersconst tronAdapter = new TronAdapter({  walletAdapters: [    new TronLinkAdapter({      openUrlWhenWalletNotFound: false,      checkTimeout: 3000    })  ]})// 4. Create a metadata object - optionalconst metadata = {  name: 'AppKit',  description: 'AppKit TRON Example',  url: 'https://example.com', // origin must match your domain & subdomain  icons: ['https://avatars.githubusercontent.com/u/179229932']}// 5. Create modalcreateAppKit({  adapters: [tronAdapter],  networks,  metadata,  projectId,  features: {    analytics: true, // Optional - defaults to your Cloud configuration    email: false,    socials: []  }})</script><template> // Rest of your app ... </template>

Install Wallet Adapters#

TRON adapter requires you to install wallet adapters separately. This gives you control over which wallets to support and reduces bundle size.

npm install @tronweb3/tronwallet-adapter-tronlink

npm install @tronweb3/tronwallet-adapter-metamask-tron

npm install @tronweb3/tronwallet-adapter-trust

npm install @tronweb3/tronwallet-adapter-okxwallet

npm install @tronweb3/tronwallet-adapter-bitkeep

npm install @tronweb3/tronwallet-adapter-binance

Note

For a complete list of available TRON wallet adapters, visit the official wallet adapter documentation.

Using Multiple Wallet Adapters#

After installing your desired wallet adapters, import and add them to the walletAdapters array when creating the TRON adapter:

import { TronLinkAdapter } from '@tronweb3/tronwallet-adapter-tronlink'import { MetaMaskAdapter } from '@tronweb3/tronwallet-adapter-metamask-tron'import { TrustAdapter } from '@tronweb3/tronwallet-adapter-trust'import { OkxWalletAdapter } from '@tronweb3/tronwallet-adapter-okxwallet'const tronAdapter = new TronAdapter({  walletAdapters: [    new TronLinkAdapter({      openUrlWhenWalletNotFound: false,      checkTimeout: 3000    }),    new MetaMaskAdapter(),    new TrustAdapter(),    new OkxWalletAdapter({      openUrlWhenWalletNotFound: false    })  ]})

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

<template>  <appkit-button /></template>

To open AppKit Core you need to call the connect function from the Universal Connector.

<script setup lang="ts">import { ref } from 'vue'let session = ref(null)async function handleConnect() {  // universalConnector is the universal connector instance from the implementation section  if (!universalConnector) {    return  }  const { session: providerSession } = await universalConnector.connect()  session.value = providerSession}async function handleDisconnect() {  if (!universalConnector) {    return  }  await universalConnector.disconnect()  session.value = null}</script><template>  <div>    <button @click="handleConnect">Open AppKit Core</button>    <button @click="handleDisconnect">Disconnect</button>  </div></template>

Smart Contract Interaction#

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 can help us interact with wallets and smart contracts:

<script setup lang="ts">  import { useAppKitProvider, useAppKitAccount } from '@reown/appkit/vue'  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)'  ]  function Components() {    const { address, isConnected } = useAppKitAccount()    const { walletProvider } = useAppKitProvider('eip155')    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))    }    return <button onClick={getBalance}>Get User Balance</button>  }</script>

@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 our lab dApp.

import { ref } from 'vue';import {  SystemProgram,  PublicKey,  Keypair,  Transaction,  TransactionInstruction,  LAMPORTS_PER_SOL} from '@solana/web3.js';import { useAppKitAccount, useAppKitProvider } from '@reown/appkit/vue'import { useAppKitConnection, type Provider } from '@reown/appkit-adapter-solana/vue'export default {  setup() {    const counterMessage = ref('');    const { address } = useAppKitAccount();    const { connection } = useAppKitConnection()    const { walletProvider } = useAppKitProvider<Provider>('solana')    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    };  }};

Alternative Installation#

If you are starting from scratch, you can use the following methods to set up your project with Reown AppKit.

AppKit Skills

AppKit Skills provide AI-powered assistance for building with Reown AppKit. Once installed, your AI coding assistant can help you set up, build, and debug your AppKit integration.

To install AppKit Skills, run the following command in your terminal:

npx skills add https://github.com/reown-com/skills --skill appkit --agent '*'

After installation, you can ask your AI assistant for help with AppKit setup, implementation, and troubleshooting.

AppKit CLI

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 Dashboard and update your project accordingly.

Refer to this section for more information.

Introduction#

Installation#

Custom Installation#

Cloud Configuration#

Implementation#

Importing networks#

Bitcoin Provider Interface#

Parameters#

Responses#

Install Wallet Adapters#

Using Multiple Wallet Adapters#

Trigger the modal#

Smart Contract Interaction#

Alternative Installation#