refactor: separate base env from deployment env

chore: improve multi-chain deployment script refactor: rename env var MAX_SEGMENT_COUNT
sablier-labs · Dec 17, 2023 · 45b5732 · 45b5732
1 parent 767d0f7
commit 45b5732
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 84 deletions.
diff --git a/.env.deployment.example b/.env.deployment.example
@@ -0,0 +1,42 @@
+# Used by the multi-chain deployment script
+
+# General
+export MAX_SEGMENT_COUNT="THE_MAX_SEGMENT_COUNT"
+export MNEMONIC="YOUR_MNEMONIC"
+
+# RPC URLs
+export ARBITRUM_RPC_URL="YOUR_RPC_URL"
+export ARBITRUM_SEPOLIA_RPC_URL="YOUR_RPC_URL"
+export AVALANCHE_RPC_URL="YOUR_RPC_URL"
+export BASE_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"
+export BASESCAN_API_KEY="YOUR_API_KEY"
+export BSCSCAN_API_KEY="YOUR_API_KEY"
+export ETHERSCAN_API_KEY="YOUR_API_KEY"
+export GNOSISSCAN_API_KEY="YOUR_API_KEY"
+export OPTIMISTIC_API_KEY="YOUR_API_KEY"
+export POLYGONSCAN_API_KEY="YOUR_API_KEY"
+export SCROLLSCAN_API_KEY="YOUR_API_KEY"
+export SNOWTRACE_API_KEY="YOUR_API_KEY"
+
+# Script variables
+export ARBITRUM_ADMIN="YOUR_ADMIN_ADDRESS"
+export ARBITRUM_SEPOLIA_ADMIN="YOUR_ADMIN_ADDRESS"
+export AVALANCHE_ADMIN="YOUR_ADMIN_ADDRESS"
+export BASE_ADMIN="YOUR_ADMIN_ADDRESS"
+export BSC_ADMIN="YOUR_ADMIN_ADDRESS"
+export GNOSIS_ADMIN="YOUR_ADMIN_ADDRESS"
+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"
diff --git a/.env.example b/.env.example
@@ -1,46 +1,11 @@
-# Run `cp .env.example .env` command to create your .env file
-
-# General
-export API_KEY_INFURA="YOUR_INFURA_KEY"
+export API_KEY_ARBISCAN="YOUR_API_KEY_ARBISCAN"
+export API_KEY_BSCSCAN="YOUR_API_KEY_BSCSCAN"
+export API_KEY_ETHERSCAN="YOUR_API_KEY_ETHERSCAN"
+export API_KEY_GNOSISSCAN="YOUR_API_KEY_GNOSISSCAN"
+export API_KEY_INFURA="YOUR_API_KEY_INFURA"
+export API_KEY_OPTIMISTIC_ETHERSCAN="YOUR_API_KEY_OPTIMISTIC_ETHERSCAN"
+export API_KEY_POLYGONSCAN="YOUR_API_KEY_POLYGONSCAN"
+export API_KEY_SNOWTRACE="YOUR_API_KEY_SNOWTRACE"
+export RPC_URL_MAINNET="YOUR_RPC_URL_MAINNET"
 export FOUNDRY_PROFILE="lite"
 export MNEMONIC="YOUR_MNEMONIC"
-
-# RPC URLs
-export ARBITRUM_RPC_URL="YOUR_RPC_URL"
-export ARBITRUM_SEPOLIA_RPC_URL="YOUR_RPC_URL"
-export AVALANCHE_RPC_URL="YOUR_RPC_URL"
-export BASE_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"
-export BASESCAN_API_KEY="YOUR_API_KEY"
-export BSCSCAN_API_KEY="YOUR_API_KEY"
-export ETHERSCAN_API_KEY="YOUR_API_KEY"
-export GNOSISSCAN_API_KEY="YOUR_API_KEY"
-export OPTIMISTIC_API_KEY="YOUR_API_KEY"
-export POLYGONSCAN_API_KEY="YOUR_API_KEY"
-export SCROLL_API_KEY="YOUR_API_KEY"
-export SNOWTRACE_API_KEY="YOUR_API_KEY"
-
-# Script variables
-export ARBITRUM_ADMIN="YOUR_ADMIN_ADDRESS"
-export ARBITRUM_SEPOLIA_ADMIN="YOUR_ADMIN_ADDRESS"
-export AVALANCHE_ADMIN="YOUR_ADMIN_ADDRESS"
-export BASE_ADMIN="YOUR_ADMIN_ADDRESS"
-export BSC_ADMIN="YOUR_ADMIN_ADDRESS"
-export GNOSIS_ADMIN="YOUR_ADMIN_ADDRESS"
-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"
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,7 @@ out-svg
 
 # files
 *.env
+*.env.deployment
 *.log
 .DS_Store
 .pnp.*

diff --git a/foundry.toml b/foundry.toml
@@ -95,7 +95,7 @@
   bnb_smart_chain = "https://bnbsmartchain-mainnet.infura.io/v3/${API_KEY_INFURA}"
   gnosis_chain = "https://rpc.gnosischain.com"
   localhost = "http://localhost:8545"
-  mainnet = "${MAINNET_RPC_URL}"
+  mainnet = "${RPC_URL_MAINNET}"
   optimism = "https://optimism-mainnet.infura.io/v3/${API_KEY_INFURA}"
   polygon = "https://polygon-mainnet.infura.io/v3/${API_KEY_INFURA}"
-  sepolia = "https://sepolia.infura.io/v3/${API_KEY_INFURA}"
+  sepolia = "https://sepolia.infura.io/v3/${API_KEY_INFURA}"
diff --git a/shell/deploy-multi-chains.sh b/shell/deploy-multi-chains.sh
@@ -1,30 +1,30 @@
 #!/usr/bin/env bash
 
-# Usage: ./shell/deploy-multi-chains.sh [options] [chain1 [chain2 ...]]
+# Usage: ./shell/deploy-multi-chains.sh [options] [[chain1 chain2 ...]]
 # Options:
-#  --deterministic Deploy using the deterministic script.
+#  --all Deploy on all chains.
 #  --broadcast Broadcast the deployment and verify on Etherscan.
+#  --deterministic Deploy using the deterministic script.
 #  --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 # By default, deploys only to Sepolia
 # Example: ./shell/deploy-multi-chains.sh --broadcast optimism mainnet
-# Example: ./shell/deploy-multi-chains.sh --deterministic --broadcast mainnet
+# Example: ./shell/deploy-multi-chains.sh --broadcast --deterministic mainnet
 
-# Make sure you set-up your .env file first. See .env.example.
+# Make sure you set-up your `.env.deployment` file first.
 
 # Pre-requisites:
+# - bash >=4.0.0
 # - foundry (https://getfoundry.sh)
-# - bash version >=4.0.0
 
 # Strict mode: https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
 set -euo pipefail
 
-# color codes
+# 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
+SC='\033[0;32m' # Success Color
+WC='\033[0;33m' # Warn Color
 
 # Unicode characters for tick
 TICK="\xE2\x9C\x94"
@@ -34,7 +34,7 @@ deployments=./deployments
 rm -rf $deployments
 mkdir $deployments
 
-# from: https://docs.sablier.com/contracts/v2/deployments
+# Addressed taken from https://docs.sablier.com/contracts/v2/deployments
 ARBITRUM_COMPTROLLER="0x17Ec73692F0aDf7E7C554822FBEAACB4BE781762"
 ARBITRUM_SEPOLIA_COMPTROLLER="0xA6A0cfA3442053fbB516D55205A749Ef2D33aed9"
 AVALANCHE_COMPTROLLER="0x66F5431B0765D984f82A4fc4551b2c9ccF7eAC9C"
@@ -47,7 +47,7 @@ POLYGON_COMPTROLLER="0x9761692EDf10F5F2A69f0150e2fd50dcecf05F2E"
 SCROLL_COMPTROLLER="0x859708495E3B3c61Bbe19e6E3E1F41dE3A5C5C5b"
 SEPOLIA_COMPTROLLER="0x2006d43E65e66C5FF20254836E63947FA8bAaD68"
 
-# Declare chain IDs
+# Declare the chain IDs
 ARBITRUM_CHAIN_ID="42161"
 ARBITRUM_SEPOLIA_CHAIN_ID="421614"
 AVALANCHE_CHAIN_ID="43114"
@@ -61,22 +61,22 @@ SCROLL_CHAIN_ID="534352"
 SEPOLIA_CHAIN_ID="11155111"
 
 # Source the .env file to load the variables
-if [ -f .env ]; then
-    source .env
+if [ -f .env.deployment ]; then
+    source .env.deployment
 else
-    echo -e "${EC}Error: .env file not found${NC}"
+    echo -e "${EC}Error: .env.deployment file not found${NC}"
     exit 1
 fi
 
-# Check: required Bash >=4.0.0 for associative arrays
+# Check: Bash >=4.0.0 is required 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
+# Define the chain configurations
 declare -A chains
 chains["arbitrum"]="$ARBITRUM_RPC_URL $ARBISCAN_API_KEY $ARBITRUM_CHAIN_ID $ARBITRUM_ADMIN $ARBITRUM_COMPTROLLER"
 chains["arbitrum_sepolia"]="$ARBITRUM_SEPOLIA_RPC_URL $ARBISCAN_API_KEY $ARBITRUM_SEPOLIA_CHAIN_ID $ARBITRUM_SEPOLIA_ADMIN $ARBITRUM_SEPOLIA_COMPTROLLER"
@@ -87,8 +87,8 @@ chains["gnosis"]="$GNOSIS_RPC_URL $GNOSISSCAN_API_KEY $GNOSIS_CHAIN_ID $GNOSIS_A
 chains["mainnet"]="$MAINNET_RPC_URL $ETHERSCAN_API_KEY $MAINNET_CHAIN_ID $MAINNET_ADMIN $MAINNET_COMPTROLLER"
 chains["optimism"]="$OPTIMISM_RPC_URL $OPTIMISTIC_API_KEY $OPTIMISM_CHAIN_ID $OPTIMISM_ADMIN $OPTIMISM_COMPTROLLER"
 chains["polygon"]="$POLYGON_RPC_URL $POLYGONSCAN_API_KEY $POLYGON_CHAIN_ID $POLYGON_ADMIN $POLYGON_COMPTROLLER"
-chains["scroll"]="$SCROLL_RPC_URL $SCROLL_API_KEY $SCROLL_CHAIN_ID $SCROLL_ADMIN $SCROLL_COMPTROLLER"
 chains["sepolia"]="$SEPOLIA_RPC_URL $ETHERSCAN_API_KEY $SEPOLIA_CHAIN_ID $SEPOLIA_ADMIN $SEPOLIA_COMPTROLLER"
+chains["scroll"]="$SCROLL_RPC_URL $SCROLLSCAN_API_KEY $SCROLL_CHAIN_ID $SCROLL_ADMIN $SCROLL_COMPTROLLER"
 
 # Flag for broadcast deployment
 BROADCAST_DEPLOYMENT=false
@@ -97,32 +97,33 @@ BROADCAST_DEPLOYMENT=false
 DETERMINISTIC_DEPLOYMENT=false
 
 # Flag for gas price
-WITH_GAS_PRICE=false
 GAS_PRICE=0
+WITH_GAS_PRICE=false
 
 # Flag for all chains
 ON_ALL_CHAINS=false
 
-# Requested chains
-requested_chains=()
+# Provided chains
+provided_chains=()
 
 # Check for arguments passed to the script
 for ((i=1; i<=$#; i++)); do
     arg=${!i}
 
-    # Check for '--broadcast' flag in the arguments
+    # Check if '--broadcast' flag is provided the arguments
     if [[ $arg == "--broadcast" ]]; then
         BROADCAST_DEPLOYMENT=true
     fi
 
-    # Check for '--broadcast' flag in the arguments
+    # Check if '--deterministic' flag is provided in the arguments
     if [[ $arg == "--deterministic" ]]; then
         DETERMINISTIC_DEPLOYMENT=true
     fi
 
-    # Check for '--with-gas-price' flag in the arguments
+    # Check if '--with-gas-price' flag is provided in the arguments
     if [[ $arg == "--with-gas-price" ]]; then
         WITH_GAS_PRICE=true
+
         # Increment index to get the next argument, which should be the gas price
         ((i++))
         GAS_PRICE=${!i}
@@ -132,36 +133,36 @@ for ((i=1; i<=$#; i++)); do
         fi
     fi
 
-    # Check for '--all' flag in the arguments
+    # Check if '--all' flag is provided in the arguments
     if [[ $arg == "--all" ]]; then
         ON_ALL_CHAINS=true
-        requested_chains=("${!chains[@]}")
+        provided_chains=("${!chains[@]}")
     fi
 
     # Check for passed chains
     if [[ $arg != "--all" && $arg != "--deterministic" && $arg != "--broadcast" && $arg != "--with-gas-price" && $ON_ALL_CHAINS == false ]]; then
-        requested_chains+=("$arg")
+        provided_chains+=("$arg")
     fi
 done
 
-# Set the default chain to Sepolia if no chains are requested
-if [ ${#requested_chains[@]} -eq 0 ]; then
-    requested_chains=("sepolia")
+# Set the default chain to Sepolia if no chains are provided
+if [ ${#provided_chains[@]} -eq 0 ]; then
+    provided_chains=("sepolia")
 fi
 
 # Compile the contracts
 echo "Compiling the contracts..."
 FOUNDRY_PROFILE=optimized forge build
 
-# Deploy to requested chains
-for chain in "${requested_chains[@]}"; do
-    # Check if the requested chain is defined
+# Deploy to the provided chains
+for chain in "${provided_chains[@]}"; do
+    # Check if the provided chain is defined
     if [[ ! -v "chains[$chain]" ]]; then
         echo -e "\n${WC}Warning: Chain configuration for '$chain' not found.${NC}"
         continue
     fi
 
-    # Split the configuration into RPC, API key, Chain ID and the admin address
+    # Split the configuration into RPC, API key, Chain ID, admin, and comptroller
     IFS=' ' read -r rpc_url api_key chain_id admin comptroller <<< "${chains[$chain]}"
 
     # Declare a deployment command
@@ -177,7 +178,7 @@ for chain in "${requested_chains[@]}"; do
         \'ChainID $chain_id, Version 1.1.1\' \
         $admin \
         $comptroller \
-        $MAX_SEGMENTS_COUNT \
+        $MAX_SEGMENT_COUNT \
         -vvv"
     else
         echo -e "\n${IC}Deploying contracts to $chain...${NC}"
@@ -187,7 +188,7 @@ for chain in "${requested_chains[@]}"; do
         --sig run(address,address,uint256) \
         $admin \
         $comptroller \
-        $MAX_SEGMENTS_COUNT \
+        $MAX_SEGMENT_COUNT \
         -vvv"
     fi
 
@@ -225,7 +226,7 @@ for chain in "${requested_chains[@]}"; do
         echo "SablierV2NFTDescriptor = $nftDescriptor_address"
     } >> "$chain_file"
 
-    echo -e "${SC}$TICK Deployed on $chain. Addresses saved in $chain_file${NC}"
+    echo -e "${SC}$TICK Deployed on $chain. You can find the addresses in $chain_file${NC}"
 done
 
-echo -e "\nAll deployments completed."
+echo -e "\nAll deployments completed."
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,7 @@ out-svg @@
     # files
     *.env
+    *.env.deployment
     *.log
     .DS_Store
     .pnp.*
@@ Expand Down @@