@magicdust/draconis
v0.0.1
Published
The best ally to your Web3 contributor journey. Become a DeWorker now.
Downloads
6
Readme
Usage
Pre Requisites
Proceed with installing dependencies:
yarn install
Compile
Compile the smart contracts with Hardhat:
$ yarn compile
Generate ABIs
Generate the smart contracts ABI files with Hardhat:
$ yarn abi
TypeChain
Compile the smart contracts and generate TypeChain artifacts:
$ yarn typechain
Format code
Format the code:
$ yarn prettier
Lint Solidity
Lint the Solidity code:
$ yarn lint:sol
Lint TypeScript
Lint the TypeScript code:
$ yarn lint:ts
Test
Run the Mocha tests:
$ yarn test
Coverage
Generate the code coverage report:
$ yarn coverage
Report Gas
See the gas usage per unit test and average gas per method call:
$ REPORT_GAS=true yarn test
Clean
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
$ yarn clean
Deploy
Deploy the contracts to Hardhat Network:
$ yarn deploy
Syntax Highlighting
If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the vscode-solidity extension. The recommended approach to set the compiler version is to add the following fields to your VSCode user settings:
{
"solidity.compileUsingRemoteVersion": "v0.8.4+commit.c7e474f2",
"solidity.defaultCompiler": "remote"
}
Where of course v0.8.4+commit.c7e474f2
can be replaced with any other version.