docs(readme): reflect implemented system, audit status, and open items - #24
Merged
Conversation
The README described the vault/legs/execution/oracle as spec'd-but-not-implemented and claimed "unaudited" with 37 tests and an "atomic by design" emergency path. All of that is stale: the full system is built and tested (151 tests), it has been self-audited (21 findings) and remediated across PRs #10-#23, and the emergency path is best-effort-within-bound, not atomic (per the audit). - Status line: implemented + self-audited/remediated, not independently audited, not deployed. - Architecture: move the vault, both legs, PT adapter, execution module and oracle hub from "in progress" to implemented, with accurate per-contract notes and the shareholderNav accounting identity. - Testing: 151 tests; describe the full lifecycle/crash/invariant coverage. - New Security section: honest audit + adversarial re-verification summary, the two robustness bugs it caught (now fixed), and the open partial remediations (M4/H6/L8 emergency anchoring, H1 fee basis, L5 health-gating).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README was stale on three counts and overclaimed on a fourth:
Changes
shareholderNav = totalNav - pending - reservedaccounting identity called out.minOutstill oracle-anchored (M4/H6/L8), performance-fee basis overcharging mid-term depositors (H1, keepperformanceFeeBps = 0until fixed), and fee mints not health-gated (L5). States plainly that an external audit is required and it is not deployed.No code changes; docs only.