Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

StdAssertions

State Variables

vm

Vm private constant vm = Vm(address(uint160(uint256(keccak256("hevm cheat code")))));

_failed

bool private _failed;

Functions

failed

function failed() public view returns (bool);

fail

function fail() internal virtual;

assertTrue

function assertTrue(bool data) internal pure virtual;

assertTrue

function assertTrue(bool data, string memory err) internal pure virtual;

assertFalse

function assertFalse(bool data) internal pure virtual;

assertFalse

function assertFalse(bool data, string memory err) internal pure virtual;

assertEq

function assertEq(bool left, bool right) internal pure virtual;

assertEq

function assertEq(bool left, bool right, string memory err) internal pure virtual;

assertEq

function assertEq(uint256 left, uint256 right) internal pure virtual;

assertEq

function assertEq(uint256 left, uint256 right, string memory err) internal pure virtual;

assertEqDecimal

function assertEqDecimal(uint256 left, uint256 right, uint256 decimals) internal pure virtual;

assertEqDecimal

function assertEqDecimal(uint256 left, uint256 right, uint256 decimals, string memory err) internal pure virtual;

assertEq

function assertEq(int256 left, int256 right) internal pure virtual;

assertEq

function assertEq(int256 left, int256 right, string memory err) internal pure virtual;

assertEqDecimal

function assertEqDecimal(int256 left, int256 right, uint256 decimals) internal pure virtual;

assertEqDecimal

function assertEqDecimal(int256 left, int256 right, uint256 decimals, string memory err) internal pure virtual;

assertEq

function assertEq(address left, address right) internal pure virtual;

assertEq

function assertEq(address left, address right, string memory err) internal pure virtual;

assertEq

function assertEq(bytes32 left, bytes32 right) internal pure virtual;

assertEq

function assertEq(bytes32 left, bytes32 right, string memory err) internal pure virtual;

assertEq32

function assertEq32(bytes32 left, bytes32 right) internal pure virtual;

assertEq32

function assertEq32(bytes32 left, bytes32 right, string memory err) internal pure virtual;

assertEq

function assertEq(string memory left, string memory right) internal pure virtual;

assertEq

function assertEq(string memory left, string memory right, string memory err) internal pure virtual;

assertEq

function assertEq(bytes memory left, bytes memory right) internal pure virtual;

assertEq

function assertEq(bytes memory left, bytes memory right, string memory err) internal pure virtual;

assertEq

function assertEq(bool[] memory left, bool[] memory right) internal pure virtual;

assertEq

function assertEq(bool[] memory left, bool[] memory right, string memory err) internal pure virtual;

assertEq

function assertEq(uint256[] memory left, uint256[] memory right) internal pure virtual;

assertEq

function assertEq(uint256[] memory left, uint256[] memory right, string memory err) internal pure virtual;

assertEq

function assertEq(int256[] memory left, int256[] memory right) internal pure virtual;

assertEq

function assertEq(int256[] memory left, int256[] memory right, string memory err) internal pure virtual;

assertEq

function assertEq(address[] memory left, address[] memory right) internal pure virtual;

assertEq

function assertEq(address[] memory left, address[] memory right, string memory err) internal pure virtual;

assertEq

function assertEq(bytes32[] memory left, bytes32[] memory right) internal pure virtual;

assertEq

function assertEq(bytes32[] memory left, bytes32[] memory right, string memory err) internal pure virtual;

assertEq

function assertEq(string[] memory left, string[] memory right) internal pure virtual;

assertEq

function assertEq(string[] memory left, string[] memory right, string memory err) internal pure virtual;

assertEq

function assertEq(bytes[] memory left, bytes[] memory right) internal pure virtual;

assertEq

function assertEq(bytes[] memory left, bytes[] memory right, string memory err) internal pure virtual;

assertEqUint

function assertEqUint(uint256 left, uint256 right) internal pure virtual;

assertNotEq

function assertNotEq(bool left, bool right) internal pure virtual;

assertNotEq

function assertNotEq(bool left, bool right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(uint256 left, uint256 right) internal pure virtual;

assertNotEq

function assertNotEq(uint256 left, uint256 right, string memory err) internal pure virtual;

assertNotEqDecimal

function assertNotEqDecimal(uint256 left, uint256 right, uint256 decimals) internal pure virtual;

assertNotEqDecimal

function assertNotEqDecimal(uint256 left, uint256 right, uint256 decimals, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(int256 left, int256 right) internal pure virtual;

assertNotEq

function assertNotEq(int256 left, int256 right, string memory err) internal pure virtual;

assertNotEqDecimal

function assertNotEqDecimal(int256 left, int256 right, uint256 decimals) internal pure virtual;

assertNotEqDecimal

function assertNotEqDecimal(int256 left, int256 right, uint256 decimals, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(address left, address right) internal pure virtual;

assertNotEq

function assertNotEq(address left, address right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(bytes32 left, bytes32 right) internal pure virtual;

assertNotEq

function assertNotEq(bytes32 left, bytes32 right, string memory err) internal pure virtual;

assertNotEq32

function assertNotEq32(bytes32 left, bytes32 right) internal pure virtual;

assertNotEq32

function assertNotEq32(bytes32 left, bytes32 right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(string memory left, string memory right) internal pure virtual;

assertNotEq

function assertNotEq(string memory left, string memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(bytes memory left, bytes memory right) internal pure virtual;

assertNotEq

function assertNotEq(bytes memory left, bytes memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(bool[] memory left, bool[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(bool[] memory left, bool[] memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(uint256[] memory left, uint256[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(uint256[] memory left, uint256[] memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(int256[] memory left, int256[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(int256[] memory left, int256[] memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(address[] memory left, address[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(address[] memory left, address[] memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(bytes32[] memory left, bytes32[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(bytes32[] memory left, bytes32[] memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(string[] memory left, string[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(string[] memory left, string[] memory right, string memory err) internal pure virtual;

assertNotEq

function assertNotEq(bytes[] memory left, bytes[] memory right) internal pure virtual;

assertNotEq

function assertNotEq(bytes[] memory left, bytes[] memory right, string memory err) internal pure virtual;

assertLt

function assertLt(uint256 left, uint256 right) internal pure virtual;

assertLt

function assertLt(uint256 left, uint256 right, string memory err) internal pure virtual;

assertLtDecimal

function assertLtDecimal(uint256 left, uint256 right, uint256 decimals) internal pure virtual;

assertLtDecimal

function assertLtDecimal(uint256 left, uint256 right, uint256 decimals, string memory err) internal pure virtual;

assertLt

function assertLt(int256 left, int256 right) internal pure virtual;

assertLt

function assertLt(int256 left, int256 right, string memory err) internal pure virtual;

assertLtDecimal

function assertLtDecimal(int256 left, int256 right, uint256 decimals) internal pure virtual;

assertLtDecimal

function assertLtDecimal(int256 left, int256 right, uint256 decimals, string memory err) internal pure virtual;

assertGt

function assertGt(uint256 left, uint256 right) internal pure virtual;

assertGt

function assertGt(uint256 left, uint256 right, string memory err) internal pure virtual;

assertGtDecimal

function assertGtDecimal(uint256 left, uint256 right, uint256 decimals) internal pure virtual;

assertGtDecimal

function assertGtDecimal(uint256 left, uint256 right, uint256 decimals, string memory err) internal pure virtual;

assertGt

function assertGt(int256 left, int256 right) internal pure virtual;

assertGt

function assertGt(int256 left, int256 right, string memory err) internal pure virtual;

assertGtDecimal

function assertGtDecimal(int256 left, int256 right, uint256 decimals) internal pure virtual;

assertGtDecimal

function assertGtDecimal(int256 left, int256 right, uint256 decimals, string memory err) internal pure virtual;

assertLe

function assertLe(uint256 left, uint256 right) internal pure virtual;

assertLe

function assertLe(uint256 left, uint256 right, string memory err) internal pure virtual;

assertLeDecimal

function assertLeDecimal(uint256 left, uint256 right, uint256 decimals) internal pure virtual;

assertLeDecimal

function assertLeDecimal(uint256 left, uint256 right, uint256 decimals, string memory err) internal pure virtual;

assertLe

function assertLe(int256 left, int256 right) internal pure virtual;

assertLe

function assertLe(int256 left, int256 right, string memory err) internal pure virtual;

assertLeDecimal

function assertLeDecimal(int256 left, int256 right, uint256 decimals) internal pure virtual;

assertLeDecimal

function assertLeDecimal(int256 left, int256 right, uint256 decimals, string memory err) internal pure virtual;

assertGe

function assertGe(uint256 left, uint256 right) internal pure virtual;

assertGe

function assertGe(uint256 left, uint256 right, string memory err) internal pure virtual;

assertGeDecimal

function assertGeDecimal(uint256 left, uint256 right, uint256 decimals) internal pure virtual;

assertGeDecimal

function assertGeDecimal(uint256 left, uint256 right, uint256 decimals, string memory err) internal pure virtual;

assertGe

function assertGe(int256 left, int256 right) internal pure virtual;

assertGe

function assertGe(int256 left, int256 right, string memory err) internal pure virtual;

assertGeDecimal

function assertGeDecimal(int256 left, int256 right, uint256 decimals) internal pure virtual;

assertGeDecimal

function assertGeDecimal(int256 left, int256 right, uint256 decimals, string memory err) internal pure virtual;

assertApproxEqAbs

function assertApproxEqAbs(uint256 left, uint256 right, uint256 maxDelta) internal pure virtual;

assertApproxEqAbs

function assertApproxEqAbs(uint256 left, uint256 right, uint256 maxDelta, string memory err) internal pure virtual;

assertApproxEqAbsDecimal

function assertApproxEqAbsDecimal(uint256 left, uint256 right, uint256 maxDelta, uint256 decimals)
    internal
    pure
    virtual;

assertApproxEqAbsDecimal

function assertApproxEqAbsDecimal(uint256 left, uint256 right, uint256 maxDelta, uint256 decimals, string memory err)
    internal
    pure
    virtual;

assertApproxEqAbs

function assertApproxEqAbs(int256 left, int256 right, uint256 maxDelta) internal pure virtual;

assertApproxEqAbs

function assertApproxEqAbs(int256 left, int256 right, uint256 maxDelta, string memory err) internal pure virtual;

assertApproxEqAbsDecimal

function assertApproxEqAbsDecimal(int256 left, int256 right, uint256 maxDelta, uint256 decimals)
    internal
    pure
    virtual;

assertApproxEqAbsDecimal

function assertApproxEqAbsDecimal(int256 left, int256 right, uint256 maxDelta, uint256 decimals, string memory err)
    internal
    pure
    virtual;

assertApproxEqRel

function assertApproxEqRel(uint256 left, uint256 right, uint256 maxPercentDelta) internal pure virtual;

assertApproxEqRel

function assertApproxEqRel(uint256 left, uint256 right, uint256 maxPercentDelta, string memory err)
    internal
    pure
    virtual;

assertApproxEqRelDecimal

function assertApproxEqRelDecimal(uint256 left, uint256 right, uint256 maxPercentDelta, uint256 decimals)
    internal
    pure
    virtual;

assertApproxEqRelDecimal

function assertApproxEqRelDecimal(
    uint256 left,
    uint256 right,
    uint256 maxPercentDelta,
    uint256 decimals,
    string memory err
) internal pure virtual;

assertApproxEqRel

function assertApproxEqRel(int256 left, int256 right, uint256 maxPercentDelta) internal pure virtual;

assertApproxEqRel

function assertApproxEqRel(int256 left, int256 right, uint256 maxPercentDelta, string memory err)
    internal
    pure
    virtual;

assertApproxEqRelDecimal

function assertApproxEqRelDecimal(int256 left, int256 right, uint256 maxPercentDelta, uint256 decimals)
    internal
    pure
    virtual;

assertApproxEqRelDecimal

function assertApproxEqRelDecimal(
    int256 left,
    int256 right,
    uint256 maxPercentDelta,
    uint256 decimals,
    string memory err
) internal pure virtual;

checkEq0

function checkEq0(bytes memory left, bytes memory right) internal pure returns (bool);

assertEq0

function assertEq0(bytes memory left, bytes memory right) internal pure virtual;

assertEq0

function assertEq0(bytes memory left, bytes memory right, string memory err) internal pure virtual;

assertNotEq0

function assertNotEq0(bytes memory left, bytes memory right) internal pure virtual;

assertNotEq0

function assertNotEq0(bytes memory left, bytes memory right, string memory err) internal pure virtual;

assertEqCall

function assertEqCall(address target, bytes memory callDataA, bytes memory callDataB) internal virtual;

assertEqCall

function assertEqCall(address targetA, bytes memory callDataA, address targetB, bytes memory callDataB)
    internal
    virtual;

assertEqCall

function assertEqCall(address target, bytes memory callDataA, bytes memory callDataB, bool strictRevertData)
    internal
    virtual;

assertEqCall

function assertEqCall(
    address targetA,
    bytes memory callDataA,
    address targetB,
    bytes memory callDataB,
    bool strictRevertData
) internal virtual;

Events

log

event log(string);

logs

event logs(bytes);

log_address

event log_address(address);

log_bytes32

event log_bytes32(bytes32);

log_int

event log_int(int256);

log_uint

event log_uint(uint256);

log_bytes

event log_bytes(bytes);

log_string

event log_string(string);

log_named_address

event log_named_address(string key, address val);

log_named_bytes32

event log_named_bytes32(string key, bytes32 val);

log_named_decimal_int

event log_named_decimal_int(string key, int256 val, uint256 decimals);

log_named_decimal_uint

event log_named_decimal_uint(string key, uint256 val, uint256 decimals);

log_named_int

event log_named_int(string key, int256 val);

log_named_uint

event log_named_uint(string key, uint256 val);

log_named_bytes

event log_named_bytes(string key, bytes val);

log_named_string

event log_named_string(string key, string val);

log_array

event log_array(uint256[] val);

log_array

event log_array(int256[] val);

log_array

event log_array(address[] val);

log_named_array

event log_named_array(string key, uint256[] val);

log_named_array

event log_named_array(string key, int256[] val);

log_named_array

event log_named_array(string key, address[] val);