gas-custom-errors.md

warning	layout	title
This is a dynamically generated file. Do not edit manually.	default	gas-custom-errors | Solhint

gas-custom-errors

The {"extends": "solhint:recommended"} property in a configuration file enables this rule.

Description

Enforces the use of Custom Errors over Require with strings error and Revert statements

Options

This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Defaults to warn.

Example Config

{
  "rules": {
    "gas-custom-errors": "warn"
  }
}

Notes

• This rules applies to Solidity version 0.8.4 and higher

Examples

👍 Examples of correct code for this rule

Use of Custom Errors

revert CustomErrorFunction();

Use of Custom Errors with arguments

revert CustomErrorFunction({ msg: "Insufficient Balance" });

Use of Require with Custom Error with arguments

require(success, CustomErrorFunction({ msg: "Insufficient Balance" });

Use of Require with function call and Custom Error

require(isAuthorized(account), CustomErrorFunction();

Use of Require with binary comparison and Custom Error

require(a > b, CustomErrorFunction();

👎 Examples of incorrect code for this rule

Use of require statement

require(userBalance >= availableAmount, "Insufficient Balance");

Use of plain revert statement

revert();

Use of revert statement with message

revert("Insufficient Balance");

Version

This rule was introduced in Solhint 4.5.0

Resources

• Rule source
• Document source
• Test cases