Coverage Report

Statements	Functions	Lines

Prerequisites

• Docker

PATH+=":./bin"    # use your sh files (which are located in bin/) directly from the root of the project

yarn install      # install deps
yarn run build    # install solc and other tools in the docker image

Don't forget to copy the .env.example file to a file named .env, and then edit it to fill in the details.

Running all the tests

yarn run test
yarn run test:trace       # shows logs + calls
yarn run test:fresh       # force compile and then run tests
yarn run test:coverage    # run tests with coverage reports

Formatters & Linters

You can use the below packages,

• Solhint
• ESLint
• Prettier

yarn run format
yarn run lint

Analyzers

You can use the below tools,

• Slither
• Mythril

yarn run analyze:static path/to/contract
yarn run analyze:security path/to/contract
yarn run analyze:all path/to/contract

Deploy Contract & Verification

To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Sepolia.

In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details.

• Enter your Etherscan API key
• Sepolia Node URL (eg from Alchemy)
• The private key of the account which will send the deployment transaction.

With a valid .env file in place, first deploy your contract:

yarn run deploy sepolia <CONTRACT_FILE_NAME>    # related to scripts/deploy/<CONTRACT_FILE_NAME>.ts
yarn run deploy:all sepolia                     # related to scripts/deploy.ts

Also, you can add contract(s) manually to your tenderly projects from the output. https://dashboard.tenderly.co/contract/<NETWORK_NAME>/<CONTRACT_ADDRESS>

And then verify it:

yarn run verify sepolia <DEPLOYED_CONTRACT_ADDRESS> "<CONSTRUCTOR_ARGUMENT(S)>"    # hardhat.config.ts to see all networks

Finder

yarn run finder --path contracts/Workshop.sol --name Workshop abi --colorify --compact --prettify    # find contract outputs of specific contract

yarn run finder --help    # see all supported outputs (abi, metadata, bytecode and more than 20+ outputs)

Storage Vault

yarn run storage:lock    # create storage layout for all contracts

yarn run storage:lock --help    # see all supported options

yarn run storage:check    # check storage layout for all contracts by comparing with existing layout json file

yarn run storage:check --help    # see all supported options

Miscellaneous

yarn run generate:docs    # generate docs according to the contracts/ folder

yarn run generate:flatten ./path/to/contract     # generate the flatten file (path must be "./" prefixed)
yarn run generate:abi ./path/to/contract         # generate the ABI file (path must be "./" prefixed)
yarn run generate:bin ./path/to/contract         # generate the binary in a hex (path must be "./" prefixed)
yarn run generate:metadata ./path/to/contract    # generate the metadata (path must be "./" prefixed)
yarn run generate:all-abi
yarn run generate:all-bin
yarn run generate:all-metadata

yarn run share    # share project folder with remix ide

TODO

• Increase diversity in the Workshop Contract
• Add Workshop Contract tests
• Add Upgradeable Contract Examples
• Add OpenZeppelin Defender
• Add Tenderly
• Fix Prettier for Solidity files