feat: add support for scenario testing

[tmigone]

Motivation

This PR adds support for e2e "scenario" testing. Scenarios are special tests that:

• Test the execution of common protocol actions.
• Can be run against any network at any time and the tests should pass.
• Can perform read and write interactions with the blockchain. Requires an account with sufficient balance!
• Example: a test validating that a user can add signal to a subgraph.

Scenarios are defined by an optional script and a test file:

• Optional ts script
  • The objective of this script is to perform actions on the protocol to advance it's state to the desired one.
  • Should follow hardhat script convention.
  • Should be named e2e/scenarios/{scenario-name}.ts.
  • They run before the test file.
• Test file
  • Should be named e2e/scenarios/{scenario-name}.test.ts.
  • Standard chai/mocha/hardhat/ethers test file.

Usage

The following command will run a scenario against the provided network:

# Run a single scenario
npx hardhat e2e:scenario <scenario-name> --network <network> --graph-config config/config.<network>.yml

Scenarios are also run as part of the e2e test suite, in this case scenarios are run one by one, meaning the script for a scenario is run followed by it's tests and only then the next scenario is run. This is to preserve the state between scenario runs as we don't know how the actions in one scenario can affect the next one.

# Run all e2e tests, including all scenarios
npx hardhat e2e --network <network> --graph-config config/config.<network>.yml

Finally, the scenario scripts can also be ran independently from the tests as they are regular hardhat scripts:

# Run only the script
npx hardhat run e2e/scenario/<scenario-name>.ts --network <network> --graph-config config/config.<network>.yml

Note that in all cases the protocol needs to be deployed and setup on the target network beforehand. Alternatively, you can run yarn test:e2e which will deploy a local network and run all e2e tests.

Changes

• Add e2e:scenario hardhat task to run a specific scenario
• Modify e2e hardhat task to run all scenarios as part of the test suite
• Add WIP "scenario1" (need better name), which corresponds to step 1.2 on L2 Testnet Validation plan.

[codecov]

Codecov Report

Merging #660 (91b467b) into dev (358a8ec) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #660   +/-   ##
=======================================
  Coverage   90.35%   90.35%           
=======================================
  Files          35       35           
  Lines        1762     1762           
  Branches      296      296           
=======================================
  Hits         1592     1592           
  Misses        170      170           

Flag	Coverage Δ
unittests	90.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 358a8ec...91b467b. Read the comment docs.