Developer mode

[Ivo-Yankov]

Description:

Adds a developer mode to the relay. Currently it only changes the behaviour of eth_getTransactionByHash, but in the future it can be used for enabling special settings in the local node, which will make it run faster.

The following code is a standard way to assert for the revert message of a contract call when using hardhat with its internal evm or any Ethereum JsonRpcRelay:

await expect(someContract.revertWithString()).to.be.revertedWith("Some revert message");

But the same code does not work when it is configured to use the relay. The difference is in eth_estimateGas - normally it throws a JsonRpc error, but in Hedera's context that is not an option. Developer mode changes the behaviour of eth_getTransactionByHash to throw that same error after it has retrieved the error_message from the Mirror node.

Related issue(s):

Fixes #

Notes for reviewer:

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

[codecov-commenter]

Codecov Report

Base: 70.60% // Head: 70.75% // Increases project coverage by +0.15% 🎉

Coverage data is based on head (31b8411) compared to base (1c14d9b).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #668      +/-   ##
==========================================
+ Coverage   70.60%   70.75%   +0.15%     
==========================================
  Files          16       16              
  Lines        1167     1173       +6     
  Branches      205      207       +2     
==========================================
+ Hits          824      830       +6     
  Misses        286      286              
  Partials       57       57              

Impacted Files	Coverage Δ
packages/relay/src/lib/eth.ts	82.66% <100.00%> (+0.20%)	⬆️
packages/relay/src/lib/constants.ts	100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[Nana-EC]

Changes are great,
Just need to fill in the documentation holes so it's easier understood. Especially since you have a vision for dev mode

This is my suggestion to make sure everyone understands and it's exposed to users.

1. Add a docs/dev-mode.md file as part of your PR
   a. It should have an initial summary with your vision for dev mode.
   b. It should have a sub section that has the above summary focused on ethersjs revert error work around.
2. Add a link under the main README where you set the DEV_MODE = false that points to the dev-mode.md for more details
3. Update the https://github.com/hashgraph/hedera-json-rpc-relay/tree/main/tools#supported-tools section with a note that points to the dev mode feature for ethersjs support

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[Nana-EC]

LG