Skip to content

docs: refresh README to match shipped rebalancer, safety, and governance - #22

Merged
jayeshy14 merged 1 commit into
mainfrom
docs/readme-refresh
Jul 28, 2026
Merged

docs: refresh README to match shipped rebalancer, safety, and governance#22
jayeshy14 merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@jayeshy14

Copy link
Copy Markdown
Owner

The README had drifted behind main. It still described the CoW rebalancer as the next build and listed the safety layer and constituent governance as unbuilt, when all three are merged.

What changed

  • Rebalancing rewritten from "not yet implemented" to the shipped system: frozen-target epochs, ERC-1271 delegated order validation, oracle-anchored minOut, the dual-threshold plus cap-trigger permissionless emergency, the buffer-aware target, quarantine-aware fresh-subset reweighting, and the mainnet-fork digest proof.
  • New Safety layer section: constituent quarantine, NAV-per-share circuit breaker, guardian pause.
  • New Constituent governance section: timelocked add, forced vs discretionary removal, wind-down-not-dump, guardian veto.
  • Methodology now covers the cap trigger and the Nasdaq-style hysteresis.
  • Trust model / limitations marks the rebalancer, safety layer, and governance as built-and-tested, and names the curator-managed yield layer and fee module as the planned next phase.
  • Design decisions gained the "adding risk is gated, removing risk is open" principle; the outflow guarantee reflects the live rebalancer path.
  • Repository layout now includes rebalancer/, governance/, GPv2Order.sol, and IRebalancer.sol.
  • Build and test reflects the real 162-test suite and the mainnet-RPC requirement for the fork tests.
  • Dropped the stale "autonomous" framing from the opener, since the project is steering toward curator management.

Docs only, no code changes.

The README still described the CoW rebalancer as the next build and listed
the safety layer and governance as unbuilt, when all three are merged. Bring
it current: add the rebalancing, safety-layer, and constituent-governance
sections, cover the cap trigger and buffer-aware target, update the trust
model and repository layout, and note the curator-managed yield layer as the
planned next phase. Drop the stale 'autonomous' framing from the opener.
@jayeshy14
jayeshy14 merged commit 7e29a28 into main Jul 28, 2026
3 checks passed
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