refactor config for CCT Foundry (#129)

Author: SyedAsadKazmi

ccip/ccip-cla-rate-limits/.gitignore

@@ -1,6 +1,7 @@
 # Compiler files
 cache/
 out/
+foundry.lock
 
 # Ignores development broadcast logs
 !/broadcast

ccip/cct/foundry/.env.example

@@ -1,5 +1,4 @@
 PRIVATE_KEY=
 RPC_URL_FUJI=
 RPC_URL_ARBITRUM_SEPOLIA=
-ETHERSCAN_API_KEY=
-ARBISCAN_API_KEY=
+ETHERSCAN_API_KEY=

ccip/cct/foundry/.gitignore

@@ -3,6 +3,7 @@ node_modules/
 # Compiler files
 cache/
 out/
+foundry.lock
 
 # Ignores all broadcast logs except specific exclusions
 /broadcast/*/

ccip/cct/foundry/README.md

@@ -83,7 +83,6 @@ PRIVATE_KEY=<your_private_key>
 RPC_URL_FUJI=<your_rpc_url_fuji>
 RPC_URL_ARBITRUM_SEPOLIA=<your_rpc_url_arbitrum_sepolia>
 ETHERSCAN_API_KEY=<your_etherscan_api_key>
-ARBISCAN_API_KEY=<your_arbiscan_api_key>
 ```
 
 Variables to configure:
@@ -92,7 +91,6 @@ Variables to configure:
 - `RPC_URL_FUJI`: The RPC URL for the Fuji testnet. You can get this from the [Alchemy](https://www.alchemy.com/) or [Infura](https://infura.io/) website.
 - `RPC_URL_ARBITRUM_SEPOLIA`: The RPC URL for the Arbitrum Sepolia testnet. You can get this from the [Alchemy](https://www.alchemy.com/) or [Infura](https://infura.io/) website.
 - `ETHERSCAN_API_KEY`: An API key from Etherscan to verify your contracts. You can obtain one from [Etherscan](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics).
-- `ARBISCAN_API_KEY`: An API key from Arbiscan to verify your contracts on Arbitrum. See [this guide](https://docs.arbiscan.io/getting-started/viewing-api-usage-statistics) to get one from Arbiscan.
 
 **Load the environment variables** into the terminal session where you will run the commands:
 
@@ -116,7 +114,7 @@ forge script script/AcceptAdminRole.s.sol --rpc-url $RPC_URL --private-key $PRIV
 
 The script pulls the token address from a previously deployed token in a JSON file located in the `script/output/` folder. The `TokenAdminRegistry` address is fetched from the `HelperConfig.s.sol` file.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
 - **TokenAdminRegistry Address**: The `TokenAdminRegistry` address is retrieved based on the network settings in `HelperConfig.s.sol`.
 
 ### Examples
@@ -197,9 +195,9 @@ forge script script/ApplyChainUpdates.s.sol --rpc-url $RPC_URL --private-key $PR
 
 The script pulls the pool and token addresses from previously deployed pool and token JSON files located in the `script/output/` folder. The cross-chain configuration (e.g., chain selector) is fetched from the `HelperConfig.s.sol` file.
 
-- **Deployed Local Pool Address**: The pool address is read from the output file corresponding to the current chain (e.g., `deployedTokenPool_avalancheFuji.json`).
-- **Deployed Remote Pool Address**: The remote pool address is read from the JSON file corresponding to the remote chain (e.g., `deployedTokenPool_arbitrumSepolia.json`).
-- **Deployed Remote Token Address**: The remote token address is read from the JSON file corresponding to the remote chain (e.g., `deployedToken_arbitrumSepolia.json`).
+- **Deployed Local Pool Address**: The pool address is read from the output file corresponding to the current chain (e.g., `deployedTokenPool_avalanche_fuji.json`).
+- **Deployed Remote Pool Address**: The remote pool address is read from the JSON file corresponding to the remote chain (e.g., `deployedTokenPool_arbitrum_one_sepolia.json`).
+- **Deployed Remote Token Address**: The remote token address is read from the JSON file corresponding to the remote chain (e.g., `deployedToken_arbitrum_one_sepolia.json`).
 - **Remote Chain Selector**: The chain selector for the remote chain is fetched based on the network configuration in `HelperConfig.s.sol`.
 - **Rate Limiter Configuration**: The script allows configuring rate limiting for both inbound and outbound transfers. By default, rate limiting is disabled in this script.
 
@@ -239,7 +237,7 @@ forge script script/ClaimAdmin.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_K
 
 The script pulls the token and admin details from the `config.json` file and the deployed token address from a JSON file located in the `script/output/` folder.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
 - **Admin Address**: The admin address is read from the `config.json` file (`ccipAdminAddress` field).
 
 ### Examples
@@ -278,7 +276,7 @@ forge script script/DeployBurnMintTokenPool.s.sol --rpc-url $RPC_URL --private-k
 
 The script pulls the token address from a previously deployed token in a JSON file located in the `script/output/` folder. The network configuration (router and RMN proxy addresses) is also fetched from the `HelperConfig.s.sol` file.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
 - **Router and RMN Proxy**: The router and RMN proxy addresses are retrieved based on the network settings in `HelperConfig.s.sol`.
 
 ### Examples
@@ -317,7 +315,7 @@ forge script script/DeployLockReleaseTokenPool.s.sol --rpc-url $RPC_URL --privat
 
 The script pulls the token address from a previously deployed token in a JSON file located in the `script/output/` folder. The network configuration (router and RMN proxy addresses) is fetched from the `HelperConfig.s.sol` file.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
 - **Router and RMN Proxy**: The router and RMN proxy addresses are retrieved based on the network settings in `HelperConfig.s.sol`.
 
 ### Examples
@@ -527,7 +525,7 @@ forge script script/MintTokens.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_K
 
 The script pulls the token address from a previously deployed token in a JSON file located in the `script/output/` folder. The mint amount is specified in the `config.json` file.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
 - **Mint Amount**: The amount of tokens to mint is read from the `config.json` file (`tokenAmountToMint` field).
 
 ### Examples
@@ -604,23 +602,23 @@ Sets the pool for a deployed token in the `TokenAdminRegistry` contract. The scr
 ### Usage
 
 ```bash
-forge script script/SetPool.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast --verify
+forge script script/SetPool.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
 ```
 
 ### Config Parameters
 
 The script pulls the token and pool addresses from previously deployed token and pool JSON files located in the `script/output/` folder. The `TokenAdminRegistry` address is retrieved from the `HelperConfig.s.sol` file.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
-- **Deployed Pool Address**: The pool address is read from the output file corresponding to the current chain (e.g., `deployedTokenPool_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
+- **Deployed Pool Address**: The pool address is read from the output file corresponding to the current chain (e.g., `deployedTokenPool_avalanche_fuji.json`).
 - **TokenAdminRegistry Address**: The `TokenAdminRegistry` address is retrieved based on the network settings in `HelperConfig.s.sol`.
 
 ### Examples
 
 - Set the pool for a token:
 
   ```bash
-  forge script script/SetPool.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast --verify
+  forge script script/SetPool.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast
   ```
 
   This will:
@@ -729,14 +727,14 @@ The `TransferTokens` script facilitates cross-chain token transfers using Chainl
 ### Usage
 
 ```bash
-forge script script/TransferTokens.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast --verify
+forge script script/TransferTokens.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
 ```
 
 ### Config Parameters
 
 The script pulls the token address, transfer amount, and fee type from the `config.json` file. It also reads the destination chain information from the same file.
 
-- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalancheFuji.json`).
+- **Deployed Token Address**: The token address is read from the output file corresponding to the current chain (e.g., `deployedToken_avalanche_fuji.json`).
 - **Transfer Amount**: The amount of tokens to transfer is read from `config.json` (`tokenAmountToTransfer` field).
 - **Fee Type**: The fee type is specified in the `config.json` file as either `"native"` (e.g., ETH, AVAX) or `"link"` (to pay fees in LINK tokens).
 - **Destination Chain**: The destination chain ID is determined based on the current chain ID and the `remoteChains` field in `config.json`.
@@ -746,7 +744,7 @@ The script pulls the token address, transfer amount, and fee type from the `conf
 - Transfer tokens across chains:
 
   ```bash
-  forge script script/TransferTokens.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast --verify
+  forge script script/TransferTokens.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast
   ```
 
   This will:

ccip/cct/foundry/foundry.toml

@@ -16,8 +16,4 @@ remappings = [
 
 fs_permissions = [{ access = "read-write", path = "./" }]
 
-[etherscan]
-avalanche-fuji = { key = "${ETHERSCAN_API_KEY}", chain = 43113, url = "https://api-testnet.snowtrace.io/api" }
-arbitrum-sepolia = { key = "${ARBISCAN_API_KEY}", chain = 421613, url = "https://api-sepolia.arbiscan.io/api" }
-
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

ccip/cct/foundry/script/AcceptAdminRole.s.sol

@@ -9,7 +9,7 @@ import {TokenAdminRegistry} from "@chainlink/contracts-ccip/contracts/tokenAdmin
 contract AcceptAdminRole is Script {
     function run() external {
         // Get the chain name based on the current chain ID
-        string memory chainName = HelperUtils.getChainName(block.chainid);
+        string memory chainName = getChain(block.chainid).chainAlias;
 
         // Construct the path to the deployed token JSON file
         string memory root = vm.projectRoot();

ccip/cct/foundry/script/AddRemotePool.s.sol

@@ -2,15 +2,13 @@
 pragma solidity 0.8.24;
 
 import {Script, console} from "forge-std/Script.sol";
-import {HelperUtils} from "./utils/HelperUtils.s.sol"; // Utility functions for JSON parsing and chain info
 import {HelperConfig} from "./HelperConfig.s.sol"; // Network configuration helper
 import {TokenPool} from "@chainlink/contracts-ccip/contracts/pools/TokenPool.sol";
 
 contract AddRemotePool is Script {
     function run(address poolAddress, uint256 remoteChainId, address remotePoolAddress) external {
         HelperConfig helperConfig = new HelperConfig();
-        HelperConfig.NetworkConfig memory remoteNetworkConfig =
-            HelperUtils.getNetworkConfig(helperConfig, remoteChainId);
+        HelperConfig.NetworkConfig memory remoteNetworkConfig = helperConfig.getNetworkConfig(remoteChainId);
 
         // Validate that configurations exist
         require(remoteNetworkConfig.chainSelector != 0, "Remote network configuration not found");

ccip/cct/foundry/script/ApplyChainUpdates.s.sol

@@ -10,7 +10,7 @@ import {RateLimiter} from "@chainlink/contracts-ccip/contracts/libraries/RateLim
 contract ApplyChainUpdates is Script {
     function run() external {
         // Get the current chain name based on the chain ID
-        string memory chainName = HelperUtils.getChainName(block.chainid);
+        string memory chainName = getChain(block.chainid).chainAlias;
 
         // Construct paths to the configuration and local pool JSON files
         string memory root = vm.projectRoot();
@@ -23,7 +23,7 @@ contract ApplyChainUpdates is Script {
         );
 
         // Get the remote chain name based on the remoteChainId
-        string memory remoteChainName = HelperUtils.getChainName(remoteChainId);
+        string memory remoteChainName = getChain(remoteChainId).chainAlias;
         string memory remotePoolPath =
             string.concat(root, "/script/output/deployedTokenPool_", remoteChainName, ".json");
         string memory remoteTokenPath = string.concat(root, "/script/output/deployedToken_", remoteChainName, ".json");
@@ -42,8 +42,7 @@ contract ApplyChainUpdates is Script {
 
         // Fetch the remote network configuration to get the chain selector
         HelperConfig helperConfig = new HelperConfig();
-        HelperConfig.NetworkConfig memory remoteNetworkConfig =
-            HelperUtils.getNetworkConfig(helperConfig, remoteChainId);
+        HelperConfig.NetworkConfig memory remoteNetworkConfig = helperConfig.getNetworkConfig(remoteChainId);
 
         uint64 remoteChainSelector = remoteNetworkConfig.chainSelector;
 

ccip/cct/foundry/script/ClaimAdmin.s.sol

@@ -4,15 +4,15 @@ pragma solidity 0.8.24;
 import {Script, console} from "forge-std/Script.sol";
 import {HelperUtils} from "./utils/HelperUtils.s.sol"; // Utility functions for JSON parsing and chain info
 import {HelperConfig} from "./HelperConfig.s.sol"; // Network configuration helper
-import {RegistryModuleOwnerCustom} from
-    "@chainlink/contracts-ccip/contracts/tokenAdminRegistry/RegistryModuleOwnerCustom.sol";
+import {
+    RegistryModuleOwnerCustom
+} from "@chainlink/contracts-ccip/contracts/tokenAdminRegistry/RegistryModuleOwnerCustom.sol";
 import {BurnMintERC20} from "@chainlink/contracts/src/v0.8/shared/token/ERC20/BurnMintERC20.sol";
 
-
 contract ClaimAdmin is Script {
     function run() external {
         // Get the chain name based on the current chain ID
-        string memory chainName = HelperUtils.getChainName(block.chainid);
+        string memory chainName = getChain(block.chainid).chainAlias;
 
         // Define paths to the necessary JSON files
         string memory root = vm.projectRoot();
@@ -32,9 +32,9 @@ contract ClaimAdmin is Script {
         require(registryModuleOwnerCustom != address(0), "Registry module owner custom is not defined for this network");
 
         vm.startBroadcast();
-        
+
         claimAdminWithCCIPAdmin(tokenAddress, tokenAdmin, registryModuleOwnerCustom);
-        
+
         vm.stopBroadcast();
     }
 
@@ -52,14 +52,11 @@ contract ClaimAdmin is Script {
         console.log("Current token admin:", tokenContractCCIPAdmin);
 
         // Ensure the CCIP admin matches the expected token admin address
-        require(
-            tokenContractCCIPAdmin == tokenAdmin, "CCIP admin of token doesn't match the token admin address."
-        );
+        require(tokenContractCCIPAdmin == tokenAdmin, "CCIP admin of token doesn't match the token admin address.");
 
         // Register the admin via getCCIPAdmin() function
         console.log("Claiming admin of the token via getCCIPAdmin() for CCIP admin:", tokenAdmin);
         registryContract.registerAdminViaGetCCIPAdmin(tokenAddress);
         console.log("Admin claimed successfully for token:", tokenAddress);
     }
-
 }

ccip/cct/foundry/script/DeployBurnMintTokenPool.s.sol

@@ -11,7 +11,7 @@ import {IBurnMintERC20} from "@chainlink/contracts/src/v0.8/shared/token/ERC20/I
 contract DeployBurnMintTokenPool is Script {
     function run() external {
         // Get the chain name based on the current chain ID
-        string memory chainName = HelperUtils.getChainName(block.chainid);
+        string memory chainName = getChain(block.chainid).chainAlias;
 
         // Construct the path to the deployed token JSON file
         string memory root = vm.projectRoot();