Skip to content

docs(contracts): add group treasury multisig and authorization model conceptual documentation - #539

Closed
cythecode wants to merge 1 commit into
codebestia:mainfrom
cythecode:feat/issue-471-concepts-treasury-multisig-model
Closed

docs(contracts): add group treasury multisig and authorization model conceptual documentation#539
cythecode wants to merge 1 commit into
codebestia:mainfrom
cythecode:feat/issue-471-concepts-treasury-multisig-model

Conversation

@cythecode

Copy link
Copy Markdown

Overview

Adds comprehensive conceptual documentation for the group_treasury Soroban smart contract's authorization and multi-signature model ($M$-of-$N$) in contracts/docs/concepts-treasury-multisig-model.md.

Related Issue

Closes #471

Changes

Smart Contract Documentation

  • [ADD] contracts/docs/concepts-treasury-multisig-model.md
    • Explains system roles and authorization architecture (Admin vs. Members vs. Public).
    • Details membership lifecycle management (add_member, remove_member, is_member, get_members).
    • Describes the threshold approval model ($M$-of-$N$), initialization requirements, and immutability.
    • Details the full withdrawal proposal lifecycle (propose_withdraw, approve_withdraw, reject_withdraw).
    • Details the mathematical blocking minority formula ($\text{rejections} \ge \text{member_count} - \text{threshold} + 1$) for early rejection termination.
    • Documents security guarantees (collusion resistance, double-voting prevention, event auditability) and known edge cases/limitations.
    • Provides Mermaid state machine and sequence diagrams.
    • Cross-references api-group-treasury.md and related contracts.

Verification Results

$ cargo test
running 46 tests
test result: ok. 40 passed; 0 failed; 6 ignored; 0 measured; 0 filtered out; finished in 0.42s

running 18 tests
test result: ok. 18 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.42s

running 8 tests
test result: ok. 8 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.04s
Acceptance Criteria Status
Explains threshold model in plain terms ✅ Fully documented with examples and initialization rules
Explains security properties and known limitations ✅ Collusion resistance, blocking minority, edge cases covered
Cross-references API doc (api-group-treasury.md) ✅ Linked with context to related docs and source files

Copilot AI lite review requested due to automatic review settings August 25, 2026 15:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

Copy link
Copy Markdown

👋 Hi @cythecode, thanks for your contribution!

Pull requests from contributors must target the dev branch — only the repo maintainer merges into main.

This PR is being closed automatically. Please open a new PR (or retarget this one by reopening it after editing the base branch) against dev.

@drips-wave

drips-wave Bot commented Aug 25, 2026

Copy link
Copy Markdown

@cythecode 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

@github-actions github-actions Bot closed this Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Concepts docs: Group treasury multisig/authorization model

2 participants