docs(TrieProof): event -> receipt

[davidperk]

Corrects the fact that TrieProof.sol can be used to prove a receipt (not an event) against the receiptsRoot of a block.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 34eefbf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This PR updates documentation and test descriptions in the TrieProof cryptography utility. Two comment corrections are made: in the contract file, the documentation comment is updated to reference "Receipt" instead of "Event" when describing the proof type, and in the test file, the test description is similarly corrected from "events" to "receipts". These are documentation-only changes with no modifications to functional code or control flow.

Possibly related PRs

• Add TrieProof library #5826: Implements the TrieProof library and establishes the initial test suite that is being refined with documentation corrections in this PR.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: correcting documentation from 'event' to 'receipt' in TrieProof, which matches the changeset.
Description check	✅ Passed	The description is directly related to the changeset, explaining the rationale for correcting the documentation from 'event' to 'receipt' in TrieProof.sol.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

---

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a83d9aa and 34eefbf.

📒 Files selected for processing (2)

• contracts/utils/cryptography/TrieProof.sol
• test/utils/cryptography/TrieProof.test.js

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: Redirect rules - solidity-contracts
• GitHub Check: Header rules - solidity-contracts
• GitHub Check: Pages changed - solidity-contracts
• GitHub Check: slither
• GitHub Check: tests
• GitHub Check: tests-foundry
• GitHub Check: coverage
• GitHub Check: tests-upgradeable
• GitHub Check: halmos

🔇 Additional comments (2)

contracts/utils/cryptography/TrieProof.sol (1)

14-14: ✓ Documentation correction is accurate.

The change from "Event" to "Receipt" correctly reflects that the TrieProof library proves receipts (not events) against the receiptsRoot of a block. The natspec documentation now accurately describes the actual capability of the functions.

test/utils/cryptography/TrieProof.test.js (1)

69-69: ✓ Test description now matches actual test behavior.

The test description accurately reflects the test's purpose: verifying receipt (not event) inclusion in a block. The test code confirms this by constructing and verifying receipt proofs (lines 96–123). The terminology is now consistent with the updated contract documentation.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[davidperk]

@Amxx why was this closed? The current documentation is wrong.