Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add solhint rule to check custom error names #4543

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

0xVolosnikov
Copy link
Contributor

Adds an additional custom-error-domains rule for solhint which is designed to check that custom error names match the rules specified in:
https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/GUIDELINES.md#solidity-conventions

The rule checks that the error starts with a domain name. The "domain name" means:

  • contract name
  • ERC name (ERC<...>)

This takes into account both the contract itself and the contracts directly inherited by it.

An example of a "correct" custom error name:

interface IGovernor {
  error GovernorDisabledDeposit();
}

An example of an "incorrect" custom error name:

library DoubleEndedQueue {
  error QueueEmpty();
}

@changeset-bot
Copy link

changeset-bot bot commented Aug 26, 2023

⚠️ No Changeset found

Latest commit: b5c7a3d

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

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.

None yet

2 participants