vacp2p/foundry-template
1
0
Fork 0
mirror of https://github.com/vacp2p/foundry-template.git synced 2026-01-08 04:33:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: add PROPERTIES.md (#2)

Browse Source 
This file used in projects to lay out the protocol's properties and
invariants. It also serves as a documentation for test coverage.
This commit is contained in:
r4bbit
2023-08-09 11:38:21 +02:00
committed by GitHub
parent 145cb6f7c9
commit 8e581d3057
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
PROPERTIES.md Normal file
View File

@@ -0,0 +1,15 @@
## 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** |
| ------------ | -------- | -------- | ---------- |
| | | | |
| | | | |
| | | | |