Code coverage results

This is a personal project to learn Solidity development. This is basically a decentralized peer to peer exchange.

For example, Alice has a lot of tokens A but wants to buy some tokens B. She will create an offer saying "I sell 10 tokens A against 15 tokens B". John looks at the offer list and he's interested to buy some tokens A. So, he buy Alice's offer by giving 15 tokens B and receiving 10 tokens. At the same time, Alice's wallet is credited of 15 tokens B.

Note that in the next version, a fee will be applied when an offer is sold.

For this project, I use the following web3 stack:

• client framework: react
• Ethereum development environment: hardhat
• Ethereum Web client library: ether.js
• Test framework: mocha
• Assertion library: chai

Go to the smart-contract folder and:

• npm install to set-up the project.
• npx hardhat compile to compile the smart contracts.
• npx hardhat test to launch unit tests.
• npx hardhat node to start a local hardhat node, be able to deploy smart contracts on it and access it through a wallet (like Metamask) to test the dApp. Then, to be able to use it, configure the wallet with the network http://127.0.0.1:8545, chain ID 31337
• npx hardhat run scripts/deploy_tests.js --network localhost to deploy smart contracts and fake data to the local hardhat node and be able to test the front-end.

Go to the front-end folder and:

• npm install to set-up the project.
• npm start to start a local server on http://localhost:3000

Thanks to Github actions, each time a commit is done on the master branch or a pull request is created, the following steps are done:

• executing unit tests and publishing a clean test report,
• running unit tests with code coverage analysis and publishing coverage result here,
• running a linter (solhint) on smart contracts files (At the moment, linting results are only visible in Github actions logs),
• running a static analyzer (slither) and exporting analysis results in the Security tab on the Github page of this project)