Files
openyield/docs/reference/architecture.md
T
cloudinit-bot 2ef3f2e39f docs(P03): complete freeholders docs + reference phase — REQ-027 complete
P3 complete. 8 docs/freeholders/ pages (signals, standing, stands-guilds,
councils-voice, bonds, partner-spectrum, anchor-preview, index) + 2
docs/reference/ pages (architecture, components). Docs firewall green
across all 26 docs pages. Full docs deliverable (README + mkdocs.yml +
26-page site) complete — REQ-027 complete.

---ci---
project: oy
phase: 3
milestone: v0.3
status: complete
tag_base: v0.2.x
phase_role: execution
requirements:
  covered: [REQ-027]
  partial: []
---/ci---
2026-08-17 22:17:07 +00:00

2.5 KiB

Architecture

This is the architecture index for OpenYield. The mesh is built from 14 modular components and 6 cross-component interfaces, with a critical blocker chain that fixes the build order. The full governance source lives in .ciagent/oy/ARCHITECTURE.md; this page is the user-facing rewrite, kept lexicon-clean by the docs firewall.

The 14 modular components

# Component Vision § Phase
1 OY Chain & Mirror §7 P1
2 Cross-Chain & Exit §7 P3
3 Bread Unit & Root Basket §6, §16 P1
4 Bloom Engine §6 P1
5 Storage Substrate §5 P1
6 Identity, Standing & Citizenship §8, §9 P1
7 Window Primitive §10 P2
8 Pacts Suite (Pause, Ground, Stance, Cover, Stand Registry, Hub API, Bonds) §16, §17 P2
9 Mesh Experience (Maps, Pay) §8 P1
10 Organizational Primitives (Stands, Guilds) §11, §12 P2
11 Partner Spectrum & Forex §13 P2
12 Bearers & Processing Mesh §14, §15 P1
13 Fee Covenant §18 P1
14 Governance (Mesh/Guild/Stand Councils) §19 P2

The 6 cross-component interfaces

  1. Standing API — consumed by Identity, Window, Pacts, Orgs, Partners, and Governance. See Standing.
  2. Forge / Fold Interface — mints Bread against Root Basket assets only. See the Bloom Engine.
  3. Watcher Attestation Interface (the Mirror) — 9 Watchers, 6-of-9 quorum. See Watchers & Mirror.
  4. Window Lifecycle Interface — Holder-authorized, scope-bounded, revocable. See Window.
  5. Fee Covenant Interface — auto-decline, ceiling/floor enforced. See Six Principles.
  6. Voice / Council Interface — multi-source Voice, Mission Lock enforced. See Councils & Voice.

The critical blocker chain

The components build in a fixed order: OY Chain (1) → Bread/Root Basket (3) → Storage (5) → Identity/Standing (6), which then unblocks {Window (7), Pacts (8), Orgs (10), Partners (11), Governance (14)}. The Fee Covenant (13) blocks Pacts, Orgs, Partners, and Bearers — the fee shape must exist before any of those can ship. v0.3 adds the Cross-Chain & Exit layer (component 2) and the Bearers/Partner/Bond extensions; see Components for the x/ module map and the v0.3 phase status.