fxadmin update readme - #282
Merged
Merged
Conversation
Signed-off-by: May.Buzaglo <May.Buzaglo@ibm.com>
MayRosenbaum
force-pushed
the
fxadmin_update_readme
branch
from
August 23, 2026 14:01
3dbc8a6 to
6e07b36
Compare
Signed-off-by: May.Buzaglo <May.Buzaglo@ibm.com>
Signed-off-by: May.Buzaglo <May.Buzaglo@ibm.com>
There was a problem hiding this comment.
Pull request overview
Updates the fxadmin CLI documentation to reflect recent UX/behavior changes around config decoding, config update computation, transaction sending, and ledger follow semantics.
Changes:
- Refines the
decodecommand description and flag documentation to clarify it extractscommon.Configfrom a config block. - Updates
compute-updatedocs/examples to include--current-block(to derive/stamp the channel ID onto the resultingConfigUpdate). - Updates
tx senddocs/examples to require--outputfor writing the prepared configuration transaction, and clarifies quorum-based success semantics (also forsubmit) plus expandsfollowcommand explanation/output.
Suppressed comments (1)
tools/fxadmin/docs/README.md:464
- This sentence uses past tense ("routers acknowledged") while describing current command behavior. Using present tense here will read more clearly and match the surrounding documentation.
The send command is equivalent to running `prepare` followed by `submit`. As with `submit`, it
succeeds only when a BFT quorum (`2f+1`) of the routers acknowledged the transaction, and fails
otherwise.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | `--output` | yes | Path to the output ConfigUpdate protobuf file | | ||
| | Flag | Required | Description | | ||
| |-------------------| :------: | ---------------------------------------------- | | ||
| | `--current-block` | yes | Path to the current config block whose channel ID the update targets| |
Comment on lines
+419
to
+424
| the per-router outcome. It **succeeds only when a BFT | ||
| quorum of the routers acknowledged** the transaction: with `n` parties (read from the | ||
| `--current-block`) the quorum is `2f+1`, where `f = (n-1)/3` is the number of faulty parties | ||
| the network tolerates. If fewer than a quorum acknowledge — because routers rejected the | ||
| transaction or were unreachable — the command fails, so a partial or failed delivery is | ||
| reported rather than silently succeeding. |
Signed-off-by: May.Buzaglo <May.Buzaglo@ibm.com>
tock-ibm
approved these changes
Aug 30, 2026
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
update decode command description
update the compute-update command to include channel id
update the send command to require an output path for the prepared tx