conventions.md

Layout of Contract:

• version
• imports
• interfaces, libraries, contracts
• errors
• Type declarations
• State variables
• Events
• Modifiers
• Functions

Layout of Functions:

• constructor
• receive function (if exists)
• fallback function (if exists)
• external
• public
• internal
• private
• view & pure functions

TODO

• Put a number before script 00-Deploy.ts -> This is because of knowing which script runs first

• Add conventions for tests

  • Unit, integration, etc...
  • Test tree !!!

• State variables -> s_stateVariable

• Internal variables -> i_internalVariable

• Constants -> constant CONSTANT_CAPS_ON

• Internal functions -> _internalFunctionName