Node Terminal smart contracts

This is blockchain part of Node Terminal project. It contains smart contracts used in application.

Overview

Usage

Before start

Create .env file from the .env.example file

Install Node and Yarn

Install Node (at least v20) and Yarn. You should be able to run the following command after the installation procedure below. Example:

$ node --version
20.x

$ yarn --version
1.22.x

Install packages and compile

yarn install
yarn compile

QA

To execute code static analysis and tests run commands

yarn static-analyze
yarn test

You can also report gas usage for each tested methods in smart contracts

REPORT_GAS=true yarn test

To show tests coverage report run

yarn coverage

API documentation

You can export smart contracts API documentation to html file. It will be saved in docs folder

yarn docgen

Smart contracts deployment

Use Hardnat Ignition plugin to deploy new contracts.

1. Prepare deployment module

2. Add file defining deployment parameters. Name should contain chain id of destination network, e.g. parameters-137.json for Polygon chain

3. Execute deployment

   yarn hardhat ignition deploy MODULE_FILE_PATH --network NETWORK --parameters PARAMETERS_FILE_PATH

4. Verify deployed contracts providing deploymentId

   yarn hardhat ignition verify DEPLOYMENT_ID

   For example:

   yarn hardhat ignition verify chain-137