Using the VeChain dApp kit

1. Create the node options

1. Optional: Wallet Connect Options

import type { WalletConnectOptions } from '@vechain/dapp-kit';

const walletConnectOptions: WalletConnectOptions = {
    // Create your project here:
    projectId: '<PROJECT_ID>', 
    metadata: {
        name: 'My dApp',
        description: 'My dApp description',
        // Your app URL
        url: window.location.origin, 
        // Your app Icon
        icons: [`${window.location.origin}/images/my-dapp-icon.png`], 

2. Initialise the DAppKit instance

For more information on using connex, please refer to the Connex documentation.

import { DAppKit } from '@vechain/dapp-kit';

const {thor, vendor, wallet} = new DAppKit({
  // Required - The URL of the node to connect to
  nodeUrl: "", 
  // Optional - "main" | "test" | Connex.Thor.Block
  genesis: "test", 
  // Optional - Wallet connect options
  walletConnectOptions: walletConnectOptions, 
  // Optional - Defaults to false. If true, account and source will be persisted in local storage
  usePersistence: true, 
  // Optional - Use the first available wallet
  useFirstDetectedSource: false,
  // Optional - Log Level - To debug the library
  logLevel: "DEBUG",

Wallet Manager

The wallet manager is the layer provided on top of connex . It can be created following the usage above.

const {wallet, thor, connex} = new DAppKit(...)

Set the wallet source

  • Set the current wallet source. This step is necessary if useFirstDetectedSource was not provided as true.

import type { WalletSource } from '@vechain/dapp-kit';

// type WalletSource = 'wallet-connect' | 'veworld' | 'sync2' | 'sync';
const mySource: WalletSource = 'veworld';



  • Connect to the selected wallet. The purpose of this is to improve the UX. For example, connecting a wallet via Wallet Connect involves switching applications multiple times. This will reduce the friction and create a better experience for the user.

  • This will connect to the user's wallet and return its address.

    • For certificate-based wallets, (eg. Sync2), this involves signing a signature

    • For other wallets, such as those using Wallet Connect, it will fetch the address without signing a certificate

  • The response will contain verified equal to true if the user signed a certificate

import { ConnectResponse } from '@vechain/dapp-kit'

const res: ConnectResponse = await wallet.connect()

// { "address": "0x995711ADca070C8f6cC9ca98A5B9C5A99b8350b1","verified": true}


  • The wallet manager will have some fields in state for ease of use.

    • address will be whatever address was retrieved when connecting, signing a certificate, or sending a transaction.

import { WalletManagerState } from '@vechain/dapp-kit'

const state: WalletManagerState = wallet.state


  • account - the address of the connected wallet. Null if not connected

  • source - the source of the currently selected wallet. Null if not selected

  • availableWallets - A list of available wallet sources

Subscribe to State

  • You can subscribe to state changes:

import { WalletManagerState } from '@vechain/dapp-kit'

const myListener = (newState: WalletManagerState) => {

//Start the subscription
const subscription = wallet.subscribe(myListener)

//End the subscription

Subscribe to a single value in the state

  • You can also subscribe to a single value in the state:

import { WalletSource } from '@vechain/dapp-kit'

const myListener = (newWalletSource: WalletSource) => {

//Start the subscription
const subscription = wallet.subscribeToKey('source', myListener)

//End the subscription

Last updated