Merge pull request #2527 from EspressoSystems/ed/diagrams-part2

Ed/diagrams part2
EspressoSystems · Feb 7, 2024 · 0eac853 · 0eac853
2 parents 171e22a + ec4b0fb
commit 0eac853
Show file tree

Hide file tree

Showing 10 changed files with 821 additions and 246 deletions.
diff --git a/docs/diagrams/General.md b/docs/diagrams/General.md
@@ -6,6 +6,19 @@
 ## Data Structures
 ```
 state_map {
+  HashMap (VIDCommitment -> Leaf)
   TODO
 }
+```
+
+```
+latest_known_view: u64
+```
+
+```
+latest_voted_view: u64
+```
+
+```
+latest_da_voted_view: u64
 ```
diff --git a/docs/diagrams/HotShotFlow.drawio b/docs/diagrams/HotShotFlow.drawio
diff --git a/docs/diagrams/OptimisticDACertificateRecv.md b/docs/diagrams/OptimisticDACertificateRecv.md
@@ -0,0 +1,8 @@
+# OptimisticDACertificateRecv
+
+![OptimisticDACertificateRecv](/docs/diagrams/images/HotShotFlow-OptimisticDACertificateRecv.drawio.png "OptimisticDACertificateRecv")
+
+## Basic Message Validation 
+
+## Optimistic DA Certificate Processing
+
diff --git a/docs/diagrams/OptimisticDAProposalRecv.md b/docs/diagrams/OptimisticDAProposalRecv.md
@@ -0,0 +1,9 @@
+# OptimisticDAProposalRecv
+
+![OptimisticDAProposalRecv](/docs/diagrams/images/HotShotFlow-OptimisticDAProposalRecv.drawio.png "QuorumProposalRecv")
+
+## Basic Message Validation
+* It is possible for some applications built on top of HotShot to listen for DA proposals but not vote on them (such as builders).  
+
+## DA Proposal Validation and Processing
+* "Valid" DA proposal data is a no-op for now.  More validation is done in the `VoteOnQuorumProposal` task. 
diff --git a/docs/diagrams/VIDShareRecv.md b/docs/diagrams/VIDShareRecv.md
@@ -0,0 +1,9 @@
+# VIDShareRecv
+
+![VIDShareRecv](/docs/diagrams/images/HotShotFlow-VIDShareRecv.drawio.png "VIDShareRecv")
+
+## Basic Message Validation 
+
+## VID Share Processing and Validation
+* A "valid" VID share is one that successfully passes the `VidScheme::verify_share` function
+
diff --git a/docs/diagrams/VoteOnQuorumProposal.md b/docs/diagrams/VoteOnQuorumProposal.md
@@ -0,0 +1,7 @@
+# VoteOnQuorumProposal
+
+![VoteOnQuorumProposal](/docs/diagrams/images/HotShotFlow-VoteOnQuorumProposal.drawio.png "VoteOnQuorumProposal")
+
+## Mutually Verify Share, Cert, and Proposal
+* Nodes must verify that the `OptimisticDACertificate`, their `VIDShare`, and the `QuorumProposal` all commit to the same data.  It is only possible to do this verification once we've receive all the necessary data.  
+* The event/task dependency infrastructure should only spawn this task if the view for all 3 dependencies is the same. It is an internal error if this is not the case. 
diff --git a/docs/diagrams/images/HotShotFlow-OptimisticDACertificateRecv.drawio.png b/docs/diagrams/images/HotShotFlow-OptimisticDACertificateRecv.drawio.png
diff --git a/docs/diagrams/images/HotShotFlow-OptimisticDAProposalRecv.drawio.png b/docs/diagrams/images/HotShotFlow-OptimisticDAProposalRecv.drawio.png
diff --git a/docs/diagrams/images/HotShotFlow-VIDShareRecv.drawio.png b/docs/diagrams/images/HotShotFlow-VIDShareRecv.drawio.png
diff --git a/docs/diagrams/images/HotShotFlow-VoteOnQuorumProposal.drawio.png b/docs/diagrams/images/HotShotFlow-VoteOnQuorumProposal.drawio.png