Expand description
Foundry cheatcodes interface.
interface Vm {
error CheatcodeError(string message);
enum CallerMode { None, Broadcast, RecurrentBroadcast, Prank, RecurrentPrank }
enum AccountAccessKind { Call, DelegateCall, CallCode, StaticCall, Create, SelfDestruct, Resume, Balance, Extcodesize, Extcodehash, Extcodecopy }
enum ForgeContext { TestGroup, Test, Coverage, Snapshot, ScriptGroup, ScriptDryRun, ScriptBroadcast, ScriptResume, Unknown }
struct Log { bytes32[] topics; bytes data; address emitter; }
struct Gas { uint64 gasLimit; uint64 gasTotalUsed; uint64 gasMemoryUsed; int64 gasRefunded; uint64 gasRemaining; }
struct Rpc { string key; string url; }
struct EthGetLogs { address emitter; bytes32[] topics; bytes data; bytes32 blockHash; uint64 blockNumber; bytes32 transactionHash; uint64 transactionIndex; uint256 logIndex; bool removed; }
struct DirEntry { string errorMessage; string path; uint64 depth; bool isDir; bool isSymlink; }
struct FsMetadata { bool isDir; bool isSymlink; uint256 length; bool readOnly; uint256 modified; uint256 accessed; uint256 created; }
struct Wallet { address addr; uint256 publicKeyX; uint256 publicKeyY; uint256 privateKey; }
struct FfiResult { int32 exitCode; bytes stdout; bytes stderr; }
struct ChainInfo { uint256 forkId; uint256 chainId; }
struct StorageAccess { address account; bytes32 slot; bool isWrite; bytes32 previousValue; bytes32 newValue; bool reverted; }
struct AccountAccess { ChainInfo chainInfo; AccountAccessKind kind; address account; address accessor; bool initialized; uint256 oldBalance; uint256 newBalance; bytes deployedCode; uint256 value; bytes data; bool reverted; StorageAccess[] storageAccesses; uint64 depth; }
struct DebugStep { uint256[] stack; bytes memoryInput; uint8 opcode; uint64 depth; bool isOutOfGas; address contractAddr; }
function addr(uint256 privateKey) external pure returns (address keyAddr);
function dumpState(string calldata pathToStateJson) external;
function getNonce(address account) external view returns (uint64 nonce);
function getNonce(Wallet calldata wallet) external returns (uint64 nonce);
function load(address target, bytes32 slot) external view returns (bytes32 data);
function loadAllocs(string calldata pathToAllocsJson) external;
function startDebugTraceRecording() external;
function stopAndReturnDebugTraceRecording() external returns (DebugStep[] memory step);
function cloneAccount(address source, address target) external;
function record() external;
function accesses(address target) external returns (bytes32[] memory readSlots, bytes32[] memory writeSlots);
function startStateDiffRecording() external;
function stopAndReturnStateDiff() external returns (AccountAccess[] memory accountAccesses);
function startMappingRecording() external;
function stopMappingRecording() external;
function getMappingLength(address target, bytes32 mappingSlot) external returns (uint256 length);
function getMappingSlotAt(address target, bytes32 mappingSlot, uint256 idx) external returns (bytes32 value);
function getMappingKeyAndParentOf(address target, bytes32 elementSlot) external returns (bool found, bytes32 key, bytes32 parent);
function chainId(uint256 newChainId) external;
function coinbase(address newCoinbase) external;
function difficulty(uint256 newDifficulty) external;
function fee(uint256 newBasefee) external;
function prevrandao(bytes32 newPrevrandao) external;
function prevrandao(uint256 newPrevrandao) external;
function blobhashes(bytes32[] calldata hashes) external;
function getBlobhashes() external view returns (bytes32[] memory hashes);
function roll(uint256 newHeight) external;
function getBlockNumber() external view returns (uint256 height);
function txGasPrice(uint256 newGasPrice) external;
function warp(uint256 newTimestamp) external;
function getBlockTimestamp() external view returns (uint256 timestamp);
function blobBaseFee(uint256 newBlobBaseFee) external;
function getBlobBaseFee() external view returns (uint256 blobBaseFee);
function setBlockhash(uint256 blockNumber, bytes32 blockHash) external;
function deal(address account, uint256 newBalance) external;
function etch(address target, bytes calldata newRuntimeBytecode) external;
function resetNonce(address account) external;
function setNonce(address account, uint64 newNonce) external;
function setNonceUnsafe(address account, uint64 newNonce) external;
function store(address target, bytes32 slot, bytes32 value) external;
function cool(address target) external;
function clearMockedCalls() external;
function mockCall(address callee, bytes calldata data, bytes calldata returnData) external;
function mockCall(address callee, uint256 msgValue, bytes calldata data, bytes calldata returnData) external;
function mockCalls(address callee, bytes calldata data, bytes[] calldata returnData) external;
function mockCalls(address callee, uint256 msgValue, bytes calldata data, bytes[] calldata returnData) external;
function mockCallRevert(address callee, bytes calldata data, bytes calldata revertData) external;
function mockCallRevert(address callee, uint256 msgValue, bytes calldata data, bytes calldata revertData) external;
function mockFunction(address callee, address target, bytes calldata data) external;
function prank(address msgSender) external;
function startPrank(address msgSender) external;
function prank(address msgSender, address txOrigin) external;
function startPrank(address msgSender, address txOrigin) external;
function stopPrank() external;
function readCallers() external returns (CallerMode callerMode, address msgSender, address txOrigin);
function snapshotValue(string calldata name, uint256 value) external;
function snapshotValue(string calldata group, string calldata name, uint256 value) external;
function snapshotGasLastCall(string calldata name) external returns (uint256 gasUsed);
function snapshotGasLastCall(string calldata group, string calldata name) external returns (uint256 gasUsed);
function startSnapshotGas(string calldata name) external;
function startSnapshotGas(string calldata group, string calldata name) external;
function stopSnapshotGas() external returns (uint256 gasUsed);
function stopSnapshotGas(string calldata name) external returns (uint256 gasUsed);
function stopSnapshotGas(string calldata group, string calldata name) external returns (uint256 gasUsed);
function snapshot() external returns (uint256 snapshotId);
function snapshotState() external returns (uint256 snapshotId);
function revertTo(uint256 snapshotId) external returns (bool success);
function revertToState(uint256 snapshotId) external returns (bool success);
function revertToAndDelete(uint256 snapshotId) external returns (bool success);
function revertToStateAndDelete(uint256 snapshotId) external returns (bool success);
function deleteSnapshot(uint256 snapshotId) external returns (bool success);
function deleteStateSnapshot(uint256 snapshotId) external returns (bool success);
function deleteSnapshots() external;
function deleteStateSnapshots() external;
function activeFork() external view returns (uint256 forkId);
function createFork(string calldata urlOrAlias) external returns (uint256 forkId);
function createFork(string calldata urlOrAlias, uint256 blockNumber) external returns (uint256 forkId);
function createFork(string calldata urlOrAlias, bytes32 txHash) external returns (uint256 forkId);
function createSelectFork(string calldata urlOrAlias) external returns (uint256 forkId);
function createSelectFork(string calldata urlOrAlias, uint256 blockNumber) external returns (uint256 forkId);
function createSelectFork(string calldata urlOrAlias, bytes32 txHash) external returns (uint256 forkId);
function rollFork(uint256 blockNumber) external;
function rollFork(bytes32 txHash) external;
function rollFork(uint256 forkId, uint256 blockNumber) external;
function rollFork(uint256 forkId, bytes32 txHash) external;
function selectFork(uint256 forkId) external;
function transact(bytes32 txHash) external;
function transact(uint256 forkId, bytes32 txHash) external;
function rpc(string calldata method, string calldata params) external returns (bytes memory data);
function rpc(string calldata urlOrAlias, string calldata method, string calldata params) external returns (bytes memory data);
function eth_getLogs(uint256 fromBlock, uint256 toBlock, address target, bytes32[] memory topics) external returns (EthGetLogs[] memory logs);
function allowCheatcodes(address account) external;
function makePersistent(address account) external;
function makePersistent(address account0, address account1) external;
function makePersistent(address account0, address account1, address account2) external;
function makePersistent(address[] calldata accounts) external;
function revokePersistent(address account) external;
function revokePersistent(address[] calldata accounts) external;
function isPersistent(address account) external view returns (bool persistent);
function recordLogs() external;
function getRecordedLogs() external returns (Log[] memory logs);
function pauseGasMetering() external;
function resumeGasMetering() external;
function resetGasMetering() external;
function lastCallGas() external view returns (Gas memory gas);
function assume(bool condition) external pure;
function assumeNoRevert() external pure;
function breakpoint(string calldata char) external pure;
function breakpoint(string calldata char, bool value) external pure;
function getFoundryVersion() external view returns (string memory version);
function rpcUrl(string calldata rpcAlias) external view returns (string memory json);
function rpcUrls() external view returns (string[2][] memory urls);
function rpcUrlStructs() external view returns (Rpc[] memory urls);
function sleep(uint256 duration) external;
function expectCall(address callee, bytes calldata data) external;
function expectCall(address callee, bytes calldata data, uint64 count) external;
function expectCall(address callee, uint256 msgValue, bytes calldata data) external;
function expectCall(address callee, uint256 msgValue, bytes calldata data, uint64 count) external;
function expectCall(address callee, uint256 msgValue, uint64 gas, bytes calldata data) external;
function expectCall(address callee, uint256 msgValue, uint64 gas, bytes calldata data, uint64 count) external;
function expectCallMinGas(address callee, uint256 msgValue, uint64 minGas, bytes calldata data) external;
function expectCallMinGas(address callee, uint256 msgValue, uint64 minGas, bytes calldata data, uint64 count) external;
function expectEmit(bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData) external;
function expectEmit(bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData, address emitter) external;
function expectEmit() external;
function expectEmit(address emitter) external;
function expectEmitAnonymous(bool checkTopic0, bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData) external;
function expectEmitAnonymous(bool checkTopic0, bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData, address emitter) external;
function expectEmitAnonymous() external;
function expectEmitAnonymous(address emitter) external;
function expectRevert() external;
function expectRevert(bytes4 revertData) external;
function expectRevert(bytes calldata revertData) external;
function expectRevert(address reverter) external;
function expectRevert(bytes4 revertData, address reverter) external;
function expectRevert(bytes calldata revertData, address reverter) external;
function expectPartialRevert(bytes4 revertData) external;
function expectPartialRevert(bytes4 revertData, address reverter) external;
function _expectCheatcodeRevert() external;
function _expectCheatcodeRevert(bytes4 revertData) external;
function _expectCheatcodeRevert(bytes calldata revertData) external;
function expectSafeMemory(uint64 min, uint64 max) external;
function stopExpectSafeMemory() external;
function expectSafeMemoryCall(uint64 min, uint64 max) external;
function skip(bool skipTest) external;
function skip(bool skipTest, string calldata reason) external;
function assertTrue(bool condition) external pure;
function assertTrue(bool condition, string calldata error) external pure;
function assertFalse(bool condition) external pure;
function assertFalse(bool condition, string calldata error) external pure;
function assertEq(bool left, bool right) external pure;
function assertEq(bool left, bool right, string calldata error) external pure;
function assertEq(uint256 left, uint256 right) external pure;
function assertEq(uint256 left, uint256 right, string calldata error) external pure;
function assertEq(int256 left, int256 right) external pure;
function assertEq(int256 left, int256 right, string calldata error) external pure;
function assertEq(address left, address right) external pure;
function assertEq(address left, address right, string calldata error) external pure;
function assertEq(bytes32 left, bytes32 right) external pure;
function assertEq(bytes32 left, bytes32 right, string calldata error) external pure;
function assertEq(string calldata left, string calldata right) external pure;
function assertEq(string calldata left, string calldata right, string calldata error) external pure;
function assertEq(bytes calldata left, bytes calldata right) external pure;
function assertEq(bytes calldata left, bytes calldata right, string calldata error) external pure;
function assertEq(bool[] calldata left, bool[] calldata right) external pure;
function assertEq(bool[] calldata left, bool[] calldata right, string calldata error) external pure;
function assertEq(uint256[] calldata left, uint256[] calldata right) external pure;
function assertEq(uint256[] calldata left, uint256[] calldata right, string calldata error) external pure;
function assertEq(int256[] calldata left, int256[] calldata right) external pure;
function assertEq(int256[] calldata left, int256[] calldata right, string calldata error) external pure;
function assertEq(address[] calldata left, address[] calldata right) external pure;
function assertEq(address[] calldata left, address[] calldata right, string calldata error) external pure;
function assertEq(bytes32[] calldata left, bytes32[] calldata right) external pure;
function assertEq(bytes32[] calldata left, bytes32[] calldata right, string calldata error) external pure;
function assertEq(string[] calldata left, string[] calldata right) external pure;
function assertEq(string[] calldata left, string[] calldata right, string calldata error) external pure;
function assertEq(bytes[] calldata left, bytes[] calldata right) external pure;
function assertEq(bytes[] calldata left, bytes[] calldata right, string calldata error) external pure;
function assertEqDecimal(uint256 left, uint256 right, uint256 decimals) external pure;
function assertEqDecimal(uint256 left, uint256 right, uint256 decimals, string calldata error) external pure;
function assertEqDecimal(int256 left, int256 right, uint256 decimals) external pure;
function assertEqDecimal(int256 left, int256 right, uint256 decimals, string calldata error) external pure;
function assertNotEq(bool left, bool right) external pure;
function assertNotEq(bool left, bool right, string calldata error) external pure;
function assertNotEq(uint256 left, uint256 right) external pure;
function assertNotEq(uint256 left, uint256 right, string calldata error) external pure;
function assertNotEq(int256 left, int256 right) external pure;
function assertNotEq(int256 left, int256 right, string calldata error) external pure;
function assertNotEq(address left, address right) external pure;
function assertNotEq(address left, address right, string calldata error) external pure;
function assertNotEq(bytes32 left, bytes32 right) external pure;
function assertNotEq(bytes32 left, bytes32 right, string calldata error) external pure;
function assertNotEq(string calldata left, string calldata right) external pure;
function assertNotEq(string calldata left, string calldata right, string calldata error) external pure;
function assertNotEq(bytes calldata left, bytes calldata right) external pure;
function assertNotEq(bytes calldata left, bytes calldata right, string calldata error) external pure;
function assertNotEq(bool[] calldata left, bool[] calldata right) external pure;
function assertNotEq(bool[] calldata left, bool[] calldata right, string calldata error) external pure;
function assertNotEq(uint256[] calldata left, uint256[] calldata right) external pure;
function assertNotEq(uint256[] calldata left, uint256[] calldata right, string calldata error) external pure;
function assertNotEq(int256[] calldata left, int256[] calldata right) external pure;
function assertNotEq(int256[] calldata left, int256[] calldata right, string calldata error) external pure;
function assertNotEq(address[] calldata left, address[] calldata right) external pure;
function assertNotEq(address[] calldata left, address[] calldata right, string calldata error) external pure;
function assertNotEq(bytes32[] calldata left, bytes32[] calldata right) external pure;
function assertNotEq(bytes32[] calldata left, bytes32[] calldata right, string calldata error) external pure;
function assertNotEq(string[] calldata left, string[] calldata right) external pure;
function assertNotEq(string[] calldata left, string[] calldata right, string calldata error) external pure;
function assertNotEq(bytes[] calldata left, bytes[] calldata right) external pure;
function assertNotEq(bytes[] calldata left, bytes[] calldata right, string calldata error) external pure;
function assertNotEqDecimal(uint256 left, uint256 right, uint256 decimals) external pure;
function assertNotEqDecimal(uint256 left, uint256 right, uint256 decimals, string calldata error) external pure;
function assertNotEqDecimal(int256 left, int256 right, uint256 decimals) external pure;
function assertNotEqDecimal(int256 left, int256 right, uint256 decimals, string calldata error) external pure;
function assertGt(uint256 left, uint256 right) external pure;
function assertGt(uint256 left, uint256 right, string calldata error) external pure;
function assertGt(int256 left, int256 right) external pure;
function assertGt(int256 left, int256 right, string calldata error) external pure;
function assertGtDecimal(uint256 left, uint256 right, uint256 decimals) external pure;
function assertGtDecimal(uint256 left, uint256 right, uint256 decimals, string calldata error) external pure;
function assertGtDecimal(int256 left, int256 right, uint256 decimals) external pure;
function assertGtDecimal(int256 left, int256 right, uint256 decimals, string calldata error) external pure;
function assertGe(uint256 left, uint256 right) external pure;
function assertGe(uint256 left, uint256 right, string calldata error) external pure;
function assertGe(int256 left, int256 right) external pure;
function assertGe(int256 left, int256 right, string calldata error) external pure;
function assertGeDecimal(uint256 left, uint256 right, uint256 decimals) external pure;
function assertGeDecimal(uint256 left, uint256 right, uint256 decimals, string calldata error) external pure;
function assertGeDecimal(int256 left, int256 right, uint256 decimals) external pure;
function assertGeDecimal(int256 left, int256 right, uint256 decimals, string calldata error) external pure;
function assertLt(uint256 left, uint256 right) external pure;
function assertLt(uint256 left, uint256 right, string calldata error) external pure;
function assertLt(int256 left, int256 right) external pure;
function assertLt(int256 left, int256 right, string calldata error) external pure;
function assertLtDecimal(uint256 left, uint256 right, uint256 decimals) external pure;
function assertLtDecimal(uint256 left, uint256 right, uint256 decimals, string calldata error) external pure;
function assertLtDecimal(int256 left, int256 right, uint256 decimals) external pure;
function assertLtDecimal(int256 left, int256 right, uint256 decimals, string calldata error) external pure;
function assertLe(uint256 left, uint256 right) external pure;
function assertLe(uint256 left, uint256 right, string calldata error) external pure;
function assertLe(int256 left, int256 right) external pure;
function assertLe(int256 left, int256 right, string calldata error) external pure;
function assertLeDecimal(uint256 left, uint256 right, uint256 decimals) external pure;
function assertLeDecimal(uint256 left, uint256 right, uint256 decimals, string calldata error) external pure;
function assertLeDecimal(int256 left, int256 right, uint256 decimals) external pure;
function assertLeDecimal(int256 left, int256 right, uint256 decimals, string calldata error) external pure;
function assertApproxEqAbs(uint256 left, uint256 right, uint256 maxDelta) external pure;
function assertApproxEqAbs(uint256 left, uint256 right, uint256 maxDelta, string calldata error) external pure;
function assertApproxEqAbs(int256 left, int256 right, uint256 maxDelta) external pure;
function assertApproxEqAbs(int256 left, int256 right, uint256 maxDelta, string calldata error) external pure;
function assertApproxEqAbsDecimal(uint256 left, uint256 right, uint256 maxDelta, uint256 decimals) external pure;
function assertApproxEqAbsDecimal(uint256 left, uint256 right, uint256 maxDelta, uint256 decimals, string calldata error) external pure;
function assertApproxEqAbsDecimal(int256 left, int256 right, uint256 maxDelta, uint256 decimals) external pure;
function assertApproxEqAbsDecimal(int256 left, int256 right, uint256 maxDelta, uint256 decimals, string calldata error) external pure;
function assertApproxEqRel(uint256 left, uint256 right, uint256 maxPercentDelta) external pure;
function assertApproxEqRel(uint256 left, uint256 right, uint256 maxPercentDelta, string calldata error) external pure;
function assertApproxEqRel(int256 left, int256 right, uint256 maxPercentDelta) external pure;
function assertApproxEqRel(int256 left, int256 right, uint256 maxPercentDelta, string calldata error) external pure;
function assertApproxEqRelDecimal(uint256 left, uint256 right, uint256 maxPercentDelta, uint256 decimals) external pure;
function assertApproxEqRelDecimal(uint256 left, uint256 right, uint256 maxPercentDelta, uint256 decimals, string calldata error) external pure;
function assertApproxEqRelDecimal(int256 left, int256 right, uint256 maxPercentDelta, uint256 decimals) external pure;
function assertApproxEqRelDecimal(int256 left, int256 right, uint256 maxPercentDelta, uint256 decimals, string calldata error) external pure;
function exists(string calldata path) external returns (bool result);
function fsMetadata(string calldata path) external view returns (FsMetadata memory metadata);
function isDir(string calldata path) external returns (bool result);
function isFile(string calldata path) external returns (bool result);
function projectRoot() external view returns (string memory path);
function unixTime() external returns (uint256 milliseconds);
function closeFile(string calldata path) external;
function copyFile(string calldata from, string calldata to) external returns (uint64 copied);
function createDir(string calldata path, bool recursive) external;
function readDir(string calldata path) external view returns (DirEntry[] memory entries);
function readDir(string calldata path, uint64 maxDepth) external view returns (DirEntry[] memory entries);
function readDir(string calldata path, uint64 maxDepth, bool followLinks) external view returns (DirEntry[] memory entries);
function readFile(string calldata path) external view returns (string memory data);
function readFileBinary(string calldata path) external view returns (bytes memory data);
function readLine(string calldata path) external view returns (string memory line);
function readLink(string calldata linkPath) external view returns (string memory targetPath);
function removeDir(string calldata path, bool recursive) external;
function removeFile(string calldata path) external;
function writeFile(string calldata path, string calldata data) external;
function writeFileBinary(string calldata path, bytes calldata data) external;
function writeLine(string calldata path, string calldata data) external;
function getArtifactPathByCode(bytes calldata code) external view returns (string memory path);
function getArtifactPathByDeployedCode(bytes calldata deployedCode) external view returns (string memory path);
function getCode(string calldata artifactPath) external view returns (bytes memory creationBytecode);
function deployCode(string calldata artifactPath) external returns (address deployedAddress);
function deployCode(string calldata artifactPath, bytes calldata constructorArgs) external returns (address deployedAddress);
function getDeployedCode(string calldata artifactPath) external view returns (bytes memory runtimeBytecode);
function ffi(string[] calldata commandInput) external returns (bytes memory result);
function tryFfi(string[] calldata commandInput) external returns (FfiResult memory result);
function prompt(string calldata promptText) external returns (string memory input);
function promptSecret(string calldata promptText) external returns (string memory input);
function promptSecretUint(string calldata promptText) external returns (uint256);
function promptAddress(string calldata promptText) external returns (address);
function promptUint(string calldata promptText) external returns (uint256);
function setEnv(string calldata name, string calldata value) external;
function envExists(string calldata name) external view returns (bool result);
function envBool(string calldata name) external view returns (bool value);
function envUint(string calldata name) external view returns (uint256 value);
function envInt(string calldata name) external view returns (int256 value);
function envAddress(string calldata name) external view returns (address value);
function envBytes32(string calldata name) external view returns (bytes32 value);
function envString(string calldata name) external view returns (string memory value);
function envBytes(string calldata name) external view returns (bytes memory value);
function envBool(string calldata name, string calldata delim) external view returns (bool[] memory value);
function envUint(string calldata name, string calldata delim) external view returns (uint256[] memory value);
function envInt(string calldata name, string calldata delim) external view returns (int256[] memory value);
function envAddress(string calldata name, string calldata delim) external view returns (address[] memory value);
function envBytes32(string calldata name, string calldata delim) external view returns (bytes32[] memory value);
function envString(string calldata name, string calldata delim) external view returns (string[] memory value);
function envBytes(string calldata name, string calldata delim) external view returns (bytes[] memory value);
function envOr(string calldata name, bool defaultValue) external view returns (bool value);
function envOr(string calldata name, uint256 defaultValue) external view returns (uint256 value);
function envOr(string calldata name, int256 defaultValue) external view returns (int256 value);
function envOr(string calldata name, address defaultValue) external view returns (address value);
function envOr(string calldata name, bytes32 defaultValue) external view returns (bytes32 value);
function envOr(string calldata name, string calldata defaultValue) external view returns (string memory value);
function envOr(string calldata name, bytes calldata defaultValue) external view returns (bytes memory value);
function envOr(string calldata name, string calldata delim, bool[] calldata defaultValue) external view returns (bool[] memory value);
function envOr(string calldata name, string calldata delim, uint256[] calldata defaultValue) external view returns (uint256[] memory value);
function envOr(string calldata name, string calldata delim, int256[] calldata defaultValue) external view returns (int256[] memory value);
function envOr(string calldata name, string calldata delim, address[] calldata defaultValue) external view returns (address[] memory value);
function envOr(string calldata name, string calldata delim, bytes32[] calldata defaultValue) external view returns (bytes32[] memory value);
function envOr(string calldata name, string calldata delim, string[] calldata defaultValue) external view returns (string[] memory value);
function envOr(string calldata name, string calldata delim, bytes[] calldata defaultValue) external view returns (bytes[] memory value);
function isContext(ForgeContext context) external view returns (bool result);
function broadcast() external;
function broadcast(address signer) external;
function broadcast(uint256 privateKey) external;
function startBroadcast() external;
function startBroadcast(address signer) external;
function startBroadcast(uint256 privateKey) external;
function stopBroadcast() external;
function broadcastRawTransaction(bytes calldata data) external;
function getWallets() external returns (address[] memory wallets);
function toString(address value) external pure returns (string memory stringifiedValue);
function toString(bytes calldata value) external pure returns (string memory stringifiedValue);
function toString(bytes32 value) external pure returns (string memory stringifiedValue);
function toString(bool value) external pure returns (string memory stringifiedValue);
function toString(uint256 value) external pure returns (string memory stringifiedValue);
function toString(int256 value) external pure returns (string memory stringifiedValue);
function parseBytes(string calldata stringifiedValue) external pure returns (bytes memory parsedValue);
function parseAddress(string calldata stringifiedValue) external pure returns (address parsedValue);
function parseUint(string calldata stringifiedValue) external pure returns (uint256 parsedValue);
function parseInt(string calldata stringifiedValue) external pure returns (int256 parsedValue);
function parseBytes32(string calldata stringifiedValue) external pure returns (bytes32 parsedValue);
function parseBool(string calldata stringifiedValue) external pure returns (bool parsedValue);
function toLowercase(string calldata input) external pure returns (string memory output);
function toUppercase(string calldata input) external pure returns (string memory output);
function trim(string calldata input) external pure returns (string memory output);
function replace(string calldata input, string calldata from, string calldata to) external pure returns (string memory output);
function split(string calldata input, string calldata delimiter) external pure returns (string[] memory outputs);
function indexOf(string calldata input, string calldata key) external pure returns (uint256);
function contains(string calldata subject, string calldata search) external returns (bool result);
function keyExists(string calldata json, string calldata key) external view returns (bool);
function keyExistsJson(string calldata json, string calldata key) external view returns (bool);
function parseJson(string calldata json) external pure returns (bytes memory abiEncodedData);
function parseJson(string calldata json, string calldata key) external pure returns (bytes memory abiEncodedData);
function parseJsonUint(string calldata json, string calldata key) external pure returns (uint256);
function parseJsonUintArray(string calldata json, string calldata key) external pure returns (uint256[] memory);
function parseJsonInt(string calldata json, string calldata key) external pure returns (int256);
function parseJsonIntArray(string calldata json, string calldata key) external pure returns (int256[] memory);
function parseJsonBool(string calldata json, string calldata key) external pure returns (bool);
function parseJsonBoolArray(string calldata json, string calldata key) external pure returns (bool[] memory);
function parseJsonAddress(string calldata json, string calldata key) external pure returns (address);
function parseJsonAddressArray(string calldata json, string calldata key) external pure returns (address[] memory);
function parseJsonString(string calldata json, string calldata key) external pure returns (string memory);
function parseJsonStringArray(string calldata json, string calldata key) external pure returns (string[] memory);
function parseJsonBytes(string calldata json, string calldata key) external pure returns (bytes memory);
function parseJsonBytesArray(string calldata json, string calldata key) external pure returns (bytes[] memory);
function parseJsonBytes32(string calldata json, string calldata key) external pure returns (bytes32);
function parseJsonBytes32Array(string calldata json, string calldata key) external pure returns (bytes32[] memory);
function parseJsonType(string calldata json, string calldata typeDescription) external pure returns (bytes memory);
function parseJsonType(string calldata json, string calldata key, string calldata typeDescription) external pure returns (bytes memory);
function parseJsonTypeArray(string calldata json, string calldata key, string calldata typeDescription) external pure returns (bytes memory);
function parseJsonKeys(string calldata json, string calldata key) external pure returns (string[] memory keys);
function serializeJson(string calldata objectKey, string calldata value) external returns (string memory json);
function serializeBool(string calldata objectKey, string calldata valueKey, bool value) external returns (string memory json);
function serializeUint(string calldata objectKey, string calldata valueKey, uint256 value) external returns (string memory json);
function serializeUintToHex(string calldata objectKey, string calldata valueKey, uint256 value) external returns (string memory json);
function serializeInt(string calldata objectKey, string calldata valueKey, int256 value) external returns (string memory json);
function serializeAddress(string calldata objectKey, string calldata valueKey, address value) external returns (string memory json);
function serializeBytes32(string calldata objectKey, string calldata valueKey, bytes32 value) external returns (string memory json);
function serializeString(string calldata objectKey, string calldata valueKey, string calldata value) external returns (string memory json);
function serializeBytes(string calldata objectKey, string calldata valueKey, bytes calldata value) external returns (string memory json);
function serializeBool(string calldata objectKey, string calldata valueKey, bool[] calldata values) external returns (string memory json);
function serializeUint(string calldata objectKey, string calldata valueKey, uint256[] calldata values) external returns (string memory json);
function serializeInt(string calldata objectKey, string calldata valueKey, int256[] calldata values) external returns (string memory json);
function serializeAddress(string calldata objectKey, string calldata valueKey, address[] calldata values) external returns (string memory json);
function serializeBytes32(string calldata objectKey, string calldata valueKey, bytes32[] calldata values) external returns (string memory json);
function serializeString(string calldata objectKey, string calldata valueKey, string[] calldata values) external returns (string memory json);
function serializeBytes(string calldata objectKey, string calldata valueKey, bytes[] calldata values) external returns (string memory json);
function serializeJsonType(string calldata typeDescription, bytes memory value) external pure returns (string memory json);
function serializeJsonType(string calldata objectKey, string calldata valueKey, string calldata typeDescription, bytes memory value) external returns (string memory json);
function writeJson(string calldata json, string calldata path) external;
function writeJson(string calldata json, string calldata path, string calldata valueKey) external;
function keyExistsToml(string calldata toml, string calldata key) external view returns (bool);
function parseToml(string calldata toml) external pure returns (bytes memory abiEncodedData);
function parseToml(string calldata toml, string calldata key) external pure returns (bytes memory abiEncodedData);
function parseTomlUint(string calldata toml, string calldata key) external pure returns (uint256);
function parseTomlUintArray(string calldata toml, string calldata key) external pure returns (uint256[] memory);
function parseTomlInt(string calldata toml, string calldata key) external pure returns (int256);
function parseTomlIntArray(string calldata toml, string calldata key) external pure returns (int256[] memory);
function parseTomlBool(string calldata toml, string calldata key) external pure returns (bool);
function parseTomlBoolArray(string calldata toml, string calldata key) external pure returns (bool[] memory);
function parseTomlAddress(string calldata toml, string calldata key) external pure returns (address);
function parseTomlAddressArray(string calldata toml, string calldata key) external pure returns (address[] memory);
function parseTomlString(string calldata toml, string calldata key) external pure returns (string memory);
function parseTomlStringArray(string calldata toml, string calldata key) external pure returns (string[] memory);
function parseTomlBytes(string calldata toml, string calldata key) external pure returns (bytes memory);
function parseTomlBytesArray(string calldata toml, string calldata key) external pure returns (bytes[] memory);
function parseTomlBytes32(string calldata toml, string calldata key) external pure returns (bytes32);
function parseTomlBytes32Array(string calldata toml, string calldata key) external pure returns (bytes32[] memory);
function parseTomlType(string calldata toml, string calldata typeDescription) external pure returns (bytes memory);
function parseTomlType(string calldata toml, string calldata key, string calldata typeDescription) external pure returns (bytes memory);
function parseTomlTypeArray(string calldata toml, string calldata key, string calldata typeDescription) external pure returns (bytes memory);
function parseTomlKeys(string calldata toml, string calldata key) external pure returns (string[] memory keys);
function writeToml(string calldata json, string calldata path) external;
function writeToml(string calldata json, string calldata path, string calldata valueKey) external;
function createWallet(string calldata walletLabel) external returns (Wallet memory wallet);
function createWallet(uint256 privateKey) external returns (Wallet memory wallet);
function createWallet(uint256 privateKey, string calldata walletLabel) external returns (Wallet memory wallet);
function sign(Wallet calldata wallet, bytes32 digest) external returns (uint8 v, bytes32 r, bytes32 s);
function signCompact(Wallet calldata wallet, bytes32 digest) external returns (bytes32 r, bytes32 vs);
function sign(uint256 privateKey, bytes32 digest) external pure returns (uint8 v, bytes32 r, bytes32 s);
function signCompact(uint256 privateKey, bytes32 digest) external pure returns (bytes32 r, bytes32 vs);
function sign(bytes32 digest) external pure returns (uint8 v, bytes32 r, bytes32 s);
function signCompact(bytes32 digest) external pure returns (bytes32 r, bytes32 vs);
function sign(address signer, bytes32 digest) external pure returns (uint8 v, bytes32 r, bytes32 s);
function signCompact(address signer, bytes32 digest) external pure returns (bytes32 r, bytes32 vs);
function signP256(uint256 privateKey, bytes32 digest) external pure returns (bytes32 r, bytes32 s);
function publicKeyP256(uint256 privateKey) external pure returns (uint256 publicKeyX, uint256 publicKeyY);
function deriveKey(string calldata mnemonic, uint32 index) external pure returns (uint256 privateKey);
function deriveKey(string calldata mnemonic, string calldata derivationPath, uint32 index) external pure returns (uint256 privateKey);
function deriveKey(string calldata mnemonic, uint32 index, string calldata language) external pure returns (uint256 privateKey);
function deriveKey(string calldata mnemonic, string calldata derivationPath, uint32 index, string calldata language) external pure returns (uint256 privateKey);
function rememberKey(uint256 privateKey) external returns (address keyAddr);
function rememberKeys(string calldata mnemonic, string calldata derivationPath, uint32 count) external returns (address[] memory keyAddrs);
function rememberKeys(string calldata mnemonic, string calldata derivationPath, string calldata language, uint32 count) external returns (address[] memory keyAddrs);
function label(address account, string calldata newLabel) external;
function getLabel(address account) external view returns (string memory currentLabel);
function computeCreateAddress(address deployer, uint256 nonce) external pure returns (address);
function computeCreate2Address(bytes32 salt, bytes32 initCodeHash, address deployer) external pure returns (address);
function computeCreate2Address(bytes32 salt, bytes32 initCodeHash) external pure returns (address);
function toBase64(bytes calldata data) external pure returns (string memory);
function toBase64(string calldata data) external pure returns (string memory);
function toBase64URL(bytes calldata data) external pure returns (string memory);
function toBase64URL(string calldata data) external pure returns (string memory);
function ensNamehash(string calldata name) external pure returns (bytes32);
function randomUint() external returns (uint256);
function randomUint(uint256 min, uint256 max) external returns (uint256);
function randomUint(uint256 bits) external view returns (uint256);
function randomAddress() external returns (address);
function randomInt() external view returns (int256);
function randomInt(uint256 bits) external view returns (int256);
function randomBool() external view returns (bool);
function randomBytes(uint256 len) external view returns (bytes memory);
function randomBytes4() external view returns (bytes4);
function randomBytes8() external view returns (bytes8);
function pauseTracing() external view;
function resumeTracing() external view;
function copyStorage(address from, address to) external;
function setArbitraryStorage(address target) external;
}
Modules§
- Contains dynamic ABI definitions for this contract.
Structs§
- The result of a
stopAndReturnStateDiff
call. - Information on the chain and fork.
- Error thrown by cheatcodes. Custom error with signature
CheatcodeError(string)
and selector0xeeaa9e6f
. - The result of the
stopDebugTraceRecording
call - A single entry in a directory listing. Returned by
readDir
. - An RPC log object. Returned by
eth_getLogs
. - The result of a
tryFfi
call. - Metadata information about a file.
- Gas used. Returned by
lastCallGas
. - An Ethereum log. Returned by
getRecordedLogs
. - An RPC URL and its alias. Returned by
rpcUrlStructs
. - The storage accessed during an
AccountAccess
. - A wallet with a public and private key.
- Expects an error on next cheatcode call with any revert data. Function with signature
_expectCheatcodeRevert()
and selector0x79a4f48a
. - Expects an error on next cheatcode call with any revert data. Container type for the return parameters of the
_expectCheatcodeRevert()
function. - Expects an error on next cheatcode call that starts with the revert data. Function with signature
_expectCheatcodeRevert(bytes4)
and selector0x884cb0ae
. - Expects an error on next cheatcode call that starts with the revert data. Container type for the return parameters of the
_expectCheatcodeRevert(bytes4)
function. - Expects an error on next cheatcode call that exactly matches the revert data. Function with signature
_expectCheatcodeRevert(bytes)
and selector0x7843b44d
. - Expects an error on next cheatcode call that exactly matches the revert data. Container type for the return parameters of the
_expectCheatcodeRevert(bytes)
function. - Gets all accessed reads and write slot from a
vm.record
session, for a given address. Function with signatureaccesses(address)
and selector0x65bc9481
. - Gets all accessed reads and write slot from a
vm.record
session, for a given address. Container type for the return parameters of theaccesses(address)
function. - Returns the identifier of the currently active fork. Reverts if no fork is currently active. Function with signature
activeFork()
and selector0x2f103f22
. - Returns the identifier of the currently active fork. Reverts if no fork is currently active. Container type for the return parameters of the
activeFork()
function. - Gets the address for a given private key. Function with signature
addr(uint256)
and selector0xffa18649
. - Gets the address for a given private key. Container type for the return parameters of the
addr(uint256)
function. - In forking mode, explicitly grant the given address cheatcode access. Function with signature
allowCheatcodes(address)
and selector0xea060291
. - In forking mode, explicitly grant the given address cheatcode access. Container type for the return parameters of the
allowCheatcodes(address)
function. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Function with signatureassertApproxEqAbsDecimal(uint256,uint256,uint256,uint256)
and selector0x045c55ce
. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Container type for the return parameters of theassertApproxEqAbsDecimal(uint256,uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertApproxEqAbsDecimal(uint256,uint256,uint256,uint256,string)
and selector0x60429eb2
. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqAbsDecimal(uint256,uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Function with signatureassertApproxEqAbsDecimal(int256,int256,uint256,uint256)
and selector0x3d5bc8bc
. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Container type for the return parameters of theassertApproxEqAbsDecimal(int256,int256,uint256,uint256)
function. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertApproxEqAbsDecimal(int256,int256,uint256,uint256,string)
and selector0x6a5066d4
. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqAbsDecimal(int256,int256,uint256,uint256,string)
function. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Function with signatureassertApproxEqAbs(uint256,uint256,uint256)
and selector0x16d207c6
. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Container type for the return parameters of theassertApproxEqAbs(uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Includes error message into revert string on failure. Function with signatureassertApproxEqAbs(uint256,uint256,uint256,string)
and selector0xf710b062
. - Compares two
uint256
values. Expects difference to be less than or equal tomaxDelta
. Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqAbs(uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Function with signatureassertApproxEqAbs(int256,int256,uint256)
and selector0x240f839d
. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Container type for the return parameters of theassertApproxEqAbs(int256,int256,uint256)
function. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Includes error message into revert string on failure. Function with signatureassertApproxEqAbs(int256,int256,uint256,string)
and selector0x8289e621
. - Compares two
int256
values. Expects difference to be less than or equal tomaxDelta
. Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqAbs(int256,int256,uint256,string)
function. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Function with signatureassertApproxEqRelDecimal(uint256,uint256,uint256,uint256)
and selector0x21ed2977
. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Container type for the return parameters of theassertApproxEqRelDecimal(uint256,uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertApproxEqRelDecimal(uint256,uint256,uint256,uint256,string)
and selector0x82d6c8fd
. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqRelDecimal(uint256,uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Function with signatureassertApproxEqRelDecimal(int256,int256,uint256,uint256)
and selector0xabbf21cc
. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Container type for the return parameters of theassertApproxEqRelDecimal(int256,int256,uint256,uint256)
function. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertApproxEqRelDecimal(int256,int256,uint256,uint256,string)
and selector0xfccc11c4
. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqRelDecimal(int256,int256,uint256,uint256,string)
function. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Function with signatureassertApproxEqRel(uint256,uint256,uint256)
and selector0x8cf25ef4
. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Container type for the return parameters of theassertApproxEqRel(uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Includes error message into revert string on failure. Function with signatureassertApproxEqRel(uint256,uint256,uint256,string)
and selector0x1ecb7d33
. - Compares two
uint256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqRel(uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Function with signatureassertApproxEqRel(int256,int256,uint256)
and selector0xfea2d14f
. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Container type for the return parameters of theassertApproxEqRel(int256,int256,uint256)
function. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Includes error message into revert string on failure. Function with signatureassertApproxEqRel(int256,int256,uint256,string)
and selector0xef277d72
. - Compares two
int256
values. Expects relative difference in percents to be less than or equal tomaxPercentDelta
.maxPercentDelta
is an 18 decimal fixed point number, where 1e18 == 100% Includes error message into revert string on failure. Container type for the return parameters of theassertApproxEqRel(int256,int256,uint256,string)
function. - Asserts that two
uint256
values are equal, formatting them with decimals in failure message. Function with signatureassertEqDecimal(uint256,uint256,uint256)
and selector0x27af7d9c
. - Asserts that two
uint256
values are equal, formatting them with decimals in failure message. Container type for the return parameters of theassertEqDecimal(uint256,uint256,uint256)
function. - Asserts that two
uint256
values are equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertEqDecimal(uint256,uint256,uint256,string)
and selector0xd0cbbdef
. - Asserts that two
uint256
values are equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertEqDecimal(uint256,uint256,uint256,string)
function. - Asserts that two
int256
values are equal, formatting them with decimals in failure message. Function with signatureassertEqDecimal(int256,int256,uint256)
and selector0x48016c04
. - Asserts that two
int256
values are equal, formatting them with decimals in failure message. Container type for the return parameters of theassertEqDecimal(int256,int256,uint256)
function. - Asserts that two
int256
values are equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertEqDecimal(int256,int256,uint256,string)
and selector0x7e77b0c5
. - Asserts that two
int256
values are equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertEqDecimal(int256,int256,uint256,string)
function. - Asserts that two
bool
values are equal. Function with signatureassertEq(bool,bool)
and selector0xf7fe3477
. - Asserts that two
bool
values are equal. Container type for the return parameters of theassertEq(bool,bool)
function. - Asserts that two
bool
values are equal and includes error message into revert string on failure. Function with signatureassertEq(bool,bool,string)
and selector0x4db19e7e
. - Asserts that two
bool
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(bool,bool,string)
function. - Asserts that two
uint256
values are equal. Function with signatureassertEq(uint256,uint256)
and selector0x98296c54
. - Asserts that two
uint256
values are equal. Container type for the return parameters of theassertEq(uint256,uint256)
function. - Asserts that two
uint256
values are equal and includes error message into revert string on failure. Function with signatureassertEq(uint256,uint256,string)
and selector0x88b44c85
. - Asserts that two
uint256
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(uint256,uint256,string)
function. - Asserts that two
int256
values are equal. Function with signatureassertEq(int256,int256)
and selector0xfe74f05b
. - Asserts that two
int256
values are equal. Container type for the return parameters of theassertEq(int256,int256)
function. - Asserts that two
int256
values are equal and includes error message into revert string on failure. Function with signatureassertEq(int256,int256,string)
and selector0x714a2f13
. - Asserts that two
int256
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(int256,int256,string)
function. - Asserts that two
address
values are equal. Function with signatureassertEq(address,address)
and selector0x515361f6
. - Asserts that two
address
values are equal. Container type for the return parameters of theassertEq(address,address)
function. - Asserts that two
address
values are equal and includes error message into revert string on failure. Function with signatureassertEq(address,address,string)
and selector0x2f2769d1
. - Asserts that two
address
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(address,address,string)
function. - Asserts that two
bytes32
values are equal. Function with signatureassertEq(bytes32,bytes32)
and selector0x7c84c69b
. - Asserts that two
bytes32
values are equal. Container type for the return parameters of theassertEq(bytes32,bytes32)
function. - Asserts that two
bytes32
values are equal and includes error message into revert string on failure. Function with signatureassertEq(bytes32,bytes32,string)
and selector0xc1fa1ed0
. - Asserts that two
bytes32
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(bytes32,bytes32,string)
function. - Asserts that two
string
values are equal. Function with signatureassertEq(string,string)
and selector0xf320d963
. - Asserts that two
string
values are equal. Container type for the return parameters of theassertEq(string,string)
function. - Asserts that two
string
values are equal and includes error message into revert string on failure. Function with signatureassertEq(string,string,string)
and selector0x36f656d8
. - Asserts that two
string
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(string,string,string)
function. - Asserts that two
bytes
values are equal. Function with signatureassertEq(bytes,bytes)
and selector0x97624631
. - Asserts that two
bytes
values are equal. Container type for the return parameters of theassertEq(bytes,bytes)
function. - Asserts that two
bytes
values are equal and includes error message into revert string on failure. Function with signatureassertEq(bytes,bytes,string)
and selector0xe24fed00
. - Asserts that two
bytes
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(bytes,bytes,string)
function. - Asserts that two arrays of
bool
values are equal. Function with signatureassertEq(bool[],bool[])
and selector0x707df785
. - Asserts that two arrays of
bool
values are equal. Container type for the return parameters of theassertEq(bool[],bool[])
function. - Asserts that two arrays of
bool
values are equal and includes error message into revert string on failure. Function with signatureassertEq(bool[],bool[],string)
and selector0xe48a8f8d
. - Asserts that two arrays of
bool
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(bool[],bool[],string)
function. - Asserts that two arrays of
uint256 values are equal. Function with signature
assertEq(uint256[],uint256[])and selector
0x975d5a12`. - Asserts that two arrays of
uint256 values are equal. Container type for the return parameters of the [
assertEq(uint256[],uint256[])`](assertEq_16Call) function. - Asserts that two arrays of
uint256
values are equal and includes error message into revert string on failure. Function with signatureassertEq(uint256[],uint256[],string)
and selector0x5d18c73a
. - Asserts that two arrays of
uint256
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(uint256[],uint256[],string)
function. - Asserts that two arrays of
int256
values are equal. Function with signatureassertEq(int256[],int256[])
and selector0x711043ac
. - Asserts that two arrays of
int256
values are equal. Container type for the return parameters of theassertEq(int256[],int256[])
function. - Asserts that two arrays of
int256
values are equal and includes error message into revert string on failure. Function with signatureassertEq(int256[],int256[],string)
and selector0x191f1b30
. - Asserts that two arrays of
int256
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(int256[],int256[],string)
function. - Asserts that two arrays of
address
values are equal. Function with signatureassertEq(address[],address[])
and selector0x3868ac34
. - Asserts that two arrays of
address
values are equal. Container type for the return parameters of theassertEq(address[],address[])
function. - Asserts that two arrays of
address
values are equal and includes error message into revert string on failure. Function with signatureassertEq(address[],address[],string)
and selector0x3e9173c5
. - Asserts that two arrays of
address
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(address[],address[],string)
function. - Asserts that two arrays of
bytes32
values are equal. Function with signatureassertEq(bytes32[],bytes32[])
and selector0x0cc9ee84
. - Asserts that two arrays of
bytes32
values are equal. Container type for the return parameters of theassertEq(bytes32[],bytes32[])
function. - Asserts that two arrays of
bytes32
values are equal and includes error message into revert string on failure. Function with signatureassertEq(bytes32[],bytes32[],string)
and selector0xe03e9177
. - Asserts that two arrays of
bytes32
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(bytes32[],bytes32[],string)
function. - Asserts that two arrays of
string
values are equal. Function with signatureassertEq(string[],string[])
and selector0xcf1c049c
. - Asserts that two arrays of
string
values are equal. Container type for the return parameters of theassertEq(string[],string[])
function. - Asserts that two arrays of
string
values are equal and includes error message into revert string on failure. Function with signatureassertEq(string[],string[],string)
and selector0xeff6b27d
. - Asserts that two arrays of
string
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(string[],string[],string)
function. - Asserts that two arrays of
bytes
values are equal. Function with signatureassertEq(bytes[],bytes[])
and selector0xe5fb9b4a
. - Asserts that two arrays of
bytes
values are equal. Container type for the return parameters of theassertEq(bytes[],bytes[])
function. - Asserts that two arrays of
bytes
values are equal and includes error message into revert string on failure. Function with signatureassertEq(bytes[],bytes[],string)
and selector0xf413f0b6
. - Asserts that two arrays of
bytes
values are equal and includes error message into revert string on failure. Container type for the return parameters of theassertEq(bytes[],bytes[],string)
function. - Asserts that the given condition is false. Function with signature
assertFalse(bool)
and selector0xa5982885
. - Asserts that the given condition is false. Container type for the return parameters of the
assertFalse(bool)
function. - Asserts that the given condition is false and includes error message into revert string on failure. Function with signature
assertFalse(bool,string)
and selector0x7ba04809
. - Asserts that the given condition is false and includes error message into revert string on failure. Container type for the return parameters of the
assertFalse(bool,string)
function. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Function with signatureassertGeDecimal(uint256,uint256,uint256)
and selector0x3d1fe08a
. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Container type for the return parameters of theassertGeDecimal(uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertGeDecimal(uint256,uint256,uint256,string)
and selector0x8bff9133
. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertGeDecimal(uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Function with signatureassertGeDecimal(int256,int256,uint256)
and selector0xdc28c0f1
. - Compares two
int256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Container type for the return parameters of theassertGeDecimal(int256,int256,uint256)
function. - Compares two
int256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertGeDecimal(int256,int256,uint256,string)
and selector0x5df93c9b
. - Compares two
int256
values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertGeDecimal(int256,int256,uint256,string)
function. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Function with signatureassertGe(uint256,uint256)
and selector0xa8d4d1d9
. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Container type for the return parameters of theassertGe(uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Includes error message into revert string on failure. Function with signatureassertGe(uint256,uint256,string)
and selector0xe25242c0
. - Compares two
uint256
values. Expects first value to be greater than or equal to second. Includes error message into revert string on failure. Container type for the return parameters of theassertGe(uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be greater than or equal to second. Function with signatureassertGe(int256,int256)
and selector0x0a30b771
. - Compares two
int256
values. Expects first value to be greater than or equal to second. Container type for the return parameters of theassertGe(int256,int256)
function. - Compares two
int256
values. Expects first value to be greater than or equal to second. Includes error message into revert string on failure. Function with signatureassertGe(int256,int256,string)
and selector0xa84328dd
. - Compares two
int256
values. Expects first value to be greater than or equal to second. Includes error message into revert string on failure. Container type for the return parameters of theassertGe(int256,int256,string)
function. - Compares two
uint256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Function with signatureassertGtDecimal(uint256,uint256,uint256)
and selector0xeccd2437
. - Compares two
uint256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Container type for the return parameters of theassertGtDecimal(uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertGtDecimal(uint256,uint256,uint256,string)
and selector0x64949a8d
. - Compares two
uint256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertGtDecimal(uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Function with signatureassertGtDecimal(int256,int256,uint256)
and selector0x78611f0e
. - Compares two
int256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Container type for the return parameters of theassertGtDecimal(int256,int256,uint256)
function. - Compares two
int256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertGtDecimal(int256,int256,uint256,string)
and selector0x04a5c7ab
. - Compares two
int256
values. Expects first value to be greater than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertGtDecimal(int256,int256,uint256,string)
function. - Compares two
uint256
values. Expects first value to be greater than second. Function with signatureassertGt(uint256,uint256)
and selector0xdb07fcd2
. - Compares two
uint256
values. Expects first value to be greater than second. Container type for the return parameters of theassertGt(uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be greater than second. Includes error message into revert string on failure. Function with signatureassertGt(uint256,uint256,string)
and selector0xd9a3c4d2
. - Compares two
uint256
values. Expects first value to be greater than second. Includes error message into revert string on failure. Container type for the return parameters of theassertGt(uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be greater than second. Function with signatureassertGt(int256,int256)
and selector0x5a362d45
. - Compares two
int256
values. Expects first value to be greater than second. Container type for the return parameters of theassertGt(int256,int256)
function. - Compares two
int256
values. Expects first value to be greater than second. Includes error message into revert string on failure. Function with signatureassertGt(int256,int256,string)
and selector0xf8d33b9b
. - Compares two
int256
values. Expects first value to be greater than second. Includes error message into revert string on failure. Container type for the return parameters of theassertGt(int256,int256,string)
function. - Compares two
uint256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Function with signatureassertLeDecimal(uint256,uint256,uint256)
and selector0xc304aab7
. - Compares two
uint256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Container type for the return parameters of theassertLeDecimal(uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertLeDecimal(uint256,uint256,uint256,string)
and selector0x7fefbbe0
. - Compares two
uint256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertLeDecimal(uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Function with signatureassertLeDecimal(int256,int256,uint256)
and selector0x11d1364a
. - Compares two
int256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Container type for the return parameters of theassertLeDecimal(int256,int256,uint256)
function. - Compares two
int256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertLeDecimal(int256,int256,uint256,string)
and selector0xaa5cf788
. - Compares two
int256
values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertLeDecimal(int256,int256,uint256,string)
function. - Compares two
uint256
values. Expects first value to be less than or equal to second. Function with signatureassertLe(uint256,uint256)
and selector0x8466f415
. - Compares two
uint256
values. Expects first value to be less than or equal to second. Container type for the return parameters of theassertLe(uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be less than or equal to second. Includes error message into revert string on failure. Function with signatureassertLe(uint256,uint256,string)
and selector0xd17d4b0d
. - Compares two
uint256
values. Expects first value to be less than or equal to second. Includes error message into revert string on failure. Container type for the return parameters of theassertLe(uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be less than or equal to second. Function with signatureassertLe(int256,int256)
and selector0x95fd154e
. - Compares two
int256
values. Expects first value to be less than or equal to second. Container type for the return parameters of theassertLe(int256,int256)
function. - Compares two
int256
values. Expects first value to be less than or equal to second. Includes error message into revert string on failure. Function with signatureassertLe(int256,int256,string)
and selector0x4dfe692c
. - Compares two
int256
values. Expects first value to be less than or equal to second. Includes error message into revert string on failure. Container type for the return parameters of theassertLe(int256,int256,string)
function. - Compares two
uint256
values. Expects first value to be less than second. Formats values with decimals in failure message. Function with signatureassertLtDecimal(uint256,uint256,uint256)
and selector0x2077337e
. - Compares two
uint256
values. Expects first value to be less than second. Formats values with decimals in failure message. Container type for the return parameters of theassertLtDecimal(uint256,uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be less than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertLtDecimal(uint256,uint256,uint256,string)
and selector0xa972d037
. - Compares two
uint256
values. Expects first value to be less than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertLtDecimal(uint256,uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be less than second. Formats values with decimals in failure message. Function with signatureassertLtDecimal(int256,int256,uint256)
and selector0xdbe8d88b
. - Compares two
int256
values. Expects first value to be less than second. Formats values with decimals in failure message. Container type for the return parameters of theassertLtDecimal(int256,int256,uint256)
function. - Compares two
int256
values. Expects first value to be less than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertLtDecimal(int256,int256,uint256,string)
and selector0x40f0b4e0
. - Compares two
int256
values. Expects first value to be less than second. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertLtDecimal(int256,int256,uint256,string)
function. - Compares two
uint256
values. Expects first value to be less than second. Function with signatureassertLt(uint256,uint256)
and selector0xb12fc005
. - Compares two
uint256
values. Expects first value to be less than second. Container type for the return parameters of theassertLt(uint256,uint256)
function. - Compares two
uint256
values. Expects first value to be less than second. Includes error message into revert string on failure. Function with signatureassertLt(uint256,uint256,string)
and selector0x65d5c135
. - Compares two
uint256
values. Expects first value to be less than second. Includes error message into revert string on failure. Container type for the return parameters of theassertLt(uint256,uint256,string)
function. - Compares two
int256
values. Expects first value to be less than second. Function with signatureassertLt(int256,int256)
and selector0x3e914080
. - Compares two
int256
values. Expects first value to be less than second. Container type for the return parameters of theassertLt(int256,int256)
function. - Compares two
int256
values. Expects first value to be less than second. Includes error message into revert string on failure. Function with signatureassertLt(int256,int256,string)
and selector0x9ff531e3
. - Compares two
int256
values. Expects first value to be less than second. Includes error message into revert string on failure. Container type for the return parameters of theassertLt(int256,int256,string)
function. - Asserts that two
uint256
values are not equal, formatting them with decimals in failure message. Function with signatureassertNotEqDecimal(uint256,uint256,uint256)
and selector0x669efca7
. - Asserts that two
uint256
values are not equal, formatting them with decimals in failure message. Container type for the return parameters of theassertNotEqDecimal(uint256,uint256,uint256)
function. - Asserts that two
uint256
values are not equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertNotEqDecimal(uint256,uint256,uint256,string)
and selector0xf5a55558
. - Asserts that two
uint256
values are not equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertNotEqDecimal(uint256,uint256,uint256,string)
function. - Asserts that two
int256
values are not equal, formatting them with decimals in failure message. Function with signatureassertNotEqDecimal(int256,int256,uint256)
and selector0x14e75680
. - Asserts that two
int256
values are not equal, formatting them with decimals in failure message. Container type for the return parameters of theassertNotEqDecimal(int256,int256,uint256)
function. - Asserts that two
int256
values are not equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Function with signatureassertNotEqDecimal(int256,int256,uint256,string)
and selector0x33949f0b
. - Asserts that two
int256
values are not equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of theassertNotEqDecimal(int256,int256,uint256,string)
function. - Asserts that two
bool
values are not equal. Function with signatureassertNotEq(bool,bool)
and selector0x236e4d66
. - Asserts that two
bool
values are not equal. Container type for the return parameters of theassertNotEq(bool,bool)
function. - Asserts that two
bool
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(bool,bool,string)
and selector0x1091a261
. - Asserts that two
bool
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(bool,bool,string)
function. - Asserts that two
uint256
values are not equal. Function with signatureassertNotEq(uint256,uint256)
and selector0xb7909320
. - Asserts that two
uint256
values are not equal. Container type for the return parameters of theassertNotEq(uint256,uint256)
function. - Asserts that two
uint256
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(uint256,uint256,string)
and selector0x98f9bdbd
. - Asserts that two
uint256
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(uint256,uint256,string)
function. - Asserts that two
int256
values are not equal. Function with signatureassertNotEq(int256,int256)
and selector0xf4c004e3
. - Asserts that two
int256
values are not equal. Container type for the return parameters of theassertNotEq(int256,int256)
function. - Asserts that two
int256
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(int256,int256,string)
and selector0x4724c5b9
. - Asserts that two
int256
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(int256,int256,string)
function. - Asserts that two
address
values are not equal. Function with signatureassertNotEq(address,address)
and selector0xb12e1694
. - Asserts that two
address
values are not equal. Container type for the return parameters of theassertNotEq(address,address)
function. - Asserts that two
address
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(address,address,string)
and selector0x8775a591
. - Asserts that two
address
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(address,address,string)
function. - Asserts that two
bytes32
values are not equal. Function with signatureassertNotEq(bytes32,bytes32)
and selector0x898e83fc
. - Asserts that two
bytes32
values are not equal. Container type for the return parameters of theassertNotEq(bytes32,bytes32)
function. - Asserts that two
bytes32
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(bytes32,bytes32,string)
and selector0xb2332f51
. - Asserts that two
bytes32
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(bytes32,bytes32,string)
function. - Asserts that two
string
values are not equal. Function with signatureassertNotEq(string,string)
and selector0x6a8237b3
. - Asserts that two
string
values are not equal. Container type for the return parameters of theassertNotEq(string,string)
function. - Asserts that two
string
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(string,string,string)
and selector0x78bdcea7
. - Asserts that two
string
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(string,string,string)
function. - Asserts that two
bytes
values are not equal. Function with signatureassertNotEq(bytes,bytes)
and selector0x3cf78e28
. - Asserts that two
bytes
values are not equal. Container type for the return parameters of theassertNotEq(bytes,bytes)
function. - Asserts that two
bytes
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(bytes,bytes,string)
and selector0x9507540e
. - Asserts that two
bytes
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(bytes,bytes,string)
function. - Asserts that two arrays of
bool
values are not equal. Function with signatureassertNotEq(bool[],bool[])
and selector0x286fafea
. - Asserts that two arrays of
bool
values are not equal. Container type for the return parameters of theassertNotEq(bool[],bool[])
function. - Asserts that two arrays of
bool
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(bool[],bool[],string)
and selector0x62c6f9fb
. - Asserts that two arrays of
bool
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(bool[],bool[],string)
function. - Asserts that two arrays of
uint256
values are not equal. Function with signatureassertNotEq(uint256[],uint256[])
and selector0x56f29cba
. - Asserts that two arrays of
uint256
values are not equal. Container type for the return parameters of theassertNotEq(uint256[],uint256[])
function. - Asserts that two arrays of
uint256
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(uint256[],uint256[],string)
and selector0x9a7fbd8f
. - Asserts that two arrays of
uint256
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(uint256[],uint256[],string)
function. - Asserts that two arrays of
int256
values are not equal. Function with signatureassertNotEq(int256[],int256[])
and selector0x0b72f4ef
. - Asserts that two arrays of
int256
values are not equal. Container type for the return parameters of theassertNotEq(int256[],int256[])
function. - Asserts that two arrays of
int256
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(int256[],int256[],string)
and selector0xd3977322
. - Asserts that two arrays of
int256
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(int256[],int256[],string)
function. - Asserts that two arrays of
address
values are not equal. Function with signatureassertNotEq(address[],address[])
and selector0x46d0b252
. - Asserts that two arrays of
address
values are not equal. Container type for the return parameters of theassertNotEq(address[],address[])
function. - Asserts that two arrays of
address
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(address[],address[],string)
and selector0x72c7e0b5
. - Asserts that two arrays of
address
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(address[],address[],string)
function. - Asserts that two arrays of
bytes32
values are not equal. Function with signatureassertNotEq(bytes32[],bytes32[])
and selector0x0603ea68
. - Asserts that two arrays of
bytes32
values are not equal. Container type for the return parameters of theassertNotEq(bytes32[],bytes32[])
function. - Asserts that two arrays of
bytes32
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(bytes32[],bytes32[],string)
and selector0xb873634c
. - Asserts that two arrays of
bytes32
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(bytes32[],bytes32[],string)
function. - Asserts that two arrays of
string
values are not equal. Function with signatureassertNotEq(string[],string[])
and selector0xbdfacbe8
. - Asserts that two arrays of
string
values are not equal. Container type for the return parameters of theassertNotEq(string[],string[])
function. - Asserts that two arrays of
string
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(string[],string[],string)
and selector0xb67187f3
. - Asserts that two arrays of
string
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(string[],string[],string)
function. - Asserts that two arrays of
bytes
values are not equal. Function with signatureassertNotEq(bytes[],bytes[])
and selector0xedecd035
. - Asserts that two arrays of
bytes
values are not equal. Container type for the return parameters of theassertNotEq(bytes[],bytes[])
function. - Asserts that two arrays of
bytes
values are not equal and includes error message into revert string on failure. Function with signatureassertNotEq(bytes[],bytes[],string)
and selector0x1dcd1f68
. - Asserts that two arrays of
bytes
values are not equal and includes error message into revert string on failure. Container type for the return parameters of theassertNotEq(bytes[],bytes[],string)
function. - Asserts that the given condition is true. Function with signature
assertTrue(bool)
and selector0x0c9fd581
. - Asserts that the given condition is true. Container type for the return parameters of the
assertTrue(bool)
function. - Asserts that the given condition is true and includes error message into revert string on failure. Function with signature
assertTrue(bool,string)
and selector0xa34edc03
. - Asserts that the given condition is true and includes error message into revert string on failure. Container type for the return parameters of the
assertTrue(bool,string)
function. - If the condition is false, discard this run’s fuzz inputs and generate new ones. Function with signature
assume(bool)
and selector0x4c63e562
. - Discard this run’s fuzz inputs and generate new ones if next call reverted. Function with signature
assumeNoRevert()
and selector0x285b366a
. - Discard this run’s fuzz inputs and generate new ones if next call reverted. Container type for the return parameters of the
assumeNoRevert()
function. - If the condition is false, discard this run’s fuzz inputs and generate new ones. Container type for the return parameters of the
assume(bool)
function. - Sets
block.blobbasefee
Function with signatureblobBaseFee(uint256)
and selector0x6d315d7e
. - Sets
block.blobbasefee
Container type for the return parameters of theblobBaseFee(uint256)
function. - Sets the blobhashes in the transaction. Not available on EVM versions before Cancun. If used on unsupported EVM versions it will revert. Function with signature
blobhashes(bytes32[])
and selector0x129de7eb
. - Sets the blobhashes in the transaction. Not available on EVM versions before Cancun. If used on unsupported EVM versions it will revert. Container type for the return parameters of the
blobhashes(bytes32[])
function. - Writes a breakpoint to jump to in the debugger. Function with signature
breakpoint(string)
and selector0xf0259e92
. - Writes a breakpoint to jump to in the debugger. Container type for the return parameters of the
breakpoint(string)
function. - Writes a conditional breakpoint to jump to in the debugger. Function with signature
breakpoint(string,bool)
and selector0xf7d39a8d
. - Writes a conditional breakpoint to jump to in the debugger. Container type for the return parameters of the
breakpoint(string,bool)
function. - Takes a signed transaction and broadcasts it to the network. Function with signature
broadcastRawTransaction(bytes)
and selector0x8c0c72e0
. - Takes a signed transaction and broadcasts it to the network. Container type for the return parameters of the
broadcastRawTransaction(bytes)
function. - Has the next call (at this call depth only) create transactions that can later be signed and sent onchain.
- Has the next call (at this call depth only) create transactions that can later be signed and sent onchain.
- Has the next call (at this call depth only) create a transaction with the address provided as the sender that can later be signed and sent onchain. Function with signature
broadcast(address)
and selector0xe6962cdb
. - Has the next call (at this call depth only) create a transaction with the address provided as the sender that can later be signed and sent onchain. Container type for the return parameters of the
broadcast(address)
function. - Has the next call (at this call depth only) create a transaction with the private key provided as the sender that can later be signed and sent onchain. Function with signature
broadcast(uint256)
and selector0xf67a965b
. - Has the next call (at this call depth only) create a transaction with the private key provided as the sender that can later be signed and sent onchain. Container type for the return parameters of the
broadcast(uint256)
function. - Sets
block.chainid
. Function with signaturechainId(uint256)
and selector0x4049ddd2
. - Sets
block.chainid
. Container type for the return parameters of thechainId(uint256)
function. - Clears all mocked calls. Function with signature
clearMockedCalls()
and selector0x3fdf4e15
. - Clears all mocked calls. Container type for the return parameters of the
clearMockedCalls()
function. - Clones a source account code, state, balance and nonce to a target account and updates in-memory EVM state. Function with signature
cloneAccount(address,address)
and selector0x533d61c9
. - Clones a source account code, state, balance and nonce to a target account and updates in-memory EVM state. Container type for the return parameters of the
cloneAccount(address,address)
function. - Closes file for reading, resetting the offset and allowing to read it from beginning with readLine.
path
is relative to the project root. Function with signaturecloseFile(string)
and selector0x48c3241f
. - Closes file for reading, resetting the offset and allowing to read it from beginning with readLine.
path
is relative to the project root. Container type for the return parameters of thecloseFile(string)
function. - Sets
block.coinbase
. Function with signaturecoinbase(address)
and selector0xff483c54
. - Sets
block.coinbase
. Container type for the return parameters of thecoinbase(address)
function. - Compute the address of a contract created with CREATE2 using the given CREATE2 deployer. Function with signature
computeCreate2Address(bytes32,bytes32,address)
and selector0xd323826a
. - Compute the address of a contract created with CREATE2 using the given CREATE2 deployer. Container type for the return parameters of the
computeCreate2Address(bytes32,bytes32,address)
function. - Compute the address of a contract created with CREATE2 using the default CREATE2 deployer. Function with signature
computeCreate2Address(bytes32,bytes32)
and selector0x890c283b
. - Compute the address of a contract created with CREATE2 using the default CREATE2 deployer. Container type for the return parameters of the
computeCreate2Address(bytes32,bytes32)
function. - Compute the address a contract will be deployed at for a given deployer address and nonce. Function with signature
computeCreateAddress(address,uint256)
and selector0x74637a7a
. - Compute the address a contract will be deployed at for a given deployer address and nonce. Container type for the return parameters of the
computeCreateAddress(address,uint256)
function. - Returns true if
search
is found insubject
, false otherwise. Function with signaturecontains(string,string)
and selector0x3fb18aec
. - Returns true if
search
is found insubject
, false otherwise. Container type for the return parameters of thecontains(string,string)
function. - Marks the slots of an account and the account address as cold. Function with signature
cool(address)
and selector0x40ff9f21
. - Marks the slots of an account and the account address as cold. Container type for the return parameters of the
cool(address)
function. - Copies the contents of one file to another. This function will overwrite the contents of
to
. On success, the total number of bytes copied is returned and it is equal to the length of theto
file as reported bymetadata
. Bothfrom
andto
are relative to the project root. Function with signaturecopyFile(string,string)
and selector0xa54a87d8
. - Copies the contents of one file to another. This function will overwrite the contents of
to
. On success, the total number of bytes copied is returned and it is equal to the length of theto
file as reported bymetadata
. Bothfrom
andto
are relative to the project root. Container type for the return parameters of thecopyFile(string,string)
function. - Utility cheatcode to copy storage of
from
contract to anotherto
contract. Function with signaturecopyStorage(address,address)
and selector0x203dac0d
. - Utility cheatcode to copy storage of
from
contract to anotherto
contract. Container type for the return parameters of thecopyStorage(address,address)
function. - Creates a new, empty directory at the provided path. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Creates a new, empty directory at the provided path. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Creates a new fork with the given endpoint and the latest block and returns the identifier of the fork. Function with signature
createFork(string)
and selector0x31ba3498
. - Creates a new fork with the given endpoint and the latest block and returns the identifier of the fork. Container type for the return parameters of the
createFork(string)
function. - Creates a new fork with the given endpoint and block and returns the identifier of the fork. Function with signature
createFork(string,uint256)
and selector0x6ba3ba2b
. - Creates a new fork with the given endpoint and block and returns the identifier of the fork. Container type for the return parameters of the
createFork(string,uint256)
function. - Creates a new fork with the given endpoint and at the block the given transaction was mined in, replays all transaction mined in the block before the transaction, and returns the identifier of the fork. Function with signature
createFork(string,bytes32)
and selector0x7ca29682
. - Creates a new fork with the given endpoint and at the block the given transaction was mined in, replays all transaction mined in the block before the transaction, and returns the identifier of the fork. Container type for the return parameters of the
createFork(string,bytes32)
function. - Creates and also selects a new fork with the given endpoint and the latest block and returns the identifier of the fork. Function with signature
createSelectFork(string)
and selector0x98680034
. - Creates and also selects a new fork with the given endpoint and the latest block and returns the identifier of the fork. Container type for the return parameters of the
createSelectFork(string)
function. - Creates and also selects a new fork with the given endpoint and block and returns the identifier of the fork. Function with signature
createSelectFork(string,uint256)
and selector0x71ee464d
. - Creates and also selects a new fork with the given endpoint and block and returns the identifier of the fork. Container type for the return parameters of the
createSelectFork(string,uint256)
function. - Creates and also selects new fork with the given endpoint and at the block the given transaction was mined in, replays all transaction mined in the block before the transaction, returns the identifier of the fork. Function with signature
createSelectFork(string,bytes32)
and selector0x84d52b7a
. - Creates and also selects new fork with the given endpoint and at the block the given transaction was mined in, replays all transaction mined in the block before the transaction, returns the identifier of the fork. Container type for the return parameters of the
createSelectFork(string,bytes32)
function. - Derives a private key from the name, labels the account with that name, and returns the wallet. Function with signature
createWallet(string)
and selector0x7404f1d2
. - Derives a private key from the name, labels the account with that name, and returns the wallet. Container type for the return parameters of the
createWallet(string)
function. - Generates a wallet from the private key and returns the wallet. Function with signature
createWallet(uint256)
and selector0x7a675bb6
. - Generates a wallet from the private key and returns the wallet. Container type for the return parameters of the
createWallet(uint256)
function. - Generates a wallet from the private key, labels the account with that name, and returns the wallet. Function with signature
createWallet(uint256,string)
and selector0xed7c5462
. - Generates a wallet from the private key, labels the account with that name, and returns the wallet. Container type for the return parameters of the
createWallet(uint256,string)
function. - Sets an address’ balance. Function with signature
deal(address,uint256)
and selector0xc88a5e6d
. - Sets an address’ balance. Container type for the return parameters of the
deal(address,uint256)
function. deleteSnapshot
is being deprecated in favor ofdeleteStateSnapshot
. It will be removed in future versions. Function with signaturedeleteSnapshot(uint256)
and selector0xa6368557
.deleteSnapshot
is being deprecated in favor ofdeleteStateSnapshot
. It will be removed in future versions. Container type for the return parameters of thedeleteSnapshot(uint256)
function.deleteSnapshots
is being deprecated in favor ofdeleteStateSnapshots
. It will be removed in future versions. Function with signaturedeleteSnapshots()
and selector0x421ae469
.deleteSnapshots
is being deprecated in favor ofdeleteStateSnapshots
. It will be removed in future versions. Container type for the return parameters of thedeleteSnapshots()
function.- Removes the snapshot with the given ID created by
snapshot
. Takes the snapshot ID to delete. - Removes the snapshot with the given ID created by
snapshot
. Takes the snapshot ID to delete. - Removes all snapshots previously created by
snapshot
. Function with signaturedeleteStateSnapshots()
and selector0xe0933c74
. - Removes all snapshots previously created by
snapshot
. Container type for the return parameters of thedeleteStateSnapshots()
function. - Deploys a contract from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. Function with signature deployCode(string)
and selector0x9a8325a0
. - Deploys a contract from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. Container type for the return parameters of the deployCode(string)
function. - Deploys a contract from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. - Deploys a contract from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. - Derive a private key from a provided mnenomic string (or mnenomic file path) at the derivation path
m/44'/60'/0'/0/{index}
. Function with signaturederiveKey(string,uint32)
and selector0x6229498b
. - Derive a private key from a provided mnenomic string (or mnenomic file path) at the derivation path
m/44'/60'/0'/0/{index}
. Container type for the return parameters of thederiveKey(string,uint32)
function. - Derive a private key from a provided mnenomic string (or mnenomic file path) at
{derivationPath}{index}
. Function with signaturederiveKey(string,string,uint32)
and selector0x6bcb2c1b
. - Derive a private key from a provided mnenomic string (or mnenomic file path) at
{derivationPath}{index}
. Container type for the return parameters of thederiveKey(string,string,uint32)
function. - Derive a private key from a provided mnenomic string (or mnenomic file path) in the specified language at the derivation path
m/44'/60'/0'/0/{index}
. Function with signaturederiveKey(string,uint32,string)
and selector0x32c8176d
. - Derive a private key from a provided mnenomic string (or mnenomic file path) in the specified language at the derivation path
m/44'/60'/0'/0/{index}
. Container type for the return parameters of thederiveKey(string,uint32,string)
function. - Derive a private key from a provided mnenomic string (or mnenomic file path) in the specified language at
{derivationPath}{index}
. Function with signaturederiveKey(string,string,uint32,string)
and selector0x29233b1f
. - Derive a private key from a provided mnenomic string (or mnenomic file path) in the specified language at
{derivationPath}{index}
. Container type for the return parameters of thederiveKey(string,string,uint32,string)
function. - Sets
block.difficulty
. Not available on EVM versions from Paris onwards. Useprevrandao
instead. Reverts if used on unsupported EVM versions. Function with signaturedifficulty(uint256)
and selector0x46cc92d9
. - Sets
block.difficulty
. Not available on EVM versions from Paris onwards. Useprevrandao
instead. Reverts if used on unsupported EVM versions. Container type for the return parameters of thedifficulty(uint256)
function. - Dump a genesis JSON file’s
allocs
to disk. Function with signaturedumpState(string)
and selector0x709ecd3f
. - Dump a genesis JSON file’s
allocs
to disk. Container type for the return parameters of thedumpState(string)
function. - Returns ENS namehash for provided string. Function with signature
ensNamehash(string)
and selector0x8c374c65
. - Returns ENS namehash for provided string. Container type for the return parameters of the
ensNamehash(string)
function. - Gets the environment variable
name
and parses it asaddress
. Reverts if the variable was not found or could not be parsed. Function with signatureenvAddress(string)
and selector0x350d56bf
. - Gets the environment variable
name
and parses it asaddress
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvAddress(string)
function. - Gets the environment variable
name
and parses it as an array ofaddress
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvAddress(string,string)
and selector0xad31b9fa
. - Gets the environment variable
name
and parses it as an array ofaddress
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvAddress(string,string)
function. - Gets the environment variable
name
and parses it asbool
. Reverts if the variable was not found or could not be parsed. Function with signatureenvBool(string)
and selector0x7ed1ec7d
. - Gets the environment variable
name
and parses it asbool
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvBool(string)
function. - Gets the environment variable
name
and parses it as an array ofbool
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvBool(string,string)
and selector0xaaaddeaf
. - Gets the environment variable
name
and parses it as an array ofbool
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvBool(string,string)
function. - Gets the environment variable
name
and parses it asbytes32
. Reverts if the variable was not found or could not be parsed. Function with signatureenvBytes32(string)
and selector0x97949042
. - Gets the environment variable
name
and parses it asbytes32
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvBytes32(string)
function. - Gets the environment variable
name
and parses it as an array ofbytes32
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvBytes32(string,string)
and selector0x5af231c1
. - Gets the environment variable
name
and parses it as an array ofbytes32
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvBytes32(string,string)
function. - Gets the environment variable
name
and parses it asbytes
. Reverts if the variable was not found or could not be parsed. Function with signatureenvBytes(string)
and selector0x4d7baf06
. - Gets the environment variable
name
and parses it asbytes
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvBytes(string)
function. - Gets the environment variable
name
and parses it as an array ofbytes
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvBytes(string,string)
and selector0xddc2651b
. - Gets the environment variable
name
and parses it as an array ofbytes
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvBytes(string,string)
function. - Gets the environment variable
name
and returns true if it exists, else returns false. Function with signatureenvExists(string)
and selector0xce8365f9
. - Gets the environment variable
name
and returns true if it exists, else returns false. Container type for the return parameters of theenvExists(string)
function. - Gets the environment variable
name
and parses it asint256
. Reverts if the variable was not found or could not be parsed. Function with signatureenvInt(string)
and selector0x892a0c61
. - Gets the environment variable
name
and parses it asint256
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvInt(string)
function. - Gets the environment variable
name
and parses it as an array ofint256
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvInt(string,string)
and selector0x42181150
. - Gets the environment variable
name
and parses it as an array ofint256
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvInt(string,string)
function. - Gets the environment variable
name
and parses it asbool
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,bool)
and selector0x4777f3cf
. - Gets the environment variable
name
and parses it asbool
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,bool)
function. - Gets the environment variable
name
and parses it asuint256
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,uint256)
and selector0x5e97348f
. - Gets the environment variable
name
and parses it asuint256
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,uint256)
function. - Gets the environment variable
name
and parses it asint256
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,int256)
and selector0xbbcb713e
. - Gets the environment variable
name
and parses it asint256
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,int256)
function. - Gets the environment variable
name
and parses it asaddress
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,address)
and selector0x561fe540
. - Gets the environment variable
name
and parses it asaddress
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,address)
function. - Gets the environment variable
name
and parses it asbytes32
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,bytes32)
and selector0xb4a85892
. - Gets the environment variable
name
and parses it asbytes32
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,bytes32)
function. - Gets the environment variable
name
and parses it asstring
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string)
and selector0xd145736c
. - Gets the environment variable
name
and parses it asstring
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string)
function. - Gets the environment variable
name
and parses it asbytes
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,bytes)
and selector0xb3e47705
. - Gets the environment variable
name
and parses it asbytes
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,bytes)
function. - Gets the environment variable
name
and parses it as an array ofbool
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,bool[])
and selector0xeb85e83b
. - Gets the environment variable
name
and parses it as an array ofbool
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,bool[])
function. - Gets the environment variable
name
and parses it as an array ofuint256
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,uint256[])
and selector0x74318528
. - Gets the environment variable
name
and parses it as an array ofuint256
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,uint256[])
function. - Gets the environment variable
name
and parses it as an array ofint256
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,int256[])
and selector0x4700d74b
. - Gets the environment variable
name
and parses it as an array ofint256
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,int256[])
function. - Gets the environment variable
name
and parses it as an array ofaddress
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,address[])
and selector0xc74e9deb
. - Gets the environment variable
name
and parses it as an array ofaddress
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,address[])
function. - Gets the environment variable
name
and parses it as an array ofbytes32
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,bytes32[])
and selector0x2281f367
. - Gets the environment variable
name
and parses it as an array ofbytes32
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,bytes32[])
function. - Gets the environment variable
name
and parses it as an array ofstring
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,string[])
and selector0x859216bc
. - Gets the environment variable
name
and parses it as an array ofstring
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,string[])
function. - Gets the environment variable
name
and parses it as an array ofbytes
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Function with signatureenvOr(string,string,bytes[])
and selector0x64bc3e64
. - Gets the environment variable
name
and parses it as an array ofbytes
, delimited bydelim
. Reverts if the variable could not be parsed. ReturnsdefaultValue
if the variable was not found. Container type for the return parameters of theenvOr(string,string,bytes[])
function. - Gets the environment variable
name
and parses it asstring
. Reverts if the variable was not found or could not be parsed. Function with signatureenvString(string)
and selector0xf877cb19
. - Gets the environment variable
name
and parses it asstring
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvString(string)
function. - Gets the environment variable
name
and parses it as an array ofstring
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvString(string,string)
and selector0x14b02bc9
. - Gets the environment variable
name
and parses it as an array ofstring
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvString(string,string)
function. - Gets the environment variable
name
and parses it asuint256
. Reverts if the variable was not found or could not be parsed. Function with signatureenvUint(string)
and selector0xc1978d1f
. - Gets the environment variable
name
and parses it asuint256
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvUint(string)
function. - Gets the environment variable
name
and parses it as an array ofuint256
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Function with signatureenvUint(string,string)
and selector0xf3dec099
. - Gets the environment variable
name
and parses it as an array ofuint256
, delimited bydelim
. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of theenvUint(string,string)
function. - Sets an address’ code. Function with signature
etch(address,bytes)
and selector0xb4d6c782
. - Sets an address’ code. Container type for the return parameters of the
etch(address,bytes)
function. - Gets all the logs according to specified filter. Function with signature
eth_getLogs(uint256,uint256,address,bytes32[])
and selector0x35e1349b
. - Gets all the logs according to specified filter. Container type for the return parameters of the
eth_getLogs(uint256,uint256,address,bytes32[])
function. - Returns true if the given path points to an existing entity, else returns false. Function with signature
exists(string)
and selector0x261a323e
. - Returns true if the given path points to an existing entity, else returns false. Container type for the return parameters of the
exists(string)
function. - Expect a call to an address with the specified
msg.value
and calldata, and a minimum amount of gas. Function with signatureexpectCallMinGas(address,uint256,uint64,bytes)
and selector0x08e4e116
. - Expect a call to an address with the specified
msg.value
and calldata, and a minimum amount of gas. Container type for the return parameters of theexpectCallMinGas(address,uint256,uint64,bytes)
function. - Expect given number of calls to an address with the specified
msg.value
and calldata, and a minimum amount of gas. Function with signatureexpectCallMinGas(address,uint256,uint64,bytes,uint64)
and selector0xe13a1834
. - Expect given number of calls to an address with the specified
msg.value
and calldata, and a minimum amount of gas. Container type for the return parameters of theexpectCallMinGas(address,uint256,uint64,bytes,uint64)
function. - Expects a call to an address with the specified calldata. Calldata can either be a strict or a partial match. Function with signature
expectCall(address,bytes)
and selector0xbd6af434
. - Expects a call to an address with the specified calldata. Calldata can either be a strict or a partial match. Container type for the return parameters of the
expectCall(address,bytes)
function. - Expects given number of calls to an address with the specified calldata. Function with signature
expectCall(address,bytes,uint64)
and selector0xc1adbbff
. - Expects given number of calls to an address with the specified calldata. Container type for the return parameters of the
expectCall(address,bytes,uint64)
function. - Expects a call to an address with the specified
msg.value
and calldata. Function with signatureexpectCall(address,uint256,bytes)
and selector0xf30c7ba3
. - Expects a call to an address with the specified
msg.value
and calldata. Container type for the return parameters of theexpectCall(address,uint256,bytes)
function. - Expects given number of calls to an address with the specified
msg.value
and calldata. Function with signatureexpectCall(address,uint256,bytes,uint64)
and selector0xa2b1a1ae
. - Expects given number of calls to an address with the specified
msg.value
and calldata. Container type for the return parameters of theexpectCall(address,uint256,bytes,uint64)
function. - Expect a call to an address with the specified
msg.value
, gas, and calldata. Function with signatureexpectCall(address,uint256,uint64,bytes)
and selector0x23361207
. - Expect a call to an address with the specified
msg.value
, gas, and calldata. Container type for the return parameters of theexpectCall(address,uint256,uint64,bytes)
function. - Expects given number of calls to an address with the specified
msg.value
, gas, and calldata. Function with signatureexpectCall(address,uint256,uint64,bytes,uint64)
and selector0x65b7b7cc
. - Expects given number of calls to an address with the specified
msg.value
, gas, and calldata. Container type for the return parameters of theexpectCall(address,uint256,uint64,bytes,uint64)
function. - Prepare an expected anonymous log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData.). Call this function, then emit an anonymous event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data (as specified by the booleans). Function with signature
expectEmitAnonymous(bool,bool,bool,bool,bool)
and selector0xc948db5e
. - Prepare an expected anonymous log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData.). Call this function, then emit an anonymous event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data (as specified by the booleans). Container type for the return parameters of the
expectEmitAnonymous(bool,bool,bool,bool,bool)
function. - Same as the previous method, but also checks supplied address against emitting contract. Function with signature
expectEmitAnonymous(bool,bool,bool,bool,bool,address)
and selector0x71c95899
. - Same as the previous method, but also checks supplied address against emitting contract. Container type for the return parameters of the
expectEmitAnonymous(bool,bool,bool,bool,bool,address)
function. - Prepare an expected anonymous log with all topic and data checks enabled. Call this function, then emit an anonymous event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data. Function with signature
expectEmitAnonymous()
and selector0x2e5f270c
. - Prepare an expected anonymous log with all topic and data checks enabled. Call this function, then emit an anonymous event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data. Container type for the return parameters of the
expectEmitAnonymous()
function. - Same as the previous method, but also checks supplied address against emitting contract. Function with signature
expectEmitAnonymous(address)
and selector0x6fc68705
. - Same as the previous method, but also checks supplied address against emitting contract. Container type for the return parameters of the
expectEmitAnonymous(address)
function. - Prepare an expected log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData.). Call this function, then emit an event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data (as specified by the booleans). Function with signature
expectEmit(bool,bool,bool,bool)
and selector0x491cc7c2
. - Prepare an expected log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData.). Call this function, then emit an event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data (as specified by the booleans). Container type for the return parameters of the
expectEmit(bool,bool,bool,bool)
function. - Same as the previous method, but also checks supplied address against emitting contract. Function with signature
expectEmit(bool,bool,bool,bool,address)
and selector0x81bad6f3
. - Same as the previous method, but also checks supplied address against emitting contract. Container type for the return parameters of the
expectEmit(bool,bool,bool,bool,address)
function. - Prepare an expected log with all topic and data checks enabled. Call this function, then emit an event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data. Function with signature
expectEmit()
and selector0x440ed10d
. - Prepare an expected log with all topic and data checks enabled. Call this function, then emit an event, then call a function. Internally after the call, we check if logs were emitted in the expected order with the expected topics and data. Container type for the return parameters of the
expectEmit()
function. - Same as the previous method, but also checks supplied address against emitting contract. Function with signature
expectEmit(address)
and selector0x86b9620d
. - Same as the previous method, but also checks supplied address against emitting contract. Container type for the return parameters of the
expectEmit(address)
function. - Expects an error on next call that starts with the revert data. Function with signature
expectPartialRevert(bytes4)
and selector0x11fb5b9c
. - Expects an error on next call that starts with the revert data. Container type for the return parameters of the
expectPartialRevert(bytes4)
function. - Expects an error on next call to reverter address, that starts with the revert data. Function with signature
expectPartialRevert(bytes4,address)
and selector0x51aa008a
. - Expects an error on next call to reverter address, that starts with the revert data. Container type for the return parameters of the
expectPartialRevert(bytes4,address)
function. - Expects an error on next call with any revert data. Function with signature
expectRevert()
and selector0xf4844814
. - Expects an error on next call with any revert data. Container type for the return parameters of the
expectRevert()
function. - Expects an error on next call that exactly matches the revert data. Function with signature
expectRevert(bytes4)
and selector0xc31eb0e0
. - Expects an error on next call that exactly matches the revert data. Container type for the return parameters of the
expectRevert(bytes4)
function. - Expects an error on next call that exactly matches the revert data. Function with signature
expectRevert(bytes)
and selector0xf28dceb3
. - Expects an error on next call that exactly matches the revert data. Container type for the return parameters of the
expectRevert(bytes)
function. - Expects an error with any revert data on next call to reverter address. Function with signature
expectRevert(address)
and selector0xd814f38a
. - Expects an error with any revert data on next call to reverter address. Container type for the return parameters of the
expectRevert(address)
function. - Expects an error from reverter address on next call, with any revert data. Function with signature
expectRevert(bytes4,address)
and selector0x260bc5de
. - Expects an error from reverter address on next call, with any revert data. Container type for the return parameters of the
expectRevert(bytes4,address)
function. - Expects an error from reverter address on next call, that exactly matches the revert data. Function with signature
expectRevert(bytes,address)
and selector0x61ebcf12
. - Expects an error from reverter address on next call, that exactly matches the revert data. Container type for the return parameters of the
expectRevert(bytes,address)
function. - Only allows memory writes to offsets [0x00, 0x60) ∪ [min, max) in the current subcontext. If any other memory is written to, the test will fail. Can be called multiple times to add more ranges to the set. Function with signature
expectSafeMemory(uint64,uint64)
and selector0x6d016688
. - Only allows memory writes to offsets [0x00, 0x60) ∪ [min, max) in the next created subcontext. If any other memory is written to, the test will fail. Can be called multiple times to add more ranges to the set. Function with signature
expectSafeMemoryCall(uint64,uint64)
and selector0x05838bf4
. - Only allows memory writes to offsets [0x00, 0x60) ∪ [min, max) in the next created subcontext. If any other memory is written to, the test will fail. Can be called multiple times to add more ranges to the set. Container type for the return parameters of the
expectSafeMemoryCall(uint64,uint64)
function. - Only allows memory writes to offsets [0x00, 0x60) ∪ [min, max) in the current subcontext. If any other memory is written to, the test will fail. Can be called multiple times to add more ranges to the set. Container type for the return parameters of the
expectSafeMemory(uint64,uint64)
function. - Sets
block.basefee
. Function with signaturefee(uint256)
and selector0x39b37ab0
. - Sets
block.basefee
. Container type for the return parameters of thefee(uint256)
function. - Performs a foreign function call via the terminal. Function with signature
ffi(string[])
and selector0x89160467
. - Performs a foreign function call via the terminal. Container type for the return parameters of the
ffi(string[])
function. - Given a path, query the file system to get information about a file, directory, etc. Function with signature
fsMetadata(string)
and selector0xaf368a08
. - Given a path, query the file system to get information about a file, directory, etc. Container type for the return parameters of the
fsMetadata(string)
function. - Gets the artifact path from code (aka. creation code). Function with signature
getArtifactPathByCode(bytes)
and selector0xeb74848c
. - Gets the artifact path from code (aka. creation code). Container type for the return parameters of the
getArtifactPathByCode(bytes)
function. - Gets the artifact path from deployed code (aka. runtime code). Function with signature
getArtifactPathByDeployedCode(bytes)
and selector0x6d853ba5
. - Gets the artifact path from deployed code (aka. runtime code). Container type for the return parameters of the
getArtifactPathByDeployedCode(bytes)
function. - Gets the current
block.blobbasefee
. You should use this instead ofblock.blobbasefee
if you usevm.blobBaseFee
, asblock.blobbasefee
is assumed to be constant across a transaction, and as a result will get optimized out by the compiler. See https://github.com/foundry-rs/foundry/issues/6180 Function with signaturegetBlobBaseFee()
and selector0x1f6d6ef7
. - Gets the current
block.blobbasefee
. You should use this instead ofblock.blobbasefee
if you usevm.blobBaseFee
, asblock.blobbasefee
is assumed to be constant across a transaction, and as a result will get optimized out by the compiler. See https://github.com/foundry-rs/foundry/issues/6180 Container type for the return parameters of thegetBlobBaseFee()
function. - Gets the blockhashes from the current transaction. Not available on EVM versions before Cancun. If used on unsupported EVM versions it will revert. Function with signature
getBlobhashes()
and selector0xf56ff18b
. - Gets the blockhashes from the current transaction. Not available on EVM versions before Cancun. If used on unsupported EVM versions it will revert. Container type for the return parameters of the
getBlobhashes()
function. - Gets the current
block.number
. You should use this instead ofblock.number
if you usevm.roll
, asblock.number
is assumed to be constant across a transaction, and as a result will get optimized out by the compiler. See https://github.com/foundry-rs/foundry/issues/6180 Function with signaturegetBlockNumber()
and selector0x42cbb15c
. - Gets the current
block.number
. You should use this instead ofblock.number
if you usevm.roll
, asblock.number
is assumed to be constant across a transaction, and as a result will get optimized out by the compiler. See https://github.com/foundry-rs/foundry/issues/6180 Container type for the return parameters of thegetBlockNumber()
function. - Gets the current
block.timestamp
. You should use this instead ofblock.timestamp
if you usevm.warp
, asblock.timestamp
is assumed to be constant across a transaction, and as a result will get optimized out by the compiler. See https://github.com/foundry-rs/foundry/issues/6180 Function with signaturegetBlockTimestamp()
and selector0x796b89b9
. - Gets the current
block.timestamp
. You should use this instead ofblock.timestamp
if you usevm.warp
, asblock.timestamp
is assumed to be constant across a transaction, and as a result will get optimized out by the compiler. See https://github.com/foundry-rs/foundry/issues/6180 Container type for the return parameters of thegetBlockTimestamp()
function. - Gets the creation bytecode from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. Function with signature getCode(string)
and selector0x8d1cc925
. - Gets the creation bytecode from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. Container type for the return parameters of the getCode(string)
function. - Gets the deployed bytecode from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. Function with signature getDeployedCode(string)
and selector0x3ebf73b4
. - Gets the deployed bytecode from an artifact file. Takes in the relative path to the json file or the path to the artifact in the form of
: : where and parts are optional. Container type for the return parameters of the getDeployedCode(string)
function. - Returns the Foundry version. Format: <cargo_version>+<git_sha>+<build_timestamp> Sample output: 0.2.0+faa94c384+202407110019 Note: Build timestamps may vary slightly across platforms due to separate CI jobs. For reliable version comparisons, use YYYYMMDD0000 format (e.g., >= 202407110000) to compare timestamps while ignoring minor time differences. Function with signature
getFoundryVersion()
and selector0xea991bb5
. - Returns the Foundry version. Format: <cargo_version>+<git_sha>+<build_timestamp> Sample output: 0.2.0+faa94c384+202407110019 Note: Build timestamps may vary slightly across platforms due to separate CI jobs. For reliable version comparisons, use YYYYMMDD0000 format (e.g., >= 202407110000) to compare timestamps while ignoring minor time differences. Container type for the return parameters of the
getFoundryVersion()
function. - Gets the label for the specified address. Function with signature
getLabel(address)
and selector0x28a249b0
. - Gets the label for the specified address. Container type for the return parameters of the
getLabel(address)
function. - Gets the map key and parent of a mapping at a given slot, for a given address. Function with signature
getMappingKeyAndParentOf(address,bytes32)
and selector0x876e24e6
. - Gets the map key and parent of a mapping at a given slot, for a given address. Container type for the return parameters of the
getMappingKeyAndParentOf(address,bytes32)
function. - Gets the number of elements in the mapping at the given slot, for a given address. Function with signature
getMappingLength(address,bytes32)
and selector0x2f2fd63f
. - Gets the number of elements in the mapping at the given slot, for a given address. Container type for the return parameters of the
getMappingLength(address,bytes32)
function. - Gets the elements at index idx of the mapping at the given slot, for a given address. The index must be less than the length of the mapping (i.e. the number of keys in the mapping). Function with signature
getMappingSlotAt(address,bytes32,uint256)
and selector0xebc73ab4
. - Gets the elements at index idx of the mapping at the given slot, for a given address. The index must be less than the length of the mapping (i.e. the number of keys in the mapping). Container type for the return parameters of the
getMappingSlotAt(address,bytes32,uint256)
function. - Gets the nonce of an account. Function with signature
getNonce(address)
and selector0x2d0335ab
. - Gets the nonce of an account. Container type for the return parameters of the
getNonce(address)
function. - Get the nonce of a
Wallet
. Function with signaturegetNonce((address,uint256,uint256,uint256))
and selector0xa5748aad
. - Get the nonce of a
Wallet
. Container type for the return parameters of thegetNonce((address,uint256,uint256,uint256))
function. - Gets all the recorded logs. Function with signature
getRecordedLogs()
and selector0x191553a4
. - Gets all the recorded logs. Container type for the return parameters of the
getRecordedLogs()
function. - Returns addresses of available unlocked wallets in the script environment. Function with signature
getWallets()
and selector0xdb7a4605
. - Returns addresses of available unlocked wallets in the script environment. Container type for the return parameters of the
getWallets()
function. - Returns the index of the first occurrence of a
key
in aninput
string. ReturnsNOT_FOUND
(i.e.type(uint256).max
) if thekey
is not found. Returns 0 in case of an emptykey
. Function with signatureindexOf(string,string)
and selector0x8a0807b7
. - Returns the index of the first occurrence of a
key
in aninput
string. ReturnsNOT_FOUND
(i.e.type(uint256).max
) if thekey
is not found. Returns 0 in case of an emptykey
. Container type for the return parameters of theindexOf(string,string)
function. - Returns true if
forge
command was executed in given context. Function with signatureisContext(uint8)
and selector0x64af255d
. - Returns true if
forge
command was executed in given context. Container type for the return parameters of theisContext(uint8)
function. - Returns true if the path exists on disk and is pointing at a directory, else returns false. Function with signature
isDir(string)
and selector0x7d15d019
. - Returns true if the path exists on disk and is pointing at a directory, else returns false. Container type for the return parameters of the
isDir(string)
function. - Returns true if the path exists on disk and is pointing at a regular file, else returns false. Function with signature
isFile(string)
and selector0xe0eb04d4
. - Returns true if the path exists on disk and is pointing at a regular file, else returns false. Container type for the return parameters of the
isFile(string)
function. - Returns true if the account is marked as persistent. Function with signature
isPersistent(address)
and selector0xd92d8efd
. - Returns true if the account is marked as persistent. Container type for the return parameters of the
isPersistent(address)
function. - Checks if
key
exists in a JSON objectkeyExists
is being deprecated in favor ofkeyExistsJson
. It will be removed in future versions. Function with signaturekeyExists(string,string)
and selector0x528a683c
. - Checks if
key
exists in a JSON object. Function with signaturekeyExistsJson(string,string)
and selector0xdb4235f6
. - Checks if
key
exists in a JSON object. Container type for the return parameters of thekeyExistsJson(string,string)
function. - Checks if
key
exists in a JSON objectkeyExists
is being deprecated in favor ofkeyExistsJson
. It will be removed in future versions. Container type for the return parameters of thekeyExists(string,string)
function. - Checks if
key
exists in a TOML table. Function with signaturekeyExistsToml(string,string)
and selector0x600903ad
. - Checks if
key
exists in a TOML table. Container type for the return parameters of thekeyExistsToml(string,string)
function. - Labels an address in call traces. Function with signature
label(address,string)
and selector0xc657c718
. - Labels an address in call traces. Container type for the return parameters of the
label(address,string)
function. - Gets the gas used in the last call from the callee perspective. Function with signature
lastCallGas()
and selector0x2b589b28
. - Gets the gas used in the last call from the callee perspective. Container type for the return parameters of the
lastCallGas()
function. - Load a genesis JSON file’s
allocs
into the in-memory EVM state. Function with signatureloadAllocs(string)
and selector0xb3a056d7
. - Load a genesis JSON file’s
allocs
into the in-memory EVM state. Container type for the return parameters of theloadAllocs(string)
function. - Loads a storage slot from an address. Function with signature
load(address,bytes32)
and selector0x667f9d70
. - Loads a storage slot from an address. Container type for the return parameters of the
load(address,bytes32)
function. - Marks that the account(s) should use persistent storage across fork swaps in a multifork setup Meaning, changes made to the state of this account will be kept when switching forks. Function with signature
makePersistent(address)
and selector0x57e22dde
. - Marks that the account(s) should use persistent storage across fork swaps in a multifork setup Meaning, changes made to the state of this account will be kept when switching forks. Container type for the return parameters of the
makePersistent(address)
function. - See
makePersistent(address)
. Function with signaturemakePersistent(address,address)
and selector0x4074e0a8
. - See
makePersistent(address)
. Container type for the return parameters of themakePersistent(address,address)
function. - See
makePersistent(address)
. Function with signaturemakePersistent(address,address,address)
and selector0xefb77a75
. - See
makePersistent(address)
. Container type for the return parameters of themakePersistent(address,address,address)
function. - See
makePersistent(address)
. Function with signaturemakePersistent(address[])
and selector0x1d9e269e
. - See
makePersistent(address)
. Container type for the return parameters of themakePersistent(address[])
function. - Reverts a call to an address with specified revert data. Function with signature
mockCallRevert(address,bytes,bytes)
and selector0xdbaad147
. - Reverts a call to an address with specified revert data. Container type for the return parameters of the
mockCallRevert(address,bytes,bytes)
function. - Reverts a call to an address with a specific
msg.value
, with specified revert data. Function with signaturemockCallRevert(address,uint256,bytes,bytes)
and selector0xd23cd037
. - Reverts a call to an address with a specific
msg.value
, with specified revert data. Container type for the return parameters of themockCallRevert(address,uint256,bytes,bytes)
function. - Mocks a call to an address, returning specified data. Calldata can either be strict or a partial match, e.g. if you only pass a Solidity selector to the expected calldata, then the entire Solidity function will be mocked. Function with signature
mockCall(address,bytes,bytes)
and selector0xb96213e4
. - Mocks a call to an address, returning specified data. Calldata can either be strict or a partial match, e.g. if you only pass a Solidity selector to the expected calldata, then the entire Solidity function will be mocked. Container type for the return parameters of the
mockCall(address,bytes,bytes)
function. - Mocks a call to an address with a specific
msg.value
, returning specified data. Calldata match takes precedence overmsg.value
in case of ambiguity. Function with signaturemockCall(address,uint256,bytes,bytes)
and selector0x81409b91
. - Mocks a call to an address with a specific
msg.value
, returning specified data. Calldata match takes precedence overmsg.value
in case of ambiguity. Container type for the return parameters of themockCall(address,uint256,bytes,bytes)
function. - Mocks multiple calls to an address, returning specified data for each call. Function with signature
mockCalls(address,bytes,bytes[])
and selector0x5c5c3de9
. - Mocks multiple calls to an address, returning specified data for each call. Container type for the return parameters of the
mockCalls(address,bytes,bytes[])
function. - Mocks multiple calls to an address with a specific
msg.value
, returning specified data for each call. Function with signaturemockCalls(address,uint256,bytes,bytes[])
and selector0x08bcbae1
. - Mocks multiple calls to an address with a specific
msg.value
, returning specified data for each call. Container type for the return parameters of themockCalls(address,uint256,bytes,bytes[])
function. - Whenever a call is made to
callee
with calldatadata
, this cheatcode instead callstarget
with the same calldata. This functionality is similar to a delegate call made totarget
contract fromcallee
. Can be used to substitute a call to a function with another implementation that captures the primary logic of the original function but is easier to reason about. If calldata is not a strict match then partial match by selector is attempted. Function with signaturemockFunction(address,address,bytes)
and selector0xadf84d21
. - Whenever a call is made to
callee
with calldatadata
, this cheatcode instead callstarget
with the same calldata. This functionality is similar to a delegate call made totarget
contract fromcallee
. Can be used to substitute a call to a function with another implementation that captures the primary logic of the original function but is easier to reason about. If calldata is not a strict match then partial match by selector is attempted. Container type for the return parameters of themockFunction(address,address,bytes)
function. - Parses the given
string
into anaddress
. Function with signatureparseAddress(string)
and selector0xc6ce059d
. - Parses the given
string
into anaddress
. Container type for the return parameters of theparseAddress(string)
function. - Parses the given
string
into abool
. Function with signatureparseBool(string)
and selector0x974ef924
. - Parses the given
string
into abool
. Container type for the return parameters of theparseBool(string)
function. - Parses the given
string
into abytes32
. Function with signatureparseBytes32(string)
and selector0x087e6e81
. - Parses the given
string
into abytes32
. Container type for the return parameters of theparseBytes32(string)
function. - Parses the given
string
intobytes
. Function with signatureparseBytes(string)
and selector0x8f5d232d
. - Parses the given
string
intobytes
. Container type for the return parameters of theparseBytes(string)
function. - Parses the given
string
into aint256
. Function with signatureparseInt(string)
and selector0x42346c5e
. - Parses the given
string
into aint256
. Container type for the return parameters of theparseInt(string)
function. - Parses a string of JSON data at
key
and coerces it toaddress[]
. Function with signatureparseJsonAddressArray(string,string)
and selector0x2fce7883
. - Parses a string of JSON data at
key
and coerces it toaddress[]
. Container type for the return parameters of theparseJsonAddressArray(string,string)
function. - Parses a string of JSON data at
key
and coerces it toaddress
. Function with signatureparseJsonAddress(string,string)
and selector0x1e19e657
. - Parses a string of JSON data at
key
and coerces it toaddress
. Container type for the return parameters of theparseJsonAddress(string,string)
function. - Parses a string of JSON data at
key
and coerces it tobool[]
. Function with signatureparseJsonBoolArray(string,string)
and selector0x91f3b94f
. - Parses a string of JSON data at
key
and coerces it tobool[]
. Container type for the return parameters of theparseJsonBoolArray(string,string)
function. - Parses a string of JSON data at
key
and coerces it tobool
. Function with signatureparseJsonBool(string,string)
and selector0x9f86dc91
. - Parses a string of JSON data at
key
and coerces it tobool
. Container type for the return parameters of theparseJsonBool(string,string)
function. - Parses a string of JSON data at
key
and coerces it tobytes32[]
. Function with signatureparseJsonBytes32Array(string,string)
and selector0x91c75bc3
. - Parses a string of JSON data at
key
and coerces it tobytes32[]
. Container type for the return parameters of theparseJsonBytes32Array(string,string)
function. - Parses a string of JSON data at
key
and coerces it tobytes32
. Function with signatureparseJsonBytes32(string,string)
and selector0x1777e59d
. - Parses a string of JSON data at
key
and coerces it tobytes32
. Container type for the return parameters of theparseJsonBytes32(string,string)
function. - Parses a string of JSON data at
key
and coerces it tobytes[]
. Function with signatureparseJsonBytesArray(string,string)
and selector0x6631aa99
. - Parses a string of JSON data at
key
and coerces it tobytes[]
. Container type for the return parameters of theparseJsonBytesArray(string,string)
function. - Parses a string of JSON data at
key
and coerces it tobytes
. Function with signatureparseJsonBytes(string,string)
and selector0xfd921be8
. - Parses a string of JSON data at
key
and coerces it tobytes
. Container type for the return parameters of theparseJsonBytes(string,string)
function. - Parses a string of JSON data at
key
and coerces it toint256[]
. Function with signatureparseJsonIntArray(string,string)
and selector0x9983c28a
. - Parses a string of JSON data at
key
and coerces it toint256[]
. Container type for the return parameters of theparseJsonIntArray(string,string)
function. - Parses a string of JSON data at
key
and coerces it toint256
. Function with signatureparseJsonInt(string,string)
and selector0x7b048ccd
. - Parses a string of JSON data at
key
and coerces it toint256
. Container type for the return parameters of theparseJsonInt(string,string)
function. - Returns an array of all the keys in a JSON object. Function with signature
parseJsonKeys(string,string)
and selector0x213e4198
. - Returns an array of all the keys in a JSON object. Container type for the return parameters of the
parseJsonKeys(string,string)
function. - Parses a string of JSON data at
key
and coerces it tostring[]
. Function with signatureparseJsonStringArray(string,string)
and selector0x498fdcf4
. - Parses a string of JSON data at
key
and coerces it tostring[]
. Container type for the return parameters of theparseJsonStringArray(string,string)
function. - Parses a string of JSON data at
key
and coerces it tostring
. Function with signatureparseJsonString(string,string)
and selector0x49c4fac8
. - Parses a string of JSON data at
key
and coerces it tostring
. Container type for the return parameters of theparseJsonString(string,string)
function. - Parses a string of JSON data at
key
and coerces it to type array corresponding totypeDescription
. Function with signatureparseJsonTypeArray(string,string,string)
and selector0x0175d535
. - Parses a string of JSON data at
key
and coerces it to type array corresponding totypeDescription
. Container type for the return parameters of theparseJsonTypeArray(string,string,string)
function. - Parses a string of JSON data and coerces it to type corresponding to
typeDescription
. Function with signatureparseJsonType(string,string)
and selector0xa9da313b
. - Parses a string of JSON data and coerces it to type corresponding to
typeDescription
. Container type for the return parameters of theparseJsonType(string,string)
function. - Parses a string of JSON data at
key
and coerces it to type corresponding totypeDescription
. Function with signatureparseJsonType(string,string,string)
and selector0xe3f5ae33
. - Parses a string of JSON data at
key
and coerces it to type corresponding totypeDescription
. Container type for the return parameters of theparseJsonType(string,string,string)
function. - Parses a string of JSON data at
key
and coerces it touint256[]
. Function with signatureparseJsonUintArray(string,string)
and selector0x522074ab
. - Parses a string of JSON data at
key
and coerces it touint256[]
. Container type for the return parameters of theparseJsonUintArray(string,string)
function. - Parses a string of JSON data at
key
and coerces it touint256
. Function with signatureparseJsonUint(string,string)
and selector0xaddde2b6
. - Parses a string of JSON data at
key
and coerces it touint256
. Container type for the return parameters of theparseJsonUint(string,string)
function. - ABI-encodes a JSON object. Function with signature
parseJson(string)
and selector0x6a82600a
. - ABI-encodes a JSON object. Container type for the return parameters of the
parseJson(string)
function. - ABI-encodes a JSON object at
key
. Function with signatureparseJson(string,string)
and selector0x85940ef1
. - ABI-encodes a JSON object at
key
. Container type for the return parameters of theparseJson(string,string)
function. - Parses a string of TOML data at
key
and coerces it toaddress[]
. Function with signatureparseTomlAddressArray(string,string)
and selector0x65c428e7
. - Parses a string of TOML data at
key
and coerces it toaddress[]
. Container type for the return parameters of theparseTomlAddressArray(string,string)
function. - Parses a string of TOML data at
key
and coerces it toaddress
. Function with signatureparseTomlAddress(string,string)
and selector0x65e7c844
. - Parses a string of TOML data at
key
and coerces it toaddress
. Container type for the return parameters of theparseTomlAddress(string,string)
function. - Parses a string of TOML data at
key
and coerces it tobool[]
. Function with signatureparseTomlBoolArray(string,string)
and selector0x127cfe9a
. - Parses a string of TOML data at
key
and coerces it tobool[]
. Container type for the return parameters of theparseTomlBoolArray(string,string)
function. - Parses a string of TOML data at
key
and coerces it tobool
. Function with signatureparseTomlBool(string,string)
and selector0xd30dced6
. - Parses a string of TOML data at
key
and coerces it tobool
. Container type for the return parameters of theparseTomlBool(string,string)
function. - Parses a string of TOML data at
key
and coerces it tobytes32[]
. Function with signatureparseTomlBytes32Array(string,string)
and selector0x3e716f81
. - Parses a string of TOML data at
key
and coerces it tobytes32[]
. Container type for the return parameters of theparseTomlBytes32Array(string,string)
function. - Parses a string of TOML data at
key
and coerces it tobytes32
. Function with signatureparseTomlBytes32(string,string)
and selector0x8e214810
. - Parses a string of TOML data at
key
and coerces it tobytes32
. Container type for the return parameters of theparseTomlBytes32(string,string)
function. - Parses a string of TOML data at
key
and coerces it tobytes[]
. Function with signatureparseTomlBytesArray(string,string)
and selector0xb197c247
. - Parses a string of TOML data at
key
and coerces it tobytes[]
. Container type for the return parameters of theparseTomlBytesArray(string,string)
function. - Parses a string of TOML data at
key
and coerces it tobytes
. Function with signatureparseTomlBytes(string,string)
and selector0xd77bfdb9
. - Parses a string of TOML data at
key
and coerces it tobytes
. Container type for the return parameters of theparseTomlBytes(string,string)
function. - Parses a string of TOML data at
key
and coerces it toint256[]
. Function with signatureparseTomlIntArray(string,string)
and selector0xd3522ae6
. - Parses a string of TOML data at
key
and coerces it toint256[]
. Container type for the return parameters of theparseTomlIntArray(string,string)
function. - Parses a string of TOML data at
key
and coerces it toint256
. Function with signatureparseTomlInt(string,string)
and selector0xc1350739
. - Parses a string of TOML data at
key
and coerces it toint256
. Container type for the return parameters of theparseTomlInt(string,string)
function. - Returns an array of all the keys in a TOML table. Function with signature
parseTomlKeys(string,string)
and selector0x812a44b2
. - Returns an array of all the keys in a TOML table. Container type for the return parameters of the
parseTomlKeys(string,string)
function. - Parses a string of TOML data at
key
and coerces it tostring[]
. Function with signatureparseTomlStringArray(string,string)
and selector0x9f629281
. - Parses a string of TOML data at
key
and coerces it tostring[]
. Container type for the return parameters of theparseTomlStringArray(string,string)
function. - Parses a string of TOML data at
key
and coerces it tostring
. Function with signatureparseTomlString(string,string)
and selector0x8bb8dd43
. - Parses a string of TOML data at
key
and coerces it tostring
. Container type for the return parameters of theparseTomlString(string,string)
function. - Parses a string of TOML data at
key
and coerces it to type array corresponding totypeDescription
. Function with signatureparseTomlTypeArray(string,string,string)
and selector0x49be3743
. - Parses a string of TOML data at
key
and coerces it to type array corresponding totypeDescription
. Container type for the return parameters of theparseTomlTypeArray(string,string,string)
function. - Parses a string of TOML data and coerces it to type corresponding to
typeDescription
. Function with signatureparseTomlType(string,string)
and selector0x47fa5e11
. - Parses a string of TOML data and coerces it to type corresponding to
typeDescription
. Container type for the return parameters of theparseTomlType(string,string)
function. - Parses a string of TOML data at
key
and coerces it to type corresponding totypeDescription
. Function with signatureparseTomlType(string,string,string)
and selector0xf9fa5cdb
. - Parses a string of TOML data at
key
and coerces it to type corresponding totypeDescription
. Container type for the return parameters of theparseTomlType(string,string,string)
function. - Parses a string of TOML data at
key
and coerces it touint256[]
. Function with signatureparseTomlUintArray(string,string)
and selector0xb5df27c8
. - Parses a string of TOML data at
key
and coerces it touint256[]
. Container type for the return parameters of theparseTomlUintArray(string,string)
function. - Parses a string of TOML data at
key
and coerces it touint256
. Function with signatureparseTomlUint(string,string)
and selector0xcc7b0487
. - Parses a string of TOML data at
key
and coerces it touint256
. Container type for the return parameters of theparseTomlUint(string,string)
function. - ABI-encodes a TOML table. Function with signature
parseToml(string)
and selector0x592151f0
. - ABI-encodes a TOML table. Container type for the return parameters of the
parseToml(string)
function. - ABI-encodes a TOML table at
key
. Function with signatureparseToml(string,string)
and selector0x37736e08
. - ABI-encodes a TOML table at
key
. Container type for the return parameters of theparseToml(string,string)
function. - Parses the given
string
into auint256
. Function with signatureparseUint(string)
and selector0xfa91454d
. - Parses the given
string
into auint256
. Container type for the return parameters of theparseUint(string)
function. - Pauses gas metering (i.e. gas usage is not counted). Noop if already paused. Function with signature
pauseGasMetering()
and selector0xd1a5b36f
. - Pauses gas metering (i.e. gas usage is not counted). Noop if already paused. Container type for the return parameters of the
pauseGasMetering()
function. - Pauses collection of call traces. Useful in cases when you want to skip tracing of complex calls which are not useful for debugging. Function with signature
pauseTracing()
and selector0xc94d1f90
. - Pauses collection of call traces. Useful in cases when you want to skip tracing of complex calls which are not useful for debugging. Container type for the return parameters of the
pauseTracing()
function. - Sets the next call’s
msg.sender
to be the input address. Function with signatureprank(address)
and selector0xca669fa7
. - Sets the next call’s
msg.sender
to be the input address. Container type for the return parameters of theprank(address)
function. - Sets the next call’s
msg.sender
to be the input address, and thetx.origin
to be the second input. Function with signatureprank(address,address)
and selector0x47e50cce
. - Sets the next call’s
msg.sender
to be the input address, and thetx.origin
to be the second input. Container type for the return parameters of theprank(address,address)
function. - Sets
block.prevrandao
. Not available on EVM versions before Paris. Usedifficulty
instead. If used on unsupported EVM versions it will revert. Function with signatureprevrandao(bytes32)
and selector0x3b925549
. - Sets
block.prevrandao
. Not available on EVM versions before Paris. Usedifficulty
instead. If used on unsupported EVM versions it will revert. Container type for the return parameters of theprevrandao(bytes32)
function. - Sets
block.prevrandao
. Not available on EVM versions before Paris. Usedifficulty
instead. If used on unsupported EVM versions it will revert. Function with signatureprevrandao(uint256)
and selector0x9cb1c0d4
. - Sets
block.prevrandao
. Not available on EVM versions before Paris. Usedifficulty
instead. If used on unsupported EVM versions it will revert. Container type for the return parameters of theprevrandao(uint256)
function. - Get the path of the current project root. Function with signature
projectRoot()
and selector0xd930a0e6
. - Get the path of the current project root. Container type for the return parameters of the
projectRoot()
function. - Prompts the user for an address in the terminal. Function with signature
promptAddress(string)
and selector0x62ee05f4
. - Prompts the user for an address in the terminal. Container type for the return parameters of the
promptAddress(string)
function. - Prompts the user for a string value in the terminal. Function with signature
prompt(string)
and selector0x47eaf474
. - Prompts the user for a string value in the terminal. Container type for the return parameters of the
prompt(string)
function. - Prompts the user for a hidden string value in the terminal. Function with signature
promptSecret(string)
and selector0x1e279d41
. - Prompts the user for a hidden string value in the terminal. Container type for the return parameters of the
promptSecret(string)
function. - Prompts the user for hidden uint256 in the terminal (usually pk). Function with signature
promptSecretUint(string)
and selector0x69ca02b7
. - Prompts the user for hidden uint256 in the terminal (usually pk). Container type for the return parameters of the
promptSecretUint(string)
function. - Prompts the user for uint256 in the terminal. Function with signature
promptUint(string)
and selector0x652fd489
. - Prompts the user for uint256 in the terminal. Container type for the return parameters of the
promptUint(string)
function. - Derives secp256r1 public key from the provided
privateKey
. Function with signaturepublicKeyP256(uint256)
and selector0xc453949e
. - Derives secp256r1 public key from the provided
privateKey
. Container type for the return parameters of thepublicKeyP256(uint256)
function. - Returns a random
address
. Function with signaturerandomAddress()
and selector0xd5bee9f5
. - Returns a random
address
. Container type for the return parameters of therandomAddress()
function. - Returns a random
bool
. Function with signaturerandomBool()
and selector0xcdc126bd
. - Returns a random
bool
. Container type for the return parameters of therandomBool()
function. - Returns a random fixed-size byte array of length 4. Function with signature
randomBytes4()
and selector0x9b7cd579
. - Returns a random fixed-size byte array of length 4. Container type for the return parameters of the
randomBytes4()
function. - Returns a random fixed-size byte array of length 8. Function with signature
randomBytes8()
and selector0x0497b0a5
. - Returns a random fixed-size byte array of length 8. Container type for the return parameters of the
randomBytes8()
function. - Returns a random byte array value of the given length. Function with signature
randomBytes(uint256)
and selector0x6c5d32a9
. - Returns a random byte array value of the given length. Container type for the return parameters of the
randomBytes(uint256)
function. - Returns a random
int256
value. Function with signaturerandomInt()
and selector0x111f1202
. - Returns a random
int256
value. Container type for the return parameters of therandomInt()
function. - Returns a random
int256
value of given bits. Function with signaturerandomInt(uint256)
and selector0x12845966
. - Returns a random
int256
value of given bits. Container type for the return parameters of therandomInt(uint256)
function. - Returns a random uint256 value. Function with signature
randomUint()
and selector0x25124730
. - Returns a random uint256 value. Container type for the return parameters of the
randomUint()
function. - Returns random uint256 value between the provided range (=min..=max). Function with signature
randomUint(uint256,uint256)
and selector0xd61b051b
. - Returns random uint256 value between the provided range (=min..=max). Container type for the return parameters of the
randomUint(uint256,uint256)
function. - Returns a random
uint256
value of given bits. Function with signaturerandomUint(uint256)
and selector0xcf81e69c
. - Returns a random
uint256
value of given bits. Container type for the return parameters of therandomUint(uint256)
function. - Reads the current
msg.sender
andtx.origin
from state and reports if there is any active caller modification. Function with signaturereadCallers()
and selector0x4ad0bac9
. - Reads the current
msg.sender
andtx.origin
from state and reports if there is any active caller modification. Container type for the return parameters of thereadCallers()
function. - Reads the directory at the given path recursively, up to
maxDepth
.maxDepth
defaults to 1, meaning only the direct children of the given directory will be returned. Follows symbolic links iffollowLinks
is true. Function with signaturereadDir(string)
and selector0xc4bc59e0
. - Reads the directory at the given path recursively, up to
maxDepth
.maxDepth
defaults to 1, meaning only the direct children of the given directory will be returned. Follows symbolic links iffollowLinks
is true. Container type for the return parameters of thereadDir(string)
function. - See
readDir(string)
. Function with signaturereadDir(string,uint64)
and selector0x1497876c
. - See
readDir(string)
. Container type for the return parameters of thereadDir(string,uint64)
function. - See
readDir(string)
. Function with signaturereadDir(string,uint64,bool)
and selector0x8102d70d
. - See
readDir(string)
. Container type for the return parameters of thereadDir(string,uint64,bool)
function. - Reads the entire content of file as binary.
path
is relative to the project root. Function with signaturereadFileBinary(string)
and selector0x16ed7bc4
. - Reads the entire content of file as binary.
path
is relative to the project root. Container type for the return parameters of thereadFileBinary(string)
function. - Reads the entire content of file to string.
path
is relative to the project root. Function with signaturereadFile(string)
and selector0x60f9bb11
. - Reads the entire content of file to string.
path
is relative to the project root. Container type for the return parameters of thereadFile(string)
function. - Reads next line of file to string. Function with signature
readLine(string)
and selector0x70f55728
. - Reads next line of file to string. Container type for the return parameters of the
readLine(string)
function. - Reads a symbolic link, returning the path that the link points to. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Reads a symbolic link, returning the path that the link points to. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Records all storage reads and writes. Function with signature
record()
and selector0x266cf109
. - Record all the transaction logs. Function with signature
recordLogs()
and selector0x41af2f52
. - Record all the transaction logs. Container type for the return parameters of the
recordLogs()
function. - Records all storage reads and writes. Container type for the return parameters of the
record()
function. - Adds a private key to the local forge wallet and returns the address. Function with signature
rememberKey(uint256)
and selector0x22100064
. - Adds a private key to the local forge wallet and returns the address. Container type for the return parameters of the
rememberKey(uint256)
function. - Derive a set number of wallets from a mnemonic at the derivation path
m/44'/60'/0'/0/{0..count}
. - Derive a set number of wallets from a mnemonic at the derivation path
m/44'/60'/0'/0/{0..count}
. - Derive a set number of wallets from a mnemonic in the specified language at the derivation path
m/44'/60'/0'/0/{0..count}
. - Derive a set number of wallets from a mnemonic in the specified language at the derivation path
m/44'/60'/0'/0/{0..count}
. - Removes a directory at the provided path. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Removes a directory at the provided path. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Removes a file from the filesystem. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Removes a file from the filesystem. This cheatcode will revert in the following situations, but is not limited to just these cases:
- Replaces occurrences of
from
in the givenstring
withto
. Function with signaturereplace(string,string,string)
and selector0xe00ad03e
. - Replaces occurrences of
from
in the givenstring
withto
. Container type for the return parameters of thereplace(string,string,string)
function. - Reset gas metering (i.e. gas usage is set to gas limit). Function with signature
resetGasMetering()
and selector0xbe367dd3
. - Reset gas metering (i.e. gas usage is set to gas limit). Container type for the return parameters of the
resetGasMetering()
function. - Resets the nonce of an account to 0 for EOAs and 1 for contract accounts. Function with signature
resetNonce(address)
and selector0x1c72346d
. - Resets the nonce of an account to 0 for EOAs and 1 for contract accounts. Container type for the return parameters of the
resetNonce(address)
function. - Resumes gas metering (i.e. gas usage is counted again). Noop if already on. Function with signature
resumeGasMetering()
and selector0x2bcd50e0
. - Resumes gas metering (i.e. gas usage is counted again). Noop if already on. Container type for the return parameters of the
resumeGasMetering()
function. - Unpauses collection of call traces. Function with signature
resumeTracing()
and selector0x72a09ccb
. - Unpauses collection of call traces. Container type for the return parameters of the
resumeTracing()
function. revertToAndDelete
is being deprecated in favor ofrevertToStateAndDelete
. It will be removed in future versions. Function with signaturerevertToAndDelete(uint256)
and selector0x03e0aca9
.revertToAndDelete
is being deprecated in favor ofrevertToStateAndDelete
. It will be removed in future versions. Container type for the return parameters of therevertToAndDelete(uint256)
function.revertTo
is being deprecated in favor ofrevertToState
. It will be removed in future versions. Function with signaturerevertTo(uint256)
and selector0x44d7f0a4
.revertTo
is being deprecated in favor ofrevertToState
. It will be removed in future versions. Container type for the return parameters of therevertTo(uint256)
function.- Revert the state of the EVM to a previous snapshot and automatically deletes the snapshots Takes the snapshot ID to revert to.
- Revert the state of the EVM to a previous snapshot and automatically deletes the snapshots Takes the snapshot ID to revert to.
- Revert the state of the EVM to a previous snapshot Takes the snapshot ID to revert to.
- Revert the state of the EVM to a previous snapshot Takes the snapshot ID to revert to.
- Revokes persistent status from the address, previously added via
makePersistent
. Function with signaturerevokePersistent(address)
and selector0x997a0222
. - Revokes persistent status from the address, previously added via
makePersistent
. Container type for the return parameters of therevokePersistent(address)
function. - See
revokePersistent(address)
. Function with signaturerevokePersistent(address[])
and selector0x3ce969e6
. - See
revokePersistent(address)
. Container type for the return parameters of therevokePersistent(address[])
function. - Sets
block.height
. Function with signatureroll(uint256)
and selector0x1f7b4f30
. - Updates the currently active fork to given block number This is similar to
roll
but for the currently active fork. Function with signaturerollFork(uint256)
and selector0xd9bbf3a1
. - Updates the currently active fork to given block number This is similar to
roll
but for the currently active fork. Container type for the return parameters of therollFork(uint256)
function. - Updates the currently active fork to given transaction. This will
rollFork
with the number of the block the transaction was mined in and replays all transaction mined before it in the block. Function with signaturerollFork(bytes32)
and selector0x0f29772b
. - Updates the currently active fork to given transaction. This will
rollFork
with the number of the block the transaction was mined in and replays all transaction mined before it in the block. Container type for the return parameters of therollFork(bytes32)
function. - Updates the given fork to given block number. Function with signature
rollFork(uint256,uint256)
and selector0xd74c83a4
. - Updates the given fork to given block number. Container type for the return parameters of the
rollFork(uint256,uint256)
function. - Updates the given fork to block number of the given transaction and replays all transaction mined before it in the block. Function with signature
rollFork(uint256,bytes32)
and selector0xf2830f7b
. - Updates the given fork to block number of the given transaction and replays all transaction mined before it in the block. Container type for the return parameters of the
rollFork(uint256,bytes32)
function. - Sets
block.height
. Container type for the return parameters of theroll(uint256)
function. - Returns the RPC url for the given alias. Function with signature
rpcUrl(string)
and selector0x975a6ce9
. - Returns the RPC url for the given alias. Container type for the return parameters of the
rpcUrl(string)
function. - Returns all rpc urls and their aliases as structs. Function with signature
rpcUrlStructs()
and selector0x9d2ad72a
. - Returns all rpc urls and their aliases as structs. Container type for the return parameters of the
rpcUrlStructs()
function. - Returns all rpc urls and their aliases
[alias, url][]
. Function with signaturerpcUrls()
and selector0xa85a8418
. - Returns all rpc urls and their aliases
[alias, url][]
. Container type for the return parameters of therpcUrls()
function. - Performs an Ethereum JSON-RPC request to the current fork URL. Function with signature
rpc(string,string)
and selector0x1206c8a8
. - Performs an Ethereum JSON-RPC request to the current fork URL. Container type for the return parameters of the
rpc(string,string)
function. - Performs an Ethereum JSON-RPC request to the given endpoint. Function with signature
rpc(string,string,string)
and selector0x0199a220
. - Performs an Ethereum JSON-RPC request to the given endpoint. Container type for the return parameters of the
rpc(string,string,string)
function. - Takes a fork identifier created by
createFork
and sets the corresponding forked state as active. Function with signatureselectFork(uint256)
and selector0x9ebf6827
. - Takes a fork identifier created by
createFork
and sets the corresponding forked state as active. Container type for the return parameters of theselectFork(uint256)
function. - See
serializeJson
. Function with signatureserializeAddress(string,string,address)
and selector0x972c6062
. - See
serializeJson
. Container type for the return parameters of theserializeAddress(string,string,address)
function. - See
serializeJson
. Function with signatureserializeAddress(string,string,address[])
and selector0x1e356e1a
. - See
serializeJson
. Container type for the return parameters of theserializeAddress(string,string,address[])
function. - See
serializeJson
. Function with signatureserializeBool(string,string,bool)
and selector0xac22e971
. - See
serializeJson
. Container type for the return parameters of theserializeBool(string,string,bool)
function. - See
serializeJson
. Function with signatureserializeBool(string,string,bool[])
and selector0x92925aa1
. - See
serializeJson
. Container type for the return parameters of theserializeBool(string,string,bool[])
function. - See
serializeJson
. Function with signatureserializeBytes32(string,string,bytes32)
and selector0x2d812b44
. - See
serializeJson
. Container type for the return parameters of theserializeBytes32(string,string,bytes32)
function. - See
serializeJson
. Function with signatureserializeBytes32(string,string,bytes32[])
and selector0x201e43e2
. - See
serializeJson
. Container type for the return parameters of theserializeBytes32(string,string,bytes32[])
function. - See
serializeJson
. Function with signatureserializeBytes(string,string,bytes)
and selector0xf21d52c7
. - See
serializeJson
. Container type for the return parameters of theserializeBytes(string,string,bytes)
function. - See
serializeJson
. Function with signatureserializeBytes(string,string,bytes[])
and selector0x9884b232
. - See
serializeJson
. Container type for the return parameters of theserializeBytes(string,string,bytes[])
function. - See
serializeJson
. Function with signatureserializeInt(string,string,int256)
and selector0x3f33db60
. - See
serializeJson
. Container type for the return parameters of theserializeInt(string,string,int256)
function. - See
serializeJson
. Function with signatureserializeInt(string,string,int256[])
and selector0x7676e127
. - See
serializeJson
. Container type for the return parameters of theserializeInt(string,string,int256[])
function. - Serializes a key and value to a JSON object stored in-memory that can be later written to a file. Returns the stringified version of the specific JSON file up to that moment. Function with signature
serializeJson(string,string)
and selector0x9b3358b0
. - Serializes a key and value to a JSON object stored in-memory that can be later written to a file. Returns the stringified version of the specific JSON file up to that moment. Container type for the return parameters of the
serializeJson(string,string)
function. - See
serializeJson
. Function with signatureserializeJsonType(string,bytes)
and selector0x6d4f96a6
. - See
serializeJson
. Container type for the return parameters of theserializeJsonType(string,bytes)
function. - See
serializeJson
. Function with signatureserializeJsonType(string,string,string,bytes)
and selector0x6f93bccb
. - See
serializeJson
. Container type for the return parameters of theserializeJsonType(string,string,string,bytes)
function. - See
serializeJson
. Function with signatureserializeString(string,string,string)
and selector0x88da6d35
. - See
serializeJson
. Container type for the return parameters of theserializeString(string,string,string)
function. - See
serializeJson
. Function with signatureserializeString(string,string,string[])
and selector0x561cd6f3
. - See
serializeJson
. Container type for the return parameters of theserializeString(string,string,string[])
function. - See
serializeJson
. Function with signatureserializeUintToHex(string,string,uint256)
and selector0xae5a2ae8
. - See
serializeJson
. Container type for the return parameters of theserializeUintToHex(string,string,uint256)
function. - See
serializeJson
. Function with signatureserializeUint(string,string,uint256)
and selector0x129e9002
. - See
serializeJson
. Container type for the return parameters of theserializeUint(string,string,uint256)
function. - See
serializeJson
. Function with signatureserializeUint(string,string,uint256[])
and selector0xfee9a469
. - See
serializeJson
. Container type for the return parameters of theserializeUint(string,string,uint256[])
function. - Utility cheatcode to set arbitrary storage for given target address. Function with signature
setArbitraryStorage(address)
and selector0xe1631837
. - Utility cheatcode to set arbitrary storage for given target address. Container type for the return parameters of the
setArbitraryStorage(address)
function. - Set blockhash for the current block. It only sets the blockhash for blocks where
block.number - 256 <= number < block.number
. Function with signaturesetBlockhash(uint256,bytes32)
and selector0x5314b54a
. - Set blockhash for the current block. It only sets the blockhash for blocks where
block.number - 256 <= number < block.number
. Container type for the return parameters of thesetBlockhash(uint256,bytes32)
function. - Sets environment variables. Function with signature
setEnv(string,string)
and selector0x3d5923ee
. - Sets environment variables. Container type for the return parameters of the
setEnv(string,string)
function. - Sets the nonce of an account. Must be higher than the current nonce of the account. Function with signature
setNonce(address,uint64)
and selector0xf8e18b57
. - Sets the nonce of an account. Must be higher than the current nonce of the account. Container type for the return parameters of the
setNonce(address,uint64)
function. - Sets the nonce of an account to an arbitrary value. Function with signature
setNonceUnsafe(address,uint64)
and selector0x9b67b21c
. - Sets the nonce of an account to an arbitrary value. Container type for the return parameters of the
setNonceUnsafe(address,uint64)
function. - Signs data with a
Wallet
. - Signs data with a
Wallet
. - Signs
digest
withprivateKey
using the secp256k1 curve. - Signs
digest
withprivateKey
using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
withprivateKey
using the secp256r1 curve. Function with signaturesignP256(uint256,bytes32)
and selector0x83211b40
. - Signs
digest
withprivateKey
using the secp256r1 curve. Container type for the return parameters of thesignP256(uint256,bytes32)
function. - Signs data with a
Wallet
. Function with signaturesign((address,uint256,uint256,uint256),bytes32)
and selector0xb25c5a25
. - Signs data with a
Wallet
. Container type for the return parameters of thesign((address,uint256,uint256,uint256),bytes32)
function. - Signs
digest
withprivateKey
using the secp256k1 curve. Function with signaturesign(uint256,bytes32)
and selector0xe341eaa4
. - Signs
digest
withprivateKey
using the secp256k1 curve. Container type for the return parameters of thesign(uint256,bytes32)
function. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Signs
digest
with signer provided to script using the secp256k1 curve. - Marks a test as skipped. Must be called at the top level of a test. Function with signature
skip(bool)
and selector0xdd82d13e
. - Marks a test as skipped. Must be called at the top level of a test. Container type for the return parameters of the
skip(bool)
function. - Marks a test as skipped with a reason. Must be called at the top level of a test. Function with signature
skip(bool,string)
and selector0xc42a80a7
. - Marks a test as skipped with a reason. Must be called at the top level of a test. Container type for the return parameters of the
skip(bool,string)
function. - Suspends execution of the main thread for
duration
milliseconds. Function with signaturesleep(uint256)
and selector0xfa9d8713
. - Suspends execution of the main thread for
duration
milliseconds. Container type for the return parameters of thesleep(uint256)
function. snapshot
is being deprecated in favor ofsnapshotState
. It will be removed in future versions. Function with signaturesnapshot()
and selector0x9711715a
.- Snapshot capture the gas usage of the last call by name from the callee perspective. Function with signature
snapshotGasLastCall(string)
and selector0xdd9fca12
. - Snapshot capture the gas usage of the last call by name from the callee perspective. Container type for the return parameters of the
snapshotGasLastCall(string)
function. - Snapshot capture the gas usage of the last call by name in a group from the callee perspective. Function with signature
snapshotGasLastCall(string,string)
and selector0x200c6772
. - Snapshot capture the gas usage of the last call by name in a group from the callee perspective. Container type for the return parameters of the
snapshotGasLastCall(string,string)
function. snapshot
is being deprecated in favor ofsnapshotState
. It will be removed in future versions. Container type for the return parameters of thesnapshot()
function.- Snapshot the current state of the evm. Returns the ID of the snapshot that was created. To revert a snapshot use
revertToState
. Function with signaturesnapshotState()
and selector0x9cd23835
. - Snapshot the current state of the evm. Returns the ID of the snapshot that was created. To revert a snapshot use
revertToState
. Container type for the return parameters of thesnapshotState()
function. - Snapshot capture an arbitrary numerical value by name. The group name is derived from the contract name. Function with signature
snapshotValue(string,uint256)
and selector0x51db805a
. - Snapshot capture an arbitrary numerical value by name. The group name is derived from the contract name. Container type for the return parameters of the
snapshotValue(string,uint256)
function. - Snapshot capture an arbitrary numerical value by name in a group. Function with signature
snapshotValue(string,string,uint256)
and selector0x6d2b27d8
. - Snapshot capture an arbitrary numerical value by name in a group. Container type for the return parameters of the
snapshotValue(string,string,uint256)
function. - Splits the given
string
into an array of strings divided by thedelimiter
. Function with signaturesplit(string,string)
and selector0x8bb75533
. - Splits the given
string
into an array of strings divided by thedelimiter
. Container type for the return parameters of thesplit(string,string)
function. - Has all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain.
- Has all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain.
- Has all subsequent calls (at this call depth only) create transactions with the address provided that can later be signed and sent onchain. Function with signature
startBroadcast(address)
and selector0x7fec2a8d
. - Has all subsequent calls (at this call depth only) create transactions with the address provided that can later be signed and sent onchain. Container type for the return parameters of the
startBroadcast(address)
function. - Has all subsequent calls (at this call depth only) create transactions with the private key provided that can later be signed and sent onchain. Function with signature
startBroadcast(uint256)
and selector0xce817d47
. - Has all subsequent calls (at this call depth only) create transactions with the private key provided that can later be signed and sent onchain. Container type for the return parameters of the
startBroadcast(uint256)
function. - Records the debug trace during the run. Function with signature
startDebugTraceRecording()
and selector0x419c8832
. - Records the debug trace during the run. Container type for the return parameters of the
startDebugTraceRecording()
function. - Starts recording all map SSTOREs for later retrieval. Function with signature
startMappingRecording()
and selector0x3e9705c0
. - Starts recording all map SSTOREs for later retrieval. Container type for the return parameters of the
startMappingRecording()
function. - Sets all subsequent calls’
msg.sender
to be the input address untilstopPrank
is called. Function with signaturestartPrank(address)
and selector0x06447d56
. - Sets all subsequent calls’
msg.sender
to be the input address untilstopPrank
is called. Container type for the return parameters of thestartPrank(address)
function. - Sets all subsequent calls’
msg.sender
to be the input address untilstopPrank
is called, and thetx.origin
to be the second input. Function with signaturestartPrank(address,address)
and selector0x45b56078
. - Sets all subsequent calls’
msg.sender
to be the input address untilstopPrank
is called, and thetx.origin
to be the second input. Container type for the return parameters of thestartPrank(address,address)
function. - Start a snapshot capture of the current gas usage by name. The group name is derived from the contract name. Function with signature
startSnapshotGas(string)
and selector0x3cad9d7b
. - Start a snapshot capture of the current gas usage by name. The group name is derived from the contract name. Container type for the return parameters of the
startSnapshotGas(string)
function. - Start a snapshot capture of the current gas usage by name in a group. Function with signature
startSnapshotGas(string,string)
and selector0x6cd0cc53
. - Start a snapshot capture of the current gas usage by name in a group. Container type for the return parameters of the
startSnapshotGas(string,string)
function. - Record all account accesses as part of CREATE, CALL or SELFDESTRUCT opcodes in order, along with the context of the calls Function with signature
startStateDiffRecording()
and selector0xcf22e3c9
. - Record all account accesses as part of CREATE, CALL or SELFDESTRUCT opcodes in order, along with the context of the calls Container type for the return parameters of the
startStateDiffRecording()
function. - Stop debug trace recording and returns the recorded debug trace. Function with signature
stopAndReturnDebugTraceRecording()
and selector0xced398a2
. - Stop debug trace recording and returns the recorded debug trace. Container type for the return parameters of the
stopAndReturnDebugTraceRecording()
function. - Returns an ordered array of all account accesses from a
vm.startStateDiffRecording
session. Function with signaturestopAndReturnStateDiff()
and selector0xaa5cf90e
. - Returns an ordered array of all account accesses from a
vm.startStateDiffRecording
session. Container type for the return parameters of thestopAndReturnStateDiff()
function. - Stops collecting onchain transactions. Function with signature
stopBroadcast()
and selector0x76eadd36
. - Stops collecting onchain transactions. Container type for the return parameters of the
stopBroadcast()
function. - Stops all safe memory expectation in the current subcontext. Function with signature
stopExpectSafeMemory()
and selector0x0956441b
. - Stops all safe memory expectation in the current subcontext. Container type for the return parameters of the
stopExpectSafeMemory()
function. - Stops recording all map SSTOREs for later retrieval and clears the recorded data. Function with signature
stopMappingRecording()
and selector0x0d4aae9b
. - Stops recording all map SSTOREs for later retrieval and clears the recorded data. Container type for the return parameters of the
stopMappingRecording()
function. - Resets subsequent calls’
msg.sender
to beaddress(this)
. Function with signaturestopPrank()
and selector0x90c5013b
. - Resets subsequent calls’
msg.sender
to beaddress(this)
. Container type for the return parameters of thestopPrank()
function. - Stop the snapshot capture of the current gas by latest snapshot name, capturing the gas used since the start. Function with signature
stopSnapshotGas()
and selector0xf6402eda
. - Stop the snapshot capture of the current gas by latest snapshot name, capturing the gas used since the start. Container type for the return parameters of the
stopSnapshotGas()
function. - Stop the snapshot capture of the current gas usage by name, capturing the gas used since the start. The group name is derived from the contract name. Function with signature
stopSnapshotGas(string)
and selector0x773b2805
. - Stop the snapshot capture of the current gas usage by name, capturing the gas used since the start. The group name is derived from the contract name. Container type for the return parameters of the
stopSnapshotGas(string)
function. - Stop the snapshot capture of the current gas usage by name in a group, capturing the gas used since the start. Function with signature
stopSnapshotGas(string,string)
and selector0x0c9db707
. - Stop the snapshot capture of the current gas usage by name in a group, capturing the gas used since the start. Container type for the return parameters of the
stopSnapshotGas(string,string)
function. - Stores a value to an address’ storage slot. Function with signature
store(address,bytes32,bytes32)
and selector0x70ca10bb
. - Stores a value to an address’ storage slot. Container type for the return parameters of the
store(address,bytes32,bytes32)
function. - Encodes a
bytes
value to a base64url string. Function with signaturetoBase64URL(bytes)
and selector0xc8bd0e4a
. - Encodes a
bytes
value to a base64url string. Container type for the return parameters of thetoBase64URL(bytes)
function. - Encodes a
string
value to a base64url string. Function with signaturetoBase64URL(string)
and selector0xae3165b3
. - Encodes a
string
value to a base64url string. Container type for the return parameters of thetoBase64URL(string)
function. - Encodes a
bytes
value to a base64 string. Function with signaturetoBase64(bytes)
and selector0xa5cbfe65
. - Encodes a
bytes
value to a base64 string. Container type for the return parameters of thetoBase64(bytes)
function. - Encodes a
string
value to a base64 string. Function with signaturetoBase64(string)
and selector0x3f8be2c8
. - Encodes a
string
value to a base64 string. Container type for the return parameters of thetoBase64(string)
function. - Converts the given
string
value to Lowercase. Function with signaturetoLowercase(string)
and selector0x50bb0884
. - Converts the given
string
value to Lowercase. Container type for the return parameters of thetoLowercase(string)
function. - Converts the given value to a
string
. Function with signaturetoString(address)
and selector0x56ca623e
. - Converts the given value to a
string
. Container type for the return parameters of thetoString(address)
function. - Converts the given value to a
string
. Function with signaturetoString(bytes)
and selector0x71aad10d
. - Converts the given value to a
string
. Container type for the return parameters of thetoString(bytes)
function. - Converts the given value to a
string
. Function with signaturetoString(bytes32)
and selector0xb11a19e8
. - Converts the given value to a
string
. Container type for the return parameters of thetoString(bytes32)
function. - Converts the given value to a
string
. Function with signaturetoString(bool)
and selector0x71dce7da
. - Converts the given value to a
string
. Container type for the return parameters of thetoString(bool)
function. - Converts the given value to a
string
. Function with signaturetoString(uint256)
and selector0x6900a3ae
. - Converts the given value to a
string
. Container type for the return parameters of thetoString(uint256)
function. - Converts the given value to a
string
. Function with signaturetoString(int256)
and selector0xa322c40e
. - Converts the given value to a
string
. Container type for the return parameters of thetoString(int256)
function. - Converts the given
string
value to Uppercase. Function with signaturetoUppercase(string)
and selector0x074ae3d7
. - Converts the given
string
value to Uppercase. Container type for the return parameters of thetoUppercase(string)
function. - Fetches the given transaction from the active fork and executes it on the current state. Function with signature
transact(bytes32)
and selector0xbe646da1
. - Fetches the given transaction from the active fork and executes it on the current state. Container type for the return parameters of the
transact(bytes32)
function. - Fetches the given transaction from the given fork and executes it on the current state. Function with signature
transact(uint256,bytes32)
and selector0x4d8abc4b
. - Fetches the given transaction from the given fork and executes it on the current state. Container type for the return parameters of the
transact(uint256,bytes32)
function. - Trims leading and trailing whitespace from the given
string
value. Function with signaturetrim(string)
and selector0xb2dad155
. - Trims leading and trailing whitespace from the given
string
value. Container type for the return parameters of thetrim(string)
function. - Performs a foreign function call via terminal and returns the exit code, stdout, and stderr. Function with signature
tryFfi(string[])
and selector0xf45c1ce7
. - Performs a foreign function call via terminal and returns the exit code, stdout, and stderr. Container type for the return parameters of the
tryFfi(string[])
function. - Sets
tx.gasprice
. Function with signaturetxGasPrice(uint256)
and selector0x48f50c0f
. - Sets
tx.gasprice
. Container type for the return parameters of thetxGasPrice(uint256)
function. - Returns the time since unix epoch in milliseconds. Function with signature
unixTime()
and selector0x625387dc
. - Returns the time since unix epoch in milliseconds. Container type for the return parameters of the
unixTime()
function. - Sets
block.timestamp
. Function with signaturewarp(uint256)
and selector0xe5d6bf02
. - Sets
block.timestamp
. Container type for the return parameters of thewarp(uint256)
function. - Writes binary data to a file, creating a file if it does not exist, and entirely replacing its contents if it does.
path
is relative to the project root. Function with signaturewriteFileBinary(string,bytes)
and selector0x1f21fc80
. - Writes binary data to a file, creating a file if it does not exist, and entirely replacing its contents if it does.
path
is relative to the project root. Container type for the return parameters of thewriteFileBinary(string,bytes)
function. - Writes data to file, creating a file if it does not exist, and entirely replacing its contents if it does.
path
is relative to the project root. Function with signaturewriteFile(string,string)
and selector0x897e0a97
. - Writes data to file, creating a file if it does not exist, and entirely replacing its contents if it does.
path
is relative to the project root. Container type for the return parameters of thewriteFile(string,string)
function. - Write a serialized JSON object to a file. If the file exists, it will be overwritten. Function with signature
writeJson(string,string)
and selector0xe23cd19f
. - Write a serialized JSON object to a file. If the file exists, it will be overwritten. Container type for the return parameters of the
writeJson(string,string)
function. - Write a serialized JSON object to an existing JSON file, replacing a value with key = <value_key.> This is useful to replace a specific value of a JSON file, without having to parse the entire thing. Function with signature
writeJson(string,string,string)
and selector0x35d6ad46
. - Write a serialized JSON object to an existing JSON file, replacing a value with key = <value_key.> This is useful to replace a specific value of a JSON file, without having to parse the entire thing. Container type for the return parameters of the
writeJson(string,string,string)
function. - Writes line to file, creating a file if it does not exist.
path
is relative to the project root. Function with signaturewriteLine(string,string)
and selector0x619d897f
. - Writes line to file, creating a file if it does not exist.
path
is relative to the project root. Container type for the return parameters of thewriteLine(string,string)
function. - Takes serialized JSON, converts to TOML and write a serialized TOML to a file. Function with signature
writeToml(string,string)
and selector0xc0865ba7
. - Takes serialized JSON, converts to TOML and write a serialized TOML to a file. Container type for the return parameters of the
writeToml(string,string)
function. - Takes serialized JSON, converts to TOML and write a serialized TOML table to an existing TOML file, replacing a value with key = <value_key.> This is useful to replace a specific value of a TOML file, without having to parse the entire thing. Function with signature
writeToml(string,string,string)
and selector0x51ac6a33
. - Takes serialized JSON, converts to TOML and write a serialized TOML table to an existing TOML file, replacing a value with key = <value_key.> This is useful to replace a specific value of a TOML file, without having to parse the entire thing. Container type for the return parameters of the
writeToml(string,string,string)
function.
Enums§
- The kind of account access that occurred.
- A modification applied to either
msg.sender
ortx.origin
. Returned byreadCallers
. - Forge execution contexts.
- Container for all the
Vm
function calls. - Container for all the
Vm
custom errors.
Constants§
- All the cheatcodes in this contract.
- All the custom errors in this contract.