Browse Source

Add data description to README.md

DebenOldert 4 năm trước cách đây
mục cha
commit
08fc9085dc
1 tập tin đã thay đổi với 45 bổ sung1 xóa
  1. 45 1
      README.md

+ 45 - 1
README.md

@@ -1 +1,45 @@
-# dsp-blockchain
+# dsp-blockchain
+This is a small description of how the chain works and how data is being formatted.
+## Data formats
+
+### Transaction stored in chain
+```json
+{
+  "sender": "public key sender",
+  "receiver": "public key receiver",
+  "id": "transaction id",
+  "timestamp": "unix timestamp of transaction creation",
+  "data": "encrypted string of contract"
+}
+```
+
+### Contract / Transaction data
+```json
+{
+  "id": "contract id",
+  "state": "state of the contract e.g. ACCEPTED|REJECTED etc",
+  "title": "title of contract",
+  "description": "description of contract",
+  "deadline": "unix timestamp of contract deadline",
+  "price": "price of contract",
+  "initiator": "public key of address that created the contract",
+  "worker": "public key of address that fulfills the contract",
+  "initial_block": "block number contract created in",
+  "modified_by": "public key of party last modified data",
+  "last_comment": "comment regarding modification",
+  "terms": [{
+    "see": "Term data" 
+  }]
+}
+```
+
+### Term data
+Terms are part of a contract.
+```json
+{
+  "id": "id of the term",
+  "title": "title of the term",
+  "description": "description of the term",
+  "deadline": "unix timestamp of term deadline"
+}
+```