Fetch BNB, MATIC, AVAX, HR or MOVR gas price #251

lucaperret · 2021-07-27T15:53:53Z

Supports multiple tokens.

cblanquera · 2021-08-01T10:47:19Z

+1

ASlowCheetah · 2021-08-01T23:44:15Z

+1

enzoferey · 2021-10-05T09:06:58Z

This would be great 🚀

lucaperret · 2021-10-28T14:03:00Z

Hey @cgewecke could you please consider a review of this PR?

cgewecke · 2021-10-28T23:30:41Z

@lucaperret Apologies, yes I will take a look over the weekend.... thanks for opening this.

lucaperret · 2021-11-12T08:23:02Z

Hi @cgewecke, any chance you could look at it soon? This PR is opened since more than 3 months and seems that some people are looking forward to the merge and publishing.
Thank you in advance,
Luca

cblanquera · 2021-11-12T17:54:19Z

This is what I have been basically doing ... @lucaperret you were able to help me out on some great demos recently.

"devDependencies": {
  ...
  "eth-gas-reporter": "git+https://github.com/lucaperret/eth-gas-reporter#6ac872b599adcaa8aab40808576e769c6872eb38",
  ...
},

shannonwells · 2021-11-18T20:15:51Z

I would really ❤️ this feature, thanks!

irux · 2021-11-21T18:49:11Z

me too!

cgewecke

This is really nice, apologies for letting it languish.

I have a question about the use context and whether there needs to be some additional info in the README about accuracy of gas readings.

Many people will be running their tests against an ethereumjs-vm EVM using HardhatEVM or ganache.

I assume Polygon and BSC are consuming gas at similar rates to an ETH client because they are ETH forks, but is this the case for the other chains you've added support for here?

cgewecke · 2021-11-24T17:15:16Z

README.md

+| coinmarketcap     | _String_               | (unprotected API key)                                           | [API key][55] to use when fetching current market price data. (Use this if you stop seeing price data)                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| gasPrice          | _Number_               | (varies)                                                        | Denominated in `gwei`. Default is loaded at runtime from the `eth gas station` api                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| token             | _String_               | 'ETH'                                                           | The reference token for gas price                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| gasPriceApi       | _String_               | [ethgasstation](https://ethgasstation.info/json/ethgasAPI.json) | The API endpoint to retrieve the gas price. Could be also [BSC](https://api.bscscan.com/api?module=proxy&action=eth_gasPrice&apikey=YourApiKeyToken), [Polygon](https://api.polygonscan.com/api?module=proxy&action=eth_gasPrice&apikey=YourApiKeyToken), [Avalanche](https://api.snowtrace.io/api?module=proxy&action=eth_gasPrice&apikey=YourApiKeyToken), [Heco](https://api.hecoinfo.com/api?module=proxy&action=eth_gasPrice&apikey=YourApiKeyToken), [Moonriver](https://api-moonriver.moonscan.io/api?module=proxy&action=eth_gasPrice&apikey=YourApiKeyToken), |


The default in this PR looks like it's no longer ethGasStation - it's an eth_gasPrice call to etherscan?

(Thanks for all these links! Great.)

Would you consider adding a table below the config options with example tokens and gasPriceApi urls? If we can reliably fetch this data without an api key maybe that part of the url could be omitted?

Example token and gasPriceApi configurations

Any network call which returns a JSON-RPC response formatted as below is supported:

{"jsonrpc":"2.0","id":73,"result":"0x6fc23ac00"}

(By default, reporter calls https://api-cn.etherscan.com for the Ethereum network gas price.)

Other networks include:

Network token gasPriceApi

Binance BNB https://api.bscscan.com/api?module=proxy&action=eth_gasPrice

Polygon MATIC https://api.polygonscan.com/api?module=proxy&action=eth_gasPrice

Avalanche AVAX https://api.snowtrace.io/api?module=proxy&action=eth_gasPrice

Heco BIRD https://api.hecoinfo.com/api?module=proxy&action=eth_gasPrice

Moonriver MOVR https://api-moonriver.moonscan.io/api?module=proxy&action=eth_gasPrice

Makes sense, I made this change on the doc and config files.

shannonwells · 2021-11-24T19:28:15Z

mock/config-template.js

@@ -12,6 +12,9 @@ module.exports = {
    reporterOptions: {
      currency: "chf",
      gasPrice: 21,
+      token: "ETH",
+      gasPriceApi:
+        "https://api-cn.etherscan.com/api?module=proxy&action=eth_gasPrice&apikey=YourApiKeyToken",


If I may butt in on this one, it would be appreciated to note in the README what the default gasPriceApi URL is.

+1. Have added a note above about possibly making a table of urls and token names for easy copy-pasting and that would be a good place to put any additional info about this feature.

Good point, also I changed the Etherscan endpoint to be compliant with their doc.

cgewecke · 2021-11-25T03:38:48Z

lib/utils.js

        response = JSON.parse(response);
-        config.gasPrice = Math.round(response.safeLow / 10);
+        config.gasPrice = Math.round(
+          parseInt(response.result, 16) / Math.pow(10, 9)


Checked this ... looks good.

lucaperret

I've made some changes to take your comments into account. Thank you.

cgewecke

Looks great!

feat(gas): allow to fetch BNB and MATIC price

6ac872b

feat(GasPriceAPI): add Avalanche, Heco and Moonriver

01caf2f

lucaperret changed the title ~~feat(gas): allow to fetch BNB and MATIC price~~ Fetch BNB, MATIC, AVAX, HR or MOVR gas price Nov 4, 2021

cgewecke reviewed Nov 24, 2021

View reviewed changes

shannonwells reviewed Nov 24, 2021

View reviewed changes

cgewecke reviewed Nov 25, 2021

View reviewed changes

lucaperret added 2 commits November 25, 2021 11:00

fix(gasPriceApi): default to etherscan.io API

6edc718

docs(README): add gasPriceApi networks details

5b6c6fe

lucaperret commented Nov 25, 2021

View reviewed changes

cgewecke self-requested a review November 25, 2021 18:23

cgewecke approved these changes Nov 25, 2021

View reviewed changes

cgewecke merged commit 27ba98a into cgewecke:master Nov 25, 2021

cgewecke mentioned this pull request Nov 29, 2021

Update eth-gas-reporter to 0.2.23 / fix gas & coin price race condition cgewecke/hardhat-gas-reporter#80

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fetch BNB, MATIC, AVAX, HR or MOVR gas price #251

Fetch BNB, MATIC, AVAX, HR or MOVR gas price #251

lucaperret commented Jul 27, 2021

cblanquera commented Aug 1, 2021

ASlowCheetah commented Aug 1, 2021

enzoferey commented Oct 5, 2021

lucaperret commented Oct 28, 2021

cgewecke commented Oct 28, 2021

lucaperret commented Nov 12, 2021

cblanquera commented Nov 12, 2021 •

edited

shannonwells commented Nov 18, 2021

irux commented Nov 21, 2021

cgewecke left a comment

cgewecke Nov 24, 2021

cgewecke Nov 25, 2021

lucaperret Nov 25, 2021

shannonwells Nov 24, 2021 •

edited

cgewecke Nov 25, 2021 •

edited

lucaperret Nov 25, 2021

cgewecke Nov 25, 2021

lucaperret left a comment

cgewecke left a comment

Network	`token`	`gasPriceApi`
Binance	BNB	https://api.bscscan.com/api?module=proxy&action=eth_gasPrice
Polygon	MATIC	https://api.polygonscan.com/api?module=proxy&action=eth_gasPrice
Avalanche	AVAX	https://api.snowtrace.io/api?module=proxy&action=eth_gasPrice
Heco	BIRD	https://api.hecoinfo.com/api?module=proxy&action=eth_gasPrice
Moonriver	MOVR	https://api-moonriver.moonscan.io/api?module=proxy&action=eth_gasPrice

Fetch BNB, MATIC, AVAX, HR or MOVR gas price #251

Fetch BNB, MATIC, AVAX, HR or MOVR gas price #251

Conversation

lucaperret commented Jul 27, 2021

cblanquera commented Aug 1, 2021

ASlowCheetah commented Aug 1, 2021

enzoferey commented Oct 5, 2021

lucaperret commented Oct 28, 2021

cgewecke commented Oct 28, 2021

lucaperret commented Nov 12, 2021

cblanquera commented Nov 12, 2021 • edited

shannonwells commented Nov 18, 2021

irux commented Nov 21, 2021

cgewecke left a comment

Choose a reason for hiding this comment

cgewecke Nov 24, 2021

Choose a reason for hiding this comment

cgewecke Nov 25, 2021

Choose a reason for hiding this comment

Example token and gasPriceApi configurations

lucaperret Nov 25, 2021

Choose a reason for hiding this comment

shannonwells Nov 24, 2021 • edited

Choose a reason for hiding this comment

cgewecke Nov 25, 2021 • edited

Choose a reason for hiding this comment

lucaperret Nov 25, 2021

Choose a reason for hiding this comment

cgewecke Nov 25, 2021

Choose a reason for hiding this comment

lucaperret left a comment

Choose a reason for hiding this comment

cgewecke left a comment

Choose a reason for hiding this comment

cblanquera commented Nov 12, 2021 •

edited

Example `token` and `gasPriceApi` configurations

shannonwells Nov 24, 2021 •

edited

cgewecke Nov 25, 2021 •

edited