Repository navigation
docs: plain emphasis, plain punctuation, and stale claims - #65
Conversation
The README said no contract sets a LayerZero DVN, which stopped being true when #58 added setDvn. ProviderChainId cited provider-research.md for a zero-id fact it does not contain; it now points at the checks that refuse a zero id.
There was a problem hiding this comment.
🟢 Approval recommended
It is a wording-only cleanup with no bytecode impact, and the three substantive stale-claim corrections were each verified accurate against the current code (setDvn write-once, ZeroProviderId/ChainConfig.providerId, and the CHECKS §5 anchor).
0 open findings
What changed in this PR
This is a documentation-and-comment wording cleanup across the repo's Markdown docs, build config, NatSpec, and a few test-assertion strings. It has no effect on compiled bytecode (the build pins bytecode_hash = "none" and cbor_metadata = false, and the .sol edits touch only comments and assertion message strings). The changes keep the docs honest and uniform in tone, which matters here because several of these docs double as the auditor-facing specification.
Changes:
- Remove all-caps emphasis (mostly
provider-research.mdandprovider-spec.md, plus a few singles elsewhere), preserving RFC 2119 keywords and quoted external text. - Replace prose em/en dashes with commas, colons, periods, or parentheses.
- Correct three stale claims: the README's LayerZero-DVN statement (now names the
setDvnzkSync exception) and test count (801 passing, 1 skipped);todo.md's #51 citation placement; andProviderChainId's zero-id citation (now points atZeroProviderId/ChainConfig.providerId).
| File | Description |
|---|---|
README.md |
De-caps two tree-diagram words; rewrites the provider-security-config bullet to name the new setDvn DVN pin; updates test count. |
docs/todo.md |
Moves the #51 citation onto the DVN-pinning clause. |
docs/provider-spec.md |
Drops ~15 all-caps emphases; keeps RFC 2119 keywords. |
docs/provider-research.md |
Drops ~45 all-caps emphases and replaces prose dashes. |
docs/message-flow.md |
De-caps one word (BE → be). |
contracts/evm/foundry.toml |
De-caps comment emphasis (NOT, SOURCE). |
CLAUDE.md |
Replaces two em dashes in the guideline prose with periods. |
contracts/evm/src/protocols/ProviderChainId.sol |
Repoints the zero-id NatSpec citation to the actual checks. |
contracts/evm/src/protocols/layerzero/LzReceiver.sol |
Replaces a NatSpec em dash. |
contracts/evm/src/protocols/ccip/CcipReceiver.sol |
Replaces a NatSpec em dash. |
contracts/evm/test/protocols/layerzero/MockLzEndpoint.sol |
Replaces a comment em dash. |
contracts/evm/test/ReceiverReport.t.sol |
De-caps a test assertion message string. |
contracts/evm/test/InboundAuth.t.sol |
De-caps a test assertion message string. |
contracts/evm/test/CommitmentSchemePlugin.t.sol |
De-caps a section-divider comment. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Wording only. No contract bytecode changes: the edits under
src/are comments, and the build pinsbytecode_hash = "none"andcbor_metadata = false.Commits
docs/provider-research.md(about 45 spots) anddocs/provider-spec.md(about 15), plus single words in the README,message-flow.md,foundry.toml, and three test files. The spec's RFC 2119 keywords stay, since line 31 defines them, and so do the ERC-7786 text quoted inIErc7786.soland the spec quote in the research doc.provider-research.md,CLAUDE.md, and comments inLzReceiver,CcipReceiver, andMockLzEndpoint.setDvn, so it now names the exception.todo.mdcited LayerZero: zkSync pathways need DVN config the transceiver cannot set #51 as if the zkSync check were the open issue. The citation now sits on the DVN pinning that LayerZero: zkSync pathways need DVN config the transceiver cannot set #51 was about.ProviderChainIdcitedprovider-research.md§§4-5 and §8 for "no provider names chain 0", which those sections do not say. It now points at the checks that refuse a zero id (ZeroProviderId,ChainConfig.providerId).Checks
forge test: 801 passed, 1 skipped.forge fmt --checkandforge lint(withlint-srcforsrc/) are clean on the changed files.forge build --sizes srcpasses. Every relative markdown link and anchor across the repo resolves.🤖 Generated with Claude Code