cloudinit-bot
82ae6cf5a2
Milestone v0.3 complete. Feature type, tags v0.2.x. Two work-streams shipped under one feature milestone: (A) Bearers skeleton + tests (D-020 pattern, 7 x/* packages, zero ext deps): - x/bridge (NEW): BridgeStatus enum (4), BridgeRoute by-ID-string refs - x/exit (NEW): ExitStatus enum (5), ExitRoute, DEXSwap (opaque venue) - x/bearers (EXT): OYSATLink surveillance-resistant LOCKED, OYQRCode idempotent - x/partner (EXT): AnchorCredential (custody-provider-id empty in skeleton) - x/hub (NEW): HubService enum (3), LendingCouponCapBps=800 LOCAL const (A-304) - x/services (NEW): ServiceKind enum (4), window-id by-ID-string ref (A-307) - x/bond (EXT): GrowthBond, ClampGrowth G-012 underflow guard, secondary market All packages >=93.3% coverage. Both lexicon firewalls green. G-003 intact. (B) Documentation deliverable (REQ-027 complete, 26-page MkDocs Material site): - README.md + mkdocs.yml + docs/index.md - docs/shared/ (7 pages): Six Principles, Bread Scale, Storage Pools, Watchers/Mirror, Lexicon, Vision - docs/nomads/ (8 pages): Reach, Stash, Bearers, Maps-Pay, Pacts, Standing, Window - docs/freeholders/ (8 pages): Signals, Standing, Stands-Guilds, Councils-Voice, Bonds, Partner Spectrum, Anchor Preview - docs/reference/ (2 pages): Architecture, Components - REQ-028: lexicon firewall extended to docs/ + README.md (lexicon_meta_docs_test.go, 5 tests incl G-013 walk-coverage + G-014 shared self-test) Phases: P0 -> v0.2.0, P1 -> v0.2.1, P2 -> v0.2.2, P3 -> v0.2.3, P4 -> v0.2.4, P5 -> v0.2.5, P6 -> v0.2.6 (milestone release). Requirements covered: REQ-010, REQ-022, REQ-023, REQ-024, REQ-025, REQ-026 (skeleton), REQ-027, REQ-028 (complete). IDEATE-01..08 ratified and delivered. ---ci--- project: oy phase: 6 milestone: v0.3 status: complete tag_base: v0.2.x phase_role: final milestone_complete: true requirements: covered: [REQ-010, REQ-022, REQ-023, REQ-024, REQ-025, REQ-026, REQ-027, REQ-028] partial: [] ---/ci---
51 lines
2.5 KiB
Markdown
51 lines
2.5 KiB
Markdown
# 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](../shared/lexicon.md).
|
|
|
|
## 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](../freeholders/standing.md).
|
|
2. **Forge / Fold Interface** — mints [Bread](../shared/bread-scale.md)
|
|
against Root Basket assets only. See the Bloom Engine.
|
|
3. **Watcher Attestation Interface (the Mirror)** — 9 Watchers, 6-of-9
|
|
quorum. See [Watchers & Mirror](../shared/watchers-mirror.md).
|
|
4. **Window Lifecycle Interface** — Holder-authorized, scope-bounded,
|
|
revocable. See [Window](../nomads/window.md).
|
|
5. **Fee Covenant Interface** — auto-decline, ceiling/floor enforced.
|
|
See [Six Principles](../shared/six-principles.md).
|
|
6. **Voice / Council Interface** — multi-source Voice, Mission Lock enforced.
|
|
See [Councils & Voice](../freeholders/councils-voice.md).
|
|
|
|
## 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](components.md) for
|
|
the `x/` module map and the v0.3 phase status. |