refactor

Author: aelmanaa

ccip/cct/hardhat/README.md

@@ -23,21 +23,22 @@ All tasks in this project use Hardhat's global options. The most important one i
 
 The following networks are configured and available for use:
 
-| Network Name      | Description              | Environment Variable       |
-| ----------------- | ------------------------ | -------------------------- |
-| `avalancheFuji`   | Avalanche Fuji Testnet   | `AVALANCHE_FUJI_RPC_URL`   |
-| `arbitrumSepolia` | Arbitrum Sepolia Testnet | `ARBITRUM_SEPOLIA_RPC_URL` |
-| `sepolia`         | Ethereum Sepolia Testnet | `ETHEREUM_SEPOLIA_RPC_URL` |
-| `baseSepolia`     | Base Sepolia Testnet     | `BASE_SEPOLIA_RPC_URL`     |
-| `polygonAmoy`     | Polygon Amoy Testnet     | `POLYGON_AMOY_RPC_URL`     |
+| Network Name      | Description              | Environment Variable         | Type    |
+| ----------------- | ------------------------ | ---------------------------- | ------- |
+| `avalancheFuji`   | Avalanche Fuji Testnet   | `AVALANCHE_FUJI_RPC_URL`     | EVM     |
+| `arbitrumSepolia` | Arbitrum Sepolia Testnet | `ARBITRUM_SEPOLIA_RPC_URL`   | EVM     |
+| `ethereumSepolia` | Ethereum Sepolia Testnet | `ETHEREUM_SEPOLIA_RPC_URL`   | EVM     |
+| `baseSepolia`     | Base Sepolia Testnet     | `BASE_SEPOLIA_RPC_URL`       | EVM     |
+| `polygonAmoy`     | Polygon Amoy Testnet     | `POLYGON_AMOY_RPC_URL`       | EVM     |
+| `solanaDevnet`    | Solana Devnet            | N/A (destination only)       | Non-EVM |
 
 ### Network Configuration
 
-Network configurations are defined in:
+Network configurations use a **professional single source of truth architecture**:
 
-- **Network settings**: `/config/networks.ts`
-- **Chain parameters**: `/config/config.json`
-- **Contract addresses**: Automatically loaded per network
+- **All network settings**: `/config/networks.ts` (consolidated configuration)
+- **Types auto-generated**: From the network configuration data
+- **Zero maintenance**: No manual enum synchronization needed
 
 To use a network, ensure:
 
@@ -1567,3 +1568,79 @@ npx hardhat applyChainUpdatesFromSafe \
 - **Network Configuration**:
   - Chain selectors and other network details are automatically fetched from the network configuration.
   - The task validates all addresses and chain configurations before creating the Safe transaction.
+
+## Adding New Networks
+
+The network configuration system uses a single source of truth architecture that automatically generates TypeScript types and Hardhat network configurations from the network data.
+
+### Adding a Network
+
+To add a new CCIP-supported network, add the network configuration to the `configData` object in `config/networks.ts`:
+
+```typescript
+export const configData = {
+  // ... existing networks
+  newNetwork: {
+    chainFamily: "evm", // or "svm" for non-EVM chains
+    chainId: 12345,
+    chainSelector: "1234567890123456789",
+    router: "0xRouterAddress",
+    rmnProxy: "0xRMNProxyAddress",
+    tokenAdminRegistry: "0xTokenAdminRegistryAddress", 
+    registryModuleOwnerCustom: "0xRegistryModuleOwnerAddress",
+    link: "0xLinkTokenAddress",
+    confirmations: 2,
+    nativeCurrencySymbol: "NEW",
+    chainType: "l1",
+  }
+};
+```
+
+The network becomes available in:
+- All task `--network` options
+- TypeScript type checking (`Chains` and `EVMChains` types)
+- Hardhat network configuration
+- Cross-chain destination options
+- Network validation throughout all tasks
+
+### CCIP Configuration Sources
+
+Obtain the required addresses and chain selectors from the official CCIP directories:
+
+- **Mainnet Networks**: [https://docs.chain.link/ccip/directory/mainnet](https://docs.chain.link/ccip/directory/mainnet)
+- **Testnet Networks**: [https://docs.chain.link/ccip/directory/testnet](https://docs.chain.link/ccip/directory/testnet)
+
+Required information from these directories:
+- Router contract addresses
+- Chain selectors (unique CCIP identifiers)
+- RMN Proxy addresses
+- Token Admin Registry addresses
+- LINK token addresses
+
+### Environment Variable
+
+Set the RPC URL environment variable:
+
+```bash
+npx env-enc set NEW_NETWORK_RPC_URL
+```
+
+### Example: Adding Optimism Sepolia
+
+```typescript
+optimismSepolia: {
+  chainFamily: "evm",
+  chainId: 11155420,
+  chainSelector: "5224473277236331295",
+  router: "0x114A20A10b43D4115e5aeef7345a1A71d2a60C57",
+  rmnProxy: "0x...",
+  tokenAdminRegistry: "0x...",
+  registryModuleOwnerCustom: "0x...",
+  link: "0x...",
+  confirmations: 2,
+  nativeCurrencySymbol: "ETH",
+  chainType: "op",
+}
+```
+
+All tasks will support `--network optimismSepolia` after adding this configuration.

ccip/cct/hardhat/config/config.json

@@ -1,24 +1,38 @@
-import { Chains, EVMChains } from "./types";
-import { networks } from "./networks";
-
+import type { Chains, EVMChains } from "./types";
+import { configData, networks } from "./networks";
 export {
-  Chains,
-  EVMChains,
   PoolType,
   TokenContractName,
   TokenPoolContractName,
   CCIPContractName,
 } from "./types";
-
-export type { Networks } from "./types"; 
-export { networks, configData } from "./networks";
+export type { Chains, EVMChains, Networks } from "./types";
+export { configData, networks } from "./networks";
 export { logger } from "./logger";
 
+/**
+ * Type guard to check if a string is a valid chain name
+ */
+export function isValidChain(chain: string): chain is Chains {
+  return chain in configData;
+}
+
 /**
  * Type guard to check if a chain is an EVM chain
  */
-export function isEVMChain(chain: string): boolean {
-  return Object.values(EVMChains).includes(chain as EVMChains);
+export function isEVMChain(chain: string): chain is EVMChains {
+  if (!isValidChain(chain)) return false;
+  return configData[chain].chainFamily === "evm";
+}
+
+/**
+ * Validates and returns a typed network name from Hardhat runtime environment
+ */
+export function validateNetworkName(networkName: string): Chains {
+  if (!isValidChain(networkName)) {
+    throw new Error(`Unsupported network: ${networkName}`);
+  }
+  return networkName;
 }
 
 /**

ccip/cct/hardhat/config/index.ts

@@ -1,5 +1,3 @@
-import { EVMChains, EtherscanConfig, Networks } from "./types";
-import configData from "./config.json";
 import * as envEnc from "@chainlink/env-enc";
 envEnc.config();
 
@@ -9,47 +7,96 @@ const accounts: string[] = [];
 if (PRIVATE_KEY) accounts.push(PRIVATE_KEY);
 if (PRIVATE_KEY_2) accounts.push(PRIVATE_KEY_2);
 
-const networks: Networks = {
-  [EVMChains.avalancheFuji]: {
-    type: "http",
-    ...configData.avalancheFuji,
-    url: process.env.AVALANCHE_FUJI_RPC_URL || "https://UNSET-PLEASE-SET-AVALANCHE_FUJI_RPC_URL",
-    gasPrice: undefined,
-    nonce: undefined,
-    accounts,
+export const configData = {
+  avalancheFuji: {
+    chainId: 43113,
+    chainSelector: "14767482510784806043",
+    router: "0xF694E193200268f9a4868e4Aa017A0118C9a8177",
+    rmnProxy: "0xAc8CFc3762a979628334a0E4C1026244498E821b",
+    tokenAdminRegistry: "0xA92053a4a3922084d992fD2835bdBa4caC6877e6",
+    registryModuleOwnerCustom: "0x97300785aF1edE1343DB6d90706A35CF14aA3d81",
+    link: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846",
+    confirmations: 2,
+    nativeCurrencySymbol: "AVAX",
+    chainType: "l1",
+    chainFamily: "evm"
   },
-  [EVMChains.arbitrumSepolia]: {
-    type: "http",
-    ...configData.arbitrumSepolia,
-    url: process.env.ARBITRUM_SEPOLIA_RPC_URL || "https://UNSET-PLEASE-SET-ARBITRUM_SEPOLIA_RPC_URL",
-    gasPrice: undefined,
-    nonce: undefined,
-    accounts,
+  arbitrumSepolia: {
+    chainId: 421614,
+    chainSelector: "3478487238524512106",
+    router: "0x2a9C5afB0d0e4BAb2BCdaE109EC4b0c4Be15a165",
+    rmnProxy: "0x9527E2d01A3064ef6b50c1Da1C0cC523803BCFF2",
+    tokenAdminRegistry: "0x8126bE56454B628a88C17849B9ED99dd5a11Bd2f",
+    registryModuleOwnerCustom: "0xE625f0b8b0Ac86946035a7729Aba124c8A64cf69",
+    link: "0xb1D4538B4571d411F07960EF2838Ce337FE1E80E",
+    confirmations: 2,
+    nativeCurrencySymbol: "ETH",
+    chainType: "l1",
+    chainFamily: "evm"
   },
-  [EVMChains.ethereumSepolia]: {
-    type: "http",
-    ...configData.ethereumSepolia,
-    url: process.env.ETHEREUM_SEPOLIA_RPC_URL || "https://UNSET-PLEASE-SET-ETHEREUM_SEPOLIA_RPC_URL",
-    gasPrice: undefined,
-    nonce: undefined,
-    accounts,
+  ethereumSepolia: {
+    chainId: 11155111,
+    chainSelector: "16015286601757825753",
+    router: "0x0BF3dE8c5D3e8A2B34D2BEeB17ABfCeBaf363A59",
+    rmnProxy: "0xba3f6251de62dED61Ff98590cB2fDf6871FbB991",
+    tokenAdminRegistry: "0x95F29FEE11c5C55d26cCcf1DB6772DE953B37B82",
+    registryModuleOwnerCustom: "0x62e731218d0D47305aba2BE3751E7EE9E5520790",
+    link: "0x779877A7B0D9E8603169DdbD7836e478b4624789",
+    confirmations: 3,
+    nativeCurrencySymbol: "ETH",
+    chainType: "l1",
+    chainFamily: "evm"
   },
-  [EVMChains.baseSepolia]: {
-    type: "http",
-    ...configData.baseSepolia,
-    url: process.env.BASE_SEPOLIA_RPC_URL || "https://UNSET-PLEASE-SET-BASE_SEPOLIA_RPC_URL",
-    gasPrice: undefined,
-    nonce: undefined,
-    accounts,
+  baseSepolia: {
+    chainId: 84532,
+    chainSelector: "10344971235874465080",
+    router: "0xD3b06cEbF099CE7DA4AcCf578aaebFDBd6e88a93",
+    rmnProxy: "0x99360767a4705f68CcCb9533195B761648d6d807",
+    tokenAdminRegistry: "0x736D0bBb318c1B27Ff686cd19804094E66250e17",
+    registryModuleOwnerCustom: "0x8A55C61227f26a3e2f217842eCF20b52007bAaBe",
+    link: "0xE4aB69C077896252FAFBD49EFD26B5D171A32410",
+    confirmations: 2,
+    nativeCurrencySymbol: "ETH",
+    chainType: "op",
+    chainFamily: "evm"
   },
-  [EVMChains.polygonAmoy]: {
-    type: "http",
-    ...configData.polygonAmoy,
-    url: process.env.POLYGON_AMOY_RPC_URL || "https://UNSET-PLEASE-SET-POLYGON_AMOY_RPC_URL",
-    gasPrice: undefined,
-    nonce: undefined,
-    accounts,
+  polygonAmoy: {
+    chainId: 80002,
+    chainSelector: "16281711391670634445",
+    router: "0x9C32fCB86BF0f4a1A8921a9Fe46de3198bb884B2",
+    rmnProxy: "0x7c1e545A40750Ee8761282382D51E017BAC68CBB",
+    tokenAdminRegistry: "0x1e73f6842d7afDD78957ac143d1f315404Dd9e5B",
+    registryModuleOwnerCustom: "0x84ad5890A63957C960e0F19b0448A038a574936B",
+    link: "0x0Fd9e8d3aF1aaee056EB9e802c3A762a667b1904",
+    confirmations: 3,
+    nativeCurrencySymbol: "POL",
+    chainType: "l1",
+    chainFamily: "evm"
   },
+  solanaDevnet: {
+    chainId: "EtWTRABZaYq6iMfeYKouRu166VU2xqa1wcaWoxPkrZBG",
+    chainSelector: "16423721717087811551",
+    chainType: "generic",
+    chainFamily: "svm"
+  }
 };
 
-export { networks, configData };
+// Generate Hardhat networks from configData (EVM only)
+const networks: Record<string, any> = {};
+
+for (const [name, config] of Object.entries(configData)) {
+  if (config.chainFamily === "evm") {
+    const envVarName = `${name.replace(/([a-z])([A-Z])/g, '$1_$2').toUpperCase()}_RPC_URL`;
+    networks[name] = {
+      type: "http" as const,
+      ...config,
+      url: process.env[envVarName] || `https://UNSET-PLEASE-SET-${envVarName}`,
+      gasPrice: undefined,
+      nonce: undefined,
+      accounts,
+    };
+  }
+}
+
+export { networks };
+