Dr-Linuxer Blog

Understanding the require Statement in Solidity

Aung Aung Myo Myint's photo
Aung Aung Myo Myint
·

3 min read

Table of contents

In Solidity, the require statement is a crucial tool that every developer should understand well. It is important for contract execution and error handling, making sure certain conditions are met before a function proceeds.

Let's explore its usage, functionality, and how it compares to other options like if-else and revert.

Basics of require Statement

The require statement is usually used to check conditions at the start of a function. If the condition isn't met, the function stops running, and any changes made during the transaction are undone.

Example: Checking if a Number is Zero

Here’s a function named isZero that demonstrates the use of the require statement:

// SPDX-License-Identifier: MIT
pragma solidity >=0.7.0 <0.9.0;

contract demo {
    function isZero(uint a) public pure returns (bool) {
    require(a == 0, "a is not equal to zero");
    return true;
    }
}

Explanation:

  • The require statement checks if a is 0.

  • If a is 0, the function goes on and returns true.

  • If a is not 0, the function gives an error message "a is not equal to zero" and undoes all changes made during the transaction.

Testing the Function:

  1. Input: 0

    • The condition a == 0 is true.

    • The function returns true.

  2. Input: 12

    • The condition a == 0 is false.

    • The transaction is undone with the error message: "a is not equal to zero".

require vs. if-else with revert

You might wonder if require can be swapped with an if-else condition. Let's look into this with another function:

// SPDX-License-Identifier: MIT
pragma solidity >=0.7.0 <0.9.0;

contract demo {
    function isZeroWithIfElse(uint a) public pure returns (bool) {
        if (a == 0) {
            return true;
        } 
        else {
            revert("a is not equal to zero");
        }
    }
}

Explanation:

  • The if-else statement checks if a is equal to 0.

  • If true, it returns true.

  • If false, it uses the revert keyword to throw an error with the message "a is not equal to zero".

Key Differences:

  1. Code Length:

    • require does the job in one line of code.

    • The if-else method needs more lines, making the code longer.

  2. Readability:

    • require is simple and commonly used, which makes the code easier to read and maintain.

  3. Error Handling:

    • Both methods give errors and undo the transaction if the condition isn't met.

When to Use require?

The require statement is usually better than if-else with revert because it is simpler and more efficient. It is especially helpful for:

  • Validating user inputs.

  • Checking conditions before running a function.

  • Enforcing access control.

Why require is Better?

Here are some reasons why require is often preferred over other options:

  1. Conciseness:

    • It removes the need for extra if-else blocks, reducing the number of lines of code.

  2. Standard Practice:

    • Most Solidity developers and projects use require, making the code easier to read and understand.

  3. Gas Efficiency:

    • Simpler code can lead to slightly lower gas usage, especially in complex contracts.

Conclusion

The require statement is a strong and efficient tool in Solidity that makes sure your contract works as it should. While if-else with revert can do the same job, require is better for simplicity, readability, and ease of maintenance. By learning to use require, you'll be ready to write solid and secure smart contracts.

Ethereum