Merge pull request #616 from api3dao/main

Initiate release

Author: bbenligiray

.changeset/curvy-wolves-draw.md

@@ -0,0 +1,16 @@
+---
+'@api3/contracts': patch
+---
+
+Updates RPC provider configurations:
+
+- Remove drpc from all
+- Remove blastapi from all
+- Add quicknode for linea, soneium, and sonic
+- Add blockpi for arbitrum, avalanche, base, berachain, blast, bsc, ethereum, gnosis, hyperliquid, ink, linea, mantle, metis, optimism, polygon-zkevm, polygon, scroll, sei, sonic, taiko, unichain, and x-layer
+- Add publicnode for arbitrum, avalanche, berachain, blast, bsc, optimism, scroll, and sonic
+- Add tenderly for apechain, berachain, ethereum, katana, metis, moonbeam, moonriver, optimism, polygon, scroll, taiko, and unichain
+- Add 0xrpc for gnosis
+- Remove alchemy from berachain, ink, optimism, polygon-zkevm, sonic, and unichain
+- Use publicnode as default provider for unichain
+- Add reblok for moonbeam and sei

.changeset/loud-cobras-feel.md

@@ -0,0 +1,7 @@
+---
+'@api3/contracts': patch
+---
+
+Updates RPC provider configurations:
+
+- Add publicnode and validationcloud providers for somnia chain.

.changeset/petite-dodos-drum.md

@@ -0,0 +1,17 @@
+---
+'@api3/contracts': patch
+---
+
+Update block explorer and verification API for following chains:
+
+- avalanche
+- avalanche-testnet
+- katana
+- monad-testnet
+- moonbeam
+- sei
+- sei-testnet
+
+Update verification API for:
+
+- polygon-zkevm-sepolia-testnet

.changeset/slick-words-remain.md

@@ -0,0 +1,7 @@
+---
+'@api3/contracts': major
+---
+
+Update hardhat config to use Etherscan V2 API
+Update chains schema to use verificationApi instead of api
+Update chains schema to use blockExplorerUrl instead of browserUrl

.github/workflows/validate-verify.yml

@@ -33,6 +33,10 @@ jobs:
         run: pnpm build
         id: build
 
+      - name: Validate verification API
+        run: pnpm validate-verification-api
+        if: steps.build.outcome == 'success'
+
       - name: Validate deployments
         run: pnpm validate-deployments
         if: steps.build.outcome == 'success'

README.md

@@ -290,9 +290,28 @@ console.log(address);
 */
 ```
 
+### hardhatConfig.blockscout()
+
+Returns an object that can be used as the `blockscout` field of [`hardhat.config.js`](https://hardhat.org/hardhat-runner/docs/config) (requires the [`hardhat-etherscan` plugin](https://v2.hardhat.org/hardhat-runner/plugins/nomicfoundation-hardhat-verify)).
+
+It includes a `customChains` field that includes all chains that support Blockscout contract verification API.
+
+```ts
+import { hardhatConfig } from '@api3/contracts';
+console.log(hardhatConfig.blockscout());
+/*
+{
+  enabled: true,
+  customChains: [
+    ...
+  ]
+}
+*/
+```
+
 ### hardhatConfig.networks()
 
-Returns an object where the key is each chain's alias and the value is an object that can be used as the `networks` field of [`hardhat.config.js`](https://hardhat.org/hardhat-runner/docs/config).
+Returns an object where the key is each chain's alias and the value is an object that can be used as the `networks` field of [`hardhat.config.js`](https://v2.hardhat.org/hardhat-runner/docs/config).
 
 The default `url` values can be overridden with chain specific environment variables. These environment variables take the form of `HARDHAT_HTTP_RPC_URL_${toUpperSnakeCase(chain.alias)}`. e.g. `HARDHAT_HTTP_RPC_URL_ARBITRUM_SEPOLIA_TESTNET`.
 
@@ -313,18 +332,16 @@ console.log(hardhatConfig.networks());
 
 ### hardhatConfig.etherscan()
 
-Returns an object where the key is each chain's alias and the value is an object that can be used as the `etherscan` field of [`hardhat.config.js`](https://hardhat.org/hardhat-runner/docs/config) (requires the [`hardhat-etherscan` plugin](https://hardhat.org/hardhat-runner/plugins/nomiclabs-hardhat-etherscan)).
+Returns an object that can be used as the `etherscan` field of [`hardhat.config.js`](https://v2.hardhat.org/hardhat-runner/docs/config) (requires the [`hardhat-etherscan` plugin](https://v2.hardhat.org/hardhat-runner/plugins/nomicfoundation-hardhat-verify)).
 
-NOTE: [hardhat-etherscan](https://www.npmjs.com/package/@nomiclabs/hardhat-etherscan) requires us to use a dummy API key with Blockscout block explorer APIs. We use "DUMMY_VALUE" but it could have been anything else.
+It includes an `apiKey` field that can be set through the `ETHERSCAN_API_KEY` environment variable. And a `customChains` field that includes all chains that support Etherscan V2 contract verification API.
 
 ```ts
 import { hardhatConfig } from '@api3/contracts';
 console.log(hardhatConfig.etherscan());
 /*
 {
-  apiKey: {
-    'arbitrumSepolia': { ... }
-  },
+  apiKey: someApiKey,
   customChains: [
     ...
   ]
@@ -334,19 +351,16 @@ console.log(hardhatConfig.etherscan());
 
 ### hardhatConfig.getEnvVariableNames()
 
-Returns an array of expected environment variable names for chains that have an API key required for the explorer. The array also includes a single `MNEMONIC` variable that can be used to configure all networks.
-
-NOTE: Each `ETHERSCAN_API_KEY_` and `HARDHAT_HTTP_RPC_URL_` environment variable has the chain alias as a suffix, where the alias has been converted to upper snake case.
+Returns an API key required for Etherscan V2 contract verification API and a single `MNEMONIC` variable that can be used to configure all networks.
 
 ```ts
 import { hardhatConfig } from '@api3/contracts';
 console.log(hardhatConfig.getEnvVariableNames());
 /*
 [
   'MNEMONIC',
-  'ETHERSCAN_API_KEY_ARBITRUM_SEPOLIA_TESTNET',
-  ...
-  'HARDHAT_HTTP_RPC_URL_ARBITRUM_SEPOLIA_TESTNET',
+  'ETHERSCAN_API_KEY',
+  'HARDHAT_HTTP_RPC_URL_APECHAIN_ARBITRUM_SEPOLIA_TESTNET',
   ...
 ]
 */

data/chains/apechain-arbitrum-sepolia-testnet.json

@@ -1,15 +1,7 @@
 {
   "alias": "apechain-arbitrum-sepolia-testnet",
+  "blockExplorerUrl": "https://curtis.apescan.io/",
   "decimals": 18,
-  "explorer": {
-    "api": {
-      "key": {
-        "required": true
-      },
-      "url": "https://api-curtis.apescan.io/api"
-    },
-    "browserUrl": "https://curtis.apescan.io/"
-  },
   "id": "33111",
   "name": "ApeChain testnet",
   "providers": [
@@ -19,5 +11,8 @@
     }
   ],
   "symbol": "APE",
-  "testnet": true
+  "testnet": true,
+  "verificationApi": {
+    "type": "etherscan"
+  }
 }

data/chains/apechain.json

@@ -1,15 +1,7 @@
 {
   "alias": "apechain",
+  "blockExplorerUrl": "https://apescan.io/",
   "decimals": 18,
-  "explorer": {
-    "api": {
-      "key": {
-        "required": true
-      },
-      "url": "https://api.apescan.io/api"
-    },
-    "browserUrl": "https://apescan.io/"
-  },
   "id": "33139",
   "name": "ApeChain",
   "providers": [
@@ -26,14 +18,13 @@
       "homepageUrl": "https://alchemy.com"
     },
     {
-      "alias": "blastapi",
-      "homepageUrl": "https://blastapi.io"
-    },
-    {
-      "alias": "drpc",
-      "homepageUrl": "https://drpc.org"
+      "alias": "tenderly",
+      "homepageUrl": "https://tenderly.co/"
     }
   ],
   "symbol": "APE",
-  "testnet": false
+  "testnet": false,
+  "verificationApi": {
+    "type": "etherscan"
+  }
 }

data/chains/arbitrum-sepolia-testnet.json

@@ -1,16 +1,7 @@
 {
   "alias": "arbitrum-sepolia-testnet",
+  "blockExplorerUrl": "https://sepolia.arbiscan.io/",
   "decimals": 18,
-  "explorer": {
-    "api": {
-      "key": {
-        "hardhatEtherscanAlias": "arbitrumSepolia",
-        "required": true
-      },
-      "url": "https://api-sepolia.arbiscan.io/api"
-    },
-    "browserUrl": "https://sepolia.arbiscan.io/"
-  },
   "id": "421614",
   "name": "Arbitrum testnet",
   "providers": [
@@ -24,5 +15,8 @@
     }
   ],
   "symbol": "ETH",
-  "testnet": true
+  "testnet": true,
+  "verificationApi": {
+    "type": "etherscan"
+  }
 }

data/chains/arbitrum.json

@@ -1,16 +1,7 @@
 {
   "alias": "arbitrum",
+  "blockExplorerUrl": "https://arbiscan.io/",
   "decimals": 18,
-  "explorer": {
-    "api": {
-      "key": {
-        "hardhatEtherscanAlias": "arbitrumOne",
-        "required": true
-      },
-      "url": "https://api.arbiscan.io/api"
-    },
-    "browserUrl": "https://arbiscan.io/"
-  },
   "id": "42161",
   "name": "Arbitrum One",
   "providers": [
@@ -19,12 +10,8 @@
       "rpcUrl": "https://arb1.arbitrum.io/rpc"
     },
     {
-      "alias": "blastapi",
-      "homepageUrl": "https://blastapi.io"
-    },
-    {
-      "alias": "drpc",
-      "homepageUrl": "https://drpc.org"
+      "alias": "publicnode",
+      "rpcUrl": "https://arbitrum-one-rpc.publicnode.com"
     },
     {
       "alias": "quicknode",
@@ -33,8 +20,15 @@
     {
       "alias": "reblok",
       "homepageUrl": "https://reblok.io"
+    },
+    {
+      "alias": "blockpi",
+      "homepageUrl": "https://blockpi.io"
     }
   ],
   "symbol": "ETH",
-  "testnet": false
+  "testnet": false,
+  "verificationApi": {
+    "type": "etherscan"
+  }
 }