Skip to content

Latest commit

 

History

History

cheatcodes

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
accesses.md
accesses.md
 
 
active-fork.md
active-fork.md
 
 
addr.md
addr.md
 
 
allow-cheatcodes.md
allow-cheatcodes.md
 
 
assertions.md
assertions.md
 
 
assume-no-revert.md
assume-no-revert.md
 
 
assume.md
assume.md
 
 
breakpoint.md
breakpoint.md
 
 
broadcast.md
broadcast.md
 
 
chain-id.md
chain-id.md
 
 
clear-mocked-calls.md
clear-mocked-calls.md
 
 
coinbase.md
coinbase.md
 
 
copy-storage.md
copy-storage.md
 
 
create-fork.md
create-fork.md
 
 
create-select-fork.md
create-select-fork.md
 
 
create-wallet.md
create-wallet.md
 
 
deal.md
deal.md
 
 
derive-key.md
derive-key.md
 
 
difficulty.md
difficulty.md
 
 
env-address.md
env-address.md
 
 
env-bool.md
env-bool.md
 
 
env-bytes.md
env-bytes.md
 
 
env-bytes32.md
env-bytes32.md
 
 
env-int.md
env-int.md
 
 
env-or.md
env-or.md
 
 
env-string.md
env-string.md
 
 
env-uint.md
env-uint.md
 
 
environment.md
environment.md
 
 
etch.md
etch.md
 
 
expect-call.md
expect-call.md
 
 
expect-emit.md
expect-emit.md
 
 
expect-revert.md
expect-revert.md
 
 
external.md
external.md
 
 
fee.md
fee.md
 
 
ffi.md
ffi.md
 
 
forking.md
forking.md
 
 
fs.md
fs.md
 
 
fuzzer.md
fuzzer.md
 
 
gas-snapshots.md
gas-snapshots.md
 
 
get-block-number.md
get-block-number.md
 
 
get-block-timestamp.md
get-block-timestamp.md
 
 
get-code.md
get-code.md
 
 
get-deployed-code.md
get-deployed-code.md
 
 
get-label.md
get-label.md
 
 
get-nonce.md
get-nonce.md
 
 
get-recorded-logs.md
get-recorded-logs.md
 
 
is-context.md
is-context.md
 
 
is-persistent.md
is-persistent.md
 
 
key-exists-json.md
key-exists-json.md
 
 
key-exists-toml.md
key-exists-toml.md
 
 
key-exists.md
key-exists.md
 
 
label.md
label.md
 
 
load.md
load.md
 
 
make-persistent.md
make-persistent.md
 
 
mock-call-revert.md
mock-call-revert.md
 
 
mock-call.md
mock-call.md
 
 
mock-calls.md
mock-calls.md
 
 
mock-function.md
mock-function.md
 
 
parse-address.md
parse-address.md
 
 
parse-bool.md
parse-bool.md
 
 
parse-bytes.md
parse-bytes.md
 
 
parse-bytes32.md
parse-bytes32.md
 
 
parse-int.md
parse-int.md
 
 
parse-json-keys.md
parse-json-keys.md
 
 
parse-json.md
parse-json.md
 
 
parse-toml-keys.md
parse-toml-keys.md
 
 
parse-toml.md
parse-toml.md
 
 
parse-uint.md
parse-uint.md
 
 
pause-gas-metering.md
pause-gas-metering.md
 
 
prank.md
prank.md
 
 
prevrandao.md
prevrandao.md
 
 
project-root.md
project-root.md
 
 
prompt.md
prompt.md
 
 
read-callers.md
read-callers.md
 
 
record-logs.md
record-logs.md
 
 
record.md
record.md
 
 
remember-key.md
remember-key.md
 
 
reset-gas-metering.md
reset-gas-metering.md
 
 
resume-gas-metering.md
resume-gas-metering.md
 
 
revoke-persistent.md
revoke-persistent.md
 
 
roll-fork.md
roll-fork.md
 
 
roll.md
roll.md
 
 
rpc.md
rpc.md
 
 
select-fork.md
select-fork.md
 
 
serialize-json.md
serialize-json.md
 
 
set-arbitrary-storage.md
set-arbitrary-storage.md
 
 
set-env.md
set-env.md
 
 
set-nonce.md
set-nonce.md
 
 
sign-delegation.md
sign-delegation.md
 
 
sign.md
sign.md
 
 
signing.md
signing.md
 
 
skip.md
skip.md
 
 
sleep.md
sleep.md
 
 
start-broadcast.md
start-broadcast.md
 
 
start-prank.md
start-prank.md
 
 
start-state-diff-recording.md
start-state-diff-recording.md
 
 
state-snapshots.md
state-snapshots.md
 
 
stop-and-return-state-diff.md
stop-and-return-state-diff.md
 
 
stop-broadcast.md
stop-broadcast.md
 
 

README.md

Cheatcodes Reference

Cheatcodes give you powerful assertions, the ability to alter the state of the EVM, mock data, and more.

Cheatcodes are made available through use of the cheatcode address (0x7109709ECfa91a80626fF3989D68f67F5b1DD12D).

ℹ️ Note

If you encounter errors for this address when using fuzzed addresses in your tests, you may wish to exclude it from your fuzz tests by using the following line:

vm.assume(address_ != 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);

You can also access cheatcodes easily via vm available in Forge Standard Library's Test contract.

Forge Standard Library Cheatcodes

Forge Std implements wrappers around cheatcodes, which combine multiple standard cheatcodes to improve development experience. These are not technically cheatcodes, but rather compositions of Forge's cheatcodes.

You can view the list of Forge Standard Library's cheatcode wrappers in the references section. You can reference the Forge Std source code to learn more about how the wrappers work under the hood.

Cheatcode Types

Below are some subsections for the different Forge cheatcodes.

  • Environment: Cheatcodes that alter the state of the EVM.
  • Assertions: Cheatcodes that are powerful assertions
  • Fuzzer: Cheatcodes that configure the fuzzer
  • External: Cheatcodes that interact with external state (files, commands, ...)
  • Signing: Cheatcodes for signing
  • Utilities: Smaller utility cheatcodes
  • Forking: Forking mode cheatcodes
  • Snapshots: Snapshot cheatcodes
  • RPC: RPC related cheatcodes
  • File: Cheatcodes for working with files

Add a new cheatcode

If you need a new feature, consider contributing to the Foundry's codebase to add the cheatcode.

Cheatcodes Interface

This is a Solidity interface for all of the cheatcodes present in Forge.

{{#include ../output/vm/Vm.sol:3:}}