docs: the README's consensus parameters were wrong and incomplete - #14
Merged
Merged
Conversation
"None of them is optional" was false: ride_auto_release_secs, mint_cosigners and mint_threshold are all serde(default), and all three were missing from the list. RideCancel had one outcome listed and has two. get_chain_info was missing from the RPC list, and it is the only way to read a chain's committed genesis from outside the node. Co-Authored-By: Claude Opus 5 <noreply@anthropic.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
1 participant
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.
Three fixes, one of them a factual error.
"None of them is optional — a config missing any key below fails to deserialize at boot." Three of them are
#[serde(default)]and all three were missing from the list:ride_auto_release_secs,mint_cosigners,mint_threshold. The README told a reader the opposite of what the struct says.The correction keeps the sharp part: optional does not mean outside consensus. Omitting one commits its default into the genesis hash just as firmly as setting it, so two nodes still cannot disagree about whether a key was present.
RideCancelhad one outcome and now has two. It refunds the passenger, or releases the unpaid fare to the driver pastride_auto_release_secs. A table row saying only "Cancel active trip" hides the half that decides who gets the money.get_chain_infowas missing from the RPC list. It is the only way to read a chain's committed genesis parameters from outside the node — the config file on disk is what a node was told, not what its chain carries. That distinction cost a round trip to establish today.🤖 Generated with Claude Code