From 9db2e71434fe8b5d4d64efb622eff4c0b872b2b2 Mon Sep 17 00:00:00 2001 From: cgewecke Date: Sat, 17 Aug 2024 15:51:32 -0700 Subject: [PATCH] Highlight need for Etherscan api keys in README and config examples (#241) --- README.md | 9 ++++++--- docs/advanced.md | 14 +++++++++++++- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 821a2f7..e6efbbe 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,7 @@ const config: HardhatUserConfig = { + Option setups for common and advanced use cases can be seen in the [Config Examples][2] docs. + Get a [free tier Coinmarketcap API key][3] if you want price data ++ (Also) get [free tier Etherscan API keys](#supported-networks) if you want price data for Ethereum mainnet or an L2 network. | Options | Type | Default | Description | | :------------------------------ | :--------: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -140,11 +141,13 @@ npx hardhat hhgas:merge "gasReporterOutput-*.json" API keys for the networks this plugin auto-configures via the `L1` and `L2` options are available from the links below. In many cases these aren't equired - you'll only need to set them if you start seeing rate-limit warnings. +:warning: **UPDATE:** Etherscan now requires api keys to fetch both L1 (Ethereum Mainnet) **and** L2 gas price data. (An example config [can be found here][2]) + **L2** -+ [arbitrum][113] (live `baseFeePerByte` prices require an API key) -+ [base][110] (live `blobBaseFee` prices require an API key) -+ [optimism][109] (live `blobBaseFee` prices require an API key) ++ [arbitrum][113] (live `baseFeePerByte` prices require an L2 API key ) ++ [base][110] (live `blobBaseFee` prices require an L2 API key) ++ [optimism][109] (live `blobBaseFee` prices require an L2 API key) **L1** diff --git a/docs/advanced.md b/docs/advanced.md index bcf6787..c3827a9 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -13,6 +13,18 @@ Some example gas reporter option settings for different use-cases +### Ethereum Mainnet + +*...with live market pricing* +```ts +const config: HardhatUserConfig = { + gasReporter: { + L1Etherscan: "ABC...", // Etherscan api key + coinmarketcap: "abc...", // Coinmarketcap api key + } +} +``` + ### L1 Network *...on a non-ethereum network with very low costs* @@ -33,7 +45,7 @@ const config: HardhatUserConfig = { const config: HardhatUserConfig = { gasReporter: { L2: "optimism", - L1Etherscan: "ABC...", + L1Etherscan: "ABC...", // Requires api keys for both Ethereum Mainnet and Optimism L2Etherscan: "ABC...", currency: "EUR", coinmarketcap: "abc...",