[docs] coordinator service#76
Merged
Merged
Conversation
This document explains the internals of coordinator. Signed-off-by: Senthil Nathan N <cendhu@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new documentation page detailing the internal design and workflow of the Coordinator service.
- Introduces coordinator service responsibilities and architecture
- Outlines configuration, workflow steps, dependency graph details, gRPC API, and failure recovery
- Provides code snippets and links to relevant manager components
Comments suppressed due to low confidence (3)
docs/coordinator.md:128
- [nitpick] Inconsistent naming: the component is referred to as both "Validator Committer Manager" and "Validator-Committer Manager". Please choose one style and apply it uniformly.
in conjunction with a [`Policy Manager`](https://github.com/hyperledger/fabric-x-committer/blob/main/service/coordinator/policy_manager.go), ensures that all `Signature Verifier` services are updated with the new endorsement policy for that namespace.
docs/coordinator.md:141
- [nitpick] LaTeX/math mode syntax may not render properly in GitHub-flavored Markdown. Consider switching to inline code or plain-text arrows (e.g.,
T_j -> T_i (rw(k))).
1. **Read-Write Dependency ($T_{i}\xleftarrow{rw\mbox{(}k\mbox{)}}T_{j}$):** $T_i$ writes to key `k`, and a later transaction $T_j$ reads the *previous* version of `k`.
docs/coordinator.md:13
- [nitpick] The ampersand in the section title generates anchors with double hyphens. Verify these links work as expected or simplify the heading to avoid special characters in the anchor ID.
* [Step 2. Dependency Analysis & Parallel Validation](#step-2-dependency-analysis--parallel-validation)
liran-funaro
approved these changes
Jul 10, 2025
Comment on lines
+141
to
+146
| 1. **Read-Write Dependency ($T_{i}\xleftarrow{rw\mbox{(}k\mbox{)}}T_{j}$):** $T_i$ writes to key `k`, and a later transaction $T_j$ reads the *previous* version of `k`. | ||
| If $T_i$ is valid, $T_j$ must be invalid because it read a stale value. | ||
| 2. **Write-Read Dependency ($T_{i}\xleftarrow{wr\mbox{(}k\mbox{)}}T_{j}$):** $T_i$ reads key `k`, and a later transaction $T_j$ writes to `k`. This dependency is used | ||
| to enforce commit order. $T_j$ cannot be committed before $T_i$ is finalized, otherwise $T_i$'s read would become stale, violating the original block order. | ||
| 3. **Write-Write Dependency ($T_{i}\xleftarrow{ww\mbox{(}k\mbox{)}}T_{j}$):** Both $T_i$ and $T_j$ write to the same key `k`. This dependency ensures $T_j$ is not | ||
| committed before $T_i$, preventing $T_j$'s write from being overwritten and lost. |
Contributor
There was a problem hiding this comment.
Read-read dependency should also be mentioned
Contributor
Author
There was a problem hiding this comment.
Read-read is not a dependency. No conflicts between transactions when two transactions are reading the same key without writes.
Co-pilot reviews. Signed-off-by: senthil <cendhu@gmail.com>
This file contains hidden or 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
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.
Type of change
Description
This document explains the internals of coordinator.
Related issues