foundry-template/PROPERTIES.md
r4bbit 8e581d3057
chore: add PROPERTIES.md (#2)
This file used in projects to lay out the protocol's properties and
invariants. It also serves as a documentation for test coverage.
2023-08-09 11:38:21 +02:00

831 B

Protocol properties and invariants

Below is a list of all documented properties and invariants of this project that must hold true.

  • Property - Describes the property of the project / protocol that should ultimately be tested and formaly verified.
  • Type - Properties are split into 5 main types: Valid State, State Transition, Variable Transition, High-Level Property, Unit Test
  • Risk - One of High, Medium and Low, depending on the property's risk factor
  • Tested - Whether this property has been (fuzz) tested
Property Type Risk Tested