Skip to content

Conversation

@VolodymyrBg
Copy link
Contributor

Updated utilities.adoc Introspection section to remove outdated _registerInterface(bytes4) guidance for ERC165 and instruct overriding supportsInterface(bytes4) with super.supportsInterface chaining.
Corrected ERC165Checker method references from _supportsInterface/_supportsAllInterfaces to supportsInterface/supportsAllInterfaces, and added references to supportsERC165 and getSupportedInterfaces.

The previous documentation reflected legacy patterns and method names not present in the current codebase. The changes align docs with the current implementations in ERC165.sol and ERC165Checker.sol, preventing user confusion.

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@VolodymyrBg VolodymyrBg requested a review from a team as a code owner November 6, 2025 18:41
@changeset-bot
Copy link

changeset-bot bot commented Nov 6, 2025

⚠️ No Changeset found

Latest commit: 3d3e56d

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
Copy link
Contributor

coderabbitai bot commented Nov 6, 2025

Walkthrough

This pull request updates documentation in the utilities module. The _verify function signatures for P256 verification are changed from internal pure to internal view in two locations, allowing state inspection during verification. Documentation text is revised to reflect updated ERC165/ERC165Checker usage patterns, replacing internal function references with public-facing alternatives and adding examples of getSupportedInterfaces usage. Additional minor grammar and wording adjustments are made throughout the documentation without altering functional semantics.

Possibly related PRs

Suggested labels

ignore-changeset, typo

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: documentation updates to fix ERC165 and ERC165Checker references to align with current implementations.
Description check ✅ Passed The description is directly related to the changeset, providing specific details about outdated documentation patterns being corrected and the alignment with current ERC165 and ERC165Checker implementations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb97fd3 and 3d3e56d.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/utilities.adoc (6 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-28T16:58:18.879Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/mocks/crosschain/ERC7786GatewayMock.sol:27-31
Timestamp: 2025-08-28T16:58:18.879Z
Learning: When a Solidity contract inherits from an interface, it has direct access to all declarations in that interface including errors, without needing to qualify them with the interface name.

Applied to files:

  • docs/modules/ROOT/pages/utilities.adoc
⏰ 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: slither
  • GitHub Check: coverage
  • GitHub Check: tests-foundry
  • GitHub Check: tests-upgradeable
  • GitHub Check: tests
  • GitHub Check: halmos
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: Pages changed - solidity-contracts
🔇 Additional comments (3)
docs/modules/ROOT/pages/utilities.adoc (3)

260-260: Documentation improvements approved.

The minor wording and grammar adjustments improve clarity and readability without altering technical accuracy or guidance. These changes enhance documentation quality.

Also applies to: 297-297, 351-351, 353-353


194-200: Documentation references are accurate. All four ERC165Checker methods (supportsInterface, supportsAllInterfaces, supportsERC165, getSupportedInterfaces) exist in the current implementation with matching signatures. The internal visibility is correct for library functions used via the using ERC165Checker for address; pattern documented. The documentation updates correctly reflect the public API surface as exposed through the library extension pattern.


49-49: ****

The change from internal pure to internal view in the P256 verification examples is correct and justified. The functions necessarily require the view keyword because they call other view functions internally (_tryVerifyNative, which calls _rip7212). In Solidity, a pure function cannot call a view function. The documentation was updated to reflect the actual implementation, not a documentation error.

Likely an incorrect or invalid review comment.


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

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

@Amxx Amxx changed the base branch from master to typo-fixes November 10, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants