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

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

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.)

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
3.6% Duplication on New Code (required ≤ 3%)
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

let mirrorNetworkAddress = client.mirrorNetwork[0];
let contractCallEndpoint = "/api/v1/contracts/call"

if (client.ledgerId?.isLocalNode) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if (client.ledgerId?.isLocalNode) {
if (!client.ledgerId || client.ledgerId.isLocalNode()) {

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
2 participants