Files
openyield/docs/shared/six-principles.md
T
cloudinit-bot 82ae6cf5a2 docs(milestone): complete OpenYield v0.3 (Bearers & Documentation)
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---
2026-08-17 22:35:36 +00:00

54 lines
2.1 KiB
Markdown

# Six Principles
The Six Principles are the immutable covenant of OpenYield (REQ-001). They
are **Mission-locked**: no Council can amend them, and the fee covenant is
locked alongside them. The mesh exists to hold real production, not
speculation; everything else follows from that.
## 1. Real value
The mesh holds **real production**. The Bread unit is the unit of real value
held in the Storage Pools; the bond market caps coupons so the mesh cannot
become a speculation engine. "Real return" is the metric, not a nominal rate.
## 2. Sustainability
Fees are floored and capped. The fee covenant fixes a ceiling and a floor
(see the Fee Covenant module), and the 1-Grain internal minimum prevents dust
games. The protocol cannot drain its users, and it cannot starve its
Watchers.
## 3. Mission-lock
The Six Principles and the fee covenant are immutable. No Council — Mesh,
Guild, or Stand — can amend them. Mission Lock is a `const` in the council
module, and an invariant test asserts it can never be set to amendable. The
coupon cap on bonds is a mission-locked ceiling, not a parameter a Council
can tune.
## 4. Openness
Anyone may join. The mesh is a public good. A Holder needs only a Reach (an
identity) and a Stash (a storage pool) to begin; there is no gatekeeper and
no custodian.
## 5. Ownership
Holders own their Stash and their Reach. Custody is theirs: the Stash is the
Holder-level storage pool, the Vault is the Stand-level pool, and the
Root-Pool is the treasury. The protocol does not custody user value; it
holds the canonical state that records who owns what.
## 6. Self-service
A Holder can act without a custodian. The Window primitive lets a Holder
delegate a scope-bounded, time-limited, revocable capability to a partner or
a service; the bearers (OY-LR, OY-BLE, OY-WiFi-Direct, OY-SAT, OY-QR) let a
Holder reach the mesh without a phone plan or a custodial on-ramp. The mesh
is jurisdiction-light by design.
---
See the [Vision](vision.md) for the covenant in brief, or the
[Lexicon](lexicon.md) for why the docs say "real production" and "Holder"
rather than the words a legacy financial institution would use.