README: point at the open-salt spec instead of restating it - #256
Open
thedavidmeister wants to merge 1 commit into
Open
thedavidmeister wants to merge 1 commit into
thedavidmeister wants to merge 1 commit into
Conversation
The README named tx.origin as the one residual the address cannot fix; the NatSpec has carried two MUSTs there since 48a0349. Keep no restated MUST. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Warning Review limit reachedNext included review available in 38 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
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 branch has not been deployed
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.
Closes #143
README.mdcarried its own account of what the open-salt address does and doesnot fix, and it had already fallen behind the NatSpec that
CLAUDE.mdnames asthe spec. It read
definite and singular, while
src/interface/ICloneableFactoryV4.sollists twoMUSTs there: no
tx.origin, and "The gasinitializeis given MUST NOT selectstate", the latter added by
48a0349, which touched that file alone. Animplementer reading the README as exhaustive keeps
tx.originout ofinitialize, leaves atry/catchthat defaults on out-of-gas, and ships thehazard the second MUST exists to prevent.
The fix is to stop keeping a second copy rather than to sync this one: the
bullet now says what is repo-local — which interface declares the open-salt
pair, that it extends
ICloneableFactoryV3, what the salt hashes — and pointsat the NatSpec for what the address commits to, what it does not fix, and the
MUSTs that places on implementations. No restated MUST is left in
README.md,so there is nothing here that can drift again.
The deleted WHO/WHAT paragraph went with it: it was the same second copy of
ICloneableFactoryV4.sol:54-90, and it is the part a reader would trust as thewhole trade-off.
README.mdis also #124's file, one section earlier. Each stands alone.QA
The drift this PR removes is exactly the kind no test can catch, which is why
the copy is removed rather than corrected.
src/ortest/change, so there is no behaviourto mutate.
src/interface/ICloneableFactoryV4.sol:135-168,read against the README sentence, and
git log --name-only 48a0349for whichfiles the second MUST landed in.
tx.origin-as-sole-residualclaim and (B) the hand-maintained paraphrase that produced it; covered A,B.
The rest of the README was checked for the same shape: the
## Librarysection describes this repo's own files, the
### Legacyentries describewhich interface superseded which, and neither restates a normative MUST, so
neither is in scope.
🤖 Generated with Claude Code