Module Vm

Help

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 AccessListItem { address target; bytes32[] storageKeys; }
    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; }
    enum BroadcastTxType { Call, Create, Create2 }
    struct BroadcastTxSummary { bytes32 txHash; BroadcastTxType txType; address contractAddress; uint64 blockNumber; bool success; }
    struct SignedDelegation { uint8 v; bytes32 r; bytes32 s; uint64 nonce; address implementation; }
    struct PotentialRevert { address reverter; bool partialMatch; bytes revertData; }
    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 getStateDiff() external view returns (string memory diff);
    function getStateDiffJson() external view returns (string memory diff);
    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 accessList(AccessListItem[] calldata access) external;
    function noAccessList() external;
    function warmSlot(address target, bytes32 slot) external;
    function coolSlot(address target, bytes32 slot) 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 mockCall(address callee, bytes4 data, bytes calldata returnData) external;
    function mockCall(address callee, uint256 msgValue, bytes4 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 mockCallRevert(address callee, bytes4 data, bytes calldata revertData) external;
    function mockCallRevert(address callee, uint256 msgValue, bytes4 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 prank(address msgSender, bool delegateCall) external;
    function startPrank(address msgSender, bool delegateCall) external;
    function prank(address msgSender, address txOrigin, bool delegateCall) external;
    function startPrank(address msgSender, address txOrigin, bool delegateCall) 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[] calldata 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 assumeNoRevert(PotentialRevert calldata potentialRevert) external pure;
    function assumeNoRevert(PotentialRevert[] calldata potentialReverts) 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 expectEmit(bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData, uint64 count) external;
    function expectEmit(bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData, address emitter, uint64 count) external;
    function expectEmit(uint64 count) external;
    function expectEmit(address emitter, uint64 count) 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 expectCreate(bytes calldata bytecode, address deployer) external;
    function expectCreate2(bytes calldata bytecode, address deployer) 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 expectRevert(uint64 count) external;
    function expectRevert(bytes4 revertData, uint64 count) external;
    function expectRevert(bytes calldata revertData, uint64 count) external;
    function expectRevert(address reverter, uint64 count) external;
    function expectRevert(bytes4 revertData, address reverter, uint64 count) external;
    function expectRevert(bytes calldata revertData, address reverter, uint64 count) 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 foundryVersionAtLeast(string calldata version) external view returns (bool);
    function foundryVersionCmp(string calldata version) external view returns (int256);
    function exists(string calldata path) external view returns (bool result);
    function fsMetadata(string calldata path) external view returns (FsMetadata memory metadata);
    function isDir(string calldata path) external view returns (bool result);
    function isFile(string calldata path) external view returns (bool result);
    function projectRoot() external view returns (string memory path);
    function unixTime() external view 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 deployCode(string calldata artifactPath, uint256 value) external returns (address deployedAddress);
    function deployCode(string calldata artifactPath, bytes calldata constructorArgs, uint256 value) external returns (address deployedAddress);
    function deployCode(string calldata artifactPath, bytes32 salt) external returns (address deployedAddress);
    function deployCode(string calldata artifactPath, bytes calldata constructorArgs, bytes32 salt) external returns (address deployedAddress);
    function deployCode(string calldata artifactPath, uint256 value, bytes32 salt) external returns (address deployedAddress);
    function deployCode(string calldata artifactPath, bytes calldata constructorArgs, uint256 value, bytes32 salt) external returns (address deployedAddress);
    function getDeployedCode(string calldata artifactPath) external view returns (bytes memory runtimeBytecode);
    function getBroadcast(string calldata contractName, uint64 chainId, BroadcastTxType txType) external view returns (BroadcastTxSummary memory);
    function getBroadcasts(string calldata contractName, uint64 chainId, BroadcastTxType txType) external view returns (BroadcastTxSummary[] memory);
    function getBroadcasts(string calldata contractName, uint64 chainId) external view returns (BroadcastTxSummary[] memory);
    function getDeployment(string calldata contractName) external view returns (address deployedAddress);
    function getDeployment(string calldata contractName, uint64 chainId) external view returns (address deployedAddress);
    function getDeployments(string calldata contractName, uint64 chainId) external view returns (address[] memory deployedAddresses);
    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 signDelegation(address implementation, uint256 privateKey) external returns (SignedDelegation memory signedDelegation);
    function signDelegation(address implementation, uint256 privateKey, uint64 nonce) external returns (SignedDelegation memory signedDelegation);
    function attachDelegation(SignedDelegation calldata signedDelegation) external;
    function signAndAttachDelegation(address implementation, uint256 privateKey) external returns (SignedDelegation memory signedDelegation);
    function signAndAttachDelegation(address implementation, uint256 privateKey, uint64 nonce) external returns (SignedDelegation memory signedDelegation);
    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 calldata value) external pure returns (string memory json);
    function serializeJsonType(string calldata objectKey, string calldata valueKey, string calldata typeDescription, bytes calldata 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;
    function setArbitraryStorage(address target, bool overwrite) external;
    function sort(uint256[] calldata array) external returns (uint256[] memory);
    function shuffle(uint256[] calldata array) external returns (uint256[] memory);
    function interceptInitcode() external;
}

Modules§

abi: Contains dynamic ABI definitions for this contract.

Structs§

AccessListItem: An EIP-2930 access list item.
AccountAccess: The result of a stopAndReturnStateDiff call.
BroadcastTxSummary: Represents a transaction’s broadcast details.
ChainInfo: Information on the chain and fork.
CheatcodeError: Error thrown by cheatcodes. Custom error with signature CheatcodeError(string) and selector 0xeeaa9e6f.
DebugStep: The result of the stopDebugTraceRecording call
DirEntry: A single entry in a directory listing. Returned by readDir.
EthGetLogs: An RPC log object. Returned by eth_getLogs.
FfiResult: The result of a tryFfi call.
FsMetadata: Metadata information about a file.
Gas: Gas used. Returned by lastCallGas.
Log: An Ethereum log. Returned by getRecordedLogs.
PotentialRevert: Represents a “potential” revert reason from a single subsequent call when using vm.assumeNoReverts. Reverts that match will result in a FOUNDRY::ASSUME rejection, whereas unmatched reverts will be surfaced as normal.
Rpc: An RPC URL and its alias. Returned by rpcUrlStructs.
SignedDelegation: Holds a signed EIP-7702 authorization for an authority account to delegate to an implementation.
StorageAccess: The storage accessed during an AccountAccess.
Wallet: A wallet with a public and private key.
_expectCheatcodeRevert_0Call: Expects an error on next cheatcode call with any revert data. Function with signature _expectCheatcodeRevert() and selector 0x79a4f48a.
_expectCheatcodeRevert_0Return: Expects an error on next cheatcode call with any revert data. Container type for the return parameters of the _expectCheatcodeRevert() function.
_expectCheatcodeRevert_1Call: Expects an error on next cheatcode call that starts with the revert data. Function with signature _expectCheatcodeRevert(bytes4) and selector 0x884cb0ae.
_expectCheatcodeRevert_1Return: Expects an error on next cheatcode call that starts with the revert data. Container type for the return parameters of the _expectCheatcodeRevert(bytes4) function.
_expectCheatcodeRevert_2Call: Expects an error on next cheatcode call that exactly matches the revert data. Function with signature _expectCheatcodeRevert(bytes) and selector 0x7843b44d.
_expectCheatcodeRevert_2Return: Expects an error on next cheatcode call that exactly matches the revert data. Container type for the return parameters of the _expectCheatcodeRevert(bytes) function.
accessListCall: Utility cheatcode to set an EIP-2930 access list for all subsequent transactions. Function with signature accessList((address,bytes32[])[]) and selector 0x743e4cb7.
accessListReturn: Utility cheatcode to set an EIP-2930 access list for all subsequent transactions. Container type for the return parameters of the accessList((address,bytes32[])[]) function.
accessesCall: Gets all accessed reads and write slot from a vm.record session, for a given address. Function with signature accesses(address) and selector 0x65bc9481.
accessesReturn: Gets all accessed reads and write slot from a vm.record session, for a given address. Container type for the return parameters of the accesses(address) function.
activeForkCall: Returns the identifier of the currently active fork. Reverts if no fork is currently active. Function with signature activeFork() and selector 0x2f103f22.
activeForkReturn: 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.
addrCall: Gets the address for a given private key. Function with signature addr(uint256) and selector 0xffa18649.
addrReturn: Gets the address for a given private key. Container type for the return parameters of the addr(uint256) function.
allowCheatcodesCall: In forking mode, explicitly grant the given address cheatcode access. Function with signature allowCheatcodes(address) and selector 0xea060291.
allowCheatcodesReturn: In forking mode, explicitly grant the given address cheatcode access. Container type for the return parameters of the allowCheatcodes(address) function.
assertApproxEqAbsDecimal_0Call: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Function with signature assertApproxEqAbsDecimal(uint256,uint256,uint256,uint256) and selector 0x045c55ce.
assertApproxEqAbsDecimal_0Return: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Container type for the return parameters of the assertApproxEqAbsDecimal(uint256,uint256,uint256,uint256) function.
assertApproxEqAbsDecimal_1Call: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signature assertApproxEqAbsDecimal(uint256,uint256,uint256,uint256,string) and selector 0x60429eb2.
assertApproxEqAbsDecimal_1Return: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of the assertApproxEqAbsDecimal(uint256,uint256,uint256,uint256,string) function.
assertApproxEqAbsDecimal_2Call: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Function with signature assertApproxEqAbsDecimal(int256,int256,uint256,uint256) and selector 0x3d5bc8bc.
assertApproxEqAbsDecimal_2Return: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Container type for the return parameters of the assertApproxEqAbsDecimal(int256,int256,uint256,uint256) function.
assertApproxEqAbsDecimal_3Call: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Includes error message into revert string on failure. Function with signature assertApproxEqAbsDecimal(int256,int256,uint256,uint256,string) and selector 0x6a5066d4.
assertApproxEqAbsDecimal_3Return: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Formats values with decimals in failure message. Includes error message into revert string on failure. Container type for the return parameters of the assertApproxEqAbsDecimal(int256,int256,uint256,uint256,string) function.
assertApproxEqAbs_0Call: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Function with signature assertApproxEqAbs(uint256,uint256,uint256) and selector 0x16d207c6.
assertApproxEqAbs_0Return: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Container type for the return parameters of the assertApproxEqAbs(uint256,uint256,uint256) function.
assertApproxEqAbs_1Call: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Includes error message into revert string on failure. Function with signature assertApproxEqAbs(uint256,uint256,uint256,string) and selector 0xf710b062.
assertApproxEqAbs_1Return: Compares two uint256 values. Expects difference to be less than or equal to maxDelta. Includes error message into revert string on failure. Container type for the return parameters of the assertApproxEqAbs(uint256,uint256,uint256,string) function.
assertApproxEqAbs_2Call: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Function with signature assertApproxEqAbs(int256,int256,uint256) and selector 0x240f839d.
assertApproxEqAbs_2Return: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Container type for the return parameters of the assertApproxEqAbs(int256,int256,uint256) function.
assertApproxEqAbs_3Call: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Includes error message into revert string on failure. Function with signature assertApproxEqAbs(int256,int256,uint256,string) and selector 0x8289e621.
assertApproxEqAbs_3Return: Compares two int256 values. Expects difference to be less than or equal to maxDelta. Includes error message into revert string on failure. Container type for the return parameters of the assertApproxEqAbs(int256,int256,uint256,string) function.
assertApproxEqRelDecimal_0Call: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Function with signature assertApproxEqRelDecimal(uint256,uint256,uint256,uint256) and selector 0x21ed2977.
assertApproxEqRelDecimal_0Return: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 the assertApproxEqRelDecimal(uint256,uint256,uint256,uint256) function.
assertApproxEqRelDecimal_1Call: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 signature assertApproxEqRelDecimal(uint256,uint256,uint256,uint256,string) and selector 0x82d6c8fd.
assertApproxEqRelDecimal_1Return: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 the assertApproxEqRelDecimal(uint256,uint256,uint256,uint256,string) function.
assertApproxEqRelDecimal_2Call: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Formats values with decimals in failure message. Function with signature assertApproxEqRelDecimal(int256,int256,uint256,uint256) and selector 0xabbf21cc.
assertApproxEqRelDecimal_2Return: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 the assertApproxEqRelDecimal(int256,int256,uint256,uint256) function.
assertApproxEqRelDecimal_3Call: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 signature assertApproxEqRelDecimal(int256,int256,uint256,uint256,string) and selector 0xfccc11c4.
assertApproxEqRelDecimal_3Return: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 the assertApproxEqRelDecimal(int256,int256,uint256,uint256,string) function.
assertApproxEqRel_0Call: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Function with signature assertApproxEqRel(uint256,uint256,uint256) and selector 0x8cf25ef4.
assertApproxEqRel_0Return: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Container type for the return parameters of the assertApproxEqRel(uint256,uint256,uint256) function.
assertApproxEqRel_1Call: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Includes error message into revert string on failure. Function with signature assertApproxEqRel(uint256,uint256,uint256,string) and selector 0x1ecb7d33.
assertApproxEqRel_1Return: Compares two uint256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 the assertApproxEqRel(uint256,uint256,uint256,string) function.
assertApproxEqRel_2Call: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Function with signature assertApproxEqRel(int256,int256,uint256) and selector 0xfea2d14f.
assertApproxEqRel_2Return: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Container type for the return parameters of the assertApproxEqRel(int256,int256,uint256) function.
assertApproxEqRel_3Call: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. maxPercentDelta is an 18 decimal fixed point number, where 1e18 == 100% Includes error message into revert string on failure. Function with signature assertApproxEqRel(int256,int256,uint256,string) and selector 0xef277d72.
assertApproxEqRel_3Return: Compares two int256 values. Expects relative difference in percents to be less than or equal to maxPercentDelta. 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 the assertApproxEqRel(int256,int256,uint256,string) function.
assertEqDecimal_0Call: Asserts that two uint256 values are equal, formatting them with decimals in failure message. Function with signature assertEqDecimal(uint256,uint256,uint256) and selector 0x27af7d9c.
assertEqDecimal_0Return: Asserts that two uint256 values are equal, formatting them with decimals in failure message. Container type for the return parameters of the assertEqDecimal(uint256,uint256,uint256) function.
assertEqDecimal_1Call: Asserts that two uint256 values are equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Function with signature assertEqDecimal(uint256,uint256,uint256,string) and selector 0xd0cbbdef.
assertEqDecimal_1Return: 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 the assertEqDecimal(uint256,uint256,uint256,string) function.
assertEqDecimal_2Call: Asserts that two int256 values are equal, formatting them with decimals in failure message. Function with signature assertEqDecimal(int256,int256,uint256) and selector 0x48016c04.
assertEqDecimal_2Return: Asserts that two int256 values are equal, formatting them with decimals in failure message. Container type for the return parameters of the assertEqDecimal(int256,int256,uint256) function.
assertEqDecimal_3Call: Asserts that two int256 values are equal, formatting them with decimals in failure message. Includes error message into revert string on failure. Function with signature assertEqDecimal(int256,int256,uint256,string) and selector 0x7e77b0c5.
assertEqDecimal_3Return: 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 the assertEqDecimal(int256,int256,uint256,string) function.
assertEq_0Call: Asserts that two bool values are equal. Function with signature assertEq(bool,bool) and selector 0xf7fe3477.
assertEq_0Return: Asserts that two bool values are equal. Container type for the return parameters of the assertEq(bool,bool) function.
assertEq_1Call: Asserts that two bool values are equal and includes error message into revert string on failure. Function with signature assertEq(bool,bool,string) and selector 0x4db19e7e.
assertEq_1Return: Asserts that two bool values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(bool,bool,string) function.
assertEq_2Call: Asserts that two uint256 values are equal. Function with signature assertEq(uint256,uint256) and selector 0x98296c54.
assertEq_2Return: Asserts that two uint256 values are equal. Container type for the return parameters of the assertEq(uint256,uint256) function.
assertEq_3Call: Asserts that two uint256 values are equal and includes error message into revert string on failure. Function with signature assertEq(uint256,uint256,string) and selector 0x88b44c85.
assertEq_3Return: Asserts that two uint256 values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(uint256,uint256,string) function.
assertEq_4Call: Asserts that two int256 values are equal. Function with signature assertEq(int256,int256) and selector 0xfe74f05b.
assertEq_4Return: Asserts that two int256 values are equal. Container type for the return parameters of the assertEq(int256,int256) function.
assertEq_5Call: Asserts that two int256 values are equal and includes error message into revert string on failure. Function with signature assertEq(int256,int256,string) and selector 0x714a2f13.
assertEq_5Return: Asserts that two int256 values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(int256,int256,string) function.
assertEq_6Call: Asserts that two address values are equal. Function with signature assertEq(address,address) and selector 0x515361f6.
assertEq_6Return: Asserts that two address values are equal. Container type for the return parameters of the assertEq(address,address) function.
assertEq_7Call: Asserts that two address values are equal and includes error message into revert string on failure. Function with signature assertEq(address,address,string) and selector 0x2f2769d1.
assertEq_7Return: Asserts that two address values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(address,address,string) function.
assertEq_8Call: Asserts that two bytes32 values are equal. Function with signature assertEq(bytes32,bytes32) and selector 0x7c84c69b.
assertEq_8Return: Asserts that two bytes32 values are equal. Container type for the return parameters of the assertEq(bytes32,bytes32) function.
assertEq_9Call: Asserts that two bytes32 values are equal and includes error message into revert string on failure. Function with signature assertEq(bytes32,bytes32,string) and selector 0xc1fa1ed0.
assertEq_9Return: Asserts that two bytes32 values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(bytes32,bytes32,string) function.
assertEq_10Call: Asserts that two string values are equal. Function with signature assertEq(string,string) and selector 0xf320d963.
assertEq_10Return: Asserts that two string values are equal. Container type for the return parameters of the assertEq(string,string) function.
assertEq_11Call: Asserts that two string values are equal and includes error message into revert string on failure. Function with signature assertEq(string,string,string) and selector 0x36f656d8.
assertEq_11Return: Asserts that two string values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(string,string,string) function.
assertEq_12Call: Asserts that two bytes values are equal. Function with signature assertEq(bytes,bytes) and selector 0x97624631.
assertEq_12Return: Asserts that two bytes values are equal. Container type for the return parameters of the assertEq(bytes,bytes) function.
assertEq_13Call: Asserts that two bytes values are equal and includes error message into revert string on failure. Function with signature assertEq(bytes,bytes,string) and selector 0xe24fed00.
assertEq_13Return: Asserts that two bytes values are equal and includes error message into revert string on failure. Container type for the return parameters of the assertEq(bytes,bytes,string) function.
assertEq_14Call: Asserts that two arrays of bool values are equal. Function with signature assertEq(bool[],bool[]) and selector 0x707df785.
assertEq_14Return: Asserts that two arrays of bool values are equal. Container type for the return parameters of the assertEq(bool[],bool[]) function.
assertEq_15Call: Asserts that two arrays of bool values are equal and includes error message into revert string on failure. Function with signature assertEq(bool[],bool[],string) and selector 0xe48a8f8d.
assertEq_15Return: 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 the assertEq(bool[],bool[],string) function.
assertEq_16Call: Asserts that two arrays of uint256 values are equal. Function with signature assertEq(uint256[],uint256[])and selector0x975d5a12`.
assertEq_16Return: Asserts that two arrays of uint256 values are equal. Container type for the return parameters of the [assertEq(uint256[],uint256[])`](assertEq_16Call) function.
assertEq_17Call: Asserts that two arrays of uint256 values are equal and includes error message into revert string on failure. Function with signature assertEq(uint256[],uint256[],string) and selector 0x5d18c73a.
assertEq_17Return: 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 the assertEq(uint256[],uint256[],string) function.
assertEq_18Call: Asserts that two arrays of int256 values are equal. Function with signature assertEq(int256[],int256[]) and selector 0x711043ac.
assertEq_18Return: Asserts that two arrays of int256 values are equal. Container type for the return parameters of the assertEq(int256[],int256[]) function.
assertEq_19Call: Asserts that two arrays of int256 values are equal and includes error message into revert string on failure. Function with signature assertEq(int256[],int256[],string) and selector 0x191f1b30.
assertEq_19Return: 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 the assertEq(int256[],int256[],string) function.
assertEq_20Call: Asserts that two arrays of address values are equal. Function with signature assertEq(address[],address[]) and selector 0x3868ac34.
assertEq_20Return: Asserts that two arrays of address values are equal. Container type for the return parameters of the assertEq(address[],address[]) function.
assertEq_21Call: Asserts that two arrays of address values are equal and includes error message into revert string on failure. Function with signature assertEq(address[],address[],string) and selector 0x3e9173c5.
assertEq_21Return: 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 the assertEq(address[],address[],string) function.
assertEq_22Call: Asserts that two arrays of bytes32 values are equal. Function with signature assertEq(bytes32[],bytes32[]) and selector 0x0cc9ee84.
assertEq_22Return: Asserts that two arrays of bytes32 values are equal. Container type for the return parameters of the assertEq(bytes32[],bytes32[]) function.
assertEq_23Call: Asserts that two arrays of bytes32 values are equal and includes error message into revert string on failure. Function with signature assertEq(bytes32[],bytes32[],string) and selector 0xe03e9177.
assertEq_23Return: 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 the assertEq(bytes32[],bytes32[],string) function.
assertEq_24Call: Asserts that two arrays of string values are equal. Function with signature assertEq(string[],string[]) and selector 0xcf1c049c.
assertEq_24Return: Asserts that two arrays of string values are equal. Container type for the return parameters of the assertEq(string[],string[]) function.
assertEq_25Call: Asserts that two arrays of string values are equal and includes error message into revert string on failure. Function with signature assertEq(string[],string[],string) and selector 0xeff6b27d.
assertEq_25Return: 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 the assertEq(string[],string[],string) function.
assertEq_26Call: Asserts that two arrays of bytes values are equal. Function with signature assertEq(bytes[],bytes[]) and selector 0xe5fb9b4a.
assertEq_26Return: Asserts that two arrays of bytes values are equal. Container type for the return parameters of the assertEq(bytes[],bytes[]) function.
assertEq_27Call: Asserts that two arrays of bytes values are equal and includes error message into revert string on failure. Function with signature assertEq(bytes[],bytes[],string) and selector 0xf413f0b6.
assertEq_27Return: 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 the assertEq(bytes[],bytes[],string) function.
assertFalse_0Call: Asserts that the given condition is false. Function with signature assertFalse(bool) and selector 0xa5982885.
assertFalse_0Return: Asserts that the given condition is false. Container type for the return parameters of the assertFalse(bool) function.
assertFalse_1Call: Asserts that the given condition is false and includes error message into revert string on failure. Function with signature assertFalse(bool,string) and selector 0x7ba04809.
assertFalse_1Return: 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.
assertGeDecimal_0Call: Compares two uint256 values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Function with signature assertGeDecimal(uint256,uint256,uint256) and selector 0x3d1fe08a.
assertGeDecimal_0Return: 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 the assertGeDecimal(uint256,uint256,uint256) function.
assertGeDecimal_1Call: 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 signature assertGeDecimal(uint256,uint256,uint256,string) and selector 0x8bff9133.
assertGeDecimal_1Return: 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 the assertGeDecimal(uint256,uint256,uint256,string) function.
assertGeDecimal_2Call: Compares two int256 values. Expects first value to be greater than or equal to second. Formats values with decimals in failure message. Function with signature assertGeDecimal(int256,int256,uint256) and selector 0xdc28c0f1.
assertGeDecimal_2Return: 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 the assertGeDecimal(int256,int256,uint256) function.
assertGeDecimal_3Call: 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 signature assertGeDecimal(int256,int256,uint256,string) and selector 0x5df93c9b.
assertGeDecimal_3Return: 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 the assertGeDecimal(int256,int256,uint256,string) function.
assertGe_0Call: Compares two uint256 values. Expects first value to be greater than or equal to second. Function with signature assertGe(uint256,uint256) and selector 0xa8d4d1d9.
assertGe_0Return: Compares two uint256 values. Expects first value to be greater than or equal to second. Container type for the return parameters of the assertGe(uint256,uint256) function.
assertGe_1Call: 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 signature assertGe(uint256,uint256,string) and selector 0xe25242c0.
assertGe_1Return: 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 the assertGe(uint256,uint256,string) function.
assertGe_2Call: Compares two int256 values. Expects first value to be greater than or equal to second. Function with signature assertGe(int256,int256) and selector 0x0a30b771.
assertGe_2Return: Compares two int256 values. Expects first value to be greater than or equal to second. Container type for the return parameters of the assertGe(int256,int256) function.
assertGe_3Call: 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 signature assertGe(int256,int256,string) and selector 0xa84328dd.
assertGe_3Return: 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 the assertGe(int256,int256,string) function.
assertGtDecimal_0Call: Compares two uint256 values. Expects first value to be greater than second. Formats values with decimals in failure message. Function with signature assertGtDecimal(uint256,uint256,uint256) and selector 0xeccd2437.
assertGtDecimal_0Return: 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 the assertGtDecimal(uint256,uint256,uint256) function.
assertGtDecimal_1Call: 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 signature assertGtDecimal(uint256,uint256,uint256,string) and selector 0x64949a8d.
assertGtDecimal_1Return: 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 the assertGtDecimal(uint256,uint256,uint256,string) function.
assertGtDecimal_2Call: Compares two int256 values. Expects first value to be greater than second. Formats values with decimals in failure message. Function with signature assertGtDecimal(int256,int256,uint256) and selector 0x78611f0e.
assertGtDecimal_2Return: 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 the assertGtDecimal(int256,int256,uint256) function.
assertGtDecimal_3Call: 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 signature assertGtDecimal(int256,int256,uint256,string) and selector 0x04a5c7ab.
assertGtDecimal_3Return: 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 the assertGtDecimal(int256,int256,uint256,string) function.
assertGt_0Call: Compares two uint256 values. Expects first value to be greater than second. Function with signature assertGt(uint256,uint256) and selector 0xdb07fcd2.
assertGt_0Return: Compares two uint256 values. Expects first value to be greater than second. Container type for the return parameters of the assertGt(uint256,uint256) function.
assertGt_1Call: Compares two uint256 values. Expects first value to be greater than second. Includes error message into revert string on failure. Function with signature assertGt(uint256,uint256,string) and selector 0xd9a3c4d2.
assertGt_1Return: 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 the assertGt(uint256,uint256,string) function.
assertGt_2Call: Compares two int256 values. Expects first value to be greater than second. Function with signature assertGt(int256,int256) and selector 0x5a362d45.
assertGt_2Return: Compares two int256 values. Expects first value to be greater than second. Container type for the return parameters of the assertGt(int256,int256) function.
assertGt_3Call: Compares two int256 values. Expects first value to be greater than second. Includes error message into revert string on failure. Function with signature assertGt(int256,int256,string) and selector 0xf8d33b9b.
assertGt_3Return: 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 the assertGt(int256,int256,string) function.
assertLeDecimal_0Call: Compares two uint256 values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Function with signature assertLeDecimal(uint256,uint256,uint256) and selector 0xc304aab7.
assertLeDecimal_0Return: 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 the assertLeDecimal(uint256,uint256,uint256) function.
assertLeDecimal_1Call: 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 signature assertLeDecimal(uint256,uint256,uint256,string) and selector 0x7fefbbe0.
assertLeDecimal_1Return: 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 the assertLeDecimal(uint256,uint256,uint256,string) function.
assertLeDecimal_2Call: Compares two int256 values. Expects first value to be less than or equal to second. Formats values with decimals in failure message. Function with signature assertLeDecimal(int256,int256,uint256) and selector 0x11d1364a.
assertLeDecimal_2Return: 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 the assertLeDecimal(int256,int256,uint256) function.
assertLeDecimal_3Call: 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 signature assertLeDecimal(int256,int256,uint256,string) and selector 0xaa5cf788.
assertLeDecimal_3Return: 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 the assertLeDecimal(int256,int256,uint256,string) function.
assertLe_0Call: Compares two uint256 values. Expects first value to be less than or equal to second. Function with signature assertLe(uint256,uint256) and selector 0x8466f415.
assertLe_0Return: Compares two uint256 values. Expects first value to be less than or equal to second. Container type for the return parameters of the assertLe(uint256,uint256) function.
assertLe_1Call: 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 signature assertLe(uint256,uint256,string) and selector 0xd17d4b0d.
assertLe_1Return: 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 the assertLe(uint256,uint256,string) function.
assertLe_2Call: Compares two int256 values. Expects first value to be less than or equal to second. Function with signature assertLe(int256,int256) and selector 0x95fd154e.
assertLe_2Return: Compares two int256 values. Expects first value to be less than or equal to second. Container type for the return parameters of the assertLe(int256,int256) function.
assertLe_3Call: 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 signature assertLe(int256,int256,string) and selector 0x4dfe692c.
assertLe_3Return: 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 the assertLe(int256,int256,string) function.
assertLtDecimal_0Call: Compares two uint256 values. Expects first value to be less than second. Formats values with decimals in failure message. Function with signature assertLtDecimal(uint256,uint256,uint256) and selector 0x2077337e.
assertLtDecimal_0Return: 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 the assertLtDecimal(uint256,uint256,uint256) function.
assertLtDecimal_1Call: 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 signature assertLtDecimal(uint256,uint256,uint256,string) and selector 0xa972d037.
assertLtDecimal_1Return: 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 the assertLtDecimal(uint256,uint256,uint256,string) function.
assertLtDecimal_2Call: Compares two int256 values. Expects first value to be less than second. Formats values with decimals in failure message. Function with signature assertLtDecimal(int256,int256,uint256) and selector 0xdbe8d88b.
assertLtDecimal_2Return: 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 the assertLtDecimal(int256,int256,uint256) function.
assertLtDecimal_3Call: 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 signature assertLtDecimal(int256,int256,uint256,string) and selector 0x40f0b4e0.
assertLtDecimal_3Return: 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 the assertLtDecimal(int256,int256,uint256,string) function.
assertLt_0Call: Compares two uint256 values. Expects first value to be less than second. Function with signature assertLt(uint256,uint256) and selector 0xb12fc005.
assertLt_0Return: Compares two uint256 values. Expects first value to be less than second. Container type for the return parameters of the assertLt(uint256,uint256) function.
assertLt_1Call: Compares two uint256 values. Expects first value to be less than second. Includes error message into revert string on failure. Function with signature assertLt(uint256,uint256,string) and selector 0x65d5c135.
assertLt_1Return: 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 the assertLt(uint256,uint256,string) function.
assertLt_2Call: Compares two int256 values. Expects first value to be less than second. Function with signature assertLt(int256,int256) and selector 0x3e914080.
assertLt_2Return: Compares two int256 values. Expects first value to be less than second. Container type for the return parameters of the assertLt(int256,int256) function.
assertLt_3Call: Compares two int256 values. Expects first value to be less than second. Includes error message into revert string on failure. Function with signature assertLt(int256,int256,string) and selector 0x9ff531e3.
assertLt_3Return: 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 the assertLt(int256,int256,string) function.
assertNotEqDecimal_0Call: Asserts that two uint256 values are not equal, formatting them with decimals in failure message. Function with signature assertNotEqDecimal(uint256,uint256,uint256) and selector 0x669efca7.
assertNotEqDecimal_0Return: Asserts that two uint256 values are not equal, formatting them with decimals in failure message. Container type for the return parameters of the assertNotEqDecimal(uint256,uint256,uint256) function.
assertNotEqDecimal_1Call: 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 signature assertNotEqDecimal(uint256,uint256,uint256,string) and selector 0xf5a55558.
assertNotEqDecimal_1Return: 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 the assertNotEqDecimal(uint256,uint256,uint256,string) function.
assertNotEqDecimal_2Call: Asserts that two int256 values are not equal, formatting them with decimals in failure message. Function with signature assertNotEqDecimal(int256,int256,uint256) and selector 0x14e75680.
assertNotEqDecimal_2Return: Asserts that two int256 values are not equal, formatting them with decimals in failure message. Container type for the return parameters of the assertNotEqDecimal(int256,int256,uint256) function.
assertNotEqDecimal_3Call: 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 signature assertNotEqDecimal(int256,int256,uint256,string) and selector 0x33949f0b.
assertNotEqDecimal_3Return: 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 the assertNotEqDecimal(int256,int256,uint256,string) function.
assertNotEq_0Call: Asserts that two bool values are not equal. Function with signature assertNotEq(bool,bool) and selector 0x236e4d66.
assertNotEq_0Return: Asserts that two bool values are not equal. Container type for the return parameters of the assertNotEq(bool,bool) function.
assertNotEq_1Call: Asserts that two bool values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(bool,bool,string) and selector 0x1091a261.
assertNotEq_1Return: Asserts that two bool values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(bool,bool,string) function.
assertNotEq_2Call: Asserts that two uint256 values are not equal. Function with signature assertNotEq(uint256,uint256) and selector 0xb7909320.
assertNotEq_2Return: Asserts that two uint256 values are not equal. Container type for the return parameters of the assertNotEq(uint256,uint256) function.
assertNotEq_3Call: Asserts that two uint256 values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(uint256,uint256,string) and selector 0x98f9bdbd.
assertNotEq_3Return: Asserts that two uint256 values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(uint256,uint256,string) function.
assertNotEq_4Call: Asserts that two int256 values are not equal. Function with signature assertNotEq(int256,int256) and selector 0xf4c004e3.
assertNotEq_4Return: Asserts that two int256 values are not equal. Container type for the return parameters of the assertNotEq(int256,int256) function.
assertNotEq_5Call: Asserts that two int256 values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(int256,int256,string) and selector 0x4724c5b9.
assertNotEq_5Return: Asserts that two int256 values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(int256,int256,string) function.
assertNotEq_6Call: Asserts that two address values are not equal. Function with signature assertNotEq(address,address) and selector 0xb12e1694.
assertNotEq_6Return: Asserts that two address values are not equal. Container type for the return parameters of the assertNotEq(address,address) function.
assertNotEq_7Call: Asserts that two address values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(address,address,string) and selector 0x8775a591.
assertNotEq_7Return: Asserts that two address values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(address,address,string) function.
assertNotEq_8Call: Asserts that two bytes32 values are not equal. Function with signature assertNotEq(bytes32,bytes32) and selector 0x898e83fc.
assertNotEq_8Return: Asserts that two bytes32 values are not equal. Container type for the return parameters of the assertNotEq(bytes32,bytes32) function.
assertNotEq_9Call: Asserts that two bytes32 values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(bytes32,bytes32,string) and selector 0xb2332f51.
assertNotEq_9Return: Asserts that two bytes32 values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(bytes32,bytes32,string) function.
assertNotEq_10Call: Asserts that two string values are not equal. Function with signature assertNotEq(string,string) and selector 0x6a8237b3.
assertNotEq_10Return: Asserts that two string values are not equal. Container type for the return parameters of the assertNotEq(string,string) function.
assertNotEq_11Call: Asserts that two string values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(string,string,string) and selector 0x78bdcea7.
assertNotEq_11Return: Asserts that two string values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(string,string,string) function.
assertNotEq_12Call: Asserts that two bytes values are not equal. Function with signature assertNotEq(bytes,bytes) and selector 0x3cf78e28.
assertNotEq_12Return: Asserts that two bytes values are not equal. Container type for the return parameters of the assertNotEq(bytes,bytes) function.
assertNotEq_13Call: Asserts that two bytes values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(bytes,bytes,string) and selector 0x9507540e.
assertNotEq_13Return: Asserts that two bytes values are not equal and includes error message into revert string on failure. Container type for the return parameters of the assertNotEq(bytes,bytes,string) function.
assertNotEq_14Call: Asserts that two arrays of bool values are not equal. Function with signature assertNotEq(bool[],bool[]) and selector 0x286fafea.
assertNotEq_14Return: Asserts that two arrays of bool values are not equal. Container type for the return parameters of the assertNotEq(bool[],bool[]) function.
assertNotEq_15Call: Asserts that two arrays of bool values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(bool[],bool[],string) and selector 0x62c6f9fb.
assertNotEq_15Return: 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 the assertNotEq(bool[],bool[],string) function.
assertNotEq_16Call: Asserts that two arrays of uint256 values are not equal. Function with signature assertNotEq(uint256[],uint256[]) and selector 0x56f29cba.
assertNotEq_16Return: Asserts that two arrays of uint256 values are not equal. Container type for the return parameters of the assertNotEq(uint256[],uint256[]) function.
assertNotEq_17Call: Asserts that two arrays of uint256 values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(uint256[],uint256[],string) and selector 0x9a7fbd8f.
assertNotEq_17Return: 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 the assertNotEq(uint256[],uint256[],string) function.
assertNotEq_18Call: Asserts that two arrays of int256 values are not equal. Function with signature assertNotEq(int256[],int256[]) and selector 0x0b72f4ef.
assertNotEq_18Return: Asserts that two arrays of int256 values are not equal. Container type for the return parameters of the assertNotEq(int256[],int256[]) function.
assertNotEq_19Call: Asserts that two arrays of int256 values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(int256[],int256[],string) and selector 0xd3977322.
assertNotEq_19Return: 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 the assertNotEq(int256[],int256[],string) function.
assertNotEq_20Call: Asserts that two arrays of address values are not equal. Function with signature assertNotEq(address[],address[]) and selector 0x46d0b252.
assertNotEq_20Return: Asserts that two arrays of address values are not equal. Container type for the return parameters of the assertNotEq(address[],address[]) function.
assertNotEq_21Call: Asserts that two arrays of address values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(address[],address[],string) and selector 0x72c7e0b5.
assertNotEq_21Return: 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 the assertNotEq(address[],address[],string) function.
assertNotEq_22Call: Asserts that two arrays of bytes32 values are not equal. Function with signature assertNotEq(bytes32[],bytes32[]) and selector 0x0603ea68.
assertNotEq_22Return: Asserts that two arrays of bytes32 values are not equal. Container type for the return parameters of the assertNotEq(bytes32[],bytes32[]) function.
assertNotEq_23Call: Asserts that two arrays of bytes32 values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(bytes32[],bytes32[],string) and selector 0xb873634c.
assertNotEq_23Return: 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 the assertNotEq(bytes32[],bytes32[],string) function.
assertNotEq_24Call: Asserts that two arrays of string values are not equal. Function with signature assertNotEq(string[],string[]) and selector 0xbdfacbe8.
assertNotEq_24Return: Asserts that two arrays of string values are not equal. Container type for the return parameters of the assertNotEq(string[],string[]) function.
assertNotEq_25Call: Asserts that two arrays of string values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(string[],string[],string) and selector 0xb67187f3.
assertNotEq_25Return: 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 the assertNotEq(string[],string[],string) function.
assertNotEq_26Call: Asserts that two arrays of bytes values are not equal. Function with signature assertNotEq(bytes[],bytes[]) and selector 0xedecd035.
assertNotEq_26Return: Asserts that two arrays of bytes values are not equal. Container type for the return parameters of the assertNotEq(bytes[],bytes[]) function.
assertNotEq_27Call: Asserts that two arrays of bytes values are not equal and includes error message into revert string on failure. Function with signature assertNotEq(bytes[],bytes[],string) and selector 0x1dcd1f68.
assertNotEq_27Return: 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 the assertNotEq(bytes[],bytes[],string) function.
assertTrue_0Call: Asserts that the given condition is true. Function with signature assertTrue(bool) and selector 0x0c9fd581.
assertTrue_0Return: Asserts that the given condition is true. Container type for the return parameters of the assertTrue(bool) function.
assertTrue_1Call: Asserts that the given condition is true and includes error message into revert string on failure. Function with signature assertTrue(bool,string) and selector 0xa34edc03.
assertTrue_1Return: 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.
assumeCall: If the condition is false, discard this run’s fuzz inputs and generate new ones. Function with signature assume(bool) and selector 0x4c63e562.
assumeNoRevert_0Call: Discard this run’s fuzz inputs and generate new ones if next call reverted. Function with signature assumeNoRevert() and selector 0x285b366a.
assumeNoRevert_0Return: Discard this run’s fuzz inputs and generate new ones if next call reverted. Container type for the return parameters of the assumeNoRevert() function.
assumeNoRevert_1Call: Discard this run’s fuzz inputs and generate new ones if next call reverts with the potential revert parameters. Function with signature assumeNoRevert((address,bool,bytes)) and selector 0xd8591eeb.
assumeNoRevert_1Return: Discard this run’s fuzz inputs and generate new ones if next call reverts with the potential revert parameters. Container type for the return parameters of the assumeNoRevert((address,bool,bytes)) function.
assumeNoRevert_2Call: Discard this run’s fuzz inputs and generate new ones if next call reverts with the any of the potential revert parameters. Function with signature assumeNoRevert((address,bool,bytes)[]) and selector 0x8a4592cc.
assumeNoRevert_2Return: Discard this run’s fuzz inputs and generate new ones if next call reverts with the any of the potential revert parameters. Container type for the return parameters of the assumeNoRevert((address,bool,bytes)[]) function.
assumeReturn: 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.
attachDelegationCall: Designate the next call as an EIP-7702 transaction Function with signature attachDelegation((uint8,bytes32,bytes32,uint64,address)) and selector 0x14ae3519.
attachDelegationReturn: Designate the next call as an EIP-7702 transaction Container type for the return parameters of the attachDelegation((uint8,bytes32,bytes32,uint64,address)) function.
blobBaseFeeCall: Sets block.blobbasefee Function with signature blobBaseFee(uint256) and selector 0x6d315d7e.
blobBaseFeeReturn: Sets block.blobbasefee Container type for the return parameters of the blobBaseFee(uint256) function.
blobhashesCall: 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 selector 0x129de7eb.
blobhashesReturn: 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.
breakpoint_0Call: Writes a breakpoint to jump to in the debugger. Function with signature breakpoint(string) and selector 0xf0259e92.
breakpoint_0Return: Writes a breakpoint to jump to in the debugger. Container type for the return parameters of the breakpoint(string) function.
breakpoint_1Call: Writes a conditional breakpoint to jump to in the debugger. Function with signature breakpoint(string,bool) and selector 0xf7d39a8d.
breakpoint_1Return: Writes a conditional breakpoint to jump to in the debugger. Container type for the return parameters of the breakpoint(string,bool) function.
broadcastRawTransactionCall: Takes a signed transaction and broadcasts it to the network. Function with signature broadcastRawTransaction(bytes) and selector 0x8c0c72e0.
broadcastRawTransactionReturn: Takes a signed transaction and broadcasts it to the network. Container type for the return parameters of the broadcastRawTransaction(bytes) function.
broadcast_0Call: Has the next call (at this call depth only) create transactions that can later be signed and sent onchain.
broadcast_0Return: Has the next call (at this call depth only) create transactions that can later be signed and sent onchain.
broadcast_1Call: 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 selector 0xe6962cdb.
broadcast_1Return: 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.
broadcast_2Call: 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 selector 0xf67a965b.
broadcast_2Return: 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.
chainIdCall: Sets block.chainid. Function with signature chainId(uint256) and selector 0x4049ddd2.
chainIdReturn: Sets block.chainid. Container type for the return parameters of the chainId(uint256) function.
clearMockedCallsCall: Clears all mocked calls. Function with signature clearMockedCalls() and selector 0x3fdf4e15.
clearMockedCallsReturn: Clears all mocked calls. Container type for the return parameters of the clearMockedCalls() function.
cloneAccountCall: 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 selector 0x533d61c9.
cloneAccountReturn: 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.
closeFileCall: 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 signature closeFile(string) and selector 0x48c3241f.
closeFileReturn: 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 the closeFile(string) function.
coinbaseCall: Sets block.coinbase. Function with signature coinbase(address) and selector 0xff483c54.
coinbaseReturn: Sets block.coinbase. Container type for the return parameters of the coinbase(address) function.
computeCreate2Address_0Call: Compute the address of a contract created with CREATE2 using the given CREATE2 deployer. Function with signature computeCreate2Address(bytes32,bytes32,address) and selector 0xd323826a.
computeCreate2Address_0Return: 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.
computeCreate2Address_1Call: Compute the address of a contract created with CREATE2 using the default CREATE2 deployer. Function with signature computeCreate2Address(bytes32,bytes32) and selector 0x890c283b.
computeCreate2Address_1Return: 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.
computeCreateAddressCall: Compute the address a contract will be deployed at for a given deployer address and nonce. Function with signature computeCreateAddress(address,uint256) and selector 0x74637a7a.
computeCreateAddressReturn: 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.
containsCall: Returns true if search is found in subject, false otherwise. Function with signature contains(string,string) and selector 0x3fb18aec.
containsReturn: Returns true if search is found in subject, false otherwise. Container type for the return parameters of the contains(string,string) function.
coolCall: Marks the slots of an account and the account address as cold. Function with signature cool(address) and selector 0x40ff9f21.
coolReturn: Marks the slots of an account and the account address as cold. Container type for the return parameters of the cool(address) function.
coolSlotCall: Utility cheatcode to mark specific storage slot as cold, simulating no prior read. Function with signature coolSlot(address,bytes32) and selector 0x8c78e654.
coolSlotReturn: Utility cheatcode to mark specific storage slot as cold, simulating no prior read. Container type for the return parameters of the coolSlot(address,bytes32) function.
copyFileCall: 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 the to file as reported by metadata. Both from and to are relative to the project root. Function with signature copyFile(string,string) and selector 0xa54a87d8.
copyFileReturn: 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 the to file as reported by metadata. Both from and to are relative to the project root. Container type for the return parameters of the copyFile(string,string) function.
copyStorageCall: Utility cheatcode to copy storage of from contract to another to contract. Function with signature copyStorage(address,address) and selector 0x203dac0d.
copyStorageReturn: Utility cheatcode to copy storage of from contract to another to contract. Container type for the return parameters of the copyStorage(address,address) function.
createDirCall: 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:
createDirReturn: 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:
createFork_0Call: 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 selector 0x31ba3498.
createFork_0Return: 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.
createFork_1Call: Creates a new fork with the given endpoint and block and returns the identifier of the fork. Function with signature createFork(string,uint256) and selector 0x6ba3ba2b.
createFork_1Return: 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.
createFork_2Call: 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 selector 0x7ca29682.
createFork_2Return: 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.
createSelectFork_0Call: 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 selector 0x98680034.
createSelectFork_0Return: 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.
createSelectFork_1Call: 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 selector 0x71ee464d.
createSelectFork_1Return: 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.
createSelectFork_2Call: 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 selector 0x84d52b7a.
createSelectFork_2Return: 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.
createWallet_0Call: Derives a private key from the name, labels the account with that name, and returns the wallet. Function with signature createWallet(string) and selector 0x7404f1d2.
createWallet_0Return: 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.
createWallet_1Call: Generates a wallet from the private key and returns the wallet. Function with signature createWallet(uint256) and selector 0x7a675bb6.
createWallet_1Return: Generates a wallet from the private key and returns the wallet. Container type for the return parameters of the createWallet(uint256) function.
createWallet_2Call: Generates a wallet from the private key, labels the account with that name, and returns the wallet. Function with signature createWallet(uint256,string) and selector 0xed7c5462.
createWallet_2Return: 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.
dealCall: Sets an address’ balance. Function with signature deal(address,uint256) and selector 0xc88a5e6d.
dealReturn: Sets an address’ balance. Container type for the return parameters of the deal(address,uint256) function.
deleteSnapshotCall: deleteSnapshot is being deprecated in favor of deleteStateSnapshot. It will be removed in future versions. Function with signature deleteSnapshot(uint256) and selector 0xa6368557.
deleteSnapshotReturn: deleteSnapshot is being deprecated in favor of deleteStateSnapshot. It will be removed in future versions. Container type for the return parameters of the deleteSnapshot(uint256) function.
deleteSnapshotsCall: deleteSnapshots is being deprecated in favor of deleteStateSnapshots. It will be removed in future versions. Function with signature deleteSnapshots() and selector 0x421ae469.
deleteSnapshotsReturn: deleteSnapshots is being deprecated in favor of deleteStateSnapshots. It will be removed in future versions. Container type for the return parameters of the deleteSnapshots() function.
deleteStateSnapshotCall: Removes the snapshot with the given ID created by snapshot. Takes the snapshot ID to delete.
deleteStateSnapshotReturn: Removes the snapshot with the given ID created by snapshot. Takes the snapshot ID to delete.
deleteStateSnapshotsCall: Removes all snapshots previously created by snapshot. Function with signature deleteStateSnapshots() and selector 0xe0933c74.
deleteStateSnapshotsReturn: Removes all snapshots previously created by snapshot. Container type for the return parameters of the deleteStateSnapshots() function.
deployCode_0Call: 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 selector 0x9a8325a0.
deployCode_0Return: 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.
deployCode_1Call: 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.
deployCode_1Return: 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.
deployCode_2Call: 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.
deployCode_2Return: 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.
deployCode_3Call: 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.
deployCode_3Return: 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.
deployCode_4Call: Deploys a contract from an artifact file, using the CREATE2 salt. 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,bytes32) and selector 0x17ab1d79.
deployCode_4Return: Deploys a contract from an artifact file, using the CREATE2 salt. 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,bytes32) function.
deployCode_5Call: Deploys a contract from an artifact file, using the CREATE2 salt. Takes in the relative path to the json file or the path to the artifact in the form of :: where and parts are optional.
deployCode_5Return: Deploys a contract from an artifact file, using the CREATE2 salt. Takes in the relative path to the json file or the path to the artifact in the form of :: where and parts are optional.
deployCode_6Call: Deploys a contract from an artifact file, using the CREATE2 salt. Takes in the relative path to the json file or the path to the artifact in the form of :: where and parts are optional.
deployCode_6Return: Deploys a contract from an artifact file, using the CREATE2 salt. Takes in the relative path to the json file or the path to the artifact in the form of :: where and parts are optional.
deployCode_7Call: Deploys a contract from an artifact file, using the CREATE2 salt. Takes in the relative path to the json file or the path to the artifact in the form of :: where and parts are optional.
deployCode_7Return: Deploys a contract from an artifact file, using the CREATE2 salt. Takes in the relative path to the json file or the path to the artifact in the form of :: where and parts are optional.
deriveKey_0Call: 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 signature deriveKey(string,uint32) and selector 0x6229498b.
deriveKey_0Return: 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 the deriveKey(string,uint32) function.
deriveKey_1Call: Derive a private key from a provided mnenomic string (or mnenomic file path) at {derivationPath}{index}. Function with signature deriveKey(string,string,uint32) and selector 0x6bcb2c1b.
deriveKey_1Return: Derive a private key from a provided mnenomic string (or mnenomic file path) at {derivationPath}{index}. Container type for the return parameters of the deriveKey(string,string,uint32) function.
deriveKey_2Call: 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 signature deriveKey(string,uint32,string) and selector 0x32c8176d.
deriveKey_2Return: 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 the deriveKey(string,uint32,string) function.
deriveKey_3Call: Derive a private key from a provided mnenomic string (or mnenomic file path) in the specified language at {derivationPath}{index}. Function with signature deriveKey(string,string,uint32,string) and selector 0x29233b1f.
deriveKey_3Return: 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 the deriveKey(string,string,uint32,string) function.
difficultyCall: Sets block.difficulty. Not available on EVM versions from Paris onwards. Use prevrandao instead. Reverts if used on unsupported EVM versions. Function with signature difficulty(uint256) and selector 0x46cc92d9.
difficultyReturn: Sets block.difficulty. Not available on EVM versions from Paris onwards. Use prevrandao instead. Reverts if used on unsupported EVM versions. Container type for the return parameters of the difficulty(uint256) function.
dumpStateCall: Dump a genesis JSON file’s allocs to disk. Function with signature dumpState(string) and selector 0x709ecd3f.
dumpStateReturn: Dump a genesis JSON file’s allocs to disk. Container type for the return parameters of the dumpState(string) function.
ensNamehashCall: Returns ENS namehash for provided string. Function with signature ensNamehash(string) and selector 0x8c374c65.
ensNamehashReturn: Returns ENS namehash for provided string. Container type for the return parameters of the ensNamehash(string) function.
envAddress_0Call: Gets the environment variable name and parses it as address. Reverts if the variable was not found or could not be parsed. Function with signature envAddress(string) and selector 0x350d56bf.
envAddress_0Return: Gets the environment variable name and parses it as address. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envAddress(string) function.
envAddress_1Call: Gets the environment variable name and parses it as an array of address, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envAddress(string,string) and selector 0xad31b9fa.
envAddress_1Return: Gets the environment variable name and parses it as an array of address, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envAddress(string,string) function.
envBool_0Call: Gets the environment variable name and parses it as bool. Reverts if the variable was not found or could not be parsed. Function with signature envBool(string) and selector 0x7ed1ec7d.
envBool_0Return: Gets the environment variable name and parses it as bool. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envBool(string) function.
envBool_1Call: Gets the environment variable name and parses it as an array of bool, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envBool(string,string) and selector 0xaaaddeaf.
envBool_1Return: Gets the environment variable name and parses it as an array of bool, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envBool(string,string) function.
envBytes32_0Call: Gets the environment variable name and parses it as bytes32. Reverts if the variable was not found or could not be parsed. Function with signature envBytes32(string) and selector 0x97949042.
envBytes32_0Return: Gets the environment variable name and parses it as bytes32. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envBytes32(string) function.
envBytes32_1Call: Gets the environment variable name and parses it as an array of bytes32, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envBytes32(string,string) and selector 0x5af231c1.
envBytes32_1Return: Gets the environment variable name and parses it as an array of bytes32, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envBytes32(string,string) function.
envBytes_0Call: Gets the environment variable name and parses it as bytes. Reverts if the variable was not found or could not be parsed. Function with signature envBytes(string) and selector 0x4d7baf06.
envBytes_0Return: Gets the environment variable name and parses it as bytes. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envBytes(string) function.
envBytes_1Call: Gets the environment variable name and parses it as an array of bytes, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envBytes(string,string) and selector 0xddc2651b.
envBytes_1Return: Gets the environment variable name and parses it as an array of bytes, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envBytes(string,string) function.
envExistsCall: Gets the environment variable name and returns true if it exists, else returns false. Function with signature envExists(string) and selector 0xce8365f9.
envExistsReturn: Gets the environment variable name and returns true if it exists, else returns false. Container type for the return parameters of the envExists(string) function.
envInt_0Call: Gets the environment variable name and parses it as int256. Reverts if the variable was not found or could not be parsed. Function with signature envInt(string) and selector 0x892a0c61.
envInt_0Return: Gets the environment variable name and parses it as int256. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envInt(string) function.
envInt_1Call: Gets the environment variable name and parses it as an array of int256, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envInt(string,string) and selector 0x42181150.
envInt_1Return: Gets the environment variable name and parses it as an array of int256, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envInt(string,string) function.
envOr_0Call: Gets the environment variable name and parses it as bool. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,bool) and selector 0x4777f3cf.
envOr_0Return: Gets the environment variable name and parses it as bool. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,bool) function.
envOr_1Call: Gets the environment variable name and parses it as uint256. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,uint256) and selector 0x5e97348f.
envOr_1Return: Gets the environment variable name and parses it as uint256. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,uint256) function.
envOr_2Call: Gets the environment variable name and parses it as int256. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,int256) and selector 0xbbcb713e.
envOr_2Return: Gets the environment variable name and parses it as int256. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,int256) function.
envOr_3Call: Gets the environment variable name and parses it as address. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,address) and selector 0x561fe540.
envOr_3Return: Gets the environment variable name and parses it as address. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,address) function.
envOr_4Call: Gets the environment variable name and parses it as bytes32. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,bytes32) and selector 0xb4a85892.
envOr_4Return: Gets the environment variable name and parses it as bytes32. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,bytes32) function.
envOr_5Call: Gets the environment variable name and parses it as string. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string) and selector 0xd145736c.
envOr_5Return: Gets the environment variable name and parses it as string. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string) function.
envOr_6Call: Gets the environment variable name and parses it as bytes. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,bytes) and selector 0xb3e47705.
envOr_6Return: Gets the environment variable name and parses it as bytes. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,bytes) function.
envOr_7Call: Gets the environment variable name and parses it as an array of bool, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,bool[]) and selector 0xeb85e83b.
envOr_7Return: Gets the environment variable name and parses it as an array of bool, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,bool[]) function.
envOr_8Call: Gets the environment variable name and parses it as an array of uint256, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,uint256[]) and selector 0x74318528.
envOr_8Return: Gets the environment variable name and parses it as an array of uint256, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,uint256[]) function.
envOr_9Call: Gets the environment variable name and parses it as an array of int256, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,int256[]) and selector 0x4700d74b.
envOr_9Return: Gets the environment variable name and parses it as an array of int256, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,int256[]) function.
envOr_10Call: Gets the environment variable name and parses it as an array of address, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,address[]) and selector 0xc74e9deb.
envOr_10Return: Gets the environment variable name and parses it as an array of address, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,address[]) function.
envOr_11Call: Gets the environment variable name and parses it as an array of bytes32, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,bytes32[]) and selector 0x2281f367.
envOr_11Return: Gets the environment variable name and parses it as an array of bytes32, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,bytes32[]) function.
envOr_12Call: Gets the environment variable name and parses it as an array of string, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,string[]) and selector 0x859216bc.
envOr_12Return: Gets the environment variable name and parses it as an array of string, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,string[]) function.
envOr_13Call: Gets the environment variable name and parses it as an array of bytes, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Function with signature envOr(string,string,bytes[]) and selector 0x64bc3e64.
envOr_13Return: Gets the environment variable name and parses it as an array of bytes, delimited by delim. Reverts if the variable could not be parsed. Returns defaultValue if the variable was not found. Container type for the return parameters of the envOr(string,string,bytes[]) function.
envString_0Call: Gets the environment variable name and parses it as string. Reverts if the variable was not found or could not be parsed. Function with signature envString(string) and selector 0xf877cb19.
envString_0Return: Gets the environment variable name and parses it as string. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envString(string) function.
envString_1Call: Gets the environment variable name and parses it as an array of string, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envString(string,string) and selector 0x14b02bc9.
envString_1Return: Gets the environment variable name and parses it as an array of string, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envString(string,string) function.
envUint_0Call: Gets the environment variable name and parses it as uint256. Reverts if the variable was not found or could not be parsed. Function with signature envUint(string) and selector 0xc1978d1f.
envUint_0Return: Gets the environment variable name and parses it as uint256. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envUint(string) function.
envUint_1Call: Gets the environment variable name and parses it as an array of uint256, delimited by delim. Reverts if the variable was not found or could not be parsed. Function with signature envUint(string,string) and selector 0xf3dec099.
envUint_1Return: Gets the environment variable name and parses it as an array of uint256, delimited by delim. Reverts if the variable was not found or could not be parsed. Container type for the return parameters of the envUint(string,string) function.
etchCall: Sets an address’ code. Function with signature etch(address,bytes) and selector 0xb4d6c782.
etchReturn: Sets an address’ code. Container type for the return parameters of the etch(address,bytes) function.
eth_getLogsCall: Gets all the logs according to specified filter. Function with signature eth_getLogs(uint256,uint256,address,bytes32[]) and selector 0x35e1349b.
eth_getLogsReturn: Gets all the logs according to specified filter. Container type for the return parameters of the eth_getLogs(uint256,uint256,address,bytes32[]) function.
existsCall: Returns true if the given path points to an existing entity, else returns false. Function with signature exists(string) and selector 0x261a323e.
existsReturn: 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.
expectCallMinGas_0Call: Expect a call to an address with the specified msg.value and calldata, and a minimum amount of gas. Function with signature expectCallMinGas(address,uint256,uint64,bytes) and selector 0x08e4e116.
expectCallMinGas_0Return: 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 the expectCallMinGas(address,uint256,uint64,bytes) function.
expectCallMinGas_1Call: Expect given number of calls to an address with the specified msg.value and calldata, and a minimum amount of gas. Function with signature expectCallMinGas(address,uint256,uint64,bytes,uint64) and selector 0xe13a1834.
expectCallMinGas_1Return: 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 the expectCallMinGas(address,uint256,uint64,bytes,uint64) function.
expectCall_0Call: 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 selector 0xbd6af434.
expectCall_0Return: 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.
expectCall_1Call: Expects given number of calls to an address with the specified calldata. Function with signature expectCall(address,bytes,uint64) and selector 0xc1adbbff.
expectCall_1Return: 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.
expectCall_2Call: Expects a call to an address with the specified msg.value and calldata. Function with signature expectCall(address,uint256,bytes) and selector 0xf30c7ba3.
expectCall_2Return: Expects a call to an address with the specified msg.value and calldata. Container type for the return parameters of the expectCall(address,uint256,bytes) function.
expectCall_3Call: Expects given number of calls to an address with the specified msg.value and calldata. Function with signature expectCall(address,uint256,bytes,uint64) and selector 0xa2b1a1ae.
expectCall_3Return: Expects given number of calls to an address with the specified msg.value and calldata. Container type for the return parameters of the expectCall(address,uint256,bytes,uint64) function.
expectCall_4Call: Expect a call to an address with the specified msg.value, gas, and calldata. Function with signature expectCall(address,uint256,uint64,bytes) and selector 0x23361207.
expectCall_4Return: Expect a call to an address with the specified msg.value, gas, and calldata. Container type for the return parameters of the expectCall(address,uint256,uint64,bytes) function.
expectCall_5Call: Expects given number of calls to an address with the specified msg.value, gas, and calldata. Function with signature expectCall(address,uint256,uint64,bytes,uint64) and selector 0x65b7b7cc.
expectCall_5Return: Expects given number of calls to an address with the specified msg.value, gas, and calldata. Container type for the return parameters of the expectCall(address,uint256,uint64,bytes,uint64) function.
expectCreate2Call: Expects the deployment of the specified bytecode by the specified address using the CREATE2 opcode Function with signature expectCreate2(bytes,address) and selector 0xea54a472.
expectCreate2Return: Expects the deployment of the specified bytecode by the specified address using the CREATE2 opcode Container type for the return parameters of the expectCreate2(bytes,address) function.
expectCreateCall: Expects the deployment of the specified bytecode by the specified address using the CREATE opcode Function with signature expectCreate(bytes,address) and selector 0x73cdce36.
expectCreateReturn: Expects the deployment of the specified bytecode by the specified address using the CREATE opcode Container type for the return parameters of the expectCreate(bytes,address) function.
expectEmitAnonymous_0Call: 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 selector 0xc948db5e.
expectEmitAnonymous_0Return: 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.
expectEmitAnonymous_1Call: Same as the previous method, but also checks supplied address against emitting contract. Function with signature expectEmitAnonymous(bool,bool,bool,bool,bool,address) and selector 0x71c95899.
expectEmitAnonymous_1Return: 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.
expectEmitAnonymous_2Call: 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 selector 0x2e5f270c.
expectEmitAnonymous_2Return: 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.
expectEmitAnonymous_3Call: Same as the previous method, but also checks supplied address against emitting contract. Function with signature expectEmitAnonymous(address) and selector 0x6fc68705.
expectEmitAnonymous_3Return: Same as the previous method, but also checks supplied address against emitting contract. Container type for the return parameters of the expectEmitAnonymous(address) function.
expectEmit_0Call: 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 selector 0x491cc7c2.
expectEmit_0Return: 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.
expectEmit_1Call: Same as the previous method, but also checks supplied address against emitting contract. Function with signature expectEmit(bool,bool,bool,bool,address) and selector 0x81bad6f3.
expectEmit_1Return: 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.
expectEmit_2Call: 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 selector 0x440ed10d.
expectEmit_2Return: 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.
expectEmit_3Call: Same as the previous method, but also checks supplied address against emitting contract. Function with signature expectEmit(address) and selector 0x86b9620d.
expectEmit_3Return: Same as the previous method, but also checks supplied address against emitting contract. Container type for the return parameters of the expectEmit(address) function.
expectEmit_4Call: Expect a given number of logs with the provided topics. Function with signature expectEmit(bool,bool,bool,bool,uint64) and selector 0x5e1d1c33.
expectEmit_4Return: Expect a given number of logs with the provided topics. Container type for the return parameters of the expectEmit(bool,bool,bool,bool,uint64) function.
expectEmit_5Call: Expect a given number of logs from a specific emitter with the provided topics. Function with signature expectEmit(bool,bool,bool,bool,address,uint64) and selector 0xc339d02c.
expectEmit_5Return: Expect a given number of logs from a specific emitter with the provided topics. Container type for the return parameters of the expectEmit(bool,bool,bool,bool,address,uint64) function.
expectEmit_6Call: Expect a given number of logs with all topic and data checks enabled. Function with signature expectEmit(uint64) and selector 0x4c74a335.
expectEmit_6Return: Expect a given number of logs with all topic and data checks enabled. Container type for the return parameters of the expectEmit(uint64) function.
expectEmit_7Call: Expect a given number of logs from a specific emitter with all topic and data checks enabled. Function with signature expectEmit(address,uint64) and selector 0xb43aece3.
expectEmit_7Return: Expect a given number of logs from a specific emitter with all topic and data checks enabled. Container type for the return parameters of the expectEmit(address,uint64) function.
expectPartialRevert_0Call: Expects an error on next call that starts with the revert data. Function with signature expectPartialRevert(bytes4) and selector 0x11fb5b9c.
expectPartialRevert_0Return: Expects an error on next call that starts with the revert data. Container type for the return parameters of the expectPartialRevert(bytes4) function.
expectPartialRevert_1Call: Expects an error on next call to reverter address, that starts with the revert data. Function with signature expectPartialRevert(bytes4,address) and selector 0x51aa008a.
expectPartialRevert_1Return: 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.
expectRevert_0Call: Expects an error on next call with any revert data. Function with signature expectRevert() and selector 0xf4844814.
expectRevert_0Return: Expects an error on next call with any revert data. Container type for the return parameters of the expectRevert() function.
expectRevert_1Call: Expects an error on next call that exactly matches the revert data. Function with signature expectRevert(bytes4) and selector 0xc31eb0e0.
expectRevert_1Return: Expects an error on next call that exactly matches the revert data. Container type for the return parameters of the expectRevert(bytes4) function.
expectRevert_2Call: Expects an error on next call that exactly matches the revert data. Function with signature expectRevert(bytes) and selector 0xf28dceb3.
expectRevert_2Return: Expects an error on next call that exactly matches the revert data. Container type for the return parameters of the expectRevert(bytes) function.
expectRevert_3Call: Expects an error with any revert data on next call to reverter address. Function with signature expectRevert(address) and selector 0xd814f38a.
expectRevert_3Return: Expects an error with any revert data on next call to reverter address. Container type for the return parameters of the expectRevert(address) function.
expectRevert_4Call: Expects an error from reverter address on next call, with any revert data. Function with signature expectRevert(bytes4,address) and selector 0x260bc5de.
expectRevert_4Return: 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.
expectRevert_5Call: Expects an error from reverter address on next call, that exactly matches the revert data. Function with signature expectRevert(bytes,address) and selector 0x61ebcf12.
expectRevert_5Return: 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.
expectRevert_6Call: Expects a count number of reverts from the upcoming calls with any revert data or reverter. Function with signature expectRevert(uint64) and selector 0x4ee38244.
expectRevert_6Return: Expects a count number of reverts from the upcoming calls with any revert data or reverter. Container type for the return parameters of the expectRevert(uint64) function.
expectRevert_7Call: Expects a count number of reverts from the upcoming calls that match the revert data. Function with signature expectRevert(bytes4,uint64) and selector 0xe45ca72d.
expectRevert_7Return: Expects a count number of reverts from the upcoming calls that match the revert data. Container type for the return parameters of the expectRevert(bytes4,uint64) function.
expectRevert_8Call: Expects a count number of reverts from the upcoming calls that exactly match the revert data. Function with signature expectRevert(bytes,uint64) and selector 0x4994c273.
expectRevert_8Return: Expects a count number of reverts from the upcoming calls that exactly match the revert data. Container type for the return parameters of the expectRevert(bytes,uint64) function.
expectRevert_9Call: Expects a count number of reverts from the upcoming calls from the reverter address. Function with signature expectRevert(address,uint64) and selector 0x1ff5f952.
expectRevert_9Return: Expects a count number of reverts from the upcoming calls from the reverter address. Container type for the return parameters of the expectRevert(address,uint64) function.
expectRevert_10Call: Expects a count number of reverts from the upcoming calls from the reverter address that match the revert data. Function with signature expectRevert(bytes4,address,uint64) and selector 0xb0762d73.
expectRevert_10Return: Expects a count number of reverts from the upcoming calls from the reverter address that match the revert data. Container type for the return parameters of the expectRevert(bytes4,address,uint64) function.
expectRevert_11Call: Expects a count number of reverts from the upcoming calls from the reverter address that exactly match the revert data. Function with signature expectRevert(bytes,address,uint64) and selector 0xd345fb1f.
expectRevert_11Return: Expects a count number of reverts from the upcoming calls from the reverter address that exactly match the revert data. Container type for the return parameters of the expectRevert(bytes,address,uint64) function.
expectSafeMemoryCall: 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 selector 0x6d016688.
expectSafeMemoryCallCall: 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 selector 0x05838bf4.
expectSafeMemoryCallReturn: 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.
expectSafeMemoryReturn: 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.
feeCall: Sets block.basefee. Function with signature fee(uint256) and selector 0x39b37ab0.
feeReturn: Sets block.basefee. Container type for the return parameters of the fee(uint256) function.
ffiCall: Performs a foreign function call via the terminal. Function with signature ffi(string[]) and selector 0x89160467.
ffiReturn: Performs a foreign function call via the terminal. Container type for the return parameters of the ffi(string[]) function.
foundryVersionAtLeastCall: Returns true if the current Foundry version is greater than or equal to the given version. The given version string must be in the format major.minor.patch.
foundryVersionAtLeastReturn: Returns true if the current Foundry version is greater than or equal to the given version. The given version string must be in the format major.minor.patch.
foundryVersionCmpCall: Compares the current Foundry version with the given version string. The given version string must be in the format major.minor.patch.
foundryVersionCmpReturn: Compares the current Foundry version with the given version string. The given version string must be in the format major.minor.patch.
fsMetadataCall: Given a path, query the file system to get information about a file, directory, etc. Function with signature fsMetadata(string) and selector 0xaf368a08.
fsMetadataReturn: 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.
getArtifactPathByCodeCall: Gets the artifact path from code (aka. creation code). Function with signature getArtifactPathByCode(bytes) and selector 0xeb74848c.
getArtifactPathByCodeReturn: Gets the artifact path from code (aka. creation code). Container type for the return parameters of the getArtifactPathByCode(bytes) function.
getArtifactPathByDeployedCodeCall: Gets the artifact path from deployed code (aka. runtime code). Function with signature getArtifactPathByDeployedCode(bytes) and selector 0x6d853ba5.
getArtifactPathByDeployedCodeReturn: Gets the artifact path from deployed code (aka. runtime code). Container type for the return parameters of the getArtifactPathByDeployedCode(bytes) function.
getBlobBaseFeeCall: Gets the current block.blobbasefee. You should use this instead of block.blobbasefee if you use vm.blobBaseFee, as block.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 signature getBlobBaseFee() and selector 0x1f6d6ef7.
getBlobBaseFeeReturn: Gets the current block.blobbasefee. You should use this instead of block.blobbasefee if you use vm.blobBaseFee, as block.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 the getBlobBaseFee() function.
getBlobhashesCall: 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 selector 0xf56ff18b.
getBlobhashesReturn: 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.
getBlockNumberCall: Gets the current block.number. You should use this instead of block.number if you use vm.roll, as block.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 signature getBlockNumber() and selector 0x42cbb15c.
getBlockNumberReturn: Gets the current block.number. You should use this instead of block.number if you use vm.roll, as block.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 the getBlockNumber() function.
getBlockTimestampCall: Gets the current block.timestamp. You should use this instead of block.timestamp if you use vm.warp, as block.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 signature getBlockTimestamp() and selector 0x796b89b9.
getBlockTimestampReturn: Gets the current block.timestamp. You should use this instead of block.timestamp if you use vm.warp, as block.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 the getBlockTimestamp() function.
getBroadcastCall: Returns the most recent broadcast for the given contract on chainId matching txType.
getBroadcastReturn: Returns the most recent broadcast for the given contract on chainId matching txType.
getBroadcasts_0Call: Returns all broadcasts for the given contract on chainId with the specified txType.
getBroadcasts_0Return: Returns all broadcasts for the given contract on chainId with the specified txType.
getBroadcasts_1Call: Returns all broadcasts for the given contract on chainId.
getBroadcasts_1Return: Returns all broadcasts for the given contract on chainId.
getCodeCall: 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 selector 0x8d1cc925.
getCodeReturn: 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.
getDeployedCodeCall: 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 selector 0x3ebf73b4.
getDeployedCodeReturn: 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.
getDeployment_0Call: Returns the most recent deployment for the current chainId. Function with signature getDeployment(string) and selector 0xa8091d97.
getDeployment_0Return: Returns the most recent deployment for the current chainId. Container type for the return parameters of the getDeployment(string) function.
getDeployment_1Call: Returns the most recent deployment for the given contract on chainId Function with signature getDeployment(string,uint64) and selector 0x0debd5d6.
getDeployment_1Return: Returns the most recent deployment for the given contract on chainId Container type for the return parameters of the getDeployment(string,uint64) function.
getDeploymentsCall: Returns all deployments for the given contract on chainId
getDeploymentsReturn: Returns all deployments for the given contract on chainId
getFoundryVersionCall: Returns the Foundry version. Format: <cargo_version>-+<git_sha_short>.<unix_build_timestamp>. Sample output: 0.3.0-nightly+3cb96bde9b.1737036656.debug Note: Build timestamps may vary slightly across platforms due to separate CI jobs. For reliable version comparisons, use UNIX format (e.g., >= 1700000000) to compare timestamps while ignoring minor time differences. Function with signature getFoundryVersion() and selector 0xea991bb5.
getFoundryVersionReturn: Returns the Foundry version. Format: <cargo_version>-+<git_sha_short>.<unix_build_timestamp>. Sample output: 0.3.0-nightly+3cb96bde9b.1737036656.debug Note: Build timestamps may vary slightly across platforms due to separate CI jobs. For reliable version comparisons, use UNIX format (e.g., >= 1700000000) to compare timestamps while ignoring minor time differences. Container type for the return parameters of the getFoundryVersion() function.
getLabelCall: Gets the label for the specified address. Function with signature getLabel(address) and selector 0x28a249b0.
getLabelReturn: Gets the label for the specified address. Container type for the return parameters of the getLabel(address) function.
getMappingKeyAndParentOfCall: Gets the map key and parent of a mapping at a given slot, for a given address. Function with signature getMappingKeyAndParentOf(address,bytes32) and selector 0x876e24e6.
getMappingKeyAndParentOfReturn: 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.
getMappingLengthCall: Gets the number of elements in the mapping at the given slot, for a given address. Function with signature getMappingLength(address,bytes32) and selector 0x2f2fd63f.
getMappingLengthReturn: 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.
getMappingSlotAtCall: 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 selector 0xebc73ab4.
getMappingSlotAtReturn: 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.
getNonce_0Call: Gets the nonce of an account. Function with signature getNonce(address) and selector 0x2d0335ab.
getNonce_0Return: Gets the nonce of an account. Container type for the return parameters of the getNonce(address) function.
getNonce_1Call: Get the nonce of a Wallet. Function with signature getNonce((address,uint256,uint256,uint256)) and selector 0xa5748aad.
getNonce_1Return: Get the nonce of a Wallet. Container type for the return parameters of the getNonce((address,uint256,uint256,uint256)) function.
getRecordedLogsCall: Gets all the recorded logs. Function with signature getRecordedLogs() and selector 0x191553a4.
getRecordedLogsReturn: Gets all the recorded logs. Container type for the return parameters of the getRecordedLogs() function.
getStateDiffCall: Returns state diffs from current vm.startStateDiffRecording session. Function with signature getStateDiff() and selector 0x80df01cc.
getStateDiffJsonCall: Returns state diffs from current vm.startStateDiffRecording session, in json format. Function with signature getStateDiffJson() and selector 0xf54fe009.
getStateDiffJsonReturn: Returns state diffs from current vm.startStateDiffRecording session, in json format. Container type for the return parameters of the getStateDiffJson() function.
getStateDiffReturn: Returns state diffs from current vm.startStateDiffRecording session. Container type for the return parameters of the getStateDiff() function.
getWalletsCall: Returns addresses of available unlocked wallets in the script environment. Function with signature getWallets() and selector 0xdb7a4605.
getWalletsReturn: Returns addresses of available unlocked wallets in the script environment. Container type for the return parameters of the getWallets() function.
indexOfCall: Returns the index of the first occurrence of a key in an input string. Returns NOT_FOUND (i.e. type(uint256).max) if the key is not found. Returns 0 in case of an empty key. Function with signature indexOf(string,string) and selector 0x8a0807b7.
indexOfReturn: Returns the index of the first occurrence of a key in an input string. Returns NOT_FOUND (i.e. type(uint256).max) if the key is not found. Returns 0 in case of an empty key. Container type for the return parameters of the indexOf(string,string) function.
interceptInitcodeCall: Causes the next contract creation (via new) to fail and return its initcode in the returndata buffer. This allows type-safe access to the initcode payload that would be used for contract creation. Example usage: vm.interceptInitcode(); bytes memory initcode; try new MyContract(param1, param2) { assert(false); } catch (bytes memory interceptedInitcode) { initcode = interceptedInitcode; } Function with signature interceptInitcode() and selector 0x838653c7.
interceptInitcodeReturn: Causes the next contract creation (via new) to fail and return its initcode in the returndata buffer. This allows type-safe access to the initcode payload that would be used for contract creation. Example usage: vm.interceptInitcode(); bytes memory initcode; try new MyContract(param1, param2) { assert(false); } catch (bytes memory interceptedInitcode) { initcode = interceptedInitcode; } Container type for the return parameters of the interceptInitcode() function.
isContextCall: Returns true if forge command was executed in given context. Function with signature isContext(uint8) and selector 0x64af255d.
isContextReturn: Returns true if forge command was executed in given context. Container type for the return parameters of the isContext(uint8) function.
isDirCall: Returns true if the path exists on disk and is pointing at a directory, else returns false. Function with signature isDir(string) and selector 0x7d15d019.
isDirReturn: 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.
isFileCall: Returns true if the path exists on disk and is pointing at a regular file, else returns false. Function with signature isFile(string) and selector 0xe0eb04d4.
isFileReturn: 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.
isPersistentCall: Returns true if the account is marked as persistent. Function with signature isPersistent(address) and selector 0xd92d8efd.
isPersistentReturn: Returns true if the account is marked as persistent. Container type for the return parameters of the isPersistent(address) function.
keyExistsCall: Checks if key exists in a JSON object keyExists is being deprecated in favor of keyExistsJson. It will be removed in future versions. Function with signature keyExists(string,string) and selector 0x528a683c.
keyExistsJsonCall: Checks if key exists in a JSON object. Function with signature keyExistsJson(string,string) and selector 0xdb4235f6.
keyExistsJsonReturn: Checks if key exists in a JSON object. Container type for the return parameters of the keyExistsJson(string,string) function.
keyExistsReturn: Checks if key exists in a JSON object keyExists is being deprecated in favor of keyExistsJson. It will be removed in future versions. Container type for the return parameters of the keyExists(string,string) function.
keyExistsTomlCall: Checks if key exists in a TOML table. Function with signature keyExistsToml(string,string) and selector 0x600903ad.
keyExistsTomlReturn: Checks if key exists in a TOML table. Container type for the return parameters of the keyExistsToml(string,string) function.
labelCall: Labels an address in call traces. Function with signature label(address,string) and selector 0xc657c718.
labelReturn: Labels an address in call traces. Container type for the return parameters of the label(address,string) function.
lastCallGasCall: Gets the gas used in the last call from the callee perspective. Function with signature lastCallGas() and selector 0x2b589b28.
lastCallGasReturn: Gets the gas used in the last call from the callee perspective. Container type for the return parameters of the lastCallGas() function.
loadAllocsCall: Load a genesis JSON file’s allocs into the in-memory EVM state. Function with signature loadAllocs(string) and selector 0xb3a056d7.
loadAllocsReturn: Load a genesis JSON file’s allocs into the in-memory EVM state. Container type for the return parameters of the loadAllocs(string) function.
loadCall: Loads a storage slot from an address. Function with signature load(address,bytes32) and selector 0x667f9d70.
loadReturn: Loads a storage slot from an address. Container type for the return parameters of the load(address,bytes32) function.
makePersistent_0Call: 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 selector 0x57e22dde.
makePersistent_0Return: 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.
makePersistent_1Call: See makePersistent(address). Function with signature makePersistent(address,address) and selector 0x4074e0a8.
makePersistent_1Return: See makePersistent(address). Container type for the return parameters of the makePersistent(address,address) function.
makePersistent_2Call: See makePersistent(address). Function with signature makePersistent(address,address,address) and selector 0xefb77a75.
makePersistent_2Return: See makePersistent(address). Container type for the return parameters of the makePersistent(address,address,address) function.
makePersistent_3Call: See makePersistent(address). Function with signature makePersistent(address[]) and selector 0x1d9e269e.
makePersistent_3Return: See makePersistent(address). Container type for the return parameters of the makePersistent(address[]) function.
mockCallRevert_0Call: Reverts a call to an address with specified revert data. Function with signature mockCallRevert(address,bytes,bytes) and selector 0xdbaad147.
mockCallRevert_0Return: Reverts a call to an address with specified revert data. Container type for the return parameters of the mockCallRevert(address,bytes,bytes) function.
mockCallRevert_1Call: Reverts a call to an address with a specific msg.value, with specified revert data. Function with signature mockCallRevert(address,uint256,bytes,bytes) and selector 0xd23cd037.
mockCallRevert_1Return: Reverts a call to an address with a specific msg.value, with specified revert data. Container type for the return parameters of the mockCallRevert(address,uint256,bytes,bytes) function.
mockCallRevert_2Call: Reverts a call to an address with specified revert data.
mockCallRevert_2Return: Reverts a call to an address with specified revert data.
mockCallRevert_3Call: Reverts a call to an address with a specific msg.value, with specified revert data.
mockCallRevert_3Return: Reverts a call to an address with a specific msg.value, with specified revert data.
mockCall_0Call: 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 selector 0xb96213e4.
mockCall_0Return: 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.
mockCall_1Call: Mocks a call to an address with a specific msg.value, returning specified data. Calldata match takes precedence over msg.value in case of ambiguity. Function with signature mockCall(address,uint256,bytes,bytes) and selector 0x81409b91.
mockCall_1Return: Mocks a call to an address with a specific msg.value, returning specified data. Calldata match takes precedence over msg.value in case of ambiguity. Container type for the return parameters of the mockCall(address,uint256,bytes,bytes) function.
mockCall_2Call: 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.
mockCall_2Return: 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.
mockCall_3Call: Mocks a call to an address with a specific msg.value, returning specified data. Calldata match takes precedence over msg.value in case of ambiguity.
mockCall_3Return: Mocks a call to an address with a specific msg.value, returning specified data. Calldata match takes precedence over msg.value in case of ambiguity.
mockCalls_0Call: Mocks multiple calls to an address, returning specified data for each call. Function with signature mockCalls(address,bytes,bytes[]) and selector 0x5c5c3de9.
mockCalls_0Return: 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.
mockCalls_1Call: Mocks multiple calls to an address with a specific msg.value, returning specified data for each call. Function with signature mockCalls(address,uint256,bytes,bytes[]) and selector 0x08bcbae1.
mockCalls_1Return: Mocks multiple calls to an address with a specific msg.value, returning specified data for each call. Container type for the return parameters of the mockCalls(address,uint256,bytes,bytes[]) function.
mockFunctionCall: Whenever a call is made to callee with calldata data, this cheatcode instead calls target with the same calldata. This functionality is similar to a delegate call made to target contract from callee. 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 signature mockFunction(address,address,bytes) and selector 0xadf84d21.
mockFunctionReturn: Whenever a call is made to callee with calldata data, this cheatcode instead calls target with the same calldata. This functionality is similar to a delegate call made to target contract from callee. 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 the mockFunction(address,address,bytes) function.
noAccessListCall: Utility cheatcode to remove any EIP-2930 access list set by accessList cheatcode. Function with signature noAccessList() and selector 0x238ad778.
noAccessListReturn: Utility cheatcode to remove any EIP-2930 access list set by accessList cheatcode. Container type for the return parameters of the noAccessList() function.
parseAddressCall: Parses the given string into an address. Function with signature parseAddress(string) and selector 0xc6ce059d.
parseAddressReturn: Parses the given string into an address. Container type for the return parameters of the parseAddress(string) function.
parseBoolCall: Parses the given string into a bool. Function with signature parseBool(string) and selector 0x974ef924.
parseBoolReturn: Parses the given string into a bool. Container type for the return parameters of the parseBool(string) function.
parseBytes32Call: Parses the given string into a bytes32. Function with signature parseBytes32(string) and selector 0x087e6e81.
parseBytes32Return: Parses the given string into a bytes32. Container type for the return parameters of the parseBytes32(string) function.
parseBytesCall: Parses the given string into bytes. Function with signature parseBytes(string) and selector 0x8f5d232d.
parseBytesReturn: Parses the given string into bytes. Container type for the return parameters of the parseBytes(string) function.
parseIntCall: Parses the given string into a int256. Function with signature parseInt(string) and selector 0x42346c5e.
parseIntReturn: Parses the given string into a int256. Container type for the return parameters of the parseInt(string) function.
parseJsonAddressArrayCall: Parses a string of JSON data at key and coerces it to address[]. Function with signature parseJsonAddressArray(string,string) and selector 0x2fce7883.
parseJsonAddressArrayReturn: Parses a string of JSON data at key and coerces it to address[]. Container type for the return parameters of the parseJsonAddressArray(string,string) function.
parseJsonAddressCall: Parses a string of JSON data at key and coerces it to address. Function with signature parseJsonAddress(string,string) and selector 0x1e19e657.
parseJsonAddressReturn: Parses a string of JSON data at key and coerces it to address. Container type for the return parameters of the parseJsonAddress(string,string) function.
parseJsonBoolArrayCall: Parses a string of JSON data at key and coerces it to bool[]. Function with signature parseJsonBoolArray(string,string) and selector 0x91f3b94f.
parseJsonBoolArrayReturn: Parses a string of JSON data at key and coerces it to bool[]. Container type for the return parameters of the parseJsonBoolArray(string,string) function.
parseJsonBoolCall: Parses a string of JSON data at key and coerces it to bool. Function with signature parseJsonBool(string,string) and selector 0x9f86dc91.
parseJsonBoolReturn: Parses a string of JSON data at key and coerces it to bool. Container type for the return parameters of the parseJsonBool(string,string) function.
parseJsonBytes32ArrayCall: Parses a string of JSON data at key and coerces it to bytes32[]. Function with signature parseJsonBytes32Array(string,string) and selector 0x91c75bc3.
parseJsonBytes32ArrayReturn: Parses a string of JSON data at key and coerces it to bytes32[]. Container type for the return parameters of the parseJsonBytes32Array(string,string) function.
parseJsonBytes32Call: Parses a string of JSON data at key and coerces it to bytes32. Function with signature parseJsonBytes32(string,string) and selector 0x1777e59d.
parseJsonBytes32Return: Parses a string of JSON data at key and coerces it to bytes32. Container type for the return parameters of the parseJsonBytes32(string,string) function.
parseJsonBytesArrayCall: Parses a string of JSON data at key and coerces it to bytes[]. Function with signature parseJsonBytesArray(string,string) and selector 0x6631aa99.
parseJsonBytesArrayReturn: Parses a string of JSON data at key and coerces it to bytes[]. Container type for the return parameters of the parseJsonBytesArray(string,string) function.
parseJsonBytesCall: Parses a string of JSON data at key and coerces it to bytes. Function with signature parseJsonBytes(string,string) and selector 0xfd921be8.
parseJsonBytesReturn: Parses a string of JSON data at key and coerces it to bytes. Container type for the return parameters of the parseJsonBytes(string,string) function.
parseJsonIntArrayCall: Parses a string of JSON data at key and coerces it to int256[]. Function with signature parseJsonIntArray(string,string) and selector 0x9983c28a.
parseJsonIntArrayReturn: Parses a string of JSON data at key and coerces it to int256[]. Container type for the return parameters of the parseJsonIntArray(string,string) function.
parseJsonIntCall: Parses a string of JSON data at key and coerces it to int256. Function with signature parseJsonInt(string,string) and selector 0x7b048ccd.
parseJsonIntReturn: Parses a string of JSON data at key and coerces it to int256. Container type for the return parameters of the parseJsonInt(string,string) function.
parseJsonKeysCall: Returns an array of all the keys in a JSON object. Function with signature parseJsonKeys(string,string) and selector 0x213e4198.
parseJsonKeysReturn: Returns an array of all the keys in a JSON object. Container type for the return parameters of the parseJsonKeys(string,string) function.
parseJsonStringArrayCall: Parses a string of JSON data at key and coerces it to string[]. Function with signature parseJsonStringArray(string,string) and selector 0x498fdcf4.
parseJsonStringArrayReturn: Parses a string of JSON data at key and coerces it to string[]. Container type for the return parameters of the parseJsonStringArray(string,string) function.
parseJsonStringCall: Parses a string of JSON data at key and coerces it to string. Function with signature parseJsonString(string,string) and selector 0x49c4fac8.
parseJsonStringReturn: Parses a string of JSON data at key and coerces it to string. Container type for the return parameters of the parseJsonString(string,string) function.
parseJsonTypeArrayCall: Parses a string of JSON data at key and coerces it to type array corresponding to typeDescription. Function with signature parseJsonTypeArray(string,string,string) and selector 0x0175d535.
parseJsonTypeArrayReturn: Parses a string of JSON data at key and coerces it to type array corresponding to typeDescription. Container type for the return parameters of the parseJsonTypeArray(string,string,string) function.
parseJsonType_0Call: Parses a string of JSON data and coerces it to type corresponding to typeDescription. Function with signature parseJsonType(string,string) and selector 0xa9da313b.
parseJsonType_0Return: Parses a string of JSON data and coerces it to type corresponding to typeDescription. Container type for the return parameters of the parseJsonType(string,string) function.
parseJsonType_1Call: Parses a string of JSON data at key and coerces it to type corresponding to typeDescription. Function with signature parseJsonType(string,string,string) and selector 0xe3f5ae33.
parseJsonType_1Return: Parses a string of JSON data at key and coerces it to type corresponding to typeDescription. Container type for the return parameters of the parseJsonType(string,string,string) function.
parseJsonUintArrayCall: Parses a string of JSON data at key and coerces it to uint256[]. Function with signature parseJsonUintArray(string,string) and selector 0x522074ab.
parseJsonUintArrayReturn: Parses a string of JSON data at key and coerces it to uint256[]. Container type for the return parameters of the parseJsonUintArray(string,string) function.
parseJsonUintCall: Parses a string of JSON data at key and coerces it to uint256. Function with signature parseJsonUint(string,string) and selector 0xaddde2b6.
parseJsonUintReturn: Parses a string of JSON data at key and coerces it to uint256. Container type for the return parameters of the parseJsonUint(string,string) function.
parseJson_0Call: ABI-encodes a JSON object. Function with signature parseJson(string) and selector 0x6a82600a.
parseJson_0Return: ABI-encodes a JSON object. Container type for the return parameters of the parseJson(string) function.
parseJson_1Call: ABI-encodes a JSON object at key. Function with signature parseJson(string,string) and selector 0x85940ef1.
parseJson_1Return: ABI-encodes a JSON object at key. Container type for the return parameters of the parseJson(string,string) function.
parseTomlAddressArrayCall: Parses a string of TOML data at key and coerces it to address[]. Function with signature parseTomlAddressArray(string,string) and selector 0x65c428e7.
parseTomlAddressArrayReturn: Parses a string of TOML data at key and coerces it to address[]. Container type for the return parameters of the parseTomlAddressArray(string,string) function.
parseTomlAddressCall: Parses a string of TOML data at key and coerces it to address. Function with signature parseTomlAddress(string,string) and selector 0x65e7c844.
parseTomlAddressReturn: Parses a string of TOML data at key and coerces it to address. Container type for the return parameters of the parseTomlAddress(string,string) function.
parseTomlBoolArrayCall: Parses a string of TOML data at key and coerces it to bool[]. Function with signature parseTomlBoolArray(string,string) and selector 0x127cfe9a.
parseTomlBoolArrayReturn: Parses a string of TOML data at key and coerces it to bool[]. Container type for the return parameters of the parseTomlBoolArray(string,string) function.
parseTomlBoolCall: Parses a string of TOML data at key and coerces it to bool. Function with signature parseTomlBool(string,string) and selector 0xd30dced6.
parseTomlBoolReturn: Parses a string of TOML data at key and coerces it to bool. Container type for the return parameters of the parseTomlBool(string,string) function.
parseTomlBytes32ArrayCall: Parses a string of TOML data at key and coerces it to bytes32[]. Function with signature parseTomlBytes32Array(string,string) and selector 0x3e716f81.
parseTomlBytes32ArrayReturn: Parses a string of TOML data at key and coerces it to bytes32[]. Container type for the return parameters of the parseTomlBytes32Array(string,string) function.
parseTomlBytes32Call: Parses a string of TOML data at key and coerces it to bytes32. Function with signature parseTomlBytes32(string,string) and selector 0x8e214810.
parseTomlBytes32Return: Parses a string of TOML data at key and coerces it to bytes32. Container type for the return parameters of the parseTomlBytes32(string,string) function.
parseTomlBytesArrayCall: Parses a string of TOML data at key and coerces it to bytes[]. Function with signature parseTomlBytesArray(string,string) and selector 0xb197c247.
parseTomlBytesArrayReturn: Parses a string of TOML data at key and coerces it to bytes[]. Container type for the return parameters of the parseTomlBytesArray(string,string) function.
parseTomlBytesCall: Parses a string of TOML data at key and coerces it to bytes. Function with signature parseTomlBytes(string,string) and selector 0xd77bfdb9.
parseTomlBytesReturn: Parses a string of TOML data at key and coerces it to bytes. Container type for the return parameters of the parseTomlBytes(string,string) function.
parseTomlIntArrayCall: Parses a string of TOML data at key and coerces it to int256[]. Function with signature parseTomlIntArray(string,string) and selector 0xd3522ae6.
parseTomlIntArrayReturn: Parses a string of TOML data at key and coerces it to int256[]. Container type for the return parameters of the parseTomlIntArray(string,string) function.
parseTomlIntCall: Parses a string of TOML data at key and coerces it to int256. Function with signature parseTomlInt(string,string) and selector 0xc1350739.
parseTomlIntReturn: Parses a string of TOML data at key and coerces it to int256. Container type for the return parameters of the parseTomlInt(string,string) function.
parseTomlKeysCall: Returns an array of all the keys in a TOML table. Function with signature parseTomlKeys(string,string) and selector 0x812a44b2.
parseTomlKeysReturn: Returns an array of all the keys in a TOML table. Container type for the return parameters of the parseTomlKeys(string,string) function.
parseTomlStringArrayCall: Parses a string of TOML data at key and coerces it to string[]. Function with signature parseTomlStringArray(string,string) and selector 0x9f629281.
parseTomlStringArrayReturn: Parses a string of TOML data at key and coerces it to string[]. Container type for the return parameters of the parseTomlStringArray(string,string) function.
parseTomlStringCall: Parses a string of TOML data at key and coerces it to string. Function with signature parseTomlString(string,string) and selector 0x8bb8dd43.
parseTomlStringReturn: Parses a string of TOML data at key and coerces it to string. Container type for the return parameters of the parseTomlString(string,string) function.
parseTomlTypeArrayCall: Parses a string of TOML data at key and coerces it to type array corresponding to typeDescription. Function with signature parseTomlTypeArray(string,string,string) and selector 0x49be3743.
parseTomlTypeArrayReturn: Parses a string of TOML data at key and coerces it to type array corresponding to typeDescription. Container type for the return parameters of the parseTomlTypeArray(string,string,string) function.
parseTomlType_0Call: Parses a string of TOML data and coerces it to type corresponding to typeDescription. Function with signature parseTomlType(string,string) and selector 0x47fa5e11.
parseTomlType_0Return: Parses a string of TOML data and coerces it to type corresponding to typeDescription. Container type for the return parameters of the parseTomlType(string,string) function.
parseTomlType_1Call: Parses a string of TOML data at key and coerces it to type corresponding to typeDescription. Function with signature parseTomlType(string,string,string) and selector 0xf9fa5cdb.
parseTomlType_1Return: Parses a string of TOML data at key and coerces it to type corresponding to typeDescription. Container type for the return parameters of the parseTomlType(string,string,string) function.
parseTomlUintArrayCall: Parses a string of TOML data at key and coerces it to uint256[]. Function with signature parseTomlUintArray(string,string) and selector 0xb5df27c8.
parseTomlUintArrayReturn: Parses a string of TOML data at key and coerces it to uint256[]. Container type for the return parameters of the parseTomlUintArray(string,string) function.
parseTomlUintCall: Parses a string of TOML data at key and coerces it to uint256. Function with signature parseTomlUint(string,string) and selector 0xcc7b0487.
parseTomlUintReturn: Parses a string of TOML data at key and coerces it to uint256. Container type for the return parameters of the parseTomlUint(string,string) function.
parseToml_0Call: ABI-encodes a TOML table. Function with signature parseToml(string) and selector 0x592151f0.
parseToml_0Return: ABI-encodes a TOML table. Container type for the return parameters of the parseToml(string) function.
parseToml_1Call: ABI-encodes a TOML table at key. Function with signature parseToml(string,string) and selector 0x37736e08.
parseToml_1Return: ABI-encodes a TOML table at key. Container type for the return parameters of the parseToml(string,string) function.
parseUintCall: Parses the given string into a uint256. Function with signature parseUint(string) and selector 0xfa91454d.
parseUintReturn: Parses the given string into a uint256. Container type for the return parameters of the parseUint(string) function.
pauseGasMeteringCall: Pauses gas metering (i.e. gas usage is not counted). Noop if already paused. Function with signature pauseGasMetering() and selector 0xd1a5b36f.
pauseGasMeteringReturn: Pauses gas metering (i.e. gas usage is not counted). Noop if already paused. Container type for the return parameters of the pauseGasMetering() function.
pauseTracingCall: 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 selector 0xc94d1f90.
pauseTracingReturn: 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.
prank_0Call: Sets the next call’s msg.sender to be the input address. Function with signature prank(address) and selector 0xca669fa7.
prank_0Return: Sets the next call’s msg.sender to be the input address. Container type for the return parameters of the prank(address) function.
prank_1Call: Sets the next call’s msg.sender to be the input address, and the tx.origin to be the second input. Function with signature prank(address,address) and selector 0x47e50cce.
prank_1Return: Sets the next call’s msg.sender to be the input address, and the tx.origin to be the second input. Container type for the return parameters of the prank(address,address) function.
prank_2Call: Sets the next delegate call’s msg.sender to be the input address. Function with signature prank(address,bool) and selector 0xa7f8bf5c.
prank_2Return: Sets the next delegate call’s msg.sender to be the input address. Container type for the return parameters of the prank(address,bool) function.
prank_3Call: Sets the next delegate call’s msg.sender to be the input address, and the tx.origin to be the second input. Function with signature prank(address,address,bool) and selector 0x7d73d042.
prank_3Return: Sets the next delegate call’s msg.sender to be the input address, and the tx.origin to be the second input. Container type for the return parameters of the prank(address,address,bool) function.
prevrandao_0Call: Sets block.prevrandao. Not available on EVM versions before Paris. Use difficulty instead. If used on unsupported EVM versions it will revert. Function with signature prevrandao(bytes32) and selector 0x3b925549.
prevrandao_0Return: Sets block.prevrandao. Not available on EVM versions before Paris. Use difficulty instead. If used on unsupported EVM versions it will revert. Container type for the return parameters of the prevrandao(bytes32) function.
prevrandao_1Call: Sets block.prevrandao. Not available on EVM versions before Paris. Use difficulty instead. If used on unsupported EVM versions it will revert. Function with signature prevrandao(uint256) and selector 0x9cb1c0d4.
prevrandao_1Return: Sets block.prevrandao. Not available on EVM versions before Paris. Use difficulty instead. If used on unsupported EVM versions it will revert. Container type for the return parameters of the prevrandao(uint256) function.
projectRootCall: Get the path of the current project root. Function with signature projectRoot() and selector 0xd930a0e6.
projectRootReturn: Get the path of the current project root. Container type for the return parameters of the projectRoot() function.
promptAddressCall: Prompts the user for an address in the terminal. Function with signature promptAddress(string) and selector 0x62ee05f4.
promptAddressReturn: Prompts the user for an address in the terminal. Container type for the return parameters of the promptAddress(string) function.
promptCall: Prompts the user for a string value in the terminal. Function with signature prompt(string) and selector 0x47eaf474.
promptReturn: Prompts the user for a string value in the terminal. Container type for the return parameters of the prompt(string) function.
promptSecretCall: Prompts the user for a hidden string value in the terminal. Function with signature promptSecret(string) and selector 0x1e279d41.
promptSecretReturn: Prompts the user for a hidden string value in the terminal. Container type for the return parameters of the promptSecret(string) function.
promptSecretUintCall: Prompts the user for hidden uint256 in the terminal (usually pk). Function with signature promptSecretUint(string) and selector 0x69ca02b7.
promptSecretUintReturn: Prompts the user for hidden uint256 in the terminal (usually pk). Container type for the return parameters of the promptSecretUint(string) function.
promptUintCall: Prompts the user for uint256 in the terminal. Function with signature promptUint(string) and selector 0x652fd489.
promptUintReturn: Prompts the user for uint256 in the terminal. Container type for the return parameters of the promptUint(string) function.
publicKeyP256Call: Derives secp256r1 public key from the provided privateKey. Function with signature publicKeyP256(uint256) and selector 0xc453949e.
publicKeyP256Return: Derives secp256r1 public key from the provided privateKey. Container type for the return parameters of the publicKeyP256(uint256) function.
randomAddressCall: Returns a random address. Function with signature randomAddress() and selector 0xd5bee9f5.
randomAddressReturn: Returns a random address. Container type for the return parameters of the randomAddress() function.
randomBoolCall: Returns a random bool. Function with signature randomBool() and selector 0xcdc126bd.
randomBoolReturn: Returns a random bool. Container type for the return parameters of the randomBool() function.
randomBytes4Call: Returns a random fixed-size byte array of length 4. Function with signature randomBytes4() and selector 0x9b7cd579.
randomBytes4Return: Returns a random fixed-size byte array of length 4. Container type for the return parameters of the randomBytes4() function.
randomBytes8Call: Returns a random fixed-size byte array of length 8. Function with signature randomBytes8() and selector 0x0497b0a5.
randomBytes8Return: Returns a random fixed-size byte array of length 8. Container type for the return parameters of the randomBytes8() function.
randomBytesCall: Returns a random byte array value of the given length. Function with signature randomBytes(uint256) and selector 0x6c5d32a9.
randomBytesReturn: Returns a random byte array value of the given length. Container type for the return parameters of the randomBytes(uint256) function.
randomInt_0Call: Returns a random int256 value. Function with signature randomInt() and selector 0x111f1202.
randomInt_0Return: Returns a random int256 value. Container type for the return parameters of the randomInt() function.
randomInt_1Call: Returns a random int256 value of given bits. Function with signature randomInt(uint256) and selector 0x12845966.
randomInt_1Return: Returns a random int256 value of given bits. Container type for the return parameters of the randomInt(uint256) function.
randomUint_0Call: Returns a random uint256 value. Function with signature randomUint() and selector 0x25124730.
randomUint_0Return: Returns a random uint256 value. Container type for the return parameters of the randomUint() function.
randomUint_1Call: Returns random uint256 value between the provided range (=min..=max). Function with signature randomUint(uint256,uint256) and selector 0xd61b051b.
randomUint_1Return: Returns random uint256 value between the provided range (=min..=max). Container type for the return parameters of the randomUint(uint256,uint256) function.
randomUint_2Call: Returns a random uint256 value of given bits. Function with signature randomUint(uint256) and selector 0xcf81e69c.
randomUint_2Return: Returns a random uint256 value of given bits. Container type for the return parameters of the randomUint(uint256) function.
readCallersCall: Reads the current msg.sender and tx.origin from state and reports if there is any active caller modification. Function with signature readCallers() and selector 0x4ad0bac9.
readCallersReturn: Reads the current msg.sender and tx.origin from state and reports if there is any active caller modification. Container type for the return parameters of the readCallers() function.
readDir_0Call: 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 if followLinks is true. Function with signature readDir(string) and selector 0xc4bc59e0.
readDir_0Return: 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 if followLinks is true. Container type for the return parameters of the readDir(string) function.
readDir_1Call: See readDir(string). Function with signature readDir(string,uint64) and selector 0x1497876c.
readDir_1Return: See readDir(string). Container type for the return parameters of the readDir(string,uint64) function.
readDir_2Call: See readDir(string). Function with signature readDir(string,uint64,bool) and selector 0x8102d70d.
readDir_2Return: See readDir(string). Container type for the return parameters of the readDir(string,uint64,bool) function.
readFileBinaryCall: Reads the entire content of file as binary. path is relative to the project root. Function with signature readFileBinary(string) and selector 0x16ed7bc4.
readFileBinaryReturn: Reads the entire content of file as binary. path is relative to the project root. Container type for the return parameters of the readFileBinary(string) function.
readFileCall: Reads the entire content of file to string. path is relative to the project root. Function with signature readFile(string) and selector 0x60f9bb11.
readFileReturn: Reads the entire content of file to string. path is relative to the project root. Container type for the return parameters of the readFile(string) function.
readLineCall: Reads next line of file to string. Function with signature readLine(string) and selector 0x70f55728.
readLineReturn: Reads next line of file to string. Container type for the return parameters of the readLine(string) function.
readLinkCall: 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:
readLinkReturn: 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:
recordCall: Records all storage reads and writes. Function with signature record() and selector 0x266cf109.
recordLogsCall: Record all the transaction logs. Function with signature recordLogs() and selector 0x41af2f52.
recordLogsReturn: Record all the transaction logs. Container type for the return parameters of the recordLogs() function.
recordReturn: Records all storage reads and writes. Container type for the return parameters of the record() function.
rememberKeyCall: Adds a private key to the local forge wallet and returns the address. Function with signature rememberKey(uint256) and selector 0x22100064.
rememberKeyReturn: Adds a private key to the local forge wallet and returns the address. Container type for the return parameters of the rememberKey(uint256) function.
rememberKeys_0Call: Derive a set number of wallets from a mnemonic at the derivation path m/44'/60'/0'/0/{0..count}.
rememberKeys_0Return: Derive a set number of wallets from a mnemonic at the derivation path m/44'/60'/0'/0/{0..count}.
rememberKeys_1Call: Derive a set number of wallets from a mnemonic in the specified language at the derivation path m/44'/60'/0'/0/{0..count}.
rememberKeys_1Return: Derive a set number of wallets from a mnemonic in the specified language at the derivation path m/44'/60'/0'/0/{0..count}.
removeDirCall: Removes a directory at the provided path. This cheatcode will revert in the following situations, but is not limited to just these cases:
removeDirReturn: Removes a directory at the provided path. This cheatcode will revert in the following situations, but is not limited to just these cases:
removeFileCall: Removes a file from the filesystem. This cheatcode will revert in the following situations, but is not limited to just these cases:
removeFileReturn: Removes a file from the filesystem. This cheatcode will revert in the following situations, but is not limited to just these cases:
replaceCall: Replaces occurrences of from in the given string with to. Function with signature replace(string,string,string) and selector 0xe00ad03e.
replaceReturn: Replaces occurrences of from in the given string with to. Container type for the return parameters of the replace(string,string,string) function.
resetGasMeteringCall: Reset gas metering (i.e. gas usage is set to gas limit). Function with signature resetGasMetering() and selector 0xbe367dd3.
resetGasMeteringReturn: Reset gas metering (i.e. gas usage is set to gas limit). Container type for the return parameters of the resetGasMetering() function.
resetNonceCall: Resets the nonce of an account to 0 for EOAs and 1 for contract accounts. Function with signature resetNonce(address) and selector 0x1c72346d.
resetNonceReturn: 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.
resumeGasMeteringCall: Resumes gas metering (i.e. gas usage is counted again). Noop if already on. Function with signature resumeGasMetering() and selector 0x2bcd50e0.
resumeGasMeteringReturn: Resumes gas metering (i.e. gas usage is counted again). Noop if already on. Container type for the return parameters of the resumeGasMetering() function.
resumeTracingCall: Unpauses collection of call traces. Function with signature resumeTracing() and selector 0x72a09ccb.
resumeTracingReturn: Unpauses collection of call traces. Container type for the return parameters of the resumeTracing() function.
revertToAndDeleteCall: revertToAndDelete is being deprecated in favor of revertToStateAndDelete. It will be removed in future versions. Function with signature revertToAndDelete(uint256) and selector 0x03e0aca9.
revertToAndDeleteReturn: revertToAndDelete is being deprecated in favor of revertToStateAndDelete. It will be removed in future versions. Container type for the return parameters of the revertToAndDelete(uint256) function.
revertToCall: revertTo is being deprecated in favor of revertToState. It will be removed in future versions. Function with signature revertTo(uint256) and selector 0x44d7f0a4.
revertToReturn: revertTo is being deprecated in favor of revertToState. It will be removed in future versions. Container type for the return parameters of the revertTo(uint256) function.
revertToStateAndDeleteCall: Revert the state of the EVM to a previous snapshot and automatically deletes the snapshots Takes the snapshot ID to revert to.
revertToStateAndDeleteReturn: Revert the state of the EVM to a previous snapshot and automatically deletes the snapshots Takes the snapshot ID to revert to.
revertToStateCall: Revert the state of the EVM to a previous snapshot Takes the snapshot ID to revert to.
revertToStateReturn: Revert the state of the EVM to a previous snapshot Takes the snapshot ID to revert to.
revokePersistent_0Call: Revokes persistent status from the address, previously added via makePersistent. Function with signature revokePersistent(address) and selector 0x997a0222.
revokePersistent_0Return: Revokes persistent status from the address, previously added via makePersistent. Container type for the return parameters of the revokePersistent(address) function.
revokePersistent_1Call: See revokePersistent(address). Function with signature revokePersistent(address[]) and selector 0x3ce969e6.
revokePersistent_1Return: See revokePersistent(address). Container type for the return parameters of the revokePersistent(address[]) function.
rollCall: Sets block.height. Function with signature roll(uint256) and selector 0x1f7b4f30.
rollFork_0Call: Updates the currently active fork to given block number This is similar to roll but for the currently active fork. Function with signature rollFork(uint256) and selector 0xd9bbf3a1.
rollFork_0Return: 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 the rollFork(uint256) function.
rollFork_1Call: 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 signature rollFork(bytes32) and selector 0x0f29772b.
rollFork_1Return: 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 the rollFork(bytes32) function.
rollFork_2Call: Updates the given fork to given block number. Function with signature rollFork(uint256,uint256) and selector 0xd74c83a4.
rollFork_2Return: Updates the given fork to given block number. Container type for the return parameters of the rollFork(uint256,uint256) function.
rollFork_3Call: 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 selector 0xf2830f7b.
rollFork_3Return: 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.
rollReturn: Sets block.height. Container type for the return parameters of the roll(uint256) function.
rpcUrlCall: Returns the RPC url for the given alias. Function with signature rpcUrl(string) and selector 0x975a6ce9.
rpcUrlReturn: Returns the RPC url for the given alias. Container type for the return parameters of the rpcUrl(string) function.
rpcUrlStructsCall: Returns all rpc urls and their aliases as structs. Function with signature rpcUrlStructs() and selector 0x9d2ad72a.
rpcUrlStructsReturn: Returns all rpc urls and their aliases as structs. Container type for the return parameters of the rpcUrlStructs() function.
rpcUrlsCall: Returns all rpc urls and their aliases [alias, url][]. Function with signature rpcUrls() and selector 0xa85a8418.
rpcUrlsReturn: Returns all rpc urls and their aliases [alias, url][]. Container type for the return parameters of the rpcUrls() function.
rpc_0Call: Performs an Ethereum JSON-RPC request to the current fork URL. Function with signature rpc(string,string) and selector 0x1206c8a8.
rpc_0Return: Performs an Ethereum JSON-RPC request to the current fork URL. Container type for the return parameters of the rpc(string,string) function.
rpc_1Call: Performs an Ethereum JSON-RPC request to the given endpoint. Function with signature rpc(string,string,string) and selector 0x0199a220.
rpc_1Return: Performs an Ethereum JSON-RPC request to the given endpoint. Container type for the return parameters of the rpc(string,string,string) function.
selectForkCall: Takes a fork identifier created by createFork and sets the corresponding forked state as active. Function with signature selectFork(uint256) and selector 0x9ebf6827.
selectForkReturn: Takes a fork identifier created by createFork and sets the corresponding forked state as active. Container type for the return parameters of the selectFork(uint256) function.
serializeAddress_0Call: See serializeJson. Function with signature serializeAddress(string,string,address) and selector 0x972c6062.
serializeAddress_0Return: See serializeJson. Container type for the return parameters of the serializeAddress(string,string,address) function.
serializeAddress_1Call: See serializeJson. Function with signature serializeAddress(string,string,address[]) and selector 0x1e356e1a.
serializeAddress_1Return: See serializeJson. Container type for the return parameters of the serializeAddress(string,string,address[]) function.
serializeBool_0Call: See serializeJson. Function with signature serializeBool(string,string,bool) and selector 0xac22e971.
serializeBool_0Return: See serializeJson. Container type for the return parameters of the serializeBool(string,string,bool) function.
serializeBool_1Call: See serializeJson. Function with signature serializeBool(string,string,bool[]) and selector 0x92925aa1.
serializeBool_1Return: See serializeJson. Container type for the return parameters of the serializeBool(string,string,bool[]) function.
serializeBytes32_0Call: See serializeJson. Function with signature serializeBytes32(string,string,bytes32) and selector 0x2d812b44.
serializeBytes32_0Return: See serializeJson. Container type for the return parameters of the serializeBytes32(string,string,bytes32) function.
serializeBytes32_1Call: See serializeJson. Function with signature serializeBytes32(string,string,bytes32[]) and selector 0x201e43e2.
serializeBytes32_1Return: See serializeJson. Container type for the return parameters of the serializeBytes32(string,string,bytes32[]) function.
serializeBytes_0Call: See serializeJson. Function with signature serializeBytes(string,string,bytes) and selector 0xf21d52c7.
serializeBytes_0Return: See serializeJson. Container type for the return parameters of the serializeBytes(string,string,bytes) function.
serializeBytes_1Call: See serializeJson. Function with signature serializeBytes(string,string,bytes[]) and selector 0x9884b232.
serializeBytes_1Return: See serializeJson. Container type for the return parameters of the serializeBytes(string,string,bytes[]) function.
serializeInt_0Call: See serializeJson. Function with signature serializeInt(string,string,int256) and selector 0x3f33db60.
serializeInt_0Return: See serializeJson. Container type for the return parameters of the serializeInt(string,string,int256) function.
serializeInt_1Call: See serializeJson. Function with signature serializeInt(string,string,int256[]) and selector 0x7676e127.
serializeInt_1Return: See serializeJson. Container type for the return parameters of the serializeInt(string,string,int256[]) function.
serializeJsonCall: 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 selector 0x9b3358b0.
serializeJsonReturn: 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.
serializeJsonType_0Call: See serializeJson. Function with signature serializeJsonType(string,bytes) and selector 0x6d4f96a6.
serializeJsonType_0Return: See serializeJson. Container type for the return parameters of the serializeJsonType(string,bytes) function.
serializeJsonType_1Call: See serializeJson. Function with signature serializeJsonType(string,string,string,bytes) and selector 0x6f93bccb.
serializeJsonType_1Return: See serializeJson. Container type for the return parameters of the serializeJsonType(string,string,string,bytes) function.
serializeString_0Call: See serializeJson. Function with signature serializeString(string,string,string) and selector 0x88da6d35.
serializeString_0Return: See serializeJson. Container type for the return parameters of the serializeString(string,string,string) function.
serializeString_1Call: See serializeJson. Function with signature serializeString(string,string,string[]) and selector 0x561cd6f3.
serializeString_1Return: See serializeJson. Container type for the return parameters of the serializeString(string,string,string[]) function.
serializeUintToHexCall: See serializeJson. Function with signature serializeUintToHex(string,string,uint256) and selector 0xae5a2ae8.
serializeUintToHexReturn: See serializeJson. Container type for the return parameters of the serializeUintToHex(string,string,uint256) function.
serializeUint_0Call: See serializeJson. Function with signature serializeUint(string,string,uint256) and selector 0x129e9002.
serializeUint_0Return: See serializeJson. Container type for the return parameters of the serializeUint(string,string,uint256) function.
serializeUint_1Call: See serializeJson. Function with signature serializeUint(string,string,uint256[]) and selector 0xfee9a469.
serializeUint_1Return: See serializeJson. Container type for the return parameters of the serializeUint(string,string,uint256[]) function.
setArbitraryStorage_0Call: Utility cheatcode to set arbitrary storage for given target address. Function with signature setArbitraryStorage(address) and selector 0xe1631837.
setArbitraryStorage_0Return: Utility cheatcode to set arbitrary storage for given target address. Container type for the return parameters of the setArbitraryStorage(address) function.
setArbitraryStorage_1Call: Utility cheatcode to set arbitrary storage for given target address and overwrite any storage slots that have been previously set. Function with signature setArbitraryStorage(address,bool) and selector 0xd3ec2a0b.
setArbitraryStorage_1Return: Utility cheatcode to set arbitrary storage for given target address and overwrite any storage slots that have been previously set. Container type for the return parameters of the setArbitraryStorage(address,bool) function.
setBlockhashCall: Set blockhash for the current block. It only sets the blockhash for blocks where block.number - 256 <= number < block.number. Function with signature setBlockhash(uint256,bytes32) and selector 0x5314b54a.
setBlockhashReturn: 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 the setBlockhash(uint256,bytes32) function.
setEnvCall: Sets environment variables. Function with signature setEnv(string,string) and selector 0x3d5923ee.
setEnvReturn: Sets environment variables. Container type for the return parameters of the setEnv(string,string) function.
setNonceCall: Sets the nonce of an account. Must be higher than the current nonce of the account. Function with signature setNonce(address,uint64) and selector 0xf8e18b57.
setNonceReturn: 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.
setNonceUnsafeCall: Sets the nonce of an account to an arbitrary value. Function with signature setNonceUnsafe(address,uint64) and selector 0x9b67b21c.
setNonceUnsafeReturn: Sets the nonce of an account to an arbitrary value. Container type for the return parameters of the setNonceUnsafe(address,uint64) function.
shuffleCall: Randomly shuffles an array. Function with signature shuffle(uint256[]) and selector 0x54f1469c.
shuffleReturn: Randomly shuffles an array. Container type for the return parameters of the shuffle(uint256[]) function.
signAndAttachDelegation_0Call: Sign an EIP-7702 authorization and designate the next call as an EIP-7702 transaction Function with signature signAndAttachDelegation(address,uint256) and selector 0xc7fa7288.
signAndAttachDelegation_0Return: Sign an EIP-7702 authorization and designate the next call as an EIP-7702 transaction Container type for the return parameters of the signAndAttachDelegation(address,uint256) function.
signAndAttachDelegation_1Call: Sign an EIP-7702 authorization and designate the next call as an EIP-7702 transaction for specific nonce Function with signature signAndAttachDelegation(address,uint256,uint64) and selector 0xcde3e5be.
signAndAttachDelegation_1Return: Sign an EIP-7702 authorization and designate the next call as an EIP-7702 transaction for specific nonce Container type for the return parameters of the signAndAttachDelegation(address,uint256,uint64) function.
signCompact_0Call: Signs data with a Wallet.
signCompact_0Return: Signs data with a Wallet.
signCompact_1Call: Signs digest with privateKey using the secp256k1 curve.
signCompact_1Return: Signs digest with privateKey using the secp256k1 curve.
signCompact_2Call: Signs digest with signer provided to script using the secp256k1 curve.
signCompact_2Return: Signs digest with signer provided to script using the secp256k1 curve.
signCompact_3Call: Signs digest with signer provided to script using the secp256k1 curve.
signCompact_3Return: Signs digest with signer provided to script using the secp256k1 curve.
signDelegation_0Call: Sign an EIP-7702 authorization for delegation Function with signature signDelegation(address,uint256) and selector 0x5b593c7b.
signDelegation_0Return: Sign an EIP-7702 authorization for delegation Container type for the return parameters of the signDelegation(address,uint256) function.
signDelegation_1Call: Sign an EIP-7702 authorization for delegation for specific nonce Function with signature signDelegation(address,uint256,uint64) and selector 0xceba2ec3.
signDelegation_1Return: Sign an EIP-7702 authorization for delegation for specific nonce Container type for the return parameters of the signDelegation(address,uint256,uint64) function.
signP256Call: Signs digest with privateKey using the secp256r1 curve. Function with signature signP256(uint256,bytes32) and selector 0x83211b40.
signP256Return: Signs digest with privateKey using the secp256r1 curve. Container type for the return parameters of the signP256(uint256,bytes32) function.
sign_0Call: Signs data with a Wallet. Function with signature sign((address,uint256,uint256,uint256),bytes32) and selector 0xb25c5a25.
sign_0Return: Signs data with a Wallet. Container type for the return parameters of the sign((address,uint256,uint256,uint256),bytes32) function.
sign_1Call: Signs digest with privateKey using the secp256k1 curve. Function with signature sign(uint256,bytes32) and selector 0xe341eaa4.
sign_1Return: Signs digest with privateKey using the secp256k1 curve. Container type for the return parameters of the sign(uint256,bytes32) function.
sign_2Call: Signs digest with signer provided to script using the secp256k1 curve.
sign_2Return: Signs digest with signer provided to script using the secp256k1 curve.
sign_3Call: Signs digest with signer provided to script using the secp256k1 curve.
sign_3Return: Signs digest with signer provided to script using the secp256k1 curve.
skip_0Call: Marks a test as skipped. Must be called at the top level of a test. Function with signature skip(bool) and selector 0xdd82d13e.
skip_0Return: 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.
skip_1Call: 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 selector 0xc42a80a7.
skip_1Return: 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.
sleepCall: Suspends execution of the main thread for duration milliseconds. Function with signature sleep(uint256) and selector 0xfa9d8713.
sleepReturn: Suspends execution of the main thread for duration milliseconds. Container type for the return parameters of the sleep(uint256) function.
snapshotCall: snapshot is being deprecated in favor of snapshotState. It will be removed in future versions. Function with signature snapshot() and selector 0x9711715a.
snapshotGasLastCall_0Call: Snapshot capture the gas usage of the last call by name from the callee perspective. Function with signature snapshotGasLastCall(string) and selector 0xdd9fca12.
snapshotGasLastCall_0Return: 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.
snapshotGasLastCall_1Call: 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 selector 0x200c6772.
snapshotGasLastCall_1Return: 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.
snapshotReturn: snapshot is being deprecated in favor of snapshotState. It will be removed in future versions. Container type for the return parameters of the snapshot() function.
snapshotStateCall: Snapshot the current state of the evm. Returns the ID of the snapshot that was created. To revert a snapshot use revertToState. Function with signature snapshotState() and selector 0x9cd23835.
snapshotStateReturn: 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 the snapshotState() function.
snapshotValue_0Call: Snapshot capture an arbitrary numerical value by name. The group name is derived from the contract name. Function with signature snapshotValue(string,uint256) and selector 0x51db805a.
snapshotValue_0Return: 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.
snapshotValue_1Call: Snapshot capture an arbitrary numerical value by name in a group. Function with signature snapshotValue(string,string,uint256) and selector 0x6d2b27d8.
snapshotValue_1Return: Snapshot capture an arbitrary numerical value by name in a group. Container type for the return parameters of the snapshotValue(string,string,uint256) function.
sortCall: Sorts an array in ascending order. Function with signature sort(uint256[]) and selector 0x9ec8b026.
sortReturn: Sorts an array in ascending order. Container type for the return parameters of the sort(uint256[]) function.
splitCall: Splits the given string into an array of strings divided by the delimiter. Function with signature split(string,string) and selector 0x8bb75533.
splitReturn: Splits the given string into an array of strings divided by the delimiter. Container type for the return parameters of the split(string,string) function.
startBroadcast_0Call: Has all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain.
startBroadcast_0Return: Has all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain.
startBroadcast_1Call: 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 selector 0x7fec2a8d.
startBroadcast_1Return: 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.
startBroadcast_2Call: 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 selector 0xce817d47.
startBroadcast_2Return: 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.
startDebugTraceRecordingCall: Records the debug trace during the run. Function with signature startDebugTraceRecording() and selector 0x419c8832.
startDebugTraceRecordingReturn: Records the debug trace during the run. Container type for the return parameters of the startDebugTraceRecording() function.
startMappingRecordingCall: Starts recording all map SSTOREs for later retrieval. Function with signature startMappingRecording() and selector 0x3e9705c0.
startMappingRecordingReturn: Starts recording all map SSTOREs for later retrieval. Container type for the return parameters of the startMappingRecording() function.
startPrank_0Call: Sets all subsequent calls’ msg.sender to be the input address until stopPrank is called. Function with signature startPrank(address) and selector 0x06447d56.
startPrank_0Return: Sets all subsequent calls’ msg.sender to be the input address until stopPrank is called. Container type for the return parameters of the startPrank(address) function.
startPrank_1Call: Sets all subsequent calls’ msg.sender to be the input address until stopPrank is called, and the tx.origin to be the second input. Function with signature startPrank(address,address) and selector 0x45b56078.
startPrank_1Return: Sets all subsequent calls’ msg.sender to be the input address until stopPrank is called, and the tx.origin to be the second input. Container type for the return parameters of the startPrank(address,address) function.
startPrank_2Call: Sets all subsequent delegate calls’ msg.sender to be the input address until stopPrank is called. Function with signature startPrank(address,bool) and selector 0x1cc0b435.
startPrank_2Return: Sets all subsequent delegate calls’ msg.sender to be the input address until stopPrank is called. Container type for the return parameters of the startPrank(address,bool) function.
startPrank_3Call: Sets all subsequent delegate calls’ msg.sender to be the input address until stopPrank is called, and the tx.origin to be the second input. Function with signature startPrank(address,address,bool) and selector 0x4eb859b5.
startPrank_3Return: Sets all subsequent delegate calls’ msg.sender to be the input address until stopPrank is called, and the tx.origin to be the second input. Container type for the return parameters of the startPrank(address,address,bool) function.
startSnapshotGas_0Call: 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 selector 0x3cad9d7b.
startSnapshotGas_0Return: 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.
startSnapshotGas_1Call: Start a snapshot capture of the current gas usage by name in a group. Function with signature startSnapshotGas(string,string) and selector 0x6cd0cc53.
startSnapshotGas_1Return: 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.
startStateDiffRecordingCall: 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 selector 0xcf22e3c9.
startStateDiffRecordingReturn: 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.
stopAndReturnDebugTraceRecordingCall: Stop debug trace recording and returns the recorded debug trace. Function with signature stopAndReturnDebugTraceRecording() and selector 0xced398a2.
stopAndReturnDebugTraceRecordingReturn: Stop debug trace recording and returns the recorded debug trace. Container type for the return parameters of the stopAndReturnDebugTraceRecording() function.
stopAndReturnStateDiffCall: Returns an ordered array of all account accesses from a vm.startStateDiffRecording session. Function with signature stopAndReturnStateDiff() and selector 0xaa5cf90e.
stopAndReturnStateDiffReturn: Returns an ordered array of all account accesses from a vm.startStateDiffRecording session. Container type for the return parameters of the stopAndReturnStateDiff() function.
stopBroadcastCall: Stops collecting onchain transactions. Function with signature stopBroadcast() and selector 0x76eadd36.
stopBroadcastReturn: Stops collecting onchain transactions. Container type for the return parameters of the stopBroadcast() function.
stopExpectSafeMemoryCall: Stops all safe memory expectation in the current subcontext. Function with signature stopExpectSafeMemory() and selector 0x0956441b.
stopExpectSafeMemoryReturn: Stops all safe memory expectation in the current subcontext. Container type for the return parameters of the stopExpectSafeMemory() function.
stopMappingRecordingCall: Stops recording all map SSTOREs for later retrieval and clears the recorded data. Function with signature stopMappingRecording() and selector 0x0d4aae9b.
stopMappingRecordingReturn: Stops recording all map SSTOREs for later retrieval and clears the recorded data. Container type for the return parameters of the stopMappingRecording() function.
stopPrankCall: Resets subsequent calls’ msg.sender to be address(this). Function with signature stopPrank() and selector 0x90c5013b.
stopPrankReturn: Resets subsequent calls’ msg.sender to be address(this). Container type for the return parameters of the stopPrank() function.
stopSnapshotGas_0Call: Stop the snapshot capture of the current gas by latest snapshot name, capturing the gas used since the start. Function with signature stopSnapshotGas() and selector 0xf6402eda.
stopSnapshotGas_0Return: 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.
stopSnapshotGas_1Call: 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 selector 0x773b2805.
stopSnapshotGas_1Return: 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.
stopSnapshotGas_2Call: 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 selector 0x0c9db707.
stopSnapshotGas_2Return: 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.
storeCall: Stores a value to an address’ storage slot. Function with signature store(address,bytes32,bytes32) and selector 0x70ca10bb.
storeReturn: Stores a value to an address’ storage slot. Container type for the return parameters of the store(address,bytes32,bytes32) function.
toBase64URL_0Call: Encodes a bytes value to a base64url string. Function with signature toBase64URL(bytes) and selector 0xc8bd0e4a.
toBase64URL_0Return: Encodes a bytes value to a base64url string. Container type for the return parameters of the toBase64URL(bytes) function.
toBase64URL_1Call: Encodes a string value to a base64url string. Function with signature toBase64URL(string) and selector 0xae3165b3.
toBase64URL_1Return: Encodes a string value to a base64url string. Container type for the return parameters of the toBase64URL(string) function.
toBase64_0Call: Encodes a bytes value to a base64 string. Function with signature toBase64(bytes) and selector 0xa5cbfe65.
toBase64_0Return: Encodes a bytes value to a base64 string. Container type for the return parameters of the toBase64(bytes) function.
toBase64_1Call: Encodes a string value to a base64 string. Function with signature toBase64(string) and selector 0x3f8be2c8.
toBase64_1Return: Encodes a string value to a base64 string. Container type for the return parameters of the toBase64(string) function.
toLowercaseCall: Converts the given string value to Lowercase. Function with signature toLowercase(string) and selector 0x50bb0884.
toLowercaseReturn: Converts the given string value to Lowercase. Container type for the return parameters of the toLowercase(string) function.
toString_0Call: Converts the given value to a string. Function with signature toString(address) and selector 0x56ca623e.
toString_0Return: Converts the given value to a string. Container type for the return parameters of the toString(address) function.
toString_1Call: Converts the given value to a string. Function with signature toString(bytes) and selector 0x71aad10d.
toString_1Return: Converts the given value to a string. Container type for the return parameters of the toString(bytes) function.
toString_2Call: Converts the given value to a string. Function with signature toString(bytes32) and selector 0xb11a19e8.
toString_2Return: Converts the given value to a string. Container type for the return parameters of the toString(bytes32) function.
toString_3Call: Converts the given value to a string. Function with signature toString(bool) and selector 0x71dce7da.
toString_3Return: Converts the given value to a string. Container type for the return parameters of the toString(bool) function.
toString_4Call: Converts the given value to a string. Function with signature toString(uint256) and selector 0x6900a3ae.
toString_4Return: Converts the given value to a string. Container type for the return parameters of the toString(uint256) function.
toString_5Call: Converts the given value to a string. Function with signature toString(int256) and selector 0xa322c40e.
toString_5Return: Converts the given value to a string. Container type for the return parameters of the toString(int256) function.
toUppercaseCall: Converts the given string value to Uppercase. Function with signature toUppercase(string) and selector 0x074ae3d7.
toUppercaseReturn: Converts the given string value to Uppercase. Container type for the return parameters of the toUppercase(string) function.
transact_0Call: Fetches the given transaction from the active fork and executes it on the current state. Function with signature transact(bytes32) and selector 0xbe646da1.
transact_0Return: 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.
transact_1Call: Fetches the given transaction from the given fork and executes it on the current state. Function with signature transact(uint256,bytes32) and selector 0x4d8abc4b.
transact_1Return: 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.
trimCall: Trims leading and trailing whitespace from the given string value. Function with signature trim(string) and selector 0xb2dad155.
trimReturn: Trims leading and trailing whitespace from the given string value. Container type for the return parameters of the trim(string) function.
tryFfiCall: Performs a foreign function call via terminal and returns the exit code, stdout, and stderr. Function with signature tryFfi(string[]) and selector 0xf45c1ce7.
tryFfiReturn: 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.
txGasPriceCall: Sets tx.gasprice. Function with signature txGasPrice(uint256) and selector 0x48f50c0f.
txGasPriceReturn: Sets tx.gasprice. Container type for the return parameters of the txGasPrice(uint256) function.
unixTimeCall: Returns the time since unix epoch in milliseconds. Function with signature unixTime() and selector 0x625387dc.
unixTimeReturn: Returns the time since unix epoch in milliseconds. Container type for the return parameters of the unixTime() function.
warmSlotCall: Utility cheatcode to mark specific storage slot as warm, simulating a prior read. Function with signature warmSlot(address,bytes32) and selector 0xb23184cf.
warmSlotReturn: Utility cheatcode to mark specific storage slot as warm, simulating a prior read. Container type for the return parameters of the warmSlot(address,bytes32) function.
warpCall: Sets block.timestamp. Function with signature warp(uint256) and selector 0xe5d6bf02.
warpReturn: Sets block.timestamp. Container type for the return parameters of the warp(uint256) function.
writeFileBinaryCall: 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 signature writeFileBinary(string,bytes) and selector 0x1f21fc80.
writeFileBinaryReturn: 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 the writeFileBinary(string,bytes) function.
writeFileCall: 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 signature writeFile(string,string) and selector 0x897e0a97.
writeFileReturn: 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 the writeFile(string,string) function.
writeJson_0Call: Write a serialized JSON object to a file. If the file exists, it will be overwritten. Function with signature writeJson(string,string) and selector 0xe23cd19f.
writeJson_0Return: 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.
writeJson_1Call: 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 selector 0x35d6ad46.
writeJson_1Return: 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.
writeLineCall: Writes line to file, creating a file if it does not exist. path is relative to the project root. Function with signature writeLine(string,string) and selector 0x619d897f.
writeLineReturn: 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 the writeLine(string,string) function.
writeToml_0Call: Takes serialized JSON, converts to TOML and write a serialized TOML to a file. Function with signature writeToml(string,string) and selector 0xc0865ba7.
writeToml_0Return: 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.
writeToml_1Call: 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 selector 0x51ac6a33.
writeToml_1Return: 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§

AccountAccessKind: The kind of account access that occurred.
BroadcastTxType: The transaction type (txType) of the broadcast.
CallerMode: A modification applied to either msg.sender or tx.origin. Returned by readCallers.
ForgeContext: Forge execution contexts.
VmCalls: Container for all the Vm function calls.
VmErrors: Container for all the Vm custom errors.

Constants§

CHEATCODES: All the cheatcodes in this contract.
VM_ERRORS: All the custom errors in this contract.

Module VmCopy item path

Modules§

Structs§

Enums§

Constants§

Module Vm