Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Implement MirrorNodeContractQuery #2723

Merged
merged 29 commits into from
Jan 9, 2025
Merged

Conversation

ivaylonikolov7
Copy link
Contributor

@ivaylonikolov7 ivaylonikolov7 commented Dec 16, 2024

Description:

A new MirrorNodeContractQuery class has been introduced to support EVM gas estimation and simulation. This query class provides two distinct types of queries:

MirrorNodeContractCallQuery – Executes a contract call and returns the result, simulating the execution of the contract.
MirrorNodeContractEstimateGasQuery – Estimates the gas usage for a contract call, allowing developers to understand the cost of executing a transaction.
The inputs for these queries match those of ContractExecuteTransaction, making it easy for developers to calculate the cost of a follow-up transaction.

The MirrorNodeContractQuery issues an HTTP request to the api/v1/contracts/call endpoint of the Mirror Node Web3 module, which supports both gas estimation and transient simulation of state-changing transactions. This enables accurate cost predictions and helps developers optimize their contract interactions before executing them on the network.

Related issue(s):

Fixes #2670

Notes for reviewer:

  • need to update package-lock.json in examples/
  • need to add @returns for JSDOCs in both queries
  • need to add dictionary that switches between different mirror node networks

Checklist

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

@ivaylonikolov7 ivaylonikolov7 marked this pull request as ready for review January 7, 2025 09:06
@ivaylonikolov7 ivaylonikolov7 requested review from a team as code owners January 7, 2025 09:06
ivaylonikolov7 and others added 14 commits January 7, 2025 12:10
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivan Ivanov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
@ivaylonikolov7 ivaylonikolov7 force-pushed the feat/estimate-contract-call-gas branch from 5b03ab6 to 3af5c92 Compare January 7, 2025 10:10
Signed-off-by: Ivaylo Nikolov <[email protected]>
Signed-off-by: Ivaylo Nikolov <[email protected]>
0xivanov
0xivanov previously approved these changes Jan 9, 2025
Copy link
Contributor

@0xivanov 0xivanov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

examples/mirror-node-contract-queries-example.js Outdated Show resolved Hide resolved
src/query/MirrorNodeContractQuery.js Outdated Show resolved Hide resolved
src/query/MirrorNodeContractQuery.js Show resolved Hide resolved
src/query/MirrorNodeContractQuery.js Outdated Show resolved Hide resolved
test/integration/MirrorNodeContractQuery.js Show resolved Hide resolved
Signed-off-by: Ivaylo Nikolov <[email protected]>
0xivanov
0xivanov previously approved these changes Jan 9, 2025
Copy link
Contributor

@0xivanov 0xivanov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@ivaylogarnev-limechain ivaylogarnev-limechain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Ivaylo Nikolov <[email protected]>
Copy link

sonarqubecloud bot commented Jan 9, 2025

Quality Gate Failed Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Copy link
Contributor

@ivaylogarnev-limechain ivaylogarnev-limechain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@0xivanov 0xivanov merged commit ddcf3d4 into main Jan 9, 2025
13 of 14 checks passed
@0xivanov 0xivanov deleted the feat/estimate-contract-call-gas branch January 9, 2025 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a query to estimate the gas of a contract call
3 participants