Partially matching call arguments

[josojo]

Background
The Gnosis MockContract is a smart contract enabling developers to quickly mock contract interactions for unit tests.
It enables developers to

• Make dependent contracts return predefined values for different methods and arguments
• Simulate exceptions such as revert and outOfGas
• Assert on how often a dependency is called

The MockContract facilitates these features without requiring any separate test contracts.
Check out the repo: https://github.com/gnosis/mock-contract

Task
Extend the functionality of the MockContract to partially matching arguments.

Acceptance criteria

• Develop a framework allowing developers to define partially matching calldata for specific methods. 
Defining partially matched call data should look similar to:

const particallyMatchedCalldata = contract.methods.methodName(
   accounts[0], ANY, ..., ANY
   ).encodeABI()

Here, ANY would be some sort of constant defined in the smart contract.

• Write the logic for the MockContract to expose predefined returns to the partially matched calldata. 
It is expected that the following functions for partially matched calldata are provided:

	function givenPartialCalldataReturn(bytes calldata call, bytes calldata response) external;
	function givenPartialCalldataReturnBool(bytes calldata call, bool response) external;
	function givenPartialCalldataReturnUint(bytes calldata call, uint response) external;
	function givenPartialCalldataReturnAddress(bytes calldata call, address response) external;

	function givenPartialCalldataRevert(bytes calldata call) external;
	function givenPartialCalldataRevertWithMessage(bytes calldata call, string calldata message) external;
	function givenPartialCalldataRunOutOfGas(bytes calldata call) external;

They should enable the same functionality on partially matching calldata as the current respective functions with the same function names, but without the word "Partial".

• Make sure the invocation count functions are still returning the expected numbers
:

       function invocationCount() external returns (uint);
       function invocationCountForMethod(bytes calldata method) external returns (uint);
       function invocationCountForCalldata(bytes calldata call) external returns (uint);

• Current naming conventions need to be preseved
• All functionality must have 100 % line and branch coverage
• The solidity style guide must be considered and code must be linted

Payout:
0.5 ETH
Additional GNO can be tipped according to the level of technical implementation

[fleupold]

Looks really good! A few small comments.

The MockContract allows for all of that without having to write a separate test contract each time.

This sentence could be slightly smoother, but I don't have a concrete suggestion either. Maybe @bh2smith ?

After the ANY example, we might want to add that ANY can be a e.g. a constant defined on the smart contract.

Should we also make the interface we expect to be implemented explicit?

function givenPartialCalldataReturn(bytes calldata call, bytes calldata response) external;
...

[josojo]

The MockContract allows for all of that without having to write a separate test contract each time.

Maybe like this?
The MockContract facilitates these features without requiring any separate test contracts.

Should we also make the interface we expect to be implemented explicit?

done

[josojo]

After the ANY example, we might want to add that ANY can be a e.g. a constant defined on the smart contract.

what is the value of making ANY also a constant? Probably, I do not understand.

[fleupold]

what is the value of making ANY also a constant?

ANY has to be defined somewhere, otherwise the code wouldn't compile. My suggestion would be to have it some magic value on the smart contract.

[bh2smith]

The MockContract facilitates these features without requiring any separate test contracts.

Much better!

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 0.5 ETH (106.07 USD @ $212.14/ETH) attached to it as part of the Gnosis fund.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $142,366.64 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Cancelled

---

Workers have applied to start work.

These users each claimed they can complete the work by 2 years, 4 months ago.
Please review their action plans below:

1) mikehathaway has applied to start work (Funders only: approve worker | reject worker).

I will use Truffle Suite tools to run a local Eth node and rapidly prototype a smart contract that can be used for mocking Gnosis contract interactions. Following completion of a contract that meets basic specifications, I will seek to iteratively improve it.

Learn more on the Gitcoin Issue Details page.

[gitcoinbot]

Issue Status: 1. Open 2. Cancelled

---

The funding of 0.5 ETH (67.09 USD @ $134.18/ETH) attached to this issue has been cancelled by the bounty submitter

• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $79,939.62 more funded OSS Work available on the Gitcoin Issue Explorer