From 8e581d3057961165d70d8ab4617d096686f28551 Mon Sep 17 00:00:00 2001
From: r4bbit <445106+0x-r4bbit@users.noreply.github.com>
Date: Wed, 9 Aug 2023 11:38:21 +0200
Subject: [PATCH] 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.
---
 PROPERTIES.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 PROPERTIES.md

diff --git a/PROPERTIES.md b/PROPERTIES.md
new file mode 100644
index 0000000..832bee6
--- /dev/null
+++ b/PROPERTIES.md
@@ -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** |
+| ------------ | -------- | -------- | ---------- |
+|              |          |          |            |
+|              |          |          |            |
+|              |          |          |            |