dabinlee708/blockchain-developer-bootcamp-final-project

blockchain-developer-bootcamp-final-project's Issues

Final Project feedback

Hey @dabinlee708 I'm checking your project for grading and it seems awesome but I have to pause due to missing the package.json file, Would you please add it to the repo file and let me , Tom or Coogan know so that we can resume the grading and send you the final feedback?

Final Project feedback

Hi @dabinlee708 – Congratulations, your Final Project passed!

We'll be approving it on the course itself in a week or two, but here's your feedback in the meanwhile:

Front end & UX :
Thank you for your hard work. Below are some recommendations to make your work better:

• Guide your users to connect to the correct network when they are on the wrong network
• Handle errors and display user-friendly messages rather than throwing the error to the user
• Add form validation to prevent users from submitting wrong data
• Detect when user change network/change account

Smart contract:
awesome code organization and documentation, few tips and tricks if you would love to make your work incredibly amazing

• Solidity versions: Using very old versions of Solidity prevents the benefits of bug fixes and newer security checks. Using the latest versions might make contracts susceptible to undiscovered compiler bugs. Consider using one of these versions: 0.7.5, 0.7.6 or 0.8.4 .
• ABIEncoderV2 is activated by default since solidity version 0.8.0
• You don't need to assign registerId = 0 ; , the default value is 0
• It's recommended to define any function that is not called inside your contract as external rather than public to reduce gas cost -
• Good practice to emit events after updating the state
• You can omit the else block in queryBalance
• Storage Layout & Ordering: Ordering of storage variables and struct members affect how they can be packed tightly. For example, declaring your storage variables in the order of uint128, uint128, uint256 instead of uint128, uint256, uint128, as the former will only take up two slots of storage whereas the latter will take up three.
  https://secureum.substack.com/p/solidity-201
• The best-practices for layout within a contract is the following order: state variables, events, modifiers, constructor and functions to improve contract readability
  https://secureum.substack.com/p/solidity-101

Unit tests
You did a great job with testing. My advice to you is to :

-check the amazing testing tools like OZ testing environment https://docs.openzeppelin.com/test-environment/0.1/ and waffle https://ethereum-waffle.readthedocs.io/en/latest/index.html as they would give you lots of amazing tools that help you develop more efficient unit tests. also if you would love to check the test coverage, tools like firefly https://fireflyblockchain.com/ would help you

General feedback:
What you have done is amazing and I do encourage you to continue your work on this amazing idea. well Done!