Skip to main content

StdCheatsSafe

Git Source

State Variables​

vm​

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

UINT256_MAX​

uint256 private constant UINT256_MAX = 115792089237316195423570985008687907853269984665640564039457584007913129639935;

gasMeteringOff​

bool private gasMeteringOff;

Functions​

assumeNotBlacklisted​

function assumeNotBlacklisted(address token, address addr) internal view virtual;

assumeNoBlacklisted​

function assumeNoBlacklisted(address token, address addr) internal view virtual;

assumeAddressIsNot​

function assumeAddressIsNot(address addr, AddressType addressType) internal virtual;

assumeAddressIsNot​

function assumeAddressIsNot(address addr, AddressType addressType1, AddressType addressType2) internal virtual;

assumeAddressIsNot​

function assumeAddressIsNot(address addr, AddressType addressType1, AddressType addressType2, AddressType addressType3)
    internal
    virtual;

assumeAddressIsNot​

function assumeAddressIsNot(
    address addr,
    AddressType addressType1,
    AddressType addressType2,
    AddressType addressType3,
    AddressType addressType4
) internal virtual;

_isPayable​

function _isPayable(address addr) private returns (bool);

assumePayable​

function assumePayable(address addr) internal virtual;

assumeNotPayable​

function assumeNotPayable(address addr) internal virtual;

assumeNotZeroAddress​

function assumeNotZeroAddress(address addr) internal pure virtual;

assumeNotPrecompile​

function assumeNotPrecompile(address addr) internal pure virtual;

assumeNotPrecompile​

function assumeNotPrecompile(address addr, uint256 chainId) internal pure virtual;

assumeNotForgeAddress​

function assumeNotForgeAddress(address addr) internal pure virtual;

readEIP1559ScriptArtifact​

function readEIP1559ScriptArtifact(string memory path) internal view virtual returns (EIP1559ScriptArtifact memory);

rawToConvertedEIPTx1559s​

function rawToConvertedEIPTx1559s(RawTx1559[] memory rawTxs) internal pure virtual returns (Tx1559[] memory);

rawToConvertedEIPTx1559​

function rawToConvertedEIPTx1559(RawTx1559 memory rawTx) internal pure virtual returns (Tx1559 memory);

rawToConvertedEIP1559Detail​

function rawToConvertedEIP1559Detail(RawTx1559Detail memory rawDetail)
    internal
    pure
    virtual
    returns (Tx1559Detail memory);

readTx1559s​

function readTx1559s(string memory path) internal view virtual returns (Tx1559[] memory);

readTx1559​

function readTx1559(string memory path, uint256 index) internal view virtual returns (Tx1559 memory);

readReceipts​

function readReceipts(string memory path) internal view virtual returns (Receipt[] memory);

readReceipt​

function readReceipt(string memory path, uint256 index) internal view virtual returns (Receipt memory);

rawToConvertedReceipts​

function rawToConvertedReceipts(RawReceipt[] memory rawReceipts) internal pure virtual returns (Receipt[] memory);

rawToConvertedReceipt​

function rawToConvertedReceipt(RawReceipt memory rawReceipt) internal pure virtual returns (Receipt memory);

rawToConvertedReceiptLogs​

function rawToConvertedReceiptLogs(RawReceiptLog[] memory rawLogs)
    internal
    pure
    virtual
    returns (ReceiptLog[] memory);

deployCode​

function deployCode(string memory what, bytes memory args) internal virtual returns (address addr);

deployCode​

function deployCode(string memory what) internal virtual returns (address addr);

deployCode​

deploy contract with value on construction

function deployCode(string memory what, bytes memory args, uint256 val) internal virtual returns (address addr);

deployCode​

function deployCode(string memory what, uint256 val) internal virtual returns (address addr);

makeAddrAndKey​

function makeAddrAndKey(string memory name) internal virtual returns (address addr, uint256 privateKey);

makeAddr​

function makeAddr(string memory name) internal virtual returns (address addr);

destroyAccount​

function destroyAccount(address who, address beneficiary) internal virtual;

makeAccount​

function makeAccount(string memory name) internal virtual returns (Account memory account);

deriveRememberKey​

function deriveRememberKey(string memory mnemonic, uint32 index)
    internal
    virtual
    returns (address who, uint256 privateKey);

_bytesToUint​

function _bytesToUint(bytes memory b) private pure returns (uint256);

isFork​

function isFork() internal view virtual returns (bool status);

skipWhenForking​

modifier skipWhenForking();

skipWhenNotForking​

modifier skipWhenNotForking();

noGasMetering​

modifier noGasMetering();

_viewChainId​

function _viewChainId() private view returns (uint256 chainId);

_pureChainId​

function _pureChainId() private pure returns (uint256 chainId);

Structs​

RawTx1559​

struct RawTx1559 {
    string[] arguments;
    address contractAddress;
    string contractName;
    string functionSig;
    bytes32 hash;
    RawTx1559Detail txDetail;
    string opcode;
}

RawTx1559Detail​

struct RawTx1559Detail {
    AccessList[] accessList;
    bytes data;
    address from;
    bytes gas;
    bytes nonce;
    address to;
    bytes txType;
    bytes value;
}

Tx1559​

struct Tx1559 {
    string[] arguments;
    address contractAddress;
    string contractName;
    string functionSig;
    bytes32 hash;
    Tx1559Detail txDetail;
    string opcode;
}

Tx1559Detail​

struct Tx1559Detail {
    AccessList[] accessList;
    bytes data;
    address from;
    uint256 gas;
    uint256 nonce;
    address to;
    uint256 txType;
    uint256 value;
}

TxLegacy​

struct TxLegacy {
    string[] arguments;
    address contractAddress;
    string contractName;
    string functionSig;
    string hash;
    string opcode;
    TxDetailLegacy transaction;
}

TxDetailLegacy​

struct TxDetailLegacy {
    AccessList[] accessList;
    uint256 chainId;
    bytes data;
    address from;
    uint256 gas;
    uint256 gasPrice;
    bytes32 hash;
    uint256 nonce;
    bytes1 opcode;
    bytes32 r;
    bytes32 s;
    uint256 txType;
    address to;
    uint8 v;
    uint256 value;
}

AccessList​

struct AccessList {
    address accessAddress;
    bytes32[] storageKeys;
}

RawReceipt​

struct RawReceipt {
    bytes32 blockHash;
    bytes blockNumber;
    address contractAddress;
    bytes cumulativeGasUsed;
    bytes effectiveGasPrice;
    address from;
    bytes gasUsed;
    RawReceiptLog[] logs;
    bytes logsBloom;
    bytes status;
    address to;
    bytes32 transactionHash;
    bytes transactionIndex;
}

Receipt​

struct Receipt {
    bytes32 blockHash;
    uint256 blockNumber;
    address contractAddress;
    uint256 cumulativeGasUsed;
    uint256 effectiveGasPrice;
    address from;
    uint256 gasUsed;
    ReceiptLog[] logs;
    bytes logsBloom;
    uint256 status;
    address to;
    bytes32 transactionHash;
    uint256 transactionIndex;
}

EIP1559ScriptArtifact​

struct EIP1559ScriptArtifact {
    string[] libraries;
    string path;
    string[] pending;
    Receipt[] receipts;
    uint256 timestamp;
    Tx1559[] transactions;
    TxReturn[] txReturns;
}

RawEIP1559ScriptArtifact​

struct RawEIP1559ScriptArtifact {
    string[] libraries;
    string path;
    string[] pending;
    RawReceipt[] receipts;
    TxReturn[] txReturns;
    uint256 timestamp;
    RawTx1559[] transactions;
}

RawReceiptLog​

struct RawReceiptLog {
    address logAddress;
    bytes32 blockHash;
    bytes blockNumber;
    bytes data;
    bytes logIndex;
    bool removed;
    bytes32[] topics;
    bytes32 transactionHash;
    bytes transactionIndex;
    bytes transactionLogIndex;
}

ReceiptLog​

struct ReceiptLog {
    address logAddress;
    bytes32 blockHash;
    uint256 blockNumber;
    bytes data;
    uint256 logIndex;
    bytes32[] topics;
    uint256 transactionIndex;
    uint256 transactionLogIndex;
    bool removed;
}

TxReturn​

struct TxReturn {
    string internalType;
    string value;
}

Account​

struct Account {
    address addr;
    uint256 key;
}

Enums​

AddressType​

enum AddressType {
    Payable,
    NonPayable,
    ZeroAddress,
    Precompile,
    ForgeAddress
}