feat(contract): Introduce CustomRevert library for efficient reverts

[shuhuiluo]

Adds a new CustomRevert library to streamline and optimize custom error handling by using efficient assembly code.

[coderabbitai]

Walkthrough

The pull request introduces a new CustomRevert library in Solidity, which provides a mechanism for reverting transactions with custom error messages. It includes three overloads of the revertWith function to handle different argument types: a basic selector, a selector with a uint256, and a selector with an address. The library uses inline assembly for efficient memory manipulation and ensures memory safety by exiting the call context immediately after the revert operation.

Changes

Files	Change Summary
contracts/src/utils/libraries/CustomRevert.sol	Added CustomRevert library with three revertWith functions for custom error handling.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 04d9018 and 7ae1df7.

Files selected for processing (1)

• contracts/src/utils/libraries/CustomRevert.sol (1 hunks)

Additional comments not posted (3)

contracts/src/utils/libraries/CustomRevert.sol (3)

11-16: Efficient use of assembly for reverting with a selector.

The implementation uses inline assembly effectively to revert with a selector. However, ensure that the "memory-safe" claim is verified through thorough testing.

---

18-25: Proper memory handling for reverting with a selector and uint256.

The function correctly manages memory for a selector followed by a uint256. Ensure the "memory-safe" claim is verified through thorough testing.

---

27-34: Correct implementation for reverting with a selector and address.

The function properly masks and stores the address, ensuring correct memory usage. Verify the "memory-safe" claim through thorough testing.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.