Support WaffleJS testing

[arianejasuwienas]

Problem

To create a custom Fixture Service, we need the ability to snapshot and revert the blockchain state. This feature is essential for efficient testing and development workflows using tools like the fixtures system of the WaffleJs library.

Solution

Implement snapshotting (evm_snapshot) and reverting (evm_revert) functionalities on the Hedera network. These functionalities should be integrated into separate Fixtures Service, utilising the alternative of the Hedera JSON RPC Relay to allow interaction through standard JSON RPC calls but also being able to create snapshot and revert the state of the machine.

Alternatives

No response

Research

Beta Give feedback

1. Research existing snapshot and revert implementations (e.g., Ethereum’s evm_snapshot and evm_revert on Ganache cli).
2. Research the possibility to utilise the Mirror Node for capturing network states
3. Design the architecture for snapshot and revert functionalities in the Hedera network.

Project management

Beta Give feedback

1. Create the GitHub Project for the Fixture Service tool.
2. Create workflows to continuously test the implemented solution.

Implement the evm_snapshot endpoint in the Fixtures Service utilising the Hedera JSON RPC Relay.

Beta Give feedback

1. Implement the logic to handle snapshot creation.
2. Implement the logic to handle snapshot creation.
3. Create unit tests for the new endpoints.

Implement the evm_snapshot endpoint in the Fixtures Service utilising the Hedera JSON RPC Relay

Beta Give feedback

1. Implement the logic to handl state reversion
2. Update the Relay’s API documentation to include the new endpoint.
3. Create unit tests for the new endpoints.

Sample usage example, tests

Beta Give feedback

1. Write documentation for the new tool.
2. Write tests to ensure the correct functionality of snapshotting and reverting features (integration / e2e).
3. Sample usage of the implemented solution can be included in the Hedera Json RPC Relay repository, using Waffle with the default https / wss hedera provider.

[acuarica]

Both evm_snapshot and evm_revert are implemented by the Ethereum Development Environment to support forking. See for example foundry-rs/foundry#1162. Instead of implementing these into Hedera Network, we provide HTS emulation as part of our current solution.

However, we need to ensure that WaffleJS library works as expected with our forking support. Create a WaffleJS minimal project that uses fixtures/forking similar to the tests we currently have. Put this under test-e2e/waffle folder. We have similar examples showcasing the Waffle on the Relay here

• https://github.com/hashgraph/hedera-json-rpc-relay/tree/main/tools/waffle-example and
• https://github.com/hashgraph/hedera-json-rpc-relay/tree/POC-for-waffle-fixtures/tools/waffle-example

[arianejasuwienas]

Something like that?

hashgraph/hedera-json-rpc-relay#3016 (comment)

[acuarica]

Exactly.

[arianejasuwienas]

Ganache is not capable of creating the necessary fork for our use case, as it fails to download the HTS Smart Contract code at runtime from the forked network JSON RPC API. Given that we are already focusing on Hardhat for our development, and the addition of Waffle doesn't provide any significant benefit, I've closed the PR.

More details:

1. before processing eth_call ganache tries to deduct the accounts taking part in the simulation:

https://github.com/trufflesuite/ganache/blob/develop/packages/ethereum/ethereum/src/helpers/run-call.ts#L115

2. and fetches the code for each of them:

https://github.com/trufflesuite/ganache/blob/547c900a50d19b094ef636a9aeccf4f7f2356430/packages/ethereum/ethereum/src/forking/trie.ts#L198

3. Then starts an EVM simulation on the prepared data. Unfortunately as soon as the EVM is called it no longer tries to fetch any additional data for calls to different smart contracts (as it happens in hardhat); it fails instead....

Let me know if we should close this issue too @acuarica .

[acuarica]

Thanks for the detailed information @arianejasuwienas. Yes, I'll close this.