docs: steer verification toward validate_with_commitment - #28
Open
peetzweg wants to merge 1 commit into
Open
Conversation
Guide users toward validate_with_commitment as the recommended verification path and state plainly that computing the ring commitment is non-trivial and grows with ring size, so it should be reused rather than rebuilt per proof. Also document that the finalized commitment can be fetched directly from a pallet-members chain (Members.Root(..).root on the source chain, MembersSubscriber.RingRoots on the consumer chain) via a plain storage query, and warn against using the intermediate accumulator field. Incorporates feedback from the verifiable crate maintainer.
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.
Documentation-only change incorporating feedback from the
verifiablecrate maintainer.Why: The docs treated
validate(rebuild-from-member-list) as the primary verification path and leftvalidate_with_commitmentas a commented-out alternative. Rebuilding the ring commitment is the expensive part of verification and grows with ring size, so users should reuse a commitment rather than recompute it per proof.How: Reframe the README (both the root docs and the published package README) to recommend
validate_with_commitment, state the commitment-computation cost plainly, and document that the finalized commitment can be fetched directly from apallet-memberschain via a plain storage query —Members.Root(collectionId, ringIndex).rooton the source chain,MembersSubscriber.RingRootson the consumer chain — with a warning not to use theintermediateaccumulator field.No code changes.