fix: `eth_estimateGas` opts to fallback estimation for contract revert #2834

victor-yanev · 2024-08-16T09:46:16Z

Description:

This PR modifies the EthImpl class to improve error handling for gas estimation.

Add logic to return predefined.CONTRACT_REVERT JSON-RPC error with the revert reason in case of contract revert
Extend predefined.CONTRACT_REVERT to cover more edge cases when decoding error messages
Extend tests for decodeErrorMessage and predefined.CONTRACT_REVERT
Extend tests for eth_estimateGas with the new logic for reverting calls

Related issue(s):

Fixes #2830

Solves problem in #2821

Notes for reviewer:

Checklist

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

…verts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

github-actions · 2024-08-16T12:43:29Z

Acceptance Tests

  18 files 225 suites 28m 23s ⏱️
611 tests 591 ✔️ 4 💤 16 ❌
719 runs 699 ✔️ 4 💤 16 ❌

Results for commit a2d38ea.

♻️ This comment has been updated with latest results.

acuarica

Shouldn't we include some tests for this new scenario?

…verts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev · 2024-08-16T12:57:14Z

Shouldn't we include some tests for this new scenario?

Good point, I will extend the tests for eth_estimateGas

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

github-actions · 2024-08-16T13:54:48Z

Tests

      3 files   203 suites 53s ⏱️
1 030 tests 1 029 ✔️ 1 💤 0 ❌
1 043 runs 1 042 ✔️ 1 💤 0 ❌

Results for commit a2d38ea.

♻️ This comment has been updated with latest results.

acuarica

looking good, left some questions

packages/relay/src/lib/eth.ts

acuarica · 2024-08-16T15:55:04Z

Nit: I think we should the remove the "Fixes #2821" from this PR's description, and replace it by something like "Related to #2821". The reason is that we wouldn't want to close #2821 when we merge this PR, but instead close it when the Axelar team can effectively confirm the issue is solved, which is when we make a new release containing this fix.

…ED error message Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

sonarqubecloud · 2024-08-16T18:15:41Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

natanasow

LGTM

codecov · 2024-08-19T14:47:28Z

Codecov Report

Attention: Patch coverage is 81.81818% with 2 lines in your changes missing coverage. Please review.

Project coverage is 81.28%. Comparing base (59a808d) to head (a2d38ea).
Report is 5 commits behind head on main.

Files	Patch %	Lines
packages/relay/src/lib/eth.ts	33.33%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2834      +/-   ##
==========================================
+ Coverage   81.26%   81.28%   +0.02%     
==========================================
  Files          46       46              
  Lines        3394     3415      +21     
  Branches      707      716       +9     
==========================================
+ Hits         2758     2776      +18     
+ Misses        414      410       -4     
- Partials      222      229       +7

Flag	Coverage Δ
relay	`80.94% <81.81%> (+0.03%)`	⬆️
server	`81.53% <ø> (ø)`
ws-server	`97.87% <ø> (ø)`

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

Files	Coverage Δ
packages/relay/src/lib/errors/JsonRpcError.ts	`70.58% <100.00%> (+4.63%)`	⬆️
...ages/relay/src/lib/errors/MirrorNodeClientError.ts	`87.50% <100.00%> (+1.13%)`	⬆️
packages/relay/src/lib/eth.ts	`81.04% <33.33%> (-0.53%)`	⬇️

... and 2 files with indirect coverage changes

#2834) * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * test: extend tests in eth_estimateGas.spec.ts to cover the new logic Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * test: fix failing postman tests due to missing 'from' field Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: throw predefined.CONTRACT_REVERT only for CONTRACT_REVERT_EXECUTED error message Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: use `Status.ContractRevertExecuted` from `@hashgraph/sdk` Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> --------- Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

#2834) * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * test: extend tests in eth_estimateGas.spec.ts to cover the new logic Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * test: fix failing postman tests due to missing 'from' field Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: throw predefined.CONTRACT_REVERT only for CONTRACT_REVERT_EXECUTED error message Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: use `Status.ContractRevertExecuted` from `@hashgraph/sdk` Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> --------- Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> Signed-off-by: Logan Nguyen <logan.nguyen@swirldslabs.com>

fix: `eth_estimateGas` opts to fallback estimation for contract revert (#2834) * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts * test: extend tests in eth_estimateGas.spec.ts to cover the new logic * test: fix failing postman tests due to missing 'from' field * fix: throw predefined.CONTRACT_REVERT only for CONTRACT_REVERT_EXECUTED error message * fix: use `Status.ContractRevertExecuted` from `@hashgraph/sdk` --------- Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> Signed-off-by: Logan Nguyen <logan.nguyen@swirldslabs.com> Co-authored-by: Victor Yanev <161485803+victor-yanev@users.noreply.github.com>

#2834) * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: `eth_estimateGas` opts to fallback estimation when a contract reverts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * test: extend tests in eth_estimateGas.spec.ts to cover the new logic Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * test: fix failing postman tests due to missing 'from' field Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: throw predefined.CONTRACT_REVERT only for CONTRACT_REVERT_EXECUTED error message Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> * fix: use `Status.ContractRevertExecuted` from `@hashgraph/sdk` Signed-off-by: Victor Yanev <victor.yanev@limechain.tech> --------- Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

fix: eth_estimateGas opts to fallback estimation when a contract re…

6e71e26

…verts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev added bug Something isn't working enhancement New feature or request labels Aug 16, 2024

victor-yanev added this to the 0.55.0 milestone Aug 16, 2024

victor-yanev requested review from Ivo-Yankov, georgi-l95, natanasow, konstantinabl and quiet-node August 16, 2024 09:46

victor-yanev self-assigned this Aug 16, 2024

victor-yanev requested review from AlfredoG87, ebadiere, lukelee-sl and a team as code owners August 16, 2024 09:46

fix: eth_estimateGas opts to fallback estimation when a contract re…

7c3af69

…verts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

acuarica requested changes Aug 16, 2024

View reviewed changes

fix: eth_estimateGas opts to fallback estimation when a contract re…

7e532ab

…verts Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

test: extend tests in eth_estimateGas.spec.ts to cover the new logic

b0369c7

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev requested a review from acuarica August 16, 2024 13:04

test: fix failing postman tests due to missing 'from' field

1a0bfbc

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

acuarica reviewed Aug 16, 2024

View reviewed changes

packages/relay/src/lib/eth.ts Outdated Show resolved Hide resolved

packages/relay/src/lib/eth.ts Outdated Show resolved Hide resolved

packages/relay/src/lib/eth.ts Outdated Show resolved Hide resolved

victor-yanev added 2 commits August 16, 2024 21:04

fix: throw predefined.CONTRACT_REVERT only for CONTRACT_REVERT_EXECUT…

304c592

…ED error message Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

fix: use Status.ContractRevertExecuted from @hashgraph/sdk

a2d38ea

Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>

victor-yanev requested a review from acuarica August 16, 2024 18:28

natanasow approved these changes Aug 19, 2024

View reviewed changes

konstantinabl approved these changes Aug 19, 2024

View reviewed changes

acuarica approved these changes Aug 19, 2024

View reviewed changes

victor-yanev merged commit 5853e30 into main Aug 19, 2024
38 checks passed

victor-yanev deleted the 2830-Calling-eth_estimateGas-opts-to-fallback-estimation-when-a-contract-revert-is-executed branch August 19, 2024 14:47

quiet-node mentioned this pull request Aug 19, 2024

chore: cherry picked PR#2834 #2845

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: `eth_estimateGas` opts to fallback estimation for contract revert #2834

fix: `eth_estimateGas` opts to fallback estimation for contract revert #2834

victor-yanev commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

acuarica left a comment

victor-yanev commented Aug 16, 2024

github-actions bot commented Aug 16, 2024 •

edited

Loading

acuarica left a comment

acuarica commented Aug 16, 2024

sonarqubecloud bot commented Aug 16, 2024

natanasow left a comment

codecov bot commented Aug 19, 2024

fix: eth_estimateGas opts to fallback estimation for contract revert #2834

fix: eth_estimateGas opts to fallback estimation for contract revert #2834

Conversation

victor-yanev commented Aug 16, 2024 • edited Loading

github-actions bot commented Aug 16, 2024 • edited Loading

Acceptance Tests

acuarica left a comment

Choose a reason for hiding this comment

victor-yanev commented Aug 16, 2024

github-actions bot commented Aug 16, 2024 • edited Loading

Tests

acuarica left a comment

Choose a reason for hiding this comment

acuarica commented Aug 16, 2024

sonarqubecloud bot commented Aug 16, 2024

Quality Gate passed

natanasow left a comment

Choose a reason for hiding this comment

codecov bot commented Aug 19, 2024

Codecov Report

fix: `eth_estimateGas` opts to fallback estimation for contract revert #2834

fix: `eth_estimateGas` opts to fallback estimation for contract revert #2834

victor-yanev commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading