Merge pull request #1164 from makerdao/rpc-config-updates

Refactor RPC configuration

Author: b-pmcg

.env.sample

@@ -1,7 +1,6 @@
 # see README for information on env variables
 
-INFURA_KEY=
-ALCHEMY_KEY=
+
 ETHERSCAN_V2_API_KEY=
 GITHUB_TOKEN=
 USE_CACHE=true
@@ -13,6 +12,10 @@ DASHBOARD_PASSWORD=
 NEXT_PUBLIC_TENDERLY_RPC_KEY=
 NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=
 NEXT_PUBLIC_SUBGRAPH_API_KEY=
+NEXT_PUBLIC_RPC_MAINNET=
+NEXT_PUBLIC_RPC_ARBITRUM=
+NEXT_PUBLIC_RPC_ARBITRUM_TESTNET=
+
 
 # this is used to determine which database to fetch data from
 NEXT_PUBLIC_VERCEL_ENV=development

.github/workflows/e2e.yml

@@ -18,9 +18,7 @@ jobs:
           - test: wallet.spec
     runs-on: ubuntu-latest
     env:
-      INFURA_KEY: ${{ secrets.INFURA_KEY }}
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      ALCHEMY_KEY: ${{ secrets.ALCHEMY_KEY }}
       REDIS_URL: ${{ secrets.REDIS_URL }}
       USE_CACHE: true
       TENDERLY_API_KEY: ${{ secrets.TENDERLY_API_KEY }}

README.md

@@ -61,7 +61,7 @@ The portal seeks to rely on on-chain data as much as possible and to minimize re
 
 #### Network providers
 
-The portal uses the [Wagmi](https://wagmi.sh/react/getting-started) library in order to communicate with the Ethereum network through its React hooks, and [Viem](https://viem.sh/docs/getting-started) in order to do so through its public client as well as provide Web3 utilities. Both Wagmi and Viem work by connecting to JSON-RPC APIs via HTTP in order to provide on-chain data to web applications. By default, they provide default RPC URLs that can be used to get started. However, these RPCs keys can quickly become rate-limited when too many requests are made. In order to prevent this, it is recommended that you sign up and add your own API keys to the configuration for [Alchemy](https://docs.alchemy.com/reference/ethereum-api-quickstart) and [Infura](https://docs.infura.io/infura/networks/ethereum/how-to/secure-a-project/project-id).
+The portal uses the [Wagmi](https://wagmi.sh/react/getting-started) library in order to communicate with the Ethereum network through its React hooks, and [Viem](https://viem.sh/docs/getting-started) in order to do so through its public client as well as provide Web3 utilities. Both Wagmi and Viem work by connecting to JSON-RPC APIs via HTTP in order to provide on-chain data to web applications. By default, they provide default RPC URLs that can be used to get started. However, these RPCs keys can quickly become rate-limited when too many requests are made. In order to prevent this, it is recommended that you sign up and add your own API keys to the configuration.
 
 Due to the large volume of data that is constantly being fetched and displayed in the portal, we use caching in order to cache various network responses for a limited amount of time. This helps to reduce the load of networking calls to various APIs. This feature can be configured to be on or off.
 
@@ -73,9 +73,9 @@ The following configuration values can be added to the `.env` file:
 
 #### Recommended for improved performance:
 
-- Set `INFURA_KEY` to a valid [Infura](https://docs.infura.io/infura/networks/ethereum/how-to/secure-a-project/project-id) API key for Wagmi and Viem to use
-
-- Set `ALCHEMY_KEY` to a valid [Alchemy](https://docs.alchemy.com/reference/ethereum-api-quickstart) API key for Wagmi and Viem to use
+- Set `NEXT_PUBLIC_RPC_MAINNET` to a valid Ethereum mainnet RPC URL (e.g. from Alchemy, Infura, Tenderly, etc)
+- Set `NEXT_PUBLIC_RPC_ARBITRUM` to a valid Arbitrum mainnet RPC URL
+- Set `NEXT_PUBLIC_RPC_ARBITRUM_TESTNET` to a valid Arbitrum testnet RPC URL
 
 - Set `ETHERSCAN_V2_API_KEY` to a valid [Etherscan V2](https://docs.etherscan.io/etherscan-v2#why-v2) API key for Wagmi to be able to generate the contract ABIs
 
@@ -95,8 +95,6 @@ The following configuration values can be added to the `.env` file:
 
 **Optional** Set `DEFENDER_API_KEY_MAINNET` and/or `DEFENDER_API_KEY_TESTNET` to a valid OpenZeppelin Defender Relay key (used for gasless poll voting)
 **Optional** Set `DEFENDER_API_SECRET_MAINNET` and/or`DEFENDER_API_SECRET_TESTNET` to a valid OpenZeppelin Defender Relay secret
-**Optional** Set `ALCHEMY_ARBITRUM_KEY` to a valid Alchemy API key for the arbitrum network
-**Optional** Set `ALCHEMY_ARBITRUM_TESTNET_KEY` to a valid Alchemy API key for the arbitrum test network
 **Optional** Set `GASLESS_BACKDOOR_SECRET` to allow for bypassing the gasless voting eligibility checks by anyone with the password
 
 - Set `DASHBOARD_PASSWORD` for adding protection to the `/dashboard` route

lib/config.ts

@@ -8,10 +8,11 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 
 type SystemConfig = {
   USE_CACHE: string;
-  ALCHEMY_KEY: string;
-  INFURA_KEY: string;
   TRACING_RPC_NODE: string;
   NODE_ENV: 'development' | 'production' | 'test';
+  RPC_MAINNET: string;
+  RPC_ARBITRUM: string;
+  RPC_ARBITRUM_TESTNET: string;
   GITHUB_TOKEN: string;
   GITHUB_TOKEN_2: string;
   GITHUB_TOKEN_3: string;
@@ -20,8 +21,6 @@ type SystemConfig = {
   DEFENDER_API_SECRET_TESTNET: string;
   DEFENDER_API_KEY_MAINNET: string;
   DEFENDER_API_SECRET_MAINNET: string;
-  ALCHEMY_ARBITRUM_KEY: string;
-  ALCHEMY_ARBITRUM_TESTNET_KEY: string;
   WALLETCONNECT_PROJECT_ID: string;
   MIGRATION_WEBHOOK_URL: string;
   GASLESS_WEBHOOK_URL: string;
@@ -36,10 +35,11 @@ type SystemConfig = {
 
 export const config: SystemConfig = {
   USE_CACHE: process.env.USE_CACHE || '',
-  ALCHEMY_KEY: process.env.ALCHEMY_KEY || '',
-  INFURA_KEY: process.env.INFURA_KEY || '',
   TRACING_RPC_NODE: process.env.TRACING_RPC_NODE || '',
   NODE_ENV: process.env.NODE_ENV || 'development',
+  RPC_MAINNET: process.env.NEXT_PUBLIC_RPC_MAINNET || '',
+  RPC_ARBITRUM: process.env.NEXT_PUBLIC_RPC_ARBITRUM || '',
+  RPC_ARBITRUM_TESTNET: process.env.NEXT_PUBLIC_RPC_ARBITRUM_TESTNET || '',
   GITHUB_TOKEN: process.env.GITHUB_TOKEN || '',
   GITHUB_TOKEN_2: process.env.GITHUB_TOKEN_2 || '',
   GITHUB_TOKEN_3: process.env.GITHUB_TOKEN_3 || '',
@@ -48,8 +48,6 @@ export const config: SystemConfig = {
   DEFENDER_API_SECRET_TESTNET: process.env.DEFENDER_API_SECRET_TESTNET || '',
   DEFENDER_API_KEY_MAINNET: process.env.DEFENDER_API_KEY_MAINNET || '',
   DEFENDER_API_SECRET_MAINNET: process.env.DEFENDER_API_SECRET_MAINNET || '',
-  ALCHEMY_ARBITRUM_KEY: process.env.NEXT_PUBLIC_ALCHEMY_ARBITRUM_KEY || '',
-  ALCHEMY_ARBITRUM_TESTNET_KEY: process.env.NEXT_PUBLIC_ALCHEMY_ARBITRUM_TESTNET_KEY || '',
   WALLETCONNECT_PROJECT_ID: process.env.NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID || '',
   MIGRATION_WEBHOOK_URL: process.env.MIGRATION_WEBHOOK_URL || '',
   GASLESS_WEBHOOK_URL: process.env.GASLESS_WEBHOOK_URL || '',

modules/wagmi/config/config.default.ts

@@ -4,7 +4,10 @@ import { SupportedChainId } from 'modules/web3/constants/chainID';
 import { coinbaseWallet, metaMask, safe, walletConnect, injected } from 'wagmi/connectors';
 import { createPublicClient } from 'viem';
 
-const tenderlyRpcUrl = `https://virtual.mainnet.rpc.tenderly.co/${process.env.NEXT_PUBLIC_TENDERLY_RPC_KEY}`;
+const RPC_TENDERLY = `https://virtual.mainnet.rpc.tenderly.co/${process.env.NEXT_PUBLIC_TENDERLY_RPC_KEY}`;
+const RPC_MAINNET = process.env.NEXT_PUBLIC_RPC_MAINNET || '';
+const RPC_ARBITRUM = process.env.NEXT_PUBLIC_RPC_ARBITRUM || '';
+const RPC_ARBITRUM_TESTNET = process.env.NEXT_PUBLIC_RPC_ARBITRUM_TESTNET || '';
 
 export const tenderly = {
   id: SupportedChainId.TENDERLY as const,
@@ -17,8 +20,8 @@ export const tenderly = {
     symbol: 'ETH'
   },
   rpcUrls: {
-    public: { http: [tenderlyRpcUrl] },
-    default: { http: [tenderlyRpcUrl] }
+    public: { http: [RPC_TENDERLY] },
+    default: { http: [RPC_TENDERLY] }
   },
   blockExplorers: {
     default: { name: '', url: '' }
@@ -32,14 +35,10 @@ const httpBatchTransport = (url: string) =>
   });
 
 const transports = {
-  [mainnet.id]: httpBatchTransport(`https://eth-mainnet.g.alchemy.com/v2/${process.env.ALCHEMY_KEY}`),
-  [tenderly.id]: httpBatchTransport(tenderlyRpcUrl),
-  [arbitrum.id]: httpBatchTransport(
-    `https://arb-mainnet.g.alchemy.com/v2/${process.env.NEXT_PUBLIC_ALCHEMY_ARBITRUM_KEY}`
-  ),
-  [arbitrumSepolia.id]: httpBatchTransport(
-    `https://arb-sepolia.g.alchemy.com/v2/${process.env.NEXT_PUBLIC_ALCHEMY_ARBITRUM_TESTNET_KEY}`
-  )
+  [mainnet.id]: httpBatchTransport(RPC_MAINNET),
+  [tenderly.id]: httpBatchTransport(RPC_TENDERLY),
+  [arbitrum.id]: httpBatchTransport(RPC_ARBITRUM),
+  [arbitrumSepolia.id]: httpBatchTransport(RPC_ARBITRUM_TESTNET)
 };
 
 const connectors = [

modules/web3/constants/networks.ts

@@ -59,16 +59,15 @@ export const CHAIN_INFO: ChainInfo = {
     label: 'Mainnet',
     type: 'normal',
     network: SupportedNetworks.MAINNET,
-    defaultRpc: NodeProviders.ALCHEMY,
+    defaultRpc: NodeProviders.TENDERLY,
     spockUrl:
       process.env.NEXT_PUBLIC_VERCEL_ENV === 'development' ? STAGING_MAINNET_SPOCK_URL : MAINNET_SPOCK_URL,
     subgraphUrl:
       process.env.NEXT_PUBLIC_VERCEL_ENV === 'development'
         ? MAINNET_STAGING_SUBGRAPH_URL
         : MAINNET_PROD_SUBGRAPH_URL,
     rpcs: {
-      [NodeProviders.INFURA]: `https://mainnet.infura.io/v3/${config.INFURA_KEY}`,
-      [NodeProviders.ALCHEMY]: `https://eth-mainnet.g.alchemy.com/v2/${config.ALCHEMY_KEY}`
+      [NodeProviders.TENDERLY]: process.env.NEXT_PUBLIC_RPC_MAINNET || ''
     },
     showInProduction: true
   },
@@ -79,9 +78,9 @@ export const CHAIN_INFO: ChainInfo = {
     label: 'ArbitrumTestnet',
     type: 'gasless',
     network: SupportedNetworks.ARBITRUMTESTNET,
-    defaultRpc: NodeProviders.ALCHEMY,
+    defaultRpc: NodeProviders.TENDERLY,
     rpcs: {
-      [NodeProviders.ALCHEMY]: `https://arb-sepolia.g.alchemy.com/v2/${config.ALCHEMY_ARBITRUM_TESTNET_KEY}`
+      [NodeProviders.TENDERLY]: process.env.NEXT_PUBLIC_RPC_ARBITRUM_TESTNET || ''
     },
     showInProduction: false
   },
@@ -92,9 +91,9 @@ export const CHAIN_INFO: ChainInfo = {
     label: 'Arbitrum',
     type: 'gasless',
     network: SupportedNetworks.ARBITRUM,
-    defaultRpc: NodeProviders.ALCHEMY,
+    defaultRpc: NodeProviders.TENDERLY,
     rpcs: {
-      [NodeProviders.ALCHEMY]: `https://arb-mainnet.g.alchemy.com/v2/${config.ALCHEMY_ARBITRUM_KEY}`
+      [NodeProviders.TENDERLY]: process.env.NEXT_PUBLIC_RPC_ARBITRUM || ''
     },
     showInProduction: false
   },

next.config.js

@@ -51,8 +51,6 @@ const moduleExports = {
   // everything in here gets exposed to the frontend.
   // prefer NEXT_PUBLIC_* instead, which makes this behavior more explicit
   env: {
-    INFURA_KEY: process.env.INFURA_KEY || '84842078b09946638c03157f83405213', // ethers default infura key
-    ALCHEMY_KEY: process.env.ALCHEMY_KEY || '_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC', // ethers default alchemy key
     GITHUB_TOKEN: process.env.GITHUB_TOKEN,
     READ_ONLY: process.env.READ_ONLY
   },

pages/api/generate-test-signature.ts

@@ -38,10 +38,7 @@ export default withApiHandler(async (req: NextApiRequest, res: NextApiResponse)
     chain,
     transport: isTestnet
       ? http(`https://virtual.mainnet.rpc.tenderly.co/${process.env.NEXT_PUBLIC_TENDERLY_RPC_KEY}`)
-      : fallback([
-          http(`https://mainnet.infura.io/v3/${process.env.INFURA_KEY}`),
-          http(`https://eth-mainnet.g.alchemy.com/v2/${process.env.ALCHEMY_KEY}`)
-        ])
+      : fallback([http(process.env.NEXT_PUBLIC_RPC_MAINNET || '')])
   });
 
   const voter = account.address;