Skip to content

Docs and test/multisig signature errors entrypoints 3of5 - #302

Open
Almikefred wants to merge 4 commits into
Lafiya-xyz:mainfrom
Almikefred:docs-and-test/multisig-signature-errors-entrypoints-3of5
Open

Docs and test/multisig signature errors entrypoints 3of5#302
Almikefred wants to merge 4 commits into
Lafiya-xyz:mainfrom
Almikefred:docs-and-test/multisig-signature-errors-entrypoints-3of5

Conversation

@Almikefred

Copy link
Copy Markdown

Summary

Completes documentation coverage for multisig-account: the Signature struct and its fields, all 7 Error variants, and the two public
entry points __constructor/__check_auth (with an ADR cross-reference for the unused _auth_contexts parameter) — plus a new 3-of-5
multisig 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 the Signature struct 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

  • All 7 Error variants documented with their real triggering conditions, matching the registry contracts' rustdoc style.
  • Cross-checked 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

  • __constructor documented with signers/threshold parameters explained.
  • __check_auth documented with signature_payload/signatures/_auth_contexts parameters; _auth_contexts marked intentionally unused
    with 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)

  • New three_of_five_signers_authorize() test configuring 5 signers/threshold 3, asserting authorization succeeds with exactly 3
    correctly-ordered valid signatures.
  • Confirms the signature-ordering and threshold logic generalizes correctly beyond the existing 2-of-3 case.

Notes

  • Code-only delivery: no install/build/test/scripts run during implementation — verification via cargo test -p multisig-account and cargo doc -p multisig-account recommended.
  • Committer: Almikefred.

Closes #177, Closes #178, Closes #179, Closes #180

@drips-wave

drips-wave Bot commented Aug 27, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant