Skip to content

docs: add ARCHITECTURE.md documenting mento-core contract subsystems (MEN-42) - #716

Closed
mento-val wants to merge 2 commits into
developfrom
qa/men-42-architecture-docs
Closed

docs: add ARCHITECTURE.md documenting mento-core contract subsystems (MEN-42)#716
mento-val wants to merge 2 commits into
developfrom
qa/men-42-architecture-docs

Conversation

@mento-val

Copy link
Copy Markdown

Summary

  • Adds ARCHITECTURE.md to the repo root documenting the full mento-core architecture
  • Covers all required sections from MEN-42: system overview, 6 contract subsystems, key interaction flows, upgradeability patterns, and entry points
  • Written for new contributors and security auditors

Sections covered

  1. System overview — what mento-core does
  2. Contract subsystems — Broker/Exchange Providers, Oracle/Relayers, Tokens, Governance, Reserve, Liquidity Strategies
  3. Key interaction flows — swap flow, oracle update flow, governance proposal flow (with ASCII diagrams)
  4. Upgradeability notes — Celo Proxy vs OpenZeppelin Transparent Proxy vs non-upgradeable, with specific contract lists
  5. Entry points — table mapping goals to starting contracts

Test plan

  • No code changes, documentation only
  • File created at repo root: ARCHITECTURE.md

Closes MEN-42

🤖 Generated with Claude Code

mento-val and others added 2 commits March 12, 2026 07:25
Covers all 5 required subsections:
1. System overview — multi-currency stablecoin and FX infrastructure
2. Contract subsystems — Broker/Exchange Providers, Oracle/Relayers,
   Tokens, Governance (TimelockController/GovernanceFactory), Reserve
3. Key interaction flows — swap, oracle update, governance proposal
4. Upgradeability notes — Celo Proxy vs OZ Transparent vs non-upgradeable
5. Entry points — where to start reading by focus area

Source: mento-core QA audit P2-9 (MEN-42)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…(MEN-42)

Documents system overview, all 6 contract subsystems (Broker/Exchange Providers,
Oracle/Relayers, Tokens, Governance, Reserve, Liquidity Strategies), key
interaction flows (swap, oracle update, governance proposal), proxy upgradeability
patterns, and recommended code entry points for new contributors and auditors.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mento-val
mento-val requested review from a team, nvtaveras and philbow61 March 12, 2026 07:27
@mento-val

Copy link
Copy Markdown
Author

Closing this PR as part of a workflow change. Going forward, all PRs must be submitted through the fork-based review process: branches are pushed to mento-val's personal forks, reviewed by the Engineering Manager, and then the EM opens the upstream PR. This work is valid and will be re-submitted through the proper workflow once Val's fork remotes are configured. See Paperclip issue MEN-61 for context.

@mento-val mento-val closed this Mar 16, 2026
@bayological
bayological deleted the qa/men-42-architecture-docs branch March 27, 2026 17:49
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.

1 participant