Add modules.md #401
Closed
Add modules.md #401
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| The module may also have another storage (other than DMS) to store its | ||
| internal states, which can deduce the set of messages to be broadcasted upon | ||
| the `flush`() operation. | ||
| - In the `update()` operation, the module reads the message stored in DMS and |
There was a problem hiding this comment.
Plus, does the module read a single message during the update() operation? If not, please fix to messages.
| - During each operation, the module may store some messages to its local DMS. | ||
| - In the `flush()` operation, the module stores all the messages it wants to | ||
| broadcast. These messages may or may not have been stored by other operations. | ||
| The module may also have another storage (other than DMS) to store its |
Comment on lines
+38
to
+52
| ## Repository | ||
|
|
||
| TODO | ||
|
|
||
| ## Governance | ||
|
|
||
| TODO | ||
|
|
||
| ## Consensus | ||
|
|
||
| TODO | ||
|
|
||
| ## Chat | ||
|
|
||
| TODO |
There was a problem hiding this comment.
How about leaving documents under each module's repository and putting a link to it above in Modules section?
There was a problem hiding this comment.
I'm not sure. Let's think about after we got actual contents
JeongHunP
reviewed
Mar 15, 2023
Co-authored-by: Taehoon Tom Kim <kim.taehoon@snu.ac.kr>
f2koi
reviewed
Mar 15, 2023
| 2. Governance: This module manages a node's client in the p2p governance voting | ||
| protocol. | ||
| 3. Consensus: This module manages a node's state machine of the BFT algorithm | ||
| (Vetomint). |
There was a problem hiding this comment.
Suggested change
| (Vetomint). | |
| ([Vetomint](https://github.com/postech-dao/simperby/blob/main/docs/vetomint.md)). |
I think it would be nice to have a link.
JeongHunP
approved these changes
Mar 15, 2023
|
After some more consideration while designing the interface, I think this description is slightly outdated and I need another way to explain the structure. Let me revisit this issue soon. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.