Quick Start


Welcome to this quick start guide to developing applications on the VeChain Thor blockchain platform.

The purpose of this guide is to serve as a quick way to set up your developer environment by installing all the needed tools to develop dApps on the VeChain platform. You will get a good understanding how the various components work together.

Basic blockchain knowledge is required to follow this guide, and throughout this guide we assume you are running a Linux OS (Ubuntu), but it’s also possible to follow this guide when running Windows or macOS.

Interacting with the blockchain

When you want to call a function on a smart contract, you need to query one of the VeChain hor Nodes and tell it:

  • The address of the smart contract.
  • The function you want to call.
  • The variable you want to send to that function.

To communicate with the Nodes we need to use the RESTful API. Thorify is an application that extends on web3 to allow us to directly communicate with the RESTful API.

Install nodejs

sudo apt-get install nodejs


sudo apt-get install npm

install web3

sudo apt-get install git


npm install web3


npm install --save thorify


Installing VS Code

To write code we need an IDE (Integrated development environment)






Setting up your own Local VeChainThor Node

See the official installation guide on https://github.com/vechain/thor.

  • Please see this guide on how to set up your own Thor Node using Docker.
  • Please see this guide on how to set up your own Thor Node on Amazon Cloud.

Creating Smart Contracts

Smart contracts on the VeChain Thor blockchain are run on the Ethereum Virtual Machine, a lightweight operating system that is specially created to run smart contracts.

Solidity is a programming language with a syntax similar to JavaScript that allows programmers to create smart contracts. Popular programs to write smart contracts are Truffle and Remix.

Smart contracts are deployed by sending a transaction to the blockchain in which the receiver address is empty and the data field contains the compiled code of the contract to be created.

To communicate with the Nodes to for example send a transaction and to deploy a contract we need to use Thor’s RESTful API. Web3-Gear is an application developed to allow Truffle and Remix to communicate with Thor’s RESTful API. It converts Ethereum RPC calls to VeChainThor RPC calls.

How to install web3-Gear

To install web3-Gear we first have to install its dependencies LibSSL and Python

sudo apt-get install libssl-dev

Install the Python installer pip by running

sudo apt install python3-pip

After this we can install Web3-Gear and it’s dependent Python packages via Pypi

pip3 install web3-gear

Run and Setup web3-Gear

You can run web3 gear with the following command. Please make sure you run the Thor client first or you will get the ” unable to connect to Thor-Restful server” message.


By default, this will start web3-gear on To change the default behavior the following parameters are accepted:

  • –host: rpc service host, eg: --host
  • –port: rpc service port, eg: --port 8545
  • –endpoint: thor restful service endpoint, eg: --endpoint
  • –keystore: keystore file path, eg: --keystore /Users/(username)/keystore), default=thor stand-alone(solo) built-in accounts
  • –pascode: passcode of keystore, eg: --passcode xxxxxxxx

Setup Remix or Truffle

Use Remix

Change the Remix environment to Web3 provide.

Use Truffle

  • Truffle 4.0.6+ support
npm install -g truffle

Modify the configuration of truffle first(truffle.js):

module.exports = {
    networks: {
        development: {
            host: "localhost",
            port: 8545,
            network_id: "*" // Match any network id

Then you can use truffle’s command line tool.



Please enter your comment!
Please enter your name here