mockCall

Signature

function mockCall(
  address where,
  bytes calldata data,
  bytes calldata retdata
) external;
function mockCall(address where, bytes4 data, bytes calldata retdata) external;

function mockCall(
  address where,
  uint256 value,
  bytes calldata data,
  bytes calldata retdata
) external;
function mockCall(
  address where,
  uint256 value,
  bytes4 data,
  bytes calldata retdata
) external;

Description

Mocks all calls to an address where if the call data either strictly or loosely matches data and returns retdata.

When a call is made to where the call data is first checked to see if it matches in its entirety with data. If not, the call data is checked to see if there is a partial match, with the match starting at the first byte of the call data.

If a match is found, then retdata is returned from the call.

Using the second signature we can mock the calls with a specific msg.value. Calldata match takes precedence over msg.value in case of ambiguity.

Mocked calls are in effect until clearMockedCalls is called.

Note

Calls to mocked addresses may revert if there is no code on the address. This is because Solidity inserts an extcodesize check before some contract calls.

To circumvent this, use the etch cheatcode if the mocked address has no code.

Note

Internal calls

This cheatcode does not currently work on internal calls.

Examples

Mocking an exact call:

function testMockCall() public {
  vm.mockCall(
    address(0),
    abi.encodeWithSelector(MyToken.balanceOf.selector, address(1)),
    abi.encode(10)
  );
  assertEq(IERC20(address(0)).balanceOf(address(1)), 10);
}

Mocking an entire function:

function testMockCall() public {
  vm.mockCall(
    address(0),
    abi.encodeWithSelector(MyToken.balanceOf.selector),
    abi.encode(10)
  );
  assertEq(IERC20(address(0)).balanceOf(address(1)), 10);
  assertEq(IERC20(address(0)).balanceOf(address(2)), 10);
}

Mocking a call with a given msg.value:

function testMockCall() public {
  assertEq(example.pay{ value: 10 }(1), 1);
  assertEq(example.pay{ value: 1 }(2), 2);
  vm.mockCall(
    address(example),
    10,
    abi.encodeWithSelector(example.pay.selector),
    abi.encode(99)
  );
  assertEq(example.pay{ value: 10 }(1), 99);
  assertEq(example.pay{ value: 1 }(2), 2);
}

Mocking a public variable:

contract Example {
  uint256 public number = 10;
}

contract ExampleTest is Test {
  Example public example;

  function setUp() public {
    example = new Example();
  }

  function testMockPublicVariable() public {
    assertEq(example.number(), 10);
    vm.mockCall(
      address(example),
      abi.encodeWithSelector(bytes4(keccak256("number()"))),
      abi.encode(5)
    );
    assertEq(example.number(), 5);
  }
}