Added initial scripts

Author: drinkcoffee

.env.example

@@ -1,4 +1,3 @@
-ETHERSCAN_API_KEY=<YOUR_ETHERSCAN_API_KEY>
-SEPOLIA_URL=https://eth-sepolia.g.alchemy.com/v2/<YOUR_ALCHEMY_API_KEY>
-MAINNET_URL=https://eth-mainnet.g.alchemy.com/v2/<YOUR_ALCHEMY_API_KEY>
+BLOCKSCOUT_APIKEY=<YOUR_BLOCKSCOUT_APIKEY>
 PRIVATE_KEY=<YOUR_PRIVATE_KEY>
+LEDGER_HD_PATH=<m/44'/60'/0'/0/0>

contracts/staking/README.md

@@ -37,12 +37,12 @@ Contract threat models and audits:
 
 **Deploy and verify using CREATE3 factory contract:**
 
-This repo includes a script for deploying via a CREATE3 factory contract. The script is defined as a test contract as per the examples [here](https://book.getfoundry.sh/reference/forge/forge-script#examples) and can be found in `./script/staking/DeployStakeHolder.sol`.
+This repo includes a script for deploying via a CREATE3 factory contract. The script is defined as a test contract as per the examples [here](https://book.getfoundry.sh/reference/forge/forge-script#examples) and can be found in `./script/staking/DeployStakeHolder.t.sol`.
 
 See the `.env.example` for required environment variables.
 
 ```sh
-forge script script/staking/DeployStakeHolder.sol --tc DeployStakeHolder --sig "deploy()" -vvv --rpc-url {rpc-url} --broadcast --verifier-url https://explorer.immutable.com/api --verifier blockscout --verify --gas-price 10000000000
+forge script script/staking/DeployStakeHolder.t.sol --tc DeployStakeHolder --sig "deploy()" -vvv --rpc-url {rpc-url} --broadcast --verifier-url https://explorer.immutable.com/api --verifier blockscout --verify --gas-price 10000000000
 ```
 
 Optionally, you can also specify `--ledger` or `--trezor` for hardware deployments. See docs [here](https://book.getfoundry.sh/reference/forge/forge-script#wallet-options---hardware-wallet).

script/staking/common.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+# Load the .env file if it exists
+if [ -f .env ]
+then
+  set -a; source .env; set +a
+fi
+
+if [[ $useMainNet -eq 1 ]]
+then
+    echo Immutable zkEVM Mainnet Configuration
+    RPC=https://rpc.immutable.com
+    BLOCKSCOUT_URI=https://explorer.immutable.com/api?
+    USEMAINNET=true
+else
+    echo Immutable zkEVM Testnet Configuration
+    RPC=https://rpc.testnet.immutable.com
+    BLOCKSCOUT_URI=https://explorer.testnet.immutable.com/api?
+    USEMAINNET=false
+fi
+if [ -z "${BLOCKSCOUT_APIKEY}" ]; then
+    echo "Error: BLOCKSCOUT_APIKEY environment variable is not set"
+    exit 1
+fi
+
+if [[ $useLedger -eq 1 ]]
+then
+    echo " with Ledger Hardware Wallet"
+    if [ -z "${LEDGER_HD_PATH}" ]; then
+        echo "Error: LEDGER_HD_PATH environment variable is not set"
+        exit 1
+    fi
+else
+    echo " with a raw private key"
+    if [ -z "${PRIVATE_KEY}" ]; then
+        echo "Error: PRIVATE_KEY environment variable is not set"
+        exit 1
+    fi
+fi
+
+
+echo "Configuration"
+echo " RPC: $RPC"
+echo " BLOCKSCOUT_APIKEY: $BLOCKSCOUT_APIKEY"
+echo " BLOCKSCOUT_URI: $BLOCKSCOUT_URI"
+if [[ $useLedger -eq 1 ]]
+then
+    echo LEDGER_HD_PATH: $LEDGER_HD_PATH
+else
+    echo " PRIVATE_KEY: <not echoed for your security>" # $PRIVATE_KEY
+fi

script/staking/deployComplex.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+# useMainNet: 1 for mainnet, 0 for testnet
+useMainNet=0
+# useLedger: 1 for ledger, 0 for private key
+useLedger=0
+# Set-up variables
+source $(dirname "$0")/common.sh
+
+
+# NOTE WELL ---------------------------------------------
+# Add resume option if the script fails part way through:
+#     --resume \
+# NOTE WELL ---------------------------------------------
+if [[ $useLedger -eq 1 ]]
+then
+    forge script --rpc-url $RPC \
+        --priority-gas-price 10000000000 \
+        --with-gas-price     10000000100 \
+        -vvv \
+        --broadcast \
+        --verify \
+        --verifier blockscout \
+        --verifier-url $BLOCKSCOUT_URI$BLOCKSCOUT_APIKEY \
+        --sig "deployComplex()" \
+        --ledger \
+        --hd-paths "$LEDGER_HD_PATH" \
+        script/staking/StakeHolderScript.t.sol:StakeHolderScript 
+else
+    forge script --rpc-url $RPC \
+        --priority-gas-price 10000000000 \
+        --with-gas-price     10000000100 \
+        -vvv \
+        --broadcast \
+        --verify \
+        --verifier blockscout \
+        --verifier-url $BLOCKSCOUT_URI$BLOCKSCOUT_APIKEY \
+        --sig "deployComplex()" \
+        --private-key $PRIVATE_KEY \
+        script/staking/StakeHolderScript.t.sol:StakeHolderScript 
+fi
+

script/staking/deploySimple.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+# useMainNet: 1 for mainnet, 0 for testnet
+useMainNet=0
+# useLedger: 1 for ledger, 0 for private key
+useLedger=0
+# Set-up variables
+source $(dirname "$0")/common.sh
+
+
+# NOTE WELL ---------------------------------------------
+# Add resume option if the script fails part way through:
+#     --resume \
+# NOTE WELL ---------------------------------------------
+if [[ $useLedger -eq 1 ]]
+then
+    forge script --rpc-url $RPC \
+        --priority-gas-price 10000000000 \
+        --with-gas-price     10000000100 \
+        -vvv \
+        --broadcast \
+        --verify \
+        --verifier blockscout \
+        --verifier-url $BLOCKSCOUT_URI$BLOCKSCOUT_APIKEY \
+        --sig "deploySimple()" \
+        --ledger \
+        --hd-paths "$LEDGER_HD_PATH" \
+        script/staking/StakeHolderScript.t.sol:StakeHolderScript 
+else
+    forge script --rpc-url $RPC \
+        --priority-gas-price 10000000000 \
+        --with-gas-price     10000000100 \
+        -vvv \
+        --broadcast \
+        --verify \
+        --verifier blockscout \
+        --verifier-url $BLOCKSCOUT_URI$BLOCKSCOUT_APIKEY \
+        --sig "deploySimple()" \
+        --private-key $PRIVATE_KEY \
+        script/staking/StakeHolderScript.t.sol:StakeHolderScript 
+fi