[contract-wrappers] Test revert with reason when decoding call result

[dekz]

We use in-process ganache which throws on an RPC error. This means all of our tests get a nice revert error thrown when testing against ganache. This is not possible with RPC providers and a revert with reason result is returned. Our callAsync doesn't handle this and attempts to decode the revert with reason error log as a successful log, which results in an error while decoding. Resulting in a invalid data for function output error, usually on takerFeePaid which is confusing to debug.

Description

This only works with our fork of ethers ethers-io/ethers.js#188 and will need to be re-worked when updating to Ethers.js 4.

We don't use the decode method directly, but the Interface parse function. This decodes but catches and wraps the error

This is a little awkward to test as we use vmErrorsOnRPCResponse = true by default so this would always pass unless vmErrorsOnRPCResponse = false. Created a PR to update DefinitelyTyped to remove the any.

@LogvinovLeon's PR ended up merging in checking for revert reasons, this PR now just ensures we have a test against this.

Testing instructions

Needed to create a ganache provider which has vmErrorsOnRPCResponse = false and thus the contracts need to be redeployed in this in-memory provider.

Types of changes

Checklist:

• Prefix PR title with [WIP] if necessary.
• Prefix PR title with bracketed package name(s) corresponding to the changed package(s). For example: [sol-cov] Fixed bug.
• Add tests to cover changes as needed.
• Update documentation as needed.
• Add new entries to the relevant CHANGELOG.jsons.

[LogvinovLeon]

Please rebase off development. #1069 just got merged.

[fabioberger]

Ideally we would use a different provider for non-contracts tests that has vmErrorsOnRPCResponse set to false. @dekz is looking into this approach.

[coveralls]

Coverage increased (+0.2%) to 85.294% when pulling 21f6072 on bug/contract-wrappers/handle-revert-with-reason into 94baded on development.