docs(#160): point the layout-validation deferral at a tracker that still exists - #187
Merged
Conversation
…ill exists README deferred runtime layout validation to "#110H". #110 is CLOSED — it was a batch of LOW/INFO findings — so the deferral was documented as tracked somewhere that no longer tracks it. Now points at #160, which is open and is the issue that raised this. Small, but this is the failure mode where a known gap stops being known: the doc says "deferred, see X", a reader checks X, finds it closed, and concludes the work was done. Also states plainly what the const_assert!s cannot do, because the reason is sharper than "they only check internal consistency". Under the exact change they exist to guard against — raising the asset count — whoever made it would update EXPECTED_PORTFOLIO_ACCOUNT_SIZE to whatever the wrong struct computed, and the assertion would pass. It is not weak evidence; in that scenario it is guaranteed to pass. #185 (merged today) removed one concrete instance of that vector by deriving V16_ACTIVE_BITMAP_WORDS from the asset count. The general case still needs a real portfolio account decoded at runtime, which is what #160 stays open for. The three false LiteSVM/compile-time claims #160 reported are already corrected in both README.md and src/slab_types_v16.rs — verified, no LiteSVM reference remains anywhere in the repo. nft suite: 11 + 6 + 5 + 5 + 4 passing, 0 failed. Refs: #160 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NgoNgagkvw7i5SSRC3FJ8D
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
Docs only. No code change.
README.md:130deferred runtime layout validation to "#110H". #110 is closed — it was a batch of LOW/INFO findings — so the deferral pointed at something that no longer tracks it. Now points at #160, which is open and raised this.Small, but it is the failure mode where a known gap quietly stops being known: the doc says "deferred, see X", a reader checks X, finds it closed, and concludes the work was done.
Also states what the assertions cannot do, and why
The existing wording ("verify internal consistency ... not alignment with the live engine") is correct but undersells it. The sharper statement:
It is not weak evidence of layout correctness. In precisely the scenario it guards, it is guaranteed to pass. That is worth a reader knowing before they trust it.
Status of #160's three reported claims
All three are already corrected on
main, verified rather than assumed:LiteSVMreference remains anywhere in the repo (grep -rln -i litesvm src/ tests/ Cargo.toml→ empty)README.mdandsrc/slab_types_v16.rsboth now say theconst_assert!s do not verify engine alignmenttests/directory now exists (5 PoC files), so "there is no tests/ directory" is outdatedWhat remains is the substantive half — runtime validation of the mirror against a real portfolio account — which #160 stays open for. #185 (merged today) removed one concrete instance of the drift vector by deriving
V16_ACTIVE_BITMAP_WORDSfrom the asset count rather than hardcoding it.nft suite: 11 + 6 + 5 + 5 + 4 passing, 0 failed.
🤖 Generated with Claude Code
https://claude.ai/code/session_01NgoNgagkvw7i5SSRC3FJ8D