hardhat-vechain

A package extending Hardhat Ethers to use a Connex provider.

Usage

• Modify hardhat.config.js to require @vechain/hardhat-vechain and @vechain/hardhat-ethers.
• Configure networks to include a vechain configuration

Note: A solo Thor instance should be running for the below configurations to work

Sample hardhat.config.js

const {
  VECHAIN_URL_SOLO
} = require("@vechain/hardhat-vechain");
require("@vechain/hardhat-ethers");

module.exports = {
    solidity: {
        version: "0.8.17",
    },
    networks: {
        vechain: {
            url: VECHAIN_URL_SOLO
        },
    }
};

Sample hardhat.config.js with fee delegation

Fee delegation can be configured by providing optional delegate config which has required url and optional signer field. Url needs to point to delegation a valid delegation service, for example https://sponsor-testnet.vechain.energy/by/${projectId}.

const {
  VECHAIN_URL_SOLO
} = require("@vechain/hardhat-vechain");
require("@vechain/hardhat-web3");

module.exports = {
    solidity: {
        version: "0.8.17",
    },
    networks: {
        vechain: {
            url: VECHAIN_URL_SOLO,
            delegate: {
                url: "${feeDelegationServiceUrl}",
                signer: "${optionalSigner}"
            }
        },
    }
};

Multi network support sample hardhat.config.js

Multiple network can also be configured to simplify testing and deployments. Networks which are targeting VechainThor nodes should have vechain as part of the network name (vechain, vechain_testnet, vechainNode are all valid). Network names without this requirement won't be preprocessed by the plugin and it is not expected to function properly with Thor network. Sample configuration:

const {
  VECHAIN_URL_SOLO
} = require("@vechain/hardhat-vechain");
require("@vechain/hardhat-web3");

module.exports = {
    solidity: {
        version: "0.8.17",
    },
    networks: {
        vechain_solo: {
            url: VECHAIN_URL_SOLO,
            delegate: {
                url: "${feeDelegationServiceUrl}",
                signer: "${optionalSigner}"
            }
        },
        vechain_mainnet: {
            url: "https://mainnet.veblocks.net",
        },
    }
};

Clauses support

Vechain Thor network supports sending multiple clauses as part of one transaction. Clauses are then executed atomically on a chain. Hardhat plugin supports Vechain tx construction with multiple clauses. Example code:

const clauseBuilder = new ClausesBuilder(baseContract);
const tx = await clauseBuilder.withClause({
    args: [1],
    abi: JSON.stringify([{ type: 'function', name: 'method1'}] ),
    method: 'method1'
}).withClause({
    args: [2],
    abi: JSON.stringify([{ type: 'function', name: 'method2'}] ),
    method: 'method2'
}).send()

Where baseContract is an instance of a deployed contract.

Testing

• Use Hardhat Ethers as usual

describe("vechain-ethers", function() {
    it("should be able to get signers", async function () {
        const accounts = await ethers.getSigners();
        assert.equals(accounts[0], "0xf077b491b355e64048ce21e3a6fc4751eeea77fa");
    });
});