Development

Visual Studio Code is the recommended IDE. Here's how to install Solidity language support:

We recommend installing the Hardhat + Solidity IDE extension from the VSCode marketplace.

Also, get the Prettier VSCode plugin:

code --install-extension esbenp.prettier-vscode

Solidity Installation

Make sure the Solidity compiler is installed. The compiler version must be >= 0.8.4.

To install solc run this command:

npm install -g solc

You can verify the version with like so:

solcjs --version

Install Project Dependencies

Install node dependencies:

yarn

To start a local network, use yarn run node. Alternatively, you can run a local Flare network.

Using the flare_local network will require you to create an initial transaction first. You can do so like this:

npm run createInitialTx <network>

Use the npm command to run tests on the in-process Hardhat network:

npm run test

Below are the steps to publish a new version:

Update version in package.json and commit the change
Create a tag that matches version for the commit and run git push --follow-tags
Create a new release for the tagged version

Provide feedback