Polish deploy-multi-chain script

.env.example

@@ -9,12 +9,13 @@ export MNEMONIC="YOUR_MNEMONIC"
 export ARBITRUM_RPC_URL="YOUR_RPC_URL"
 export AVALANCHE_RPC_URL="YOUR_RPC_URL"
 export BASE_RPC_URL="YOUR_RPC_URL"
-export BINANCE_RPC_URL="YOUR_RPC_URL"
+export BSC_RPC_URL="YOUR_RPC_URL"
 export GNOSIS_RPC_URL="YOUR_RPC_URL"
 export MAINNET_RPC_URL="YOUR_RPC_URL"
 export OPTIMISM_RPC_URL="YOUR_RPC_URL"
 export POLYGON_RPC_URL="YOUR_RPC_URL"
 export SCROLL_RPC_URL="YOUR_RPC_URL"
+export SEPOLIA_RPC_URL="YOUR_RPC_URL"
 
 # Etherscan API keys
 export ARBISCAN_API_KEY="YOUR_API_KEY"
@@ -37,4 +38,7 @@ export MAINNET_ADMIN="YOUR_ADMIN_ADDRESS"
 export OPTIMISM_ADMIN="YOUR_ADMIN_ADDRESS"
 export POLYGON_ADMIN="YOUR_ADMIN_ADDRESS"
 export SCROLL_ADMIN="YOUR_ADMIN_ADDRESS"
+export SEPOLIA_ADMIN="YOUR_ADMIN_ADDRESS"
+
+# The maximum number of segments allowed in a stream
 export MAX_SEGMENTS_COUNT="THE_MAX_SEGMENT_COUNT"

.github/workflows/ci-deep.yml

@@ -3,7 +3,7 @@ name: "CI Deep"
 env:
   API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
   API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
-  RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
+  MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
 
 on:
   schedule:
@@ -93,7 +93,7 @@ jobs:
         run: "FOUNDRY_PROFILE=optimized forge build"
 
       - name: "Build the test contracts"
-        run: "FOUNDRY_PROFILE=test-optimized forge build"  
+        run: "FOUNDRY_PROFILE=test-optimized forge build"
 
       - name: "Cache the build so that it can be re-used by the other jobs"
         uses: "actions/cache/save@v3"
@@ -103,7 +103,7 @@ jobs:
             cache
             out
             out-optimized
-  
+
       - name: "Add build summary"
         run: |
           echo "## Build result" >> $GITHUB_STEP_SUMMARY
@@ -133,7 +133,7 @@ jobs:
           node-version: "lts/*"
 
       - name: "Install the Node.js dependencies"
-        run: "pnpm install"        
+        run: "pnpm install"
 
       - name: "Restore the cached build"
         uses: "actions/cache/restore@v3"
@@ -188,7 +188,7 @@ jobs:
             cache
             out
             out-optimized
-    
+
       - name: "Run the integration tests against the optimized build"
         run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/integration/**/*.sol\""
 
@@ -222,8 +222,8 @@ jobs:
           node-version: "lts/*"
 
       - name: "Install the Node.js dependencies"
-        run: "pnpm install"       
-        
+        run: "pnpm install"
+
 
       - name: "Restore the cached build"
         uses: "actions/cache/restore@v3"
@@ -234,7 +234,7 @@ jobs:
             cache
             out
             out-optimized
-            
+
       - name: "Run the invariant tests against the optimized build"
         run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/invariant/**/*.sol\""
 
@@ -285,4 +285,4 @@ jobs:
       - name: "Add test summary"
         run: |
           echo "## Fork tests result" >> $GITHUB_STEP_SUMMARY
-          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ concurrency:
 env:
   API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }}
   API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }}
-  RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }}
+  MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
 
 on:
   workflow_dispatch:
@@ -76,7 +76,7 @@ jobs:
 
       - name: "Generate and prepare the contract artifacts"
         run: "./shell/prepare-artifacts.sh"
-        
+
       - name: "Build the test contracts"
         run: "FOUNDRY_PROFILE=test-optimized forge build"
 
@@ -91,7 +91,7 @@ jobs:
 
       - name: "Install the Node.js dependencies"
         run: "pnpm install"
-  
+
       - name: "Store the contract artifacts in CI"
         uses: "actions/upload-artifact@v3"
         with:
@@ -126,8 +126,8 @@ jobs:
           node-version: "lts/*"
 
       - name: "Install the Node.js dependencies"
-        run: "pnpm install"  
-        
+        run: "pnpm install"
+
       - name: "Restore the cached build"
         uses: "actions/cache/restore@v3"
         with:
@@ -255,7 +255,7 @@ jobs:
 
       - name: "Install the Node.js dependencies"
         run: "pnpm install"
-        
+
       - name: "Restore the cached build"
         uses: "actions/cache/restore@v3"
         with:
@@ -265,7 +265,7 @@ jobs:
             cache
             out
             out-optimized
-    
+
       - name: "Run the invariant tests against the optimized build"
         run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/invariant/**/*.sol\""
 
@@ -309,7 +309,7 @@ jobs:
             cache
             out
             out-optimized
-    
+
       - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance"
         run: |
           echo "FOUNDRY_FUZZ_SEED=$(echo $(($EPOCHSECONDS / 604800)))" >> $GITHUB_ENV

shell/deploy-multi-chains.sh

@@ -1,10 +1,11 @@
-
 #!/usr/bin/env bash
 
 # Usage: ./shell/deploy-multi-chains.sh [options] [chain1 [chain2 ...]]
 # Options:
 #  --deterministic Deploy using the deterministic script.
 #  --broadcast Broadcast the deployment and verify on Etherscan.
+#  --with-gas-price Specify gas price for transaction.
+#  --all Deploy on all chains.
 # Example: ./shell/deploy-multi-chains.sh # Default deploys only to Sepolia
 # Example: ./shell/deploy-multi-chains.sh --broadcast arbitrum_one mainnet
 # Example: ./shell/deploy-multi-chains.sh --deterministic --broadcast mainnet
@@ -13,10 +14,21 @@
 
 # Pre-requisites:
 # - foundry (https://getfoundry.sh)
+# - bash version >=4.0.0
 
 # Strict mode: https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
 set -euo pipefail
 
+# color codes
+EC='\033[0;31m' # Error Color
+SC='\033[0;32m' # Success Color
+WC='\033[0;33m' # Warn Color
+IC='\033[0;36m' # Info Color
+NC='\033[0m' # No Color
+
+# Unicode characters for tick
+TICK="\xE2\x9C\x94"
+
 # Create deployments directory
 deployments=./deployments
 rm -rf $deployments
@@ -39,15 +51,26 @@ ARBITRUM_CHAIN_ID="42161"
 AVALANCHE_CHAIN_ID="43114"
 BASE_CHAIN_ID="8453"
 BSC_CHAIN_ID="56"
-GOERLI_CHAIN_ID="5"
 GNOSIS_CHAIN_ID="100"
 MAINNET_CHAIN_ID="1"
 OPTIMISM_CHAIN_ID="10"
 POLYGON_CHAIN_ID="137"
 SCROLL_CHAIN_ID="534352"
 SEPOLIA_CHAIN_ID="11155111"
 
-echo $BASH_VERSION
+# Source the .env file to load the variables
+if [ -f .env ]; then
+    source .env
+else
+    echo -e "${EC}Error: .env file not found${NC}"
+    exit 1
+fi
+
+# Check: required Bash >=4.0.0 for associative arrays
+if ((BASH_VERSINFO[0] < 4)); then
+    echo -e "${EC}Error:\nThis script requires Bash version 4.0.0 or higher.\nYou are currently using Bash version ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}.${BASH_VERSINFO[2]}.\nPlease upgrade your Bash version and try again.${NC}"
+    exit 1
+fi
 
 # Define chain configurations
 declare -A chains
@@ -72,6 +95,9 @@ DETERMINISTIC_DEPLOYMENT=false
 WITH_GAS_PRICE=false
 GAS_PRICE=0
 
+# Flag for all chains
+ON_ALL_CHAINS=false
+
 # Requested chains
 requested_chains=()
 
@@ -87,7 +113,7 @@ for ((i=1; i<=$#; i++)); do
     # Check for '--broadcast' flag in the arguments
     if [[ $arg == "--deterministic" ]]; then
         DETERMINISTIC_DEPLOYMENT=true
-    fi      
+    fi
 
     # Check for '--with-gas-price' flag in the arguments
     if [[ $arg == "--with-gas-price" ]]; then
@@ -96,18 +122,19 @@ for ((i=1; i<=$#; i++)); do
         ((i++))
         GAS_PRICE=${!i}
         if ! [[ $GAS_PRICE =~ ^[0-9]+$ ]]; then
-            echo "Error: Gas price must be a number."
+            echo -e "${EC}Error: Invalid value for --with-gas-price, must be number${NC}"
             exit 1
         fi
     fi
 
     # Check for '--all' flag in the arguments
     if [[ $arg == "--all" ]]; then
+        ON_ALL_CHAINS=true
         requested_chains=("${!chains[@]}")
     fi
 
     # Check for passed chains
-    if [[ $arg != "--all" && $arg != "--deterministic" && $arg != "--broadcast"  && $arg != "--with-gas-price" ]]; then
+    if [[ $arg != "--all" && $arg != "--deterministic" && $arg != "--broadcast" && $arg != "--with-gas-price" && $ON_ALL_CHAINS == false ]]; then
         requested_chains+=("$arg")
     fi
 done
@@ -125,7 +152,7 @@ FOUNDRY_PROFILE=optimized forge build
 for chain in "${requested_chains[@]}"; do
     # Check if the requested chain is defined
     if [[ ! -v "chains[$chain]" ]]; then
-        echo "Chain configuration for '$chain' not found."
+        echo -e "\n${WC}Warning: Chain configuration for '$chain' not found.${NC}"
         continue
     fi
 
@@ -137,36 +164,38 @@ for chain in "${requested_chains[@]}"; do
 
     # Choose the script based on the flag
     if [[ $DETERMINISTIC_DEPLOYMENT == true ]]; then
-        echo "Deploying deterministic contracts to $chain..."
+        echo -e "\n${IC}Deploying deterministic contracts to $chain...${NC}"
         # Construct the command
         deployment_command="forge script script/DeployDeterministicCore.s.sol \
         --rpc-url $rpc_url \
         --sig run(string,address,uint256) \
-        \"ChainID $chain_id, Version 1.1.0\" \
+        \'ChainID $chain_id, Version 1.1.0\' \
         $admin \
         $MAX_SEGMENTS_COUNT \
-        -vv"
+        -vvv"
     else
-        echo "Deploying contracts to $chain..."
+        echo -e "\n${IC}Deploying contracts to $chain...${NC}"
         # Construct the command
         deployment_command="forge script script/DeployCore.s.sol \
         --rpc-url $rpc_url \
         --sig run(address,uint256) \
         $admin \
         $MAX_SEGMENTS_COUNT \
-        -vv"
+        -vvv"
     fi
 
     # Append additional options if broadcast is enabled
-    if [[ $BROADCAST_DEPLOYMENT == true ]]; then    
-        echo "This deployment is broadcasted on $chain"
+    if [[ $BROADCAST_DEPLOYMENT == true ]]; then
+        echo -e "${SC}+${NC} Broadcasting on $chain"
         deployment_command+=" --broadcast --verify --etherscan-api-key \"$api_key\""
+    else
+        echo -e "${SC}+${NC} Simulating on $chain"
     fi
 
     # Append additional options if gas price is enabled
     if [[ $WITH_GAS_PRICE == true ]]; then
         gas_price_in_gwei=$(echo "scale=2; $GAS_PRICE / 1000000000" | bc)
-        echo "This deployment is using gas price of $gas_price_in_gwei gwei"
+        echo -e "${SC}+${NC} Using gas price of $gas_price_in_gwei gwei"
         deployment_command+=" --with-gas-price $GAS_PRICE"
     fi
 
@@ -191,7 +220,7 @@ for chain in "${requested_chains[@]}"; do
         echo "SablierV2NFTDescriptor = $nftDescriptor_address"
     } >> "$chain_file"
 
-    echo "Deployment for $chain done. Addresses saved in $chain_file"
+    echo -e "${SC}$TICK Deployed on $chain. Addresses saved in $chain_file${NC}"
 done
 
-echo "All deployments completed."
+echo -e "\nAll deployments completed."