generate keccak256 mappings from sol errors

[Intizar-T]

Description

Processes all .sol files in contracts/v0.1/src and generate keccak256 encoding from error function definitions. This error to encoding mapping will prove useful for debugging contract errors.

Note: error function definition params are processed to remove param names and only leave types. I've confirmed the validity of generated encodings using chisel.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist before requesting a review

• I have performed a self-review of my code.
• If it is a core feature, I have added thorough tests.

Deployment

• Should publish npm package
• Should publish Docker image

[coderabbitai]

Walkthrough

Walkthrough

The enhancements in error-keccak-mapping.js streamline the handling of Solidity error mappings by adding functions for file and directory management, SHA3 hash generation for error messages, and a mapping for storing the hashes. The new get-error-from-encoding.js script aids in fetching error messages based on hash keys, improving error handling in Solidity projects.

Changes

File Path	Change Summary
contracts/v0.1/scripts/...	Introduced functions processFile(filePath) and processDirectory(dirPath) to manage error mappings in Solidity files. Added a constant mapping to store SHA3 hashes of error messages.
contracts/v0.1/scripts/sol-error-mappings/get-error-from-encoding.js	Added a script to retrieve error messages based on hash keys from a JSON file.

🐇
In code we trust, with hashes we bind,
Errors mapped, no bugs to find.
Solidity sings, in SHA3's embrace,
A rabbit's joy, in this coded space.
🐰

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

• Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
• Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
• Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

• Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
• Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
• High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
• Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

---

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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 4

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 988d92d and d641ad5.

Files ignored due to path filters (2)

• contracts/v0.1/package.json is excluded by !**/*.json
• contracts/v0.1/scripts/sol-error-mappings/errorMappings.json is excluded by !**/*.json

Files selected for processing (1)

• contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js (1 hunks)

Additional Context Used

Biome (5)

contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js (5)

1-1: A Node.js builtin module should be imported with the node: protocol.

---

2-2: A Node.js builtin module should be imported with the node: protocol.

---

10-27: Prefer for...of instead of forEach.

---

18-21: Template literals are preferred over string concatenation.

---

36-43: Prefer for...of instead of forEach.

Additional comments not posted (1)

contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js (1)

48-49: The usage of the mapping constant to store and write the keccak256 mappings is correctly implemented.

[nick-bisonai]

please check lint error from github action

/home/runner/work/orakl/orakl/contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js
  3:7  error  Parsing error: Identifier 'path' has already been declared

[Intizar-T]

please check lint error from github action

/home/runner/work/orakl/orakl/contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js
  3:7  error  Parsing error: Identifier 'path' has already been declared

just pushed a fix commit :)

[nick-bisonai]

lgtm!, left minor comments

[nick-bisonai]

it's probably gonna have different hash if address is replaced with specific value, did you also check the case? would it be still recognizable with this hash value?

[nick-bisonai]

just a suggestion, but how about making a yarn command taking hash and return decoded custom error using related library?
i found this kind of answer in stackoverflow
https://ethereum.stackexchange.com/a/153295

[Intizar-T]

regarding, hash correctness, i found the following piece:

In Solidity, the error signature is generated from its name and the types of its parameters. The parameter names are not included in the signature. This is similar to how function signatures are generated in Solidity.

The signature is then hashed using the Keccak256 algorithm to produce a 4-byte identifier. This identifier is what's used in the bytecode to represent the error.

so as long as the error definitions dont change the encoding/hash won't change. And if the error def changes, we can always generate updated hashes by running this script. Pls let me know if I misunderstood your point.

[nick-bisonai]

awh I see, think I misunderstood how hashes were generated. thank you for the explanation.
still, it'd be nice to have if we can parse the data together if there's a parameter in the error  😄

[Intizar-T]

yes that'd be great! I'm currently testing out the library that you suggested, ethers-decode-error, from vrf-consumer script but I keep running into errors when I try to initialize the decoder (it's failing to parse the passed abi) or cannot parse the error if no abi is passed. Maybe we can take a quick look together on Monday :)

[coderabbitai]

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d641ad5 and 71a6625.

Files ignored due to path filters (2)

• contracts/v0.1/package.json is excluded by !**/*.json
• contracts/v0.1/scripts/sol-error-mappings/errorMappings.json is excluded by !**/*.json

Files selected for processing (2)

• contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js (1 hunks)
• contracts/v0.1/scripts/sol-error-mappings/get-error-from-encoding.js (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• contracts/v0.1/scripts/sol-error-mappings/error-keccak-mapping.js

Additional Context Used

Biome (1)

contracts/v0.1/scripts/sol-error-mappings/get-error-from-encoding.js (1)

1-1: A Node.js builtin module should be imported with the node: protocol.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 71a6625 and 13136f4.

Files selected for processing (1)

• contracts/v0.1/scripts/sol-error-mappings/get-error-from-encoding.js (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• contracts/v0.1/scripts/sol-error-mappings/get-error-from-encoding.js