Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 cloudinit-bot
|
c7f7391774 |
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"phase": 2,
|
||||
"phase": 3,
|
||||
"stage": "execute",
|
||||
"milestone": "v0.2",
|
||||
"milestone_type": "feature",
|
||||
@@ -7,5 +7,5 @@
|
||||
"phase_role": "execution",
|
||||
"project": "oy",
|
||||
"attempts": 0,
|
||||
"updated_at": "2026-08-17T21:30:00Z"
|
||||
"updated_at": "2026-08-17T21:40:00Z"
|
||||
}
|
||||
@@ -0,0 +1,154 @@
|
||||
# P3 Ship Verification — v0.2 Phase 3 (Councils + Forex)
|
||||
|
||||
**Branch**: `oy/phase/03-councils-forex`
|
||||
**Phase**: P3 — Councils + Forex (REQ-011, Forex v1)
|
||||
**Tag target**: `v0.1.3` (orchestrator ships; executor does NOT merge/tag/push)
|
||||
**Date**: 2026-08-17
|
||||
|
||||
## Summary
|
||||
|
||||
Phase 3 ships two new Mesh modules — `x/council` (3-Council enum
|
||||
Mesh/Guild/Stand with Mission Lock as a `const bool` + Voice/SignalKind/
|
||||
TallyResult types mirroring `x/gov`) and `x/forex` (Forex Engine v1 stub:
|
||||
ForexPair with lexicon-clean "Bread/Asset" labels + RateOracle interface +
|
||||
StubOracle + 4-OracleKind enum) — both referencing x/stand and x/guild
|
||||
by-ID-string (G-003). All six P3 tasks executed atomically with per-task
|
||||
commits. Build green, tests green, coverage ≥80% on both new packages,
|
||||
lexicon firewall green (forex is the highest lexicon-risk module per
|
||||
RESEARCH §1.10 — verified clean), Mission Lock invariant green.
|
||||
|
||||
## Must-Haves (from PLANS.md P3 Must-Haves)
|
||||
|
||||
| Must-Have | Status | Evidence |
|
||||
|---|---|---|
|
||||
| `x/council`, `x/forex` each have `types/types.go` + `types/types_test.go` | ✅ | 6 files created (council: types.go+types_test.go+genesis.go; forex: types.go+types_test.go+genesis.go) |
|
||||
| `go build ./...` and `go test ./...` green | ✅ | `go build ./...` → BUILD OK; `go test ./... -count=1` → all 22 packages ok (0 FAIL) |
|
||||
| ≥80% coverage on `x/council/types`, `x/forex/types` | ✅ | council 96.4%, forex 100.0% |
|
||||
| Council locked-const: exactly 3 types (Mesh, Guild, Stand) | ✅ | `CouncilKindCount == 3`, `AllCouncilKinds()` returns MeshCouncil/GuildCouncil/StandCouncil; `TestCouncilKindCountLockedConst` + `TestAllCouncilKindsNames` |
|
||||
| **Mission Lock invariant**: `MissionLockAmendable == false`, test asserts non-amendable (highest-severity) | ✅ | `MissionLockAmendable` const bool false; `TestMissionLockAmendableConstFalse` + `TestMissionLockAmendableCannotBeSetTrue` (const is the firewall — cannot be reassigned) |
|
||||
| `TallyResult` shape mirrors `x/gov` (A-204) for future wiring | ✅ | Fields yes/no/abstain/nowithveto/total/quorum_met; JSON tags verified in `TestTallyResultStructShape`; NoWithVeto always 0 (anti-greed, no veto option) |
|
||||
| `VoteOption` has no "no-with-veto" (anti-greed) | ✅ | N/A — council uses `TallyResult` with NoWithVeto locked to 0 (no separate VoteOption enum; the TallyResult field is the parity-with-x-gov shape with the anti-greed invariant); `TestTallyResultNoWithVetoAlwaysZero` |
|
||||
| Forex pair labels lexicon-clean (no banned tradable-unit terms); `RateOracle` interface compiles | ✅ | ForexPair uses `base_asset`/`quote_asset` JSON tags (A-208 "Bread/Asset"); `TestForexPairStructFields` + `TestForexPairLabelsLexiconClean`; `RateOracle` interface compiles (`TestRateOracleInterfaceCompiles` + `TestStubOracleSatisfiesInterface`) |
|
||||
| Lexicon assertion in both new test files | ✅ | `TestLexiconNoBannedTermsInCouncilPackage` + `TestLexiconNoBannedTermsInCouncilTestFile`; `TestLexiconNoBannedTermsInForexPackage` + `TestLexiconNoBannedTermsInForexTestFile` |
|
||||
| `ValidateGenesis` ID-uniqueness + referential integrity (Council) | ✅ | council rejects dup/empty council-ids + dup/empty voice-ids + unknown kinds/signals + Stand Council without stand-id-ref + Guild Council without guild-id-ref + Voice with unknown council-id (referential integrity P3-01-03); forex rejects dup/empty pair-ids + dup/empty provider-ids + empty base/quote-asset + unknown oracle-kind (A-212) |
|
||||
| Git tag `v0.1.3` | ⏸ DEFERRED | Orchestrator ships (executor does NOT tag/merge/push per instructions) |
|
||||
|
||||
## Tasks Committed (6)
|
||||
|
||||
| Task | Commit | Description |
|
||||
|---|---|---|
|
||||
| P3-01-01 | `81708bd` | council types — 3 CouncilKind enum, Mission Lock const, Voice/SignalKind/TallyResult |
|
||||
| P3-02-01 | `73aa90f` | forex types — ForexPair (Bread/Asset labels), RateOracle iface, 4 OracleKind enum, StubOracle |
|
||||
| P3-01-02 | `02d02c8` | council types tests — locked-const, Mission Lock invariant, SignalKind, TallyResult, lexicon |
|
||||
| P3-01-03 | `7804fdb` | council genesis schema — Voice tally referential integrity, Mission Lock check |
|
||||
| P3-02-02 | `94eeca6` | forex types tests — OracleKind enum, RateOracle iface, StubOracle sentinel, lexicon (highest risk) |
|
||||
| P3-02-03 | `a7567e2` | forex genesis schema — ValidatePairs/ValidateProviders, dup-id rejection |
|
||||
|
||||
## Build / Test / Coverage Results
|
||||
|
||||
### `go build ./...`
|
||||
```
|
||||
BUILD OK
|
||||
```
|
||||
|
||||
### `go test ./... -count=1`
|
||||
- 22 packages with tests, all `ok` (0 FAILs)
|
||||
- Total test count: **264** (up from 207 baseline → +57 new tests across council + forex)
|
||||
- Packages with no test files: lexicon, x/identity/types, x/processing/types, x/rootpool/types, x/vault/types (unchanged from baseline)
|
||||
|
||||
### `go test -cover ./x/council/types/... ./x/forex/types/...`
|
||||
| Package | Coverage | Target | Pass |
|
||||
|---|---|---|---|
|
||||
| `x/council/types` | **96.4%** | ≥80% | ✅ |
|
||||
| `x/forex/types` | **100.0%** | ≥80% | ✅ |
|
||||
|
||||
### Lexicon meta-test (`go test -run TestLexiconMeta .`)
|
||||
- `TestLexiconMetaNoBannedTermsInX` — PASS (scans all `x/**/*.go` production + test for 10 banned terms; council + forex files clean)
|
||||
- `TestLexiconMetaSelfTestTable` — PASS (G-009 self-test table for all 10 banned terms)
|
||||
- `TestLexiconMetaBannedTermsCount` — PASS
|
||||
- `TestLexiconMetaNoFalsePositiveOnOpenYield` — PASS (word-boundary matcher, "openyield" not flagged)
|
||||
|
||||
### G-003 by-ID-string invariant (`go test -run TestG003 ./x/window/...`)
|
||||
- `TestG003NoCrossModuleStructImportsInProduction` — PASS (no production `.go` file under `x/` imports a foreign `x/<module>/types` package; council references x/stand + x/guild by-ID-string; forex has no cross-module refs)
|
||||
|
||||
## Module Details
|
||||
|
||||
### x/council (REQ-011, D-022)
|
||||
- **CouncilKind enum**: MeshCouncil, GuildCouncil, StandCouncil — exactly 3 (REQ-011)
|
||||
- **Council struct**: id, kind, stand-id-ref (optional, by-ID-string to x/stand — P1-02-01), guild-id-ref (optional, by-ID-string to x/guild — P1-03-01), members ([]CouncilMember), voice-threshold
|
||||
- **CouncilMember struct**: reach-id (lexicon-clean holder identifier — NOT the banned financial holder term), voice-weight, joined-at
|
||||
- **Voice struct**: id, council-id, proposer-reach, signal-kind, target-ref, tally, timestamp
|
||||
- **SignalKind enum**: Stash, Standing, Vouch, Capital — exactly 4 (the four Freeholder signals, cross-ref v0.1 REQ-005 / vision §9.1 x/standing FreeholderSignals)
|
||||
- **TallyResult struct**: yes, no, abstain, nowithveto (always 0 — anti-greed), total, quorum-met — mirrors x/gov shape (A-204)
|
||||
- **Mission Lock invariant**: `MissionLockAmendable` const bool false — the highest-severity regression firewall; the const can NEVER be set true (compile-time const)
|
||||
- **Genesis**: `GenesisState{Councils, Voices, Params}`, `DefaultGenesisState()`, `ValidateGenesis` (rejects dup/empty council-ids, dup/empty voice-ids, unknown kinds/signals, Stand Council without stand-id-ref, Guild Council without guild-id-ref, Voice with unknown council-id [referential integrity]); data-engineer's `ValidateCouncils` + `ValidateVoices` + `MissionLockCheck` wired into the genesis load path (G-008)
|
||||
|
||||
### x/forex (Forex v1, D-030)
|
||||
- **ForexPair struct**: id, base-asset, quote-asset, decimals — uses "Bread/Asset" style labels (A-208), NOT the banned financial tradable-unit terms (lexicon-hostile per RESEARCH §1.10)
|
||||
- **RateOracle Go interface**: `GetRate(pairID) (rate uint64, timestamp int64, err error)` — no impl in v0.2 (Phase 3 wires Piers)
|
||||
- **OracleProvider struct**: id, name, kind
|
||||
- **OracleKind enum**: Chainlink, Pyth, UMA, Internal — exactly 4 (Forex v1)
|
||||
- **SpotRate struct**: pair-id, rate, timestamp, provider-id (by-ID-string refs per G-003)
|
||||
- **StubOracle**: stub keeper; `GetRate` returns sentinel `ErrOracleNotIntegrated` ("forex oracle not integrated (Phase 3 wires Piers)")
|
||||
- **SpreadCapBps**: const 0 (A-214 documented placeholder; test asserts ≥0; v0.3 may set a positive cap)
|
||||
- **Genesis**: `GenesisState{Pairs, Providers, Params}`, `DefaultGenesisState()`, `ValidateGenesis` (rejects dup/empty pair-ids, dup/empty provider-ids, empty base/quote-asset, unknown oracle-kind); data-engineer's `ValidatePairs` + `ValidateProviders` (G-008)
|
||||
|
||||
## Deviation: genesis.go created in Wave 1 alongside types.go (P3-01-01 / P3-02-01)
|
||||
|
||||
The plan ordered genesis.go as tasks P3-01-03 and P3-02-03 (after the test
|
||||
tasks P3-01-02 and P3-02-02), but `types.go` references `ValidateCouncils`/
|
||||
`ValidateVoices` (council) and `ValidatePairs`/`ValidateProviders` (forex)
|
||||
— the genesis helpers — and the build must be green after each per-task
|
||||
commit. I therefore created `genesis.go` with the Validate* helpers in the
|
||||
Wave 1 types tasks (P3-01-01 and P3-02-01), and the Wave 2 genesis tasks
|
||||
(P3-01-03 and P3-02-03) then refined the doc/comments to make the
|
||||
deliverable explicit and committed the refinement. This matches the P2
|
||||
deviation pattern (documented in P2_SHIP_VERIFICATION.md). All four tasks
|
||||
are individually committed; the deviation is structural only (genesis
|
||||
helper landed in the types task to keep the build green, then was refined
|
||||
in the genesis task). No semantic change to the plan's deliverables.
|
||||
|
||||
## Lexicon Compliance Notes (Forex is highest risk per RESEARCH §1.10)
|
||||
|
||||
- **No banned literals** in any new `x/council/**/*.go` or `x/forex/**/*.go`
|
||||
file (production or test). The 10 banned terms (bank, deposit, interest,
|
||||
yield, currency, dollar, euro, account, savings, depositor) are
|
||||
referenced only via the `lexicon` package helpers
|
||||
(`lexicon.FindBannedTerm`, `lexicon.BannedTerms`) in test files.
|
||||
- **Council module** uses "reach-id"/"voice-holder"/"proposer-reach"
|
||||
(NOT the banned financial holder term — the lexicon-clean holder
|
||||
identifier per RESEARCH §2). Comments deliberately avoid the banned term
|
||||
even in "NOT <banned-term>" form (the word-boundary matcher would flag it).
|
||||
- **Forex module** uses "Forex" (allowed — vision §13 names it; NOT in the
|
||||
banned list), "base-asset"/"quote-asset" (A-208 — NOT the banned
|
||||
tradable-unit terms), "Bread"/"Asset" sample labels (A-208). The banned
|
||||
financial terms for tradable units (the three lexicon-hostile terms
|
||||
per RESEARCH §1.10) NEVER appear in source. "fx" is borderline but
|
||||
avoided (the module name is "forex" not "fx").
|
||||
- **Self-bootstrapping**: each test file has a
|
||||
`TestLexiconNoBannedTermsIn*TestFile` self-check that asserts the test
|
||||
file itself contains no banned literals (the lexicon helpers must be
|
||||
used, not inline strings).
|
||||
- **Project-wide meta-test** (`lexicon_meta_test.go`) scans ALL
|
||||
`x/**/*.go` including the new council + forex files — PASS.
|
||||
|
||||
## Pre-existing LSP noise (not P3 scope)
|
||||
|
||||
The LSP reports errors in `x/watcher/` files (cosmos-sdk/codec imports) and
|
||||
`go.mod` (version "v2.0.1" invalid). These are **pre-existing** and **not
|
||||
in P3 scope** — `x/watcher` is a v0.1 module with stale cosmos-sdk
|
||||
references that are not part of the v0.2 skeleton (the v0.2 skeleton is
|
||||
zero-deps; `go build ./...` succeeds because the watcher files are
|
||||
excluded from the build path or compile cleanly via `go build`).
|
||||
`go build ./...` and `go test ./...` both PASS, confirming the LSP noise
|
||||
does not affect the build. (Same note as P1/P2 ship verification.)
|
||||
|
||||
## Orchestrator Handoff
|
||||
|
||||
- **Do NOT merge/tag/push** — executor leaves the branch
|
||||
`oy/phase/03-councils-forex` with 6 commits for the orchestrator to ship
|
||||
as tag `v0.1.3`.
|
||||
- All P3 must-haves pass except the git tag (deferred to orchestrator per
|
||||
instructions).
|
||||
- No regressions: all v0.1 baseline tests + all v0.2-P1 tests + all v0.2-P2
|
||||
tests + 57 new P3 tests = 264 total, all green.
|
||||
@@ -0,0 +1,123 @@
|
||||
package types
|
||||
|
||||
import "fmt"
|
||||
|
||||
// genesis.go holds the data-engineer's genesis schema helpers for the
|
||||
// council module (G-008 split). ValidateGenesis in types.go composes these
|
||||
// helpers; the security-engineer's test assertions live in types_test.go.
|
||||
//
|
||||
// The Council genesis schema has two top-level sets: Councils (the three
|
||||
// governance councils — Mesh/Guild/Stand) and Voices (the Voice-tally
|
||||
// set). The invariants enforced at genesis load are (1) council-id
|
||||
// uniqueness, (2) voice-id uniqueness, (3) referential integrity (each
|
||||
// Voice's council-id references an existing Council), and (4) the
|
||||
// Mission-Lock check (the global MissionLockAmendable const bool is the
|
||||
// firewall — this helper is the genesis-side echo).
|
||||
|
||||
// ValidateCouncils asserts council-ids are present and unique, and that
|
||||
// each Council's kind is a known CouncilKind. A Stand Council must populate
|
||||
// stand-id-ref (by-ID-string ref to x/stand); a Guild Council must populate
|
||||
// guild-id-ref (by-ID-string ref to x/guild). A Mesh Council leaves both
|
||||
// refs empty. ValidateCouncils is the data-engineer's schema validator,
|
||||
// composed by ValidateGenesis in types.go.
|
||||
func ValidateCouncils(councils []Council) error {
|
||||
seen := make(map[string]bool, len(councils))
|
||||
for i, c := range councils {
|
||||
if c.CouncilID == "" {
|
||||
return fmt.Errorf("council [%d]: empty council-id", i)
|
||||
}
|
||||
if seen[c.CouncilID] {
|
||||
return fmt.Errorf("council: duplicate council-id %q", c.CouncilID)
|
||||
}
|
||||
seen[c.CouncilID] = true
|
||||
if !knownCouncilKind(c.Kind) {
|
||||
return fmt.Errorf("council %q: unknown council kind %q", c.CouncilID, c.Kind)
|
||||
}
|
||||
// A Stand Council must reference a Stand by-ID-string (P1-02-01 ref).
|
||||
if c.Kind == CouncilStand && c.StandIDRef == "" {
|
||||
return fmt.Errorf("council %q: Stand Council missing stand-id-ref", c.CouncilID)
|
||||
}
|
||||
// A Guild Council must reference a Guild by-ID-string (P1-03-01 ref).
|
||||
if c.Kind == CouncilGuild && c.GuildIDRef == "" {
|
||||
return fmt.Errorf("council %q: Guild Council missing guild-id-ref", c.CouncilID)
|
||||
}
|
||||
}
|
||||
if err := MissionLockCheck(councils); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ValidateVoices asserts voice-ids are present and unique, and that each
|
||||
// Voice's council-id references an existing Council in the genesis set
|
||||
// (referential integrity — the P3-01-03 deliverable: each Voice tally's
|
||||
// council-id must resolve to a genesis Council). signal-kind must be a
|
||||
// known SignalKind (the four Freeholder signals, cross-ref REQ-005). The
|
||||
// referential-integrity check is the data-engineer's genesis invariant: a
|
||||
// Voice tally pointing at a non-existent Council is rejected at genesis
|
||||
// load (no orphan tallies).
|
||||
func ValidateVoices(voices []Voice, councils []Council) error {
|
||||
councilIDs := make(map[string]bool, len(councils))
|
||||
for _, c := range councils {
|
||||
councilIDs[c.CouncilID] = true
|
||||
}
|
||||
seen := make(map[string]bool, len(voices))
|
||||
for i, v := range voices {
|
||||
if v.VoiceID == "" {
|
||||
return fmt.Errorf("voice [%d]: empty voice-id", i)
|
||||
}
|
||||
if seen[v.VoiceID] {
|
||||
return fmt.Errorf("voice: duplicate voice-id %q", v.VoiceID)
|
||||
}
|
||||
seen[v.VoiceID] = true
|
||||
if !councilIDs[v.CouncilID] {
|
||||
return fmt.Errorf("voice %q: council-id %q does not reference an existing council", v.VoiceID, v.CouncilID)
|
||||
}
|
||||
if !knownSignalKind(v.SignalKind) {
|
||||
return fmt.Errorf("voice %q: unknown signal-kind %q", v.VoiceID, v.SignalKind)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// knownCouncilKind reports whether k is one of the three CouncilKind values.
|
||||
func knownCouncilKind(k CouncilKind) bool {
|
||||
for _, kk := range AllCouncilKinds() {
|
||||
if k == kk {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// knownSignalKind reports whether s is one of the four SignalKind values.
|
||||
func knownSignalKind(s SignalKind) bool {
|
||||
for _, kk := range AllSignalKinds() {
|
||||
if s == kk {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// MissionLockCheck asserts the Mission-Lock invariant on a slice of
|
||||
// Councils (vision §19, REQ-011). Because MissionLockAmendable is a compile-
|
||||
// time const bool == false, this check always passes — it exists as the
|
||||
// data-engineer's genesis-side assertion that the Mission-Lock firewall is
|
||||
// intact. If the const ever flipped to true (which the test suite rejects),
|
||||
// the genesis load would surface it here. The helper is the genesis hook
|
||||
// for v0.3 keeper logic to extend with live per-council Mission-Lock
|
||||
// enforcement.
|
||||
func MissionLockCheck(councils []Council) error {
|
||||
// The global MissionLockAmendable const is the firewall: if it were ever
|
||||
// flipped to true (which the test suite rejects), the genesis load would
|
||||
// surface it here. The per-council loop is the hook for v0.3 live logic.
|
||||
if MissionLockAmendable {
|
||||
return fmt.Errorf("council: Mission Lock amendable (MissionLockAmendable == true) — firewall breach")
|
||||
}
|
||||
for range councils {
|
||||
// No per-council runtime data to verify in the skeleton — the const
|
||||
// is the source of truth. The loop preserves the hook point.
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,187 @@
|
||||
package types
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
const (
|
||||
ModuleName = "council"
|
||||
StoreKey = ModuleName
|
||||
RouterKey = ModuleName
|
||||
QuerierRoute = ModuleName
|
||||
|
||||
// CouncilKindCount is the locked count of CouncilKind enum values
|
||||
// (vision §13 / REQ-011). A regression firewall: adding/removing/renaming
|
||||
// a Council kind breaks this const's test.
|
||||
CouncilKindCount = 3
|
||||
|
||||
// MissionLockAmendable is the Mission-Lock invariant (vision §19, REQ-011):
|
||||
// the Six Principles + Fee Covenant + no-amend covenant can NEVER be
|
||||
// amended by any council. This is a locked const bool — the highest-
|
||||
// severity regression firewall in the council module. The const can
|
||||
// NEVER be set true; the test asserts it is false and that no code path
|
||||
// can flip it (the compile-time const is the firewall, not runtime data).
|
||||
MissionLockAmendable = false
|
||||
|
||||
// SignalKindCount is the locked count of SignalKind enum values — the
|
||||
// four Freeholder signals (vision §9.1 / REQ-005) plus Capital (REQ-011
|
||||
// multi-source Voice). Cross-ref v0.1 x/standing FreeholderSignals.
|
||||
SignalKindCount = 4
|
||||
)
|
||||
|
||||
// CouncilKind enumerates the three governance councils (vision §13, REQ-011):
|
||||
// Mesh Council (whole-mesh), Guild Council (guild-level), Stand Council
|
||||
// (Stand-level). Each uses multi-source Voice. Mission Lock (the Six
|
||||
// Principles + fee covenant + no-amend covenant) cannot be amended by any
|
||||
// council — enforced by the compile-time MissionLockAmendable const bool.
|
||||
type CouncilKind string
|
||||
|
||||
const (
|
||||
CouncilMesh CouncilKind = "MeshCouncil" // whole-mesh council
|
||||
CouncilGuild CouncilKind = "GuildCouncil" // guild-level council
|
||||
CouncilStand CouncilKind = "StandCouncil" // Stand-level council
|
||||
)
|
||||
|
||||
// AllCouncilKinds returns all three CouncilKind values in REQ-011 order.
|
||||
// Locked-const test asserts exactly 3 entries with these names (REQ-011).
|
||||
func AllCouncilKinds() []CouncilKind {
|
||||
return []CouncilKind{
|
||||
CouncilMesh,
|
||||
CouncilGuild,
|
||||
CouncilStand,
|
||||
}
|
||||
}
|
||||
|
||||
// Council is one of three governance councils (REQ-011). kind picks the
|
||||
// tier (Mesh/Guild/Stand). stand-id-ref references x/stand by ID string
|
||||
// (optional — only Stand Councils populate it; P1-02-01 by-ID-string ref).
|
||||
// guild-id-ref references x/guild by ID string (optional — only Guild
|
||||
// Councils populate it; P1-03-01 by-ID-string ref). Both refs are by-ID-
|
||||
// string per G-003 (no struct imports of x/stand or x/guild). members is
|
||||
// the voice-holder set; voice-threshold is the tally pass threshold.
|
||||
type Council struct {
|
||||
CouncilID string `json:"council_id" yaml:"council_id"`
|
||||
Kind CouncilKind `json:"kind" yaml:"kind"`
|
||||
StandIDRef string `json:"stand_id_ref,omitempty" yaml:"stand_id_ref,omitempty"`
|
||||
GuildIDRef string `json:"guild_id_ref,omitempty" yaml:"guild_id_ref,omitempty"`
|
||||
Members []CouncilMember `json:"members" yaml:"members"`
|
||||
VoiceThreshold uint32 `json:"voice_threshold" yaml:"voice_threshold"`
|
||||
}
|
||||
|
||||
// CouncilMember is a voice-holder in a Council (REQ-011). reach-id
|
||||
// references x/identity Reach by string (G-003 — the lexicon-clean holder
|
||||
// identifier; the banned financial holder term is NOT used here). voice-
|
||||
// weight is the member's Voice weight in the tally; joined-at is the join
|
||||
// timestamp.
|
||||
type CouncilMember struct {
|
||||
ReachID string `json:"reach_id" yaml:"reach_id"`
|
||||
VoiceWeight uint32 `json:"voice_weight" yaml:"voice_weight"`
|
||||
JoinedAt int64 `json:"joined_at" yaml:"joined_at"`
|
||||
}
|
||||
|
||||
// Voice is a single Voice signal cast on a Council proposal (REQ-011).
|
||||
// council-id references the Council by ID string (G-003). proposer-reach
|
||||
// references x/identity Reach by string (lexicon-clean holder identifier;
|
||||
// the banned financial holder term is NOT used).
|
||||
// signal-kind picks the multi-source Voice input (Stash/Standing/Vouch/
|
||||
// Capital — the four Freeholder signals, cross-ref v0.1 REQ-005
|
||||
// FreeholderSignals). target-ref is the proposal/option the Voice targets
|
||||
// (opaque string ref). tally is the running tally result; timestamp is the
|
||||
// cast time.
|
||||
type Voice struct {
|
||||
VoiceID string `json:"voice_id" yaml:"voice_id"`
|
||||
CouncilID string `json:"council_id" yaml:"council_id"`
|
||||
ProposerReach string `json:"proposer_reach" yaml:"proposer_reach"`
|
||||
SignalKind SignalKind `json:"signal_kind" yaml:"signal_kind"`
|
||||
TargetRef string `json:"target_ref" yaml:"target_ref"`
|
||||
Tally TallyResult `json:"tally" yaml:"tally"`
|
||||
Timestamp int64 `json:"timestamp" yaml:"timestamp"`
|
||||
}
|
||||
|
||||
// SignalKind enumerates the multi-source Voice inputs (REQ-011). The four
|
||||
// Freeholder signals (vision §9.1 / REQ-005, cross-ref x/standing
|
||||
// FreeholderSignals): Stash, Standing, Vouch, Capital. No "Freeholder"
|
||||
// SignalKind — the four signals are the inputs a Freeholder-eligible Reach
|
||||
// casts; the eligibility is upstream (x/standing). Capital is the committed-
|
||||
// capital signal (vision §9.1 committed_capital).
|
||||
type SignalKind string
|
||||
|
||||
const (
|
||||
SignalStash SignalKind = "Stash" // Stash-maturity signal (vision §9.1)
|
||||
SignalStanding SignalKind = "Standing" // multi-domain Standing signal (§9.1)
|
||||
SignalVouch SignalKind = "Vouch" // community endorsement / Vouch (§9.1)
|
||||
SignalCapital SignalKind = "Capital" // committed-capital signal (§9.1)
|
||||
)
|
||||
|
||||
// AllSignalKinds returns all four SignalKind values in REQ-005 / vision §9.1
|
||||
// order. Locked-const test asserts exactly 4 entries (cross-ref v0.1
|
||||
// x/standing FreeholderSignals: StashMaturity, MultiDomainStanding,
|
||||
// CommittedCapital, CommunityEndorsement — the four signals map to
|
||||
// Stash/Standing/Capital/Vouch here).
|
||||
func AllSignalKinds() []SignalKind {
|
||||
return []SignalKind{
|
||||
SignalStash,
|
||||
SignalStanding,
|
||||
SignalVouch,
|
||||
SignalCapital,
|
||||
}
|
||||
}
|
||||
|
||||
// TallyResult mirrors Cosmos SDK x/gov TallyResult shape (A-204) for
|
||||
// future wiring of Council governance to x/gov. Fields: yes, no, abstain
|
||||
// (no "no-with-veto" — anti-greed, vision §19), nowithveto (kept as a
|
||||
// zero-locked field for x/gov shape parity — always 0 in OY since the
|
||||
// VoteOption enum has no veto option), total (total Voice cast). The
|
||||
// quorum-met flag is the tally pass indicator. The field names (yes, no,
|
||||
// abstain) match x/gov exactly so a future x/gov wiring is mechanical.
|
||||
type TallyResult struct {
|
||||
Yes uint64 `json:"yes" yaml:"yes"`
|
||||
No uint64 `json:"no" yaml:"no"`
|
||||
Abstain uint64 `json:"abstain" yaml:"abstain"`
|
||||
NoWithVeto uint64 `json:"nowithveto" yaml:"nowithveto"` // always 0 — no veto option (anti-greed)
|
||||
Total uint64 `json:"total" yaml:"total"`
|
||||
QuorumMet bool `json:"quorum_met" yaml:"quorum_met"`
|
||||
}
|
||||
|
||||
// Params for the council module (skeleton — no tunables in v0.2).
|
||||
type Params struct{}
|
||||
|
||||
func DefaultParams() Params { return Params{} }
|
||||
|
||||
// GenesisState defines the council module genesis state (REQ-011).
|
||||
// Councils is the top-level set of three Council kinds; Voices is the
|
||||
// Voice-tally set. ValidateGenesis enforces council-id uniqueness,
|
||||
// voice-id uniqueness, and the Mission-Lock check (the const firewall echo).
|
||||
// The data-engineer's genesis.go holds the schema helpers (G-008).
|
||||
type GenesisState struct {
|
||||
Councils []Council `json:"councils" yaml:"councils"`
|
||||
Voices []Voice `json:"voices" yaml:"voices"`
|
||||
Params Params `json:"params" yaml:"params"`
|
||||
}
|
||||
|
||||
func DefaultGenesisState() *GenesisState {
|
||||
return &GenesisState{
|
||||
Councils: []Council{},
|
||||
Voices: []Voice{},
|
||||
Params: DefaultParams(),
|
||||
}
|
||||
}
|
||||
|
||||
// ValidateGenesis performs ID-uniqueness checks (A-212 upgrade from v0.1
|
||||
// no-op): rejects duplicate council-ids and duplicate voice-ids, and runs
|
||||
// the Mission-Lock check. Delegates to the data-engineer's genesis.go
|
||||
// helpers (G-008).
|
||||
func ValidateGenesis(bz json.RawMessage) error {
|
||||
var gs GenesisState
|
||||
if err := json.Unmarshal(bz, &gs); err != nil {
|
||||
return fmt.Errorf("council: invalid genesis: %w", err)
|
||||
}
|
||||
if err := ValidateCouncils(gs.Councils); err != nil {
|
||||
return fmt.Errorf("council: %w", err)
|
||||
}
|
||||
if err := ValidateVoices(gs.Voices, gs.Councils); err != nil {
|
||||
return fmt.Errorf("council: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,506 @@
|
||||
package types_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/oy/openyield/lexicon"
|
||||
"github.com/oy/openyield/x/council/types"
|
||||
)
|
||||
|
||||
// TestCouncilKindCountLockedConst asserts CouncilKindCount is exactly 3
|
||||
// and AllCouncilKinds() returns exactly 3 (REQ-011). A regression firewall:
|
||||
// adding/removing/renaming a Council kind breaks this test.
|
||||
func TestCouncilKindCountLockedConst(t *testing.T) {
|
||||
if types.CouncilKindCount != 3 {
|
||||
t.Errorf("CouncilKindCount = %d, expected 3 (REQ-011 LOCKED)", types.CouncilKindCount)
|
||||
}
|
||||
all := types.AllCouncilKinds()
|
||||
if len(all) != 3 {
|
||||
t.Errorf("AllCouncilKinds() len = %d, expected 3", len(all))
|
||||
}
|
||||
}
|
||||
|
||||
// TestAllCouncilKindsNames asserts the 3 REQ-011 names in order with no
|
||||
// extras, no dups, no renames.
|
||||
func TestAllCouncilKindsNames(t *testing.T) {
|
||||
want := []string{"MeshCouncil", "GuildCouncil", "StandCouncil"}
|
||||
all := types.AllCouncilKinds()
|
||||
if len(all) != len(want) {
|
||||
t.Fatalf("len = %d, want %d", len(all), len(want))
|
||||
}
|
||||
seen := map[string]bool{}
|
||||
for i, k := range all {
|
||||
if string(k) != want[i] {
|
||||
t.Errorf("AllCouncilKinds()[%d] = %q, want %q", i, k, want[i])
|
||||
}
|
||||
if seen[string(k)] {
|
||||
t.Errorf("duplicate CouncilKind %q", k)
|
||||
}
|
||||
seen[string(k)] = true
|
||||
}
|
||||
}
|
||||
|
||||
// TestCouncilKindValues asserts each named const matches its AllCouncilKinds
|
||||
// entry.
|
||||
func TestCouncilKindValues(t *testing.T) {
|
||||
if types.CouncilMesh != "MeshCouncil" {
|
||||
t.Errorf("CouncilMesh = %q", types.CouncilMesh)
|
||||
}
|
||||
if types.CouncilGuild != "GuildCouncil" {
|
||||
t.Errorf("CouncilGuild = %q", types.CouncilGuild)
|
||||
}
|
||||
if types.CouncilStand != "StandCouncil" {
|
||||
t.Errorf("CouncilStand = %q", types.CouncilStand)
|
||||
}
|
||||
}
|
||||
|
||||
// TestMissionLockAmendableConstFalse asserts the global Mission-Lock const
|
||||
// is false (vision §19, REQ-011): the Mission Lock can NEVER be amended.
|
||||
// This is the highest-severity regression firewall for the council module.
|
||||
// The const can NEVER be set true; this test is the firewall that breaks if
|
||||
// anyone flips the const.
|
||||
func TestMissionLockAmendableConstFalse(t *testing.T) {
|
||||
if types.MissionLockAmendable != false {
|
||||
t.Fatalf("MissionLockAmendable = %v, expected false (Mission Lock non-amendable — vision §19)", types.MissionLockAmendable)
|
||||
}
|
||||
// Re-assert via a bool-typed comparison so the test fails to compile if
|
||||
// the const is ever changed to a non-bool type (defence in depth).
|
||||
var isFalse bool = types.MissionLockAmendable == false
|
||||
if !isFalse {
|
||||
t.Fatal("MissionLockAmendable must equal false")
|
||||
}
|
||||
}
|
||||
|
||||
// TestMissionLockAmendableCannotBeSetTrue asserts the const cannot be set
|
||||
// true — it is a compile-time const, not a runtime variable. The test
|
||||
// constructs an expression that would fail to compile if the const were a
|
||||
// mutable var (the const-ness is the firewall). This is the regression
|
||||
// firewall the spec mandates: "a test asserting it can never be set true".
|
||||
func TestMissionLockAmendableCannotBeSetTrue(t *testing.T) {
|
||||
// The const is declared as `const MissionLockAmendable = false`. Go
|
||||
// consts cannot be reassigned at runtime. The test below would be a
|
||||
// compile error if it tried to assign to the const:
|
||||
// types.MissionLockAmendable = true // cannot assign to const
|
||||
// So the firewall IS the compile-time const-ness. We assert the value
|
||||
// is false and the type is bool (so a future change to a string or int
|
||||
// would break the typed comparison above). The regression guard is that
|
||||
// any PR flipping the const to true breaks TestMissionLockAmendableConstFalse
|
||||
// AND any PR changing it to a var breaks the `const` declaration (Go
|
||||
// compiler rejects assignment to a var-typed const in other code paths).
|
||||
if types.MissionLockAmendable {
|
||||
t.Fatal("MissionLockAmendable must be false; the const is the firewall — flipping it to true is a Mission Lock breach")
|
||||
}
|
||||
}
|
||||
|
||||
// TestSignalKindCountLockedConst asserts SignalKindCount is exactly 4
|
||||
// (the four Freeholder signals, cross-ref v0.1 REQ-005 / vision §9.1).
|
||||
func TestSignalKindCountLockedConst(t *testing.T) {
|
||||
if types.SignalKindCount != 4 {
|
||||
t.Errorf("SignalKindCount = %d, expected 4 (REQ-005 four Freeholder signals)", types.SignalKindCount)
|
||||
}
|
||||
all := types.AllSignalKinds()
|
||||
if len(all) != 4 {
|
||||
t.Errorf("AllSignalKinds() len = %d, expected 4", len(all))
|
||||
}
|
||||
}
|
||||
|
||||
// TestAllSignalKindsNames asserts the 4 signal names (Stash, Standing,
|
||||
// Vouch, Capital) cross-ref v0.1 x/standing FreeholderSignals (StashMaturity,
|
||||
// MultiDomainStanding, CommunityEndorsement, CommittedCapital).
|
||||
func TestAllSignalKindsNames(t *testing.T) {
|
||||
want := []string{"Stash", "Standing", "Vouch", "Capital"}
|
||||
all := types.AllSignalKinds()
|
||||
if len(all) != len(want) {
|
||||
t.Fatalf("len = %d, want %d", len(all), len(want))
|
||||
}
|
||||
seen := map[string]bool{}
|
||||
for i, s := range all {
|
||||
if string(s) != want[i] {
|
||||
t.Errorf("AllSignalKinds()[%d] = %q, want %q", i, s, want[i])
|
||||
}
|
||||
if seen[string(s)] {
|
||||
t.Errorf("duplicate SignalKind %q", s)
|
||||
}
|
||||
seen[string(s)] = true
|
||||
}
|
||||
}
|
||||
|
||||
// TestSignalKindValues asserts each named const matches its AllSignalKinds
|
||||
// entry.
|
||||
func TestSignalKindValues(t *testing.T) {
|
||||
if types.SignalStash != "Stash" {
|
||||
t.Errorf("SignalStash = %q", types.SignalStash)
|
||||
}
|
||||
if types.SignalStanding != "Standing" {
|
||||
t.Errorf("SignalStanding = %q", types.SignalStanding)
|
||||
}
|
||||
if types.SignalVouch != "Vouch" {
|
||||
t.Errorf("SignalVouch = %q", types.SignalVouch)
|
||||
}
|
||||
if types.SignalCapital != "Capital" {
|
||||
t.Errorf("SignalCapital = %q", types.SignalCapital)
|
||||
}
|
||||
}
|
||||
|
||||
// TestTallyResultStructShape asserts TallyResult mirrors x/gov shape (A-204):
|
||||
// fields yes, no, abstain, nowithveto, total, quorum_met. The no-with-veto
|
||||
// field is kept for x/gov parity but always 0 (OY has no veto option —
|
||||
// anti-greed, vision §19). The test asserts the field names via JSON tags
|
||||
// and that NoWithVeto is zero by default.
|
||||
func TestTallyResultStructShape(t *testing.T) {
|
||||
tr := types.TallyResult{
|
||||
Yes: 10,
|
||||
No: 3,
|
||||
Abstain: 1,
|
||||
NoWithVeto: 0, // always 0 — no veto option
|
||||
Total: 14,
|
||||
QuorumMet: true,
|
||||
}
|
||||
if tr.Yes != 10 || tr.No != 3 || tr.Abstain != 1 || tr.NoWithVeto != 0 ||
|
||||
tr.Total != 14 || tr.QuorumMet != true {
|
||||
t.Error("TallyResult fields not set correctly")
|
||||
}
|
||||
// x/gov field-name parity: marshal and check JSON tags.
|
||||
bz, err := json.Marshal(tr)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
js := string(bz)
|
||||
for _, tag := range []string{`"yes"`, `"no"`, `"abstain"`, `"nowithveto"`, `"total"`, `"quorum_met"`} {
|
||||
if !strings.Contains(js, tag) {
|
||||
t.Errorf("TallyResult JSON missing tag %s (x/gov shape parity A-204)", tag)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestTallyResultNoWithVetoAlwaysZero asserts the default TallyResult has
|
||||
// NoWithVeto == 0 (the anti-greed invariant — no veto option in OY).
|
||||
func TestTallyResultNoWithVetoAlwaysZero(t *testing.T) {
|
||||
var tr types.TallyResult
|
||||
if tr.NoWithVeto != 0 {
|
||||
t.Errorf("default TallyResult.NoWithVeto = %d, expected 0 (no veto option — anti-greed)", tr.NoWithVeto)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCouncilStructFields asserts Council carries all required fields
|
||||
// including the by-ID-string refs (stand-id-ref, guild-id-ref per G-003).
|
||||
func TestCouncilStructFields(t *testing.T) {
|
||||
c := types.Council{
|
||||
CouncilID: "c1",
|
||||
Kind: types.CouncilStand,
|
||||
StandIDRef: "stand-xyz",
|
||||
GuildIDRef: "",
|
||||
Members: []types.CouncilMember{{ReachID: "reach:a", VoiceWeight: 5, JoinedAt: 100}},
|
||||
VoiceThreshold: 3,
|
||||
}
|
||||
if c.CouncilID != "c1" || c.Kind != types.CouncilStand || c.StandIDRef != "stand-xyz" ||
|
||||
c.GuildIDRef != "" || len(c.Members) != 1 || c.VoiceThreshold != 3 {
|
||||
t.Error("Council fields not set correctly")
|
||||
}
|
||||
}
|
||||
|
||||
// TestCouncilStructRefsAreStrings asserts stand-id-ref and guild-id-ref are
|
||||
// string-typed (G-003 by-ID-string invariant; the G-003 import invariant is
|
||||
// enforced project-wide by P1-01-02's go/parser scan, so this test only
|
||||
// asserts the field types at the struct level, not cross-module imports).
|
||||
func TestCouncilStructRefsAreStrings(t *testing.T) {
|
||||
c := types.Council{StandIDRef: "stand-abc", GuildIDRef: "guild-def"}
|
||||
if c.StandIDRef != "stand-abc" {
|
||||
t.Errorf("StandIDRef = %q", c.StandIDRef)
|
||||
}
|
||||
if c.GuildIDRef != "guild-def" {
|
||||
t.Errorf("GuildIDRef = %q", c.GuildIDRef)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCouncilMemberStructFields asserts CouncilMember uses reach-id (NOT
|
||||
// the banned financial holder term — lexicon-clean).
|
||||
func TestCouncilMemberStructFields(t *testing.T) {
|
||||
m := types.CouncilMember{ReachID: "reach:a", VoiceWeight: 7, JoinedAt: 200}
|
||||
if m.ReachID != "reach:a" || m.VoiceWeight != 7 || m.JoinedAt != 200 {
|
||||
t.Error("CouncilMember fields not set correctly")
|
||||
}
|
||||
}
|
||||
|
||||
// TestVoiceStructFields asserts Voice carries all required fields.
|
||||
func TestVoiceStructFields(t *testing.T) {
|
||||
v := types.Voice{
|
||||
VoiceID: "v1",
|
||||
CouncilID: "c1",
|
||||
ProposerReach: "reach:prop",
|
||||
SignalKind: types.SignalStash,
|
||||
TargetRef: "proposal:p1",
|
||||
Tally: types.TallyResult{Yes: 1, Total: 1, QuorumMet: true},
|
||||
Timestamp: 999,
|
||||
}
|
||||
if v.VoiceID != "v1" || v.CouncilID != "c1" || v.ProposerReach != "reach:prop" ||
|
||||
v.SignalKind != types.SignalStash || v.TargetRef != "proposal:p1" ||
|
||||
v.Tally.Yes != 1 || v.Tally.Total != 1 || v.Tally.QuorumMet != true || v.Timestamp != 999 {
|
||||
t.Error("Voice fields not set correctly")
|
||||
}
|
||||
}
|
||||
|
||||
// TestDefaultGenesisStateEmpty asserts DefaultGenesisState returns non-nil
|
||||
// empty slices for Councils and Voices.
|
||||
func TestDefaultGenesisStateEmpty(t *testing.T) {
|
||||
gs := types.DefaultGenesisState()
|
||||
if gs == nil {
|
||||
t.Fatal("DefaultGenesisState returned nil")
|
||||
}
|
||||
if gs.Councils == nil || len(gs.Councils) != 0 {
|
||||
t.Errorf("Default Councils should be non-nil empty slice; got len=%d nil=%v", len(gs.Councils), gs.Councils == nil)
|
||||
}
|
||||
if gs.Voices == nil || len(gs.Voices) != 0 {
|
||||
t.Errorf("Default Voices should be non-nil empty slice; got len=%d nil=%v", len(gs.Voices), gs.Voices == nil)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsDupCouncilIDs asserts A-212: duplicate
|
||||
// council-ids are rejected.
|
||||
func TestValidateGenesisRejectsDupCouncilIDs(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{
|
||||
{CouncilID: "c1", Kind: types.CouncilMesh},
|
||||
{CouncilID: "c1", Kind: types.CouncilGuild, GuildIDRef: "g1"}, // dup
|
||||
},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject duplicate council-ids")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsDupVoiceIDs asserts A-212: duplicate voice-ids
|
||||
// are rejected.
|
||||
func TestValidateGenesisRejectsDupVoiceIDs(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "c1", Kind: types.CouncilMesh}},
|
||||
Voices: []types.Voice{
|
||||
{VoiceID: "v1", CouncilID: "c1", SignalKind: types.SignalStash},
|
||||
{VoiceID: "v1", CouncilID: "c1", SignalKind: types.SignalVouch}, // dup
|
||||
},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject duplicate voice-ids")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsEmptyCouncilID asserts empty council-id is
|
||||
// rejected.
|
||||
func TestValidateGenesisRejectsEmptyCouncilID(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "", Kind: types.CouncilMesh}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject empty council-id")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsEmptyVoiceID asserts empty voice-id is rejected.
|
||||
func TestValidateGenesisRejectsEmptyVoiceID(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "c1", Kind: types.CouncilMesh}},
|
||||
Voices: []types.Voice{{VoiceID: "", CouncilID: "c1", SignalKind: types.SignalStash}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject empty voice-id")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsUnknownCouncilKind asserts an unknown
|
||||
// CouncilKind is rejected (data-engineer schema validation).
|
||||
func TestValidateGenesisRejectsUnknownCouncilKind(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "c1", Kind: types.CouncilKind("Bogus")}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject unknown council kind")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsUnknownSignalKind asserts an unknown SignalKind
|
||||
// is rejected.
|
||||
func TestValidateGenesisRejectsUnknownSignalKind(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "c1", Kind: types.CouncilMesh}},
|
||||
Voices: []types.Voice{{VoiceID: "v1", CouncilID: "c1", SignalKind: types.SignalKind("Bogus")}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject unknown signal-kind")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsBadJSON asserts malformed JSON is rejected.
|
||||
func TestValidateGenesisRejectsBadJSON(t *testing.T) {
|
||||
if err := types.ValidateGenesis(json.RawMessage(`{not json`)); err == nil {
|
||||
t.Error("ValidateGenesis should reject malformed JSON")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisAcceptsClean asserts a clean genesis validates.
|
||||
func TestValidateGenesisAcceptsClean(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{
|
||||
{CouncilID: "cm", Kind: types.CouncilMesh},
|
||||
{CouncilID: "cg", Kind: types.CouncilGuild, GuildIDRef: "g1"},
|
||||
{CouncilID: "cs", Kind: types.CouncilStand, StandIDRef: "s1"},
|
||||
},
|
||||
Voices: []types.Voice{
|
||||
{VoiceID: "v1", CouncilID: "cm", SignalKind: types.SignalStash},
|
||||
{VoiceID: "v2", CouncilID: "cs", SignalKind: types.SignalCapital},
|
||||
},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err != nil {
|
||||
t.Errorf("ValidateGenesis should accept clean genesis, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsStandCouncilWithoutStandIDRef asserts a Stand
|
||||
// Council without stand-id-ref is rejected (by-ID-string ref to x/stand).
|
||||
func TestValidateGenesisRejectsStandCouncilWithoutStandIDRef(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "cs", Kind: types.CouncilStand, StandIDRef: ""}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject Stand Council without stand-id-ref")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsGuildCouncilWithoutGuildIDRef asserts a Guild
|
||||
// Council without guild-id-ref is rejected (by-ID-string ref to x/guild).
|
||||
func TestValidateGenesisRejectsGuildCouncilWithoutGuildIDRef(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "cg", Kind: types.CouncilGuild, GuildIDRef: ""}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject Guild Council without guild-id-ref")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsVoiceWithUnknownCouncil asserts referential
|
||||
// integrity: a Voice whose council-id does not reference an existing
|
||||
// Council is rejected (P3-01-03 deliverable).
|
||||
func TestValidateGenesisRejectsVoiceWithUnknownCouncil(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Councils: []types.Council{{CouncilID: "c1", Kind: types.CouncilMesh}},
|
||||
Voices: []types.Voice{{VoiceID: "v1", CouncilID: "no-such-council", SignalKind: types.SignalStash}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject Voice with unknown council-id (referential integrity)")
|
||||
}
|
||||
}
|
||||
|
||||
// TestMissionLockCheckIsNoOp asserts the genesis-side MissionLockCheck helper
|
||||
// is a no-op (the const is the true firewall). It must return nil for any
|
||||
// slice of Councils.
|
||||
func TestMissionLockCheckIsNoOp(t *testing.T) {
|
||||
councils := []types.Council{
|
||||
{CouncilID: "c1", Kind: types.CouncilMesh},
|
||||
{CouncilID: "c2", Kind: types.CouncilGuild, GuildIDRef: "g1"},
|
||||
{CouncilID: "c3", Kind: types.CouncilStand, StandIDRef: "s1"},
|
||||
}
|
||||
if err := types.MissionLockCheck(councils); err != nil {
|
||||
t.Errorf("MissionLockCheck should be a no-op (const is the firewall), got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestModuleConsts asserts the four Cosmos-convention module consts.
|
||||
func TestModuleConsts(t *testing.T) {
|
||||
if types.ModuleName != "council" {
|
||||
t.Errorf("ModuleName = %q", types.ModuleName)
|
||||
}
|
||||
if types.StoreKey != "council" {
|
||||
t.Errorf("StoreKey = %q", types.StoreKey)
|
||||
}
|
||||
if types.RouterKey != "council" {
|
||||
t.Errorf("RouterKey = %q", types.RouterKey)
|
||||
}
|
||||
if types.QuerierRoute != "council" {
|
||||
t.Errorf("QuerierRoute = %q", types.QuerierRoute)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDefaultParams asserts DefaultParams returns a zero-value Params.
|
||||
func TestDefaultParams(t *testing.T) {
|
||||
_ = types.DefaultParams() // no panics
|
||||
}
|
||||
|
||||
// --- Lexicon assertion (REQ-012) -------------------------------------------------
|
||||
|
||||
// TestLexiconNoBannedTermsInCouncilPackage scans every non-test .go file in
|
||||
// the council/types package directory for the 9 banned terms
|
||||
// (case-insensitive). Production files only — the test file references
|
||||
// banned terms via the lexicon package helpers (standard lexicon-test
|
||||
// bootstrapping pattern; no banned literals are inlined in this test file).
|
||||
func TestLexiconNoBannedTermsInCouncilPackage(t *testing.T) {
|
||||
pkgDir := packageDir(t, "github.com/oy/openyield/x/council/types")
|
||||
files, err := filepath.Glob(filepath.Join(pkgDir, "*.go"))
|
||||
if err != nil {
|
||||
t.Fatalf("glob: %v", err)
|
||||
}
|
||||
prodFiles := []string{}
|
||||
for _, f := range files {
|
||||
if strings.HasSuffix(f, "_test.go") {
|
||||
continue
|
||||
}
|
||||
prodFiles = append(prodFiles, f)
|
||||
}
|
||||
if len(prodFiles) == 0 {
|
||||
t.Fatal("no production .go files found in council/types")
|
||||
}
|
||||
for _, f := range prodFiles {
|
||||
bz, err := os.ReadFile(f)
|
||||
if err != nil {
|
||||
t.Fatalf("read %s: %v", f, err)
|
||||
}
|
||||
if found, ok := lexicon.FindBannedTerm(string(bz)); ok {
|
||||
t.Errorf("%s: banned term %q (REQ-012 lexicon firewall)", filepath.Base(f), found)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestLexiconNoBannedTermsInCouncilTestFile asserts this test file itself
|
||||
// does not contain any banned term as a literal (the firewall scans test
|
||||
// files too; the lexicon helpers must be used rather than inlining banned
|
||||
// terms). This is the self-bootstrapping check.
|
||||
func TestLexiconNoBannedTermsInCouncilTestFile(t *testing.T) {
|
||||
_, thisFile, _, ok := runtime.Caller(0)
|
||||
if !ok {
|
||||
t.Fatal("runtime.Caller failed")
|
||||
}
|
||||
bz, err := os.ReadFile(thisFile)
|
||||
if err != nil {
|
||||
t.Fatalf("read self: %v", err)
|
||||
}
|
||||
if found, ok := lexicon.FindBannedTerm(string(bz)); ok {
|
||||
t.Fatalf("council test file contains banned term %q — use lexicon helpers, not literals", found)
|
||||
}
|
||||
}
|
||||
|
||||
// packageDir resolves a Go import path to its filesystem directory by
|
||||
// walking up from this test file (v0.2 skeleton has zero external deps).
|
||||
func packageDir(t *testing.T, importPath string) string {
|
||||
t.Helper()
|
||||
_, file, _, ok := runtime.Caller(0)
|
||||
if !ok {
|
||||
t.Fatal("runtime.Caller failed")
|
||||
}
|
||||
// file = .../oy/x/council/types/types_test.go -> repoRoot = .../oy (4 dirs up)
|
||||
repoRoot := filepath.Dir(filepath.Dir(filepath.Dir(filepath.Dir(file))))
|
||||
rel := strings.TrimPrefix(importPath, "github.com/oy/openyield/")
|
||||
return filepath.Join(repoRoot, rel)
|
||||
}
|
||||
@@ -0,0 +1,71 @@
|
||||
package types
|
||||
|
||||
import "fmt"
|
||||
|
||||
// genesis.go holds the data-engineer's genesis schema helpers for the
|
||||
// forex module (G-008 split). ValidateGenesis in types.go composes these
|
||||
// helpers; the security-engineer's test assertions live in types_test.go.
|
||||
//
|
||||
// The Forex genesis schema has two top-level sets: Pairs (the tradable
|
||||
// ForexPairs) and Providers (the oracle-provider registry). The
|
||||
// invariants enforced at genesis load are (1) pair-id uniqueness and
|
||||
// (2) provider-id uniqueness (A-212 upgrade from v0.1's no-op). The
|
||||
// lexicon firewall is the highest-severity constraint for this module
|
||||
// (RESEARCH §1.10): the data-engineer's schema uses "base-asset"/"quote-
|
||||
// asset" field names (A-208 "Bread/Asset" labels) and never the banned
|
||||
// financial terms for tradable units.
|
||||
|
||||
// ValidatePairs asserts pair-ids are present and unique, and that the
|
||||
// base-asset / quote-asset labels are non-empty (the lexicon-clean "Bread/
|
||||
// Asset" labels per A-208 — the schema trusts the labels are lexicon-clean
|
||||
// because the production code never inlines a banned term; the project-wide
|
||||
// meta-test in lexicon_meta_test.go is the durable firewall). This is the
|
||||
// P3-02-03 data-engineer schema validator composed by ValidateGenesis.
|
||||
func ValidatePairs(pairs []ForexPair) error {
|
||||
seen := make(map[string]bool, len(pairs))
|
||||
for i, p := range pairs {
|
||||
if p.PairID == "" {
|
||||
return fmt.Errorf("forex pair [%d]: empty pair-id", i)
|
||||
}
|
||||
if seen[p.PairID] {
|
||||
return fmt.Errorf("forex: duplicate pair-id %q", p.PairID)
|
||||
}
|
||||
seen[p.PairID] = true
|
||||
if p.BaseAsset == "" {
|
||||
return fmt.Errorf("forex pair %q: empty base-asset", p.PairID)
|
||||
}
|
||||
if p.QuoteAsset == "" {
|
||||
return fmt.Errorf("forex pair %q: empty quote-asset", p.PairID)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ValidateProviders asserts provider-ids are present and unique, and that
|
||||
// each provider's kind is a known OracleKind.
|
||||
func ValidateProviders(providers []OracleProvider) error {
|
||||
seen := make(map[string]bool, len(providers))
|
||||
for i, p := range providers {
|
||||
if p.ProviderID == "" {
|
||||
return fmt.Errorf("forex provider [%d]: empty provider-id", i)
|
||||
}
|
||||
if seen[p.ProviderID] {
|
||||
return fmt.Errorf("forex: duplicate provider-id %q", p.ProviderID)
|
||||
}
|
||||
seen[p.ProviderID] = true
|
||||
if !knownOracleKind(p.Kind) {
|
||||
return fmt.Errorf("forex provider %q: unknown oracle kind %q", p.ProviderID, p.Kind)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// knownOracleKind reports whether k is one of the four OracleKind values.
|
||||
func knownOracleKind(k OracleKind) bool {
|
||||
for _, kk := range AllOracleKinds() {
|
||||
if k == kk {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -0,0 +1,155 @@
|
||||
package types
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
const (
|
||||
ModuleName = "forex"
|
||||
StoreKey = ModuleName
|
||||
RouterKey = ModuleName
|
||||
QuerierRoute = ModuleName
|
||||
|
||||
// SpreadCapBps is the LOCKED spread cap for Forex rates (vision §18
|
||||
// risk #18, A-214). The exact value is deferred to a v0.3 decision; the
|
||||
// skeleton sets a documented placeholder of 0 (≥0 invariant). The test
|
||||
// asserts SpreadCapBps >= 0. A v0.3+ governance decision may set a
|
||||
// positive cap; the placeholder is the locked skeleton value.
|
||||
SpreadCapBps = 0
|
||||
|
||||
// OracleKindCount is the locked count of OracleKind enum values
|
||||
// (vision §13 / Forex v1). A regression firewall: adding/removing/
|
||||
// renaming an Oracle kind breaks this const's test.
|
||||
OracleKindCount = 4
|
||||
|
||||
// ErrOracleNotIntegrated is the sentinel error returned by the stub
|
||||
// keeper GetRate when no live oracle is wired (skeleton — Phase 3
|
||||
// wires Piers as the oracle consumer). The sentinel is the "not-
|
||||
// integrated" marker the spec mandates.
|
||||
ErrOracleNotIntegrated = "forex oracle not integrated (Phase 3 wires Piers)"
|
||||
)
|
||||
|
||||
// ForexPair is a tradable pair in the Forex Engine v1 (vision §13, Forex v1).
|
||||
// base-asset / quote-asset use "Bread/Asset" style labels (A-208) — NOT the
|
||||
// banned financial terms for tradable units (which are lexicon-hostile per
|
||||
// RESEARCH §1.10). "Forex" itself is allowed (vision §13 names it). The
|
||||
// pair is a (base, quote) tuple of asset labels plus a decimals precision.
|
||||
// The labels are opaque strings (e.g. "Bread"/"Asset") so downstream modules
|
||||
// reference pairs by ID without importing banned terms.
|
||||
type ForexPair struct {
|
||||
PairID string `json:"pair_id" yaml:"pair_id"`
|
||||
BaseAsset string `json:"base_asset" yaml:"base_asset"`
|
||||
QuoteAsset string `json:"quote_asset" yaml:"quote_asset"`
|
||||
Decimals uint32 `json:"decimals" yaml:"decimals"`
|
||||
}
|
||||
|
||||
// RateOracle is the Go interface a Forex rate oracle must satisfy (Forex v1).
|
||||
// GetRate returns the current rate for a pair-id (as a fixed-point uint64),
|
||||
// the timestamp of the rate (block/unix time), and an error if the oracle
|
||||
// is unavailable or the pair-id is unknown. The interface has no impl in
|
||||
// v0.2 (skeleton — Phase 3 wires Piers as the oracle consumer per the
|
||||
// soft-ordering note in PLANS.md cross-phase map).
|
||||
type RateOracle interface {
|
||||
GetRate(pairID string) (rate uint64, timestamp int64, err error)
|
||||
}
|
||||
|
||||
// OracleKind enumerates the supported oracle providers (Forex v1).
|
||||
// Chainlink (aggregated off-chain reports), Pyth (low-latency pull-based),
|
||||
// UMA (optimistic oracle with dispute window), Internal (a protocol-internal
|
||||
// rate source — e.g. a DEX TWAP). The skeleton defines the enum only; no
|
||||
// live integration.
|
||||
type OracleKind string
|
||||
|
||||
const (
|
||||
OracleChainlink OracleKind = "Chainlink"
|
||||
OraclePyth OracleKind = "Pyth"
|
||||
OracleUMA OracleKind = "UMA"
|
||||
OracleInternal OracleKind = "Internal"
|
||||
)
|
||||
|
||||
// AllOracleKinds returns all four OracleKind values in Forex v1 order.
|
||||
// Locked-const test asserts exactly 4 entries with these names.
|
||||
func AllOracleKinds() []OracleKind {
|
||||
return []OracleKind{
|
||||
OracleChainlink,
|
||||
OraclePyth,
|
||||
OracleUMA,
|
||||
OracleInternal,
|
||||
}
|
||||
}
|
||||
|
||||
// OracleProvider is a registered oracle provider in the Forex Engine
|
||||
// (Forex v1). id is the provider's unique identifier; name is a human-
|
||||
// readable label; kind picks the OracleKind (Chainlink/Pyth/UMA/Internal).
|
||||
type OracleProvider struct {
|
||||
ProviderID string `json:"provider_id" yaml:"provider_id"`
|
||||
Name string `json:"name" yaml:"name"`
|
||||
Kind OracleKind `json:"kind" yaml:"kind"`
|
||||
}
|
||||
|
||||
// SpotRate is a single spot-rate observation for a ForexPair (Forex v1).
|
||||
// pair-id references the ForexPair by ID string (G-003); rate is the fixed-
|
||||
// point uint64 rate; timestamp is the observation time; provider-id
|
||||
// references the OracleProvider by ID string (G-003).
|
||||
type SpotRate struct {
|
||||
PairID string `json:"pair_id" yaml:"pair_id"`
|
||||
Rate uint64 `json:"rate" yaml:"rate"`
|
||||
Timestamp int64 `json:"timestamp" yaml:"timestamp"`
|
||||
ProviderID string `json:"provider_id" yaml:"provider_id"`
|
||||
}
|
||||
|
||||
// StubOracle is the stub keeper for the Forex Engine (Forex v1). GetRate
|
||||
// returns the sentinel ErrOracleNotIntegrated for any pair-id (the skeleton
|
||||
// is not wired to a live oracle — Phase 3 wires Piers). The stub satisfies
|
||||
// the RateOracle interface so the interface compiles and a stub impl is
|
||||
// callable from tests.
|
||||
type StubOracle struct{}
|
||||
|
||||
// GetRate returns the sentinel "not-integrated" rate for any pair-id.
|
||||
// The skeleton never returns a live rate; Phase 3 wires the real keeper.
|
||||
func (StubOracle) GetRate(pairID string) (uint64, int64, error) {
|
||||
_ = pairID
|
||||
return 0, 0, fmt.Errorf("%s", ErrOracleNotIntegrated)
|
||||
}
|
||||
|
||||
// Params for the forex module (skeleton — no tunables in v0.2; SpreadCapBps
|
||||
// is the locked const, not a tunable param).
|
||||
type Params struct{}
|
||||
|
||||
func DefaultParams() Params { return Params{} }
|
||||
|
||||
// GenesisState defines the forex module genesis state (Forex v1).
|
||||
// Pairs is the top-level set of ForexPairs; Providers is the oracle-provider
|
||||
// registry. ValidateGenesis enforces pair-id uniqueness and provider-id
|
||||
// uniqueness. The data-engineer's genesis.go holds the schema helpers (G-008).
|
||||
type GenesisState struct {
|
||||
Pairs []ForexPair `json:"pairs" yaml:"pairs"`
|
||||
Providers []OracleProvider `json:"providers" yaml:"providers"`
|
||||
Params Params `json:"params" yaml:"params"`
|
||||
}
|
||||
|
||||
func DefaultGenesisState() *GenesisState {
|
||||
return &GenesisState{
|
||||
Pairs: []ForexPair{},
|
||||
Providers: []OracleProvider{},
|
||||
Params: DefaultParams(),
|
||||
}
|
||||
}
|
||||
|
||||
// ValidateGenesis performs ID-uniqueness checks (A-212 upgrade from v0.1
|
||||
// no-op): rejects duplicate pair-ids and duplicate provider-ids. Delegates
|
||||
// to the data-engineer's genesis.go helpers (G-008).
|
||||
func ValidateGenesis(bz json.RawMessage) error {
|
||||
var gs GenesisState
|
||||
if err := json.Unmarshal(bz, &gs); err != nil {
|
||||
return fmt.Errorf("forex: invalid genesis: %w", err)
|
||||
}
|
||||
if err := ValidatePairs(gs.Pairs); err != nil {
|
||||
return fmt.Errorf("forex: %w", err)
|
||||
}
|
||||
if err := ValidateProviders(gs.Providers); err != nil {
|
||||
return fmt.Errorf("forex: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,421 @@
|
||||
package types_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/oy/openyield/lexicon"
|
||||
"github.com/oy/openyield/x/forex/types"
|
||||
)
|
||||
|
||||
// TestOracleKindCountLockedConst asserts OracleKindCount is exactly 4 and
|
||||
// AllOracleKinds() returns exactly 4 (Forex v1). A regression firewall:
|
||||
// adding/removing/renaming an Oracle kind breaks this test.
|
||||
func TestOracleKindCountLockedConst(t *testing.T) {
|
||||
if types.OracleKindCount != 4 {
|
||||
t.Errorf("OracleKindCount = %d, expected 4 (Forex v1 LOCKED)", types.OracleKindCount)
|
||||
}
|
||||
all := types.AllOracleKinds()
|
||||
if len(all) != 4 {
|
||||
t.Errorf("AllOracleKinds() len = %d, expected 4", len(all))
|
||||
}
|
||||
}
|
||||
|
||||
// TestAllOracleKindsNames asserts the 4 oracle-kind names in order with no
|
||||
// extras, no dups, no renames.
|
||||
func TestAllOracleKindsNames(t *testing.T) {
|
||||
want := []string{"Chainlink", "Pyth", "UMA", "Internal"}
|
||||
all := types.AllOracleKinds()
|
||||
if len(all) != len(want) {
|
||||
t.Fatalf("len = %d, want %d", len(all), len(want))
|
||||
}
|
||||
seen := map[string]bool{}
|
||||
for i, k := range all {
|
||||
if string(k) != want[i] {
|
||||
t.Errorf("AllOracleKinds()[%d] = %q, want %q", i, k, want[i])
|
||||
}
|
||||
if seen[string(k)] {
|
||||
t.Errorf("duplicate OracleKind %q", k)
|
||||
}
|
||||
seen[string(k)] = true
|
||||
}
|
||||
}
|
||||
|
||||
// TestOracleKindValues asserts each named const matches its AllOracleKinds
|
||||
// entry.
|
||||
func TestOracleKindValues(t *testing.T) {
|
||||
if types.OracleChainlink != "Chainlink" {
|
||||
t.Errorf("OracleChainlink = %q", types.OracleChainlink)
|
||||
}
|
||||
if types.OraclePyth != "Pyth" {
|
||||
t.Errorf("OraclePyth = %q", types.OraclePyth)
|
||||
}
|
||||
if types.OracleUMA != "UMA" {
|
||||
t.Errorf("OracleUMA = %q", types.OracleUMA)
|
||||
}
|
||||
if types.OracleInternal != "Internal" {
|
||||
t.Errorf("OracleInternal = %q", types.OracleInternal)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSpreadCapBpsNonNegative asserts SpreadCapBps >= 0 (A-214: the exact
|
||||
// value is deferred to v0.3; the skeleton uses a documented placeholder of
|
||||
// 0; the test asserts the invariant is non-negative).
|
||||
func TestSpreadCapBpsNonNegative(t *testing.T) {
|
||||
if types.SpreadCapBps < 0 {
|
||||
t.Errorf("SpreadCapBps = %d, expected >= 0 (A-214)", types.SpreadCapBps)
|
||||
}
|
||||
// The skeleton placeholder is exactly 0 (documented TBD per A-214).
|
||||
if types.SpreadCapBps != 0 {
|
||||
t.Logf("SpreadCapBps = %d (skeleton placeholder is 0; v0.3 may set a positive cap)", types.SpreadCapBps)
|
||||
}
|
||||
}
|
||||
|
||||
// TestForexPairStructFields asserts ForexPair uses base-asset / quote-asset
|
||||
// field names (A-208 "Bread/Asset" labels) — NOT the banned financial terms
|
||||
// for tradable units (lexicon-hostile per RESEARCH §1.10). The test asserts
|
||||
// the field names via JSON tags and constructs a sample pair with lexicon-
|
||||
// clean labels.
|
||||
func TestForexPairStructFields(t *testing.T) {
|
||||
p := types.ForexPair{
|
||||
PairID: "pair-1",
|
||||
BaseAsset: "Bread",
|
||||
QuoteAsset: "Asset",
|
||||
Decimals: 8,
|
||||
}
|
||||
if p.PairID != "pair-1" || p.BaseAsset != "Bread" || p.QuoteAsset != "Asset" || p.Decimals != 8 {
|
||||
t.Error("ForexPair fields not set correctly")
|
||||
}
|
||||
// Assert the JSON tags are "base_asset"/"quote_asset" (NOT the banned
|
||||
// tradable-unit terms). This is the lexicon shape invariant.
|
||||
bz, err := json.Marshal(p)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
js := string(bz)
|
||||
if !strings.Contains(js, `"base_asset"`) {
|
||||
t.Error("ForexPair JSON missing base_asset tag (A-208)")
|
||||
}
|
||||
if !strings.Contains(js, `"quote_asset"`) {
|
||||
t.Error("ForexPair JSON missing quote_asset tag (A-208)")
|
||||
}
|
||||
}
|
||||
|
||||
// TestForexPairLabelsLexiconClean asserts the sample pair labels ("Bread"/
|
||||
// "Asset") are lexicon-clean — the highest-severity check for the forex
|
||||
// module (RESEARCH §1.10). The test scans the literal labels used in this
|
||||
// test file AND the production types.go for any banned term.
|
||||
func TestForexPairLabelsLexiconClean(t *testing.T) {
|
||||
// Sample labels per A-208.
|
||||
labels := []string{"Bread", "Asset", "base_asset", "quote_asset", "BaseAsset", "QuoteAsset"}
|
||||
for _, l := range labels {
|
||||
if found, ok := lexicon.FindBannedTerm(l); ok {
|
||||
t.Errorf("label %q contains banned term %q (A-208 lexicon-clean labels)", l, found)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRateOracleInterfaceCompiles asserts the RateOracle interface signature
|
||||
// compiles and a stub impl satisfies it. This is the interface-shape
|
||||
// regression firewall: GetRate(pairID) (rate uint64, timestamp int64, err error).
|
||||
func TestRateOracleInterfaceCompiles(t *testing.T) {
|
||||
var oracle types.RateOracle = types.StubOracle{}
|
||||
if oracle == nil {
|
||||
t.Fatal("StubOracle should be non-nil")
|
||||
}
|
||||
// The interface method must be callable.
|
||||
_, _, err := oracle.GetRate("pair-1")
|
||||
if err == nil {
|
||||
t.Error("StubOracle.GetRate should return the not-integrated sentinel error")
|
||||
}
|
||||
}
|
||||
|
||||
// TestStubOracleGetRateSentinel asserts the stub keeper GetRate returns the
|
||||
// sentinel "not-integrated" error for any pair-id (Forex v1 stub; Phase 3
|
||||
// wires Piers as the oracle consumer).
|
||||
func TestStubOracleGetRateSentinel(t *testing.T) {
|
||||
stub := types.StubOracle{}
|
||||
rate, ts, err := stub.GetRate("any-pair-id")
|
||||
if err == nil {
|
||||
t.Fatal("StubOracle.GetRate should error (not integrated)")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "not integrated") {
|
||||
t.Errorf("StubOracle.GetRate error = %q, want sentinel containing 'not integrated'", err.Error())
|
||||
}
|
||||
if rate != 0 {
|
||||
t.Errorf("StubOracle.GetRate rate = %d, expected 0 (sentinel)", rate)
|
||||
}
|
||||
if ts != 0 {
|
||||
t.Errorf("StubOracle.GetRate timestamp = %d, expected 0 (sentinel)", ts)
|
||||
}
|
||||
}
|
||||
|
||||
// TestStubOracleSatisfiesInterface asserts StubOracle satisfies the
|
||||
// RateOracle interface at compile time (var _ types.RateOracle = StubOracle{}
|
||||
// would be a compile error if the interface drifted).
|
||||
func TestStubOracleSatisfiesInterface(t *testing.T) {
|
||||
var _ types.RateOracle = types.StubOracle{}
|
||||
}
|
||||
|
||||
// TestOracleProviderStructFields asserts OracleProvider carries id, name,
|
||||
// kind.
|
||||
func TestOracleProviderStructFields(t *testing.T) {
|
||||
p := types.OracleProvider{
|
||||
ProviderID: "op-1",
|
||||
Name: "Chainlink FX",
|
||||
Kind: types.OracleChainlink,
|
||||
}
|
||||
if p.ProviderID != "op-1" || p.Name != "Chainlink FX" || p.Kind != types.OracleChainlink {
|
||||
t.Error("OracleProvider fields not set correctly")
|
||||
}
|
||||
}
|
||||
|
||||
// TestSpotRateStructFields asserts SpotRate carries pair-id, rate, timestamp,
|
||||
// provider-id (by-ID-string ref per G-003).
|
||||
func TestSpotRateStructFields(t *testing.T) {
|
||||
sr := types.SpotRate{
|
||||
PairID: "pair-1",
|
||||
Rate: 100000000,
|
||||
Timestamp: 1700000000,
|
||||
ProviderID: "op-1",
|
||||
}
|
||||
if sr.PairID != "pair-1" || sr.Rate != 100000000 || sr.Timestamp != 1700000000 || sr.ProviderID != "op-1" {
|
||||
t.Error("SpotRate fields not set correctly")
|
||||
}
|
||||
}
|
||||
|
||||
// TestDefaultGenesisStateEmpty asserts DefaultGenesisState returns non-nil
|
||||
// empty slices for Pairs and Providers.
|
||||
func TestDefaultGenesisStateEmpty(t *testing.T) {
|
||||
gs := types.DefaultGenesisState()
|
||||
if gs == nil {
|
||||
t.Fatal("DefaultGenesisState returned nil")
|
||||
}
|
||||
if gs.Pairs == nil || len(gs.Pairs) != 0 {
|
||||
t.Errorf("Default Pairs should be non-nil empty slice; got len=%d nil=%v", len(gs.Pairs), gs.Pairs == nil)
|
||||
}
|
||||
if gs.Providers == nil || len(gs.Providers) != 0 {
|
||||
t.Errorf("Default Providers should be non-nil empty slice; got len=%d nil=%v", len(gs.Providers), gs.Providers == nil)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsDupPairIDs asserts A-212: duplicate pair-ids
|
||||
// are rejected.
|
||||
func TestValidateGenesisRejectsDupPairIDs(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Pairs: []types.ForexPair{
|
||||
{PairID: "p1", BaseAsset: "Bread", QuoteAsset: "Asset"},
|
||||
{PairID: "p1", BaseAsset: "Bread", QuoteAsset: "Asset"}, // dup
|
||||
},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject duplicate pair-ids")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsDupProviderIDs asserts A-212: duplicate
|
||||
// provider-ids are rejected.
|
||||
func TestValidateGenesisRejectsDupProviderIDs(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Providers: []types.OracleProvider{
|
||||
{ProviderID: "op1", Name: "A", Kind: types.OracleChainlink},
|
||||
{ProviderID: "op1", Name: "B", Kind: types.OraclePyth}, // dup
|
||||
},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject duplicate provider-ids")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsEmptyPairID asserts empty pair-id is rejected.
|
||||
func TestValidateGenesisRejectsEmptyPairID(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Pairs: []types.ForexPair{{PairID: "", BaseAsset: "Bread", QuoteAsset: "Asset"}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject empty pair-id")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsEmptyProviderID asserts empty provider-id is
|
||||
// rejected.
|
||||
func TestValidateGenesisRejectsEmptyProviderID(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Providers: []types.OracleProvider{{ProviderID: "", Name: "A", Kind: types.OracleChainlink}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject empty provider-id")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsEmptyBaseAsset asserts empty base-asset is
|
||||
// rejected (the lexicon-clean label must be present).
|
||||
func TestValidateGenesisRejectsEmptyBaseAsset(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Pairs: []types.ForexPair{{PairID: "p1", BaseAsset: "", QuoteAsset: "Asset"}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject empty base-asset")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsEmptyQuoteAsset asserts empty quote-asset is
|
||||
// rejected.
|
||||
func TestValidateGenesisRejectsEmptyQuoteAsset(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Pairs: []types.ForexPair{{PairID: "p1", BaseAsset: "Bread", QuoteAsset: ""}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject empty quote-asset")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsUnknownOracleKind asserts an unknown OracleKind
|
||||
// is rejected.
|
||||
func TestValidateGenesisRejectsUnknownOracleKind(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Providers: []types.OracleProvider{{ProviderID: "op1", Name: "A", Kind: types.OracleKind("Bogus")}},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err == nil {
|
||||
t.Error("ValidateGenesis should reject unknown oracle kind")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisRejectsBadJSON asserts malformed JSON is rejected.
|
||||
func TestValidateGenesisRejectsBadJSON(t *testing.T) {
|
||||
if err := types.ValidateGenesis(json.RawMessage(`{not json`)); err == nil {
|
||||
t.Error("ValidateGenesis should reject malformed JSON")
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateGenesisAcceptsClean asserts a clean genesis validates.
|
||||
func TestValidateGenesisAcceptsClean(t *testing.T) {
|
||||
gs := types.GenesisState{
|
||||
Pairs: []types.ForexPair{
|
||||
{PairID: "p1", BaseAsset: "Bread", QuoteAsset: "Asset", Decimals: 8},
|
||||
{PairID: "p2", BaseAsset: "Bread", QuoteAsset: "Other", Decimals: 6},
|
||||
},
|
||||
Providers: []types.OracleProvider{
|
||||
{ProviderID: "op1", Name: "Chainlink FX", Kind: types.OracleChainlink},
|
||||
{ProviderID: "op2", Name: "Pyth FX", Kind: types.OraclePyth},
|
||||
},
|
||||
}
|
||||
bz, _ := json.Marshal(gs)
|
||||
if err := types.ValidateGenesis(bz); err != nil {
|
||||
t.Errorf("ValidateGenesis should accept clean genesis, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestModuleConsts asserts the four Cosmos-convention module consts.
|
||||
func TestModuleConsts(t *testing.T) {
|
||||
if types.ModuleName != "forex" {
|
||||
t.Errorf("ModuleName = %q", types.ModuleName)
|
||||
}
|
||||
if types.StoreKey != "forex" {
|
||||
t.Errorf("StoreKey = %q", types.StoreKey)
|
||||
}
|
||||
if types.RouterKey != "forex" {
|
||||
t.Errorf("RouterKey = %q", types.RouterKey)
|
||||
}
|
||||
if types.QuerierRoute != "forex" {
|
||||
t.Errorf("QuerierRoute = %q", types.QuerierRoute)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDefaultParams asserts DefaultParams returns a zero-value Params.
|
||||
func TestDefaultParams(t *testing.T) {
|
||||
_ = types.DefaultParams() // no panics
|
||||
}
|
||||
|
||||
// TestErrOracleNotIntegratedSentinel asserts the sentinel error string is
|
||||
// non-empty and mentions "not integrated".
|
||||
func TestErrOracleNotIntegratedSentinel(t *testing.T) {
|
||||
if types.ErrOracleNotIntegrated == "" {
|
||||
t.Error("ErrOracleNotIntegrated sentinel is empty")
|
||||
}
|
||||
if !strings.Contains(types.ErrOracleNotIntegrated, "not integrated") {
|
||||
t.Errorf("ErrOracleNotIntegrated = %q, want substring 'not integrated'", types.ErrOracleNotIntegrated)
|
||||
}
|
||||
}
|
||||
|
||||
// --- Lexicon assertion (REQ-012) -------------------------------------------------
|
||||
//
|
||||
// The forex module is the HIGHEST lexicon-risk module per RESEARCH §1.10
|
||||
// (the banned financial terms for tradable units are "natural" fit-words
|
||||
// for Forex). The lexicon assertion scans production files AND the test
|
||||
// file itself; sample pair-label data ("Bread"/"Asset") is asserted clean.
|
||||
|
||||
// TestLexiconNoBannedTermsInForexPackage scans every non-test .go file in
|
||||
// the forex/types package directory for the 9 banned terms
|
||||
// (case-insensitive). Production files only — the test file references
|
||||
// banned terms via the lexicon package helpers (standard lexicon-test
|
||||
// bootstrapping pattern; no banned literals are inlined in this test file).
|
||||
func TestLexiconNoBannedTermsInForexPackage(t *testing.T) {
|
||||
pkgDir := packageDir(t, "github.com/oy/openyield/x/forex/types")
|
||||
files, err := filepath.Glob(filepath.Join(pkgDir, "*.go"))
|
||||
if err != nil {
|
||||
t.Fatalf("glob: %v", err)
|
||||
}
|
||||
prodFiles := []string{}
|
||||
for _, f := range files {
|
||||
if strings.HasSuffix(f, "_test.go") {
|
||||
continue
|
||||
}
|
||||
prodFiles = append(prodFiles, f)
|
||||
}
|
||||
if len(prodFiles) == 0 {
|
||||
t.Fatal("no production .go files found in forex/types")
|
||||
}
|
||||
for _, f := range prodFiles {
|
||||
bz, err := os.ReadFile(f)
|
||||
if err != nil {
|
||||
t.Fatalf("read %s: %v", f, err)
|
||||
}
|
||||
if found, ok := lexicon.FindBannedTerm(string(bz)); ok {
|
||||
t.Errorf("%s: banned term %q (REQ-012 lexicon firewall — forex is highest risk)", filepath.Base(f), found)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestLexiconNoBannedTermsInForexTestFile asserts this test file itself does
|
||||
// not contain any banned term as a literal (the firewall scans test files
|
||||
// too; the lexicon helpers must be used rather than inlining banned terms).
|
||||
// This is the self-bootstrapping check.
|
||||
func TestLexiconNoBannedTermsInForexTestFile(t *testing.T) {
|
||||
_, thisFile, _, ok := runtime.Caller(0)
|
||||
if !ok {
|
||||
t.Fatal("runtime.Caller failed")
|
||||
}
|
||||
bz, err := os.ReadFile(thisFile)
|
||||
if err != nil {
|
||||
t.Fatalf("read self: %v", err)
|
||||
}
|
||||
if found, ok := lexicon.FindBannedTerm(string(bz)); ok {
|
||||
t.Fatalf("forex test file contains banned term %q — use lexicon helpers, not literals", found)
|
||||
}
|
||||
}
|
||||
|
||||
// packageDir resolves a Go import path to its filesystem directory by
|
||||
// walking up from this test file (v0.2 skeleton has zero external deps).
|
||||
func packageDir(t *testing.T, importPath string) string {
|
||||
t.Helper()
|
||||
_, file, _, ok := runtime.Caller(0)
|
||||
if !ok {
|
||||
t.Fatal("runtime.Caller failed")
|
||||
}
|
||||
// file = .../oy/x/forex/types/types_test.go -> repoRoot = .../oy (4 dirs up)
|
||||
repoRoot := filepath.Dir(filepath.Dir(filepath.Dir(filepath.Dir(file))))
|
||||
rel := strings.TrimPrefix(importPath, "github.com/oy/openyield/")
|
||||
return filepath.Join(repoRoot, rel)
|
||||
}
|
||||
Reference in New Issue
Block a user