Docs/consolidate contracts md - #143
Merged
elizabetheonoja-art merged 2 commits intoAug 22, 2026
Merged
Conversation
elizabetheonoja-art
merged commit Aug 22, 2026
05a9a86
into
Utility-Protocol:main
7 of 11 checks passed
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.
Consolidate smart contract documentation into CONTRACTS.md
Resolves: #137
Description
This PR consolidates fragmented smart contract documentation across the repository into a single, canonical
CONTRACTS.mdfile, acting as the ultimate source of truth for on-chain logic.Scope of Changes
CONTRACTS.mdas the unified technical specification and overview.SETTLEMENT_IMPLEMENTATION.md,mint-atomicity.md,macro-auth.md,SECURITY.md, etc.)..rssource code.WEBHOOK_ARCHITECTURE.md,EMERGENCY_RUNBOOK.md).README.mdwith a minimalist pointer toCONTRACTS.md.Review Notes / Open Questions
.mdfiles indocs/and root (e.g.CONTRIBUTING.md, backend runbooks) were explicitly kept out of the merge as they do not document the on-chain contract logic. Please confirm this separation is correct.Verification
cargo testpasses successfully.