feat(`cheatcodes`): add `expect*Call` cheatcodes

[grandizzy]

Component

Forge

Describe the feature you would like

Follow up of #4072 for adding remaining expect*Call cheatcodes

• expect*Call cheatcodes: similar to expectEmit, these let us specify the expected call with its callee and calldata. We use these less frequently, but I think they can be useful even for fuzzing tests.

  • expectRegularCall: Expect a call using the CALL opcode and specified parameters
  • expectStaticCall: Expect a call using the STATICCALL opcode and specified parameters
  • expectDelegateCall: Expect a call using the DELEGATECALL opcode and specified parameters
  • expectNoCall: Expect no calls to be made after this cheat code
  • expectCreate: Expects the deployment of the specified bytecode by the specified address using the CREATE opcode
  • expectCreate2: Expects the deployment of the specified bytecode by the specified address using the CREATE2 opcode

Additional context

No response

[Utilitycoder]

I would love to handle this issue. I will probably need the files that will be affected and where to draw inspiration from in the codebase.

[mimisavage]

Can I work on this, please?

[Nityam573]

May I take care of this?

[anukul]

@grandizzy hi! i'm interested in working on this :)

[grandizzy]

@anukul awesome, thanks! I assigned it to you

[anukul]

From the existing expectCall overloads, which is the ideal set of parameters to use for each expect*Call cheatcode? 🤔

foundry/crates/cheatcodes/spec/src/vm.rs

Lines 930 to 962 in dabacec

	/// Expects a call to an address with the specified calldata.
	/// Calldata can either be a strict or a partial match.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCall(address callee, bytes calldata data) external;
	/// Expects given number of calls to an address with the specified calldata.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCall(address callee, bytes calldata data, uint64 count) external;
	/// Expects a call to an address with the specified `msg.value` and calldata.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCall(address callee, uint256 msgValue, bytes calldata data) external;
	/// Expects given number of calls to an address with the specified `msg.value` and calldata.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCall(address callee, uint256 msgValue, bytes calldata data, uint64 count) external;
	/// Expect a call to an address with the specified `msg.value`, gas, and calldata.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCall(address callee, uint256 msgValue, uint64 gas, bytes calldata data) external;
	/// Expects given number of calls to an address with the specified `msg.value`, gas, and calldata.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCall(address callee, uint256 msgValue, uint64 gas, bytes calldata data, uint64 count) external;
	/// Expect a call to an address with the specified `msg.value` and calldata, and a *minimum* amount of gas.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCallMinGas(address callee, uint256 msgValue, uint64 minGas, bytes calldata data) external;
	/// Expect given number of calls to an address with the specified `msg.value` and calldata, and a *minimum* amount of gas.
	#[cheatcode(group = Testing, safety = Unsafe)]
	function expectCallMinGas(address callee, uint256 msgValue, uint64 minGas, bytes calldata data, uint64 count)
	external;

There is this option:

function expectRegularCall(address callee, uint256 msgValue, uint64 gas, bytes calldata data) external;
function expectRegularCall(address callee, uint256 msgValue, uint64 gas, bytes calldata data, uint64 count) external;

or the possibility of another function, something like:

enum CallType {
  Regular,
  Static,
  Delegate
}

struct ExpectCallOptions {
    CallType kind;

    // optional gas fields (0 = don't check)
    uint64 exactGas;
    uint64 minGas;
    // optional count (0 = expect at least once)
    uint64 count;
    
    // optional msg.value
    uint256 msgValue;
    // flag for ambiguous zero value fields
    // or alternatively, an OptionalUint256 { bool hasValue, uint256 value} 
    bool checkMsgValue;
}

function expectCall(
    address callee,
    bytes calldata data,
    ExpectCallOptions calldata options
) external;

Somewhat related - #8845, to make data optional