documentation, change log message and method names #524
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
Signed-off-by: Lovesh <[email protected]>
ashcherbakov
reviewed
Feb 7, 2018
docs/main.md
Outdated
| @@ -1,3 +1,18 @@ | |||
| Outline of the system | |||
| # TODO | |||
| #Overview of the system | |||
There was a problem hiding this comment.
Missing space between # and Overview
docs/main.md
Outdated
|
|
||
| - The system maintains maintains a replicated ordered log of transactions called the ledger. |
docs/main.md
Outdated
| - The system maintains maintains a replicated ordered log of transactions called the ledger. | ||
| - Participants of the system which maintain this log are called the nodes. The nodes run a consensus protocol ([RBFT](http://lig-membres.imag.fr/aublin/rbft/report.pdf)) to agree on the order of transactions. For simplicity it can be assumed that one of the node is the leader (primary) which determines the order of transactions and communicates it to the rest of the nodes (followers). | ||
| - Each run (3 phase commit) of the consensus protocol orders a batch (collection) of transactions. | ||
| - Nodes maintain several ledgers, each for a distinct purpose, it has a pool ledger for node membership transactions like addition of new node, suspension of a node, change of IP/port or keys of a node, a ledger for identity transactions, etc |
There was a problem hiding this comment.
It's better to end the sentence after distinct purpose.
docs/main.md
Outdated
| - Nodes maintain several ledgers, each for a distinct purpose, it has a pool ledger for node membership transactions like addition of new node, suspension of a node, change of IP/port or keys of a node, a ledger for identity transactions, etc | ||
| - Apart for the ledger, nodes maintain state (for each ledger) which is [Merkle Patricia Trie](https://github.com/ethereum/wiki/wiki/Patricia-Tree). It might maintain several other projections of the ledger. For more on storage, refer the [storage document](storage.md). | ||
| - Clients with appropriate permissions can send write requests (transactions) to the nodes but any client can send read requests to the nodes. | ||
| - Communicate between nodes and clients and node-to-node happens on [CurveZMQ](http://curvezmq.org/). The codebase has an abstraction called `Stack` that manages communication. It has several variants which offer different features. |
There was a problem hiding this comment.
It's better to say Client-to-node and node-to-node communication happens on ....
docs/main.md
Outdated
| Here the nodes communicate their state and learn other node's states and then if the nodes realise that they are behind, they run a protocol to get the missing transactions. More on this in the [catchup document](catchup.md) | ||
| - The nodes can request various protocol-specific messages from other nodes by a `MESSAGE_REQUEST` message. | ||
| - When the primary node crashes (or becomes non functional in any way), or it misbehaves by sending bad messages or it slows down then the follower nodes initiate a protocol to change the leader, this protocol is called view change. | ||
| View change involves selecting a new leader, which is done in a round robin fashion and communication (and catchup if needed) of state so before the new leader starts, every node has the same state. |
There was a problem hiding this comment.
Please add three more paragraphs explicitly describing how our consensus protocol differs from RBFT one:
- BLS signatures
- timestamps (set by Primary)
- batches of requests
Signed-off-by: Lovesh <[email protected]>
ashcherbakov
approved these changes
Feb 8, 2018
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.
Signed-off-by: Lovesh [email protected]