Docs and test/multisig signature errors entrypoints 3of5 - #302
Open
Almikefred wants to merge 4 commits into
Open
Docs and test/multisig signature errors entrypoints 3of5#302Almikefred wants to merge 4 commits into
Almikefred wants to merge 4 commits into
Conversation
…k_auth, cross-reference ADR (Lafiya-xyz#179)
|
@Almikefred Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Summary
Completes documentation coverage for
multisig-account: theSignaturestruct and its fields, all 7Errorvariants, and the two publicentry points
__constructor/__check_auth(with an ADR cross-reference for the unused_auth_contextsparameter) — plus a new 3-of-5multisig test confirming the signature-ordering/threshold logic actually generalizes beyond the existing 2-of-3 test case.
Changes
#177 — Add doc comments to multisig-account's Signature struct fields
///doc comments added to theSignaturestruct and each field (public_key,signature), verified against actual usage in__check_auth; comment-only, no behavior change.#178 — Add doc comments to every multisig-account Error variant
Errorvariants documented with their real triggering conditions, matching the registry contracts' rustdoc style.docs/error-codes.md: all 7 multisig-account errors already listed there, no update required.#179 — Add doc comments to multisig-account's __constructor and __check_auth
__constructordocumented withsigners/thresholdparameters explained.__check_authdocumented withsignature_payload/signatures/_auth_contextsparameters;_auth_contextsmarked intentionally unusedwith cross-reference to ADR-0007 (confirmed via
docs/adr/0007-unscoped-multisig-authorization.md).#180 — Add an N-of-M multisig test with N greater than 2 (e.g. 3-of-5)
three_of_five_signers_authorize()test configuring 5 signers/threshold 3, asserting authorization succeeds with exactly 3correctly-ordered valid signatures.
Notes
cargo test -p multisig-accountandcargo doc -p multisig-accountrecommended.Closes #177, Closes #178, Closes #179, Closes #180