Deployment script + doc

keep-starknet-strange · Mar 30, 2024 · 1336383 · 1336383
1 parent fec2219
commit 1336383
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 33 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,5 @@ book/book/
 package.json
 yarn.lock
 node_modules/
+
+.env
diff --git a/scripts/README.md b/scripts/README.md
@@ -1,12 +1,26 @@
-## Set up `starkli`
+# Tooling documentation
 
-Follow [Starkli 101](https://book.starkli.rs/tutorials/starkli-101) tutorial to set up a signer and an account. We are deploying to Sepolia so remember to use the `--network sepolia` option to interact with the testnet.
+## Setting up `starkli`
 
-Create a `.env` file in project root as follows :
+Follow [Starkli 101](https://book.starkli.rs/tutorials/starkli-101) tutorial to set up a signer and an account. We are deploying to Sepolia, so you can use the `--network sepolia` option to interact with the testnet with a free RPC vendor.
+
+Create a `.env` file in project root as follows:
 
 ````shell
 STARKNET_KEYSTORE="/path/to/key.json"
-KEYSTORE_PASSWORD="password"
 STARKNET_ACCOUNT="/path/to/account.json"
 ````
 
+## Deploying the blobstreamx contract
+
+Run the deployment script:
+
+````shell
+deploy-blobstreamx.sh --owner <owner_address> --height <block_height> --header <block_header>
+````
+
+You will be prompted to enter your keystore password two times: once for declaring the class hash and another for deploying the contract.
+
+You are required to provide an owner, a height, and a header, although additional parameters can be provided.
+
+Please review the `--help` menu for more information. You can use `--debug` to create a log file.
diff --git a/scripts/deploy-blobstreamx.sh b/scripts/deploy-blobstreamx.sh
@@ -3,54 +3,51 @@ source ../.env
 
 # Check if required env variables are set, if not exit
 if [ -z "$STARKNET_KEYSTORE" ]; then
-  echo "STARKNET_KEYSTORE is not set."
-  exit 1
-elif [ -z "$KEYSTORE_PASSWORD" ]; then
-  echo "KEYSTORE_PASSWORD is not set."
+  echo "Error: STARKNET_KEYSTORE is not set."
   exit 1
 elif [ -z "$STARKNET_ACCOUNT" ]; then
-  echo "STARKNET_ACCOUNT is not set."
+  echo "Error: STARKNET_ACCOUNT is not set."
   exit 1
 fi
 
 # Constants
 SIERRA_FILE=../target/dev/blobstream_sn_blobstreamx.contract_class.json
 # Optional arguments
-HERODOTUS_FACT_REGISTRY_ADDRESS="0x07d3550237ecf2d6ddef9b78e59b38647ee511467fe000ce276f245a006b40bc"
+HERODOTUS_FACTS_REGISTRY_ADDRESS="0x07d3550237ecf2d6ddef9b78e59b38647ee511467fe000ce276f245a006b40bc"
 BLOBSTREAMX_L1_ADDRESS="0x48B257EC1610d04191cC2c528d0c940AdbE1E439"
 # TODO : Change when Succint contracts are deployed
 GATEWAY_ADDRESS="0x07e4220832ecf2d6ddef9b78e59b38647ee511467fe000ce225f245a006b32cb"
 HEADER_RANGE_FUNCTION_ID="0x1"
 NEXT_HEADER_FUNCTION_ID="0x2"
 
 display_help() {
-  echo "Usage: $0 [option...] {arguments...}"
+  echo "Usage: $0 [option...]"
   echo
   echo "   -o, --owner ADDR                         Owner address on Starknet"
   echo "                                            (required)"
   echo "   -H, --height U64                         Height of the latest block number updated by the light client"
   echo "                                            (required)"
-  echo "   -a, --header U256                        Header hash for the block height"
+  echo "   -a, --header U256                        Header hash for the corresponding block height"
   echo "                                            (required)"
 
   echo
   echo "   -g, --gateway ADDR                       Succint gateway contract address on Starknet"
   echo "                                            (default: $GATEWAY_ADDRESS (SEPOLIA))"
   echo "   -r, --header-range-function-id U256      Header range function id"
   echo "                                            (default: $HEADER_RANGE_FUNCTION_ID)"
-  echo "   -n, --next-header-function_id U256       Next header function id"
+  echo "   -n, --next-header-function-id U256       Next header function id"
   echo "                                            (default: $NEXT_HEADER_FUNCTION_ID)"
-  echo "   -f, --herodotus-facts-registry ADDR      Herodotus fact registry address on Starknet"
-  echo "                                            (default: $HERODOTUS_FACT_REGISTRY_ADDRESS (SEPOLIA))"
+  echo "   -f, --herodotus-facts-registry ADDR      Herodotus facts registry address on Starknet"
+  echo "                                            (default: $HERODOTUS_FACTS_REGISTRY_ADDRESS (SEPOLIA))"
   echo "   -b, --blobstreamx-l1 ADDR                BlobstreamX contract address on L1"
   echo "                                            (default: $BLOBSTREAMX_L1_ADDRESS (SEPOLIA))"
 
   echo
   echo "   -h, --help                               display help"
-  echo "   -d, --debug                              debug mode: creates debug_blobstreamx.log"
+  echo "   -d, --debug                              save logs in debug_blobstreamx.log"
 
   echo
-  echo "Example: $0"
+  echo "Example: $0 --owner 0x0 --height 0x1 --header 0x2"
 }
 
 # Transform long options to short ones
@@ -62,15 +59,22 @@ for arg in "$@"; do
     "--height") set -- "$@" "-H" ;;
     "--header") set -- "$@" "-a" ;;
     "--header-range-function-id") set -- "$@" "-r" ;;
-    "--next-header-function_id") set -- "$@" "-n" ;;
+    "--next-header-function-id") set -- "$@" "-n" ;;
     "--herodotus-facts-registry") set -- "$@" "-f" ;;
     "--blobstreamx-l1") set -- "$@" "-b" ;;
     "--help") set -- "$@" "-h" ;;
     "--debug") set -- "$@" "-d" ;;
+    --*) unrecognized_options+=("$arg") ;;
     *) set -- "$@" "$arg"
   esac
 done
 
+# Check if unknown options are passed, if so exit
+if [ ! -z "${unrecognized_options[@]}" ]; then
+  echo "Error: invalid option(s) passed ${unrecognized_options[*]}" 1>&2
+  exit 1
+fi
+
 # Parse command line arguments
 while getopts ":hdg:o:a:H:r:n:f:b:-:" opt; do
   case ${opt} in
@@ -100,7 +104,7 @@ while getopts ":hdg:o:a:H:r:n:f:b:-:" opt; do
       NEXT_HEADER_FUNCTION_ID="$OPTARG"
       ;;
     f )
-      HERODOTUS_FACT_REGISTRY_ADDRESS="$OPTARG"
+      HERODOTUS_FACTS_REGISTRY_ADDRESS="$OPTARG"
       ;;
     b )
       BLOBSTREAMX_L1_ADDRESS="$OPTARG"
@@ -118,18 +122,13 @@ while getopts ":hdg:o:a:H:r:n:f:b:-:" opt; do
   esac
 done
 
-# Check if required parameters are set, if not exit.
-if [ -z "$OWNER" ]; then
-  echo "Error: --owner is not specified."
-  exit 1
-elif [ -z "$HEIGHT" ]; then
-  echo "Error: --height is not specified."
-  exit 1
-elif [ -z "$HEADER" ]; then
-  echo "Error: --header is not specified."
+# Check if required options are set, if not exit
+if [ -z "$OWNER" ] || [ -z "$HEIGHT" ] || [ -z "$HEADER" ]; then
+  echo "Error: missing required options (see --help)"
   exit 1
 fi
 
+
 # Build the contract
 build() {
     output=$(scarb build 2>&1)
@@ -144,10 +143,15 @@ build() {
 declare() {
     build
     if [ "$DEBUG" = true ]; then
-        echo "declare --keystore $STARKNET_KEYSTORE --keystore-password $KEYSTORE_PASSWORD --account $STARKNET_ACCOUNT --watch $SIERRA_FILE" > debug_blobstreamx.log
+        echo "declare --keystore $STARKNET_KEYSTORE --account $STARKNET_ACCOUNT --watch $SIERRA_FILE" > debug_blobstreamx.log
     fi
-    output=$(starkli declare --network sepolia --keystore $STARKNET_KEYSTORE --keystore-password $KEYSTORE_PASSWORD --account $STARKNET_ACCOUNT --watch $SIERRA_FILE 2>&1)
 
+    output=$(starkli declare --network sepolia --keystore $STARKNET_KEYSTORE --account $STARKNET_ACCOUNT --watch $SIERRA_FILE 2>&1)
+
+    if [ "$DEBUG" = true ]; then
+        echo "$output" >> debug_blobstreamx.log
+    fi
+
     if [[ $output == *"Error"* ]]; then
         echo "Error: $output"
         exit 1
@@ -162,9 +166,14 @@ deploy() {
     class_hash=$(declare | tail -n 1)
 
     if [ "$DEBUG" = true ]; then
-        echo "deploy --network sepolia --keystore $STARKNET_KEYSTORE --keystore-password $KEYSTORE_PASSWORD --account $STARKNET_ACCOUNT --watch $class_hash $GATEWAY_ADDRESS $OWNER $HEIGHT u256:$HEADER u256:$HEADER_RANGE_FUNCTION_ID u256:$NEXT_HEADER_FUNCTION_ID $HERODOTUS_FACT_REGISTRY_ADDRESS $BLOBSTREAMX_L1_ADDRESS" >> debug_blobstreamx.log
+        echo "deploy --network sepolia --keystore $STARKNET_KEYSTORE --account $STARKNET_ACCOUNT --watch $class_hash $GATEWAY_ADDRESS $OWNER $HEIGHT u256:$HEADER u256:$HEADER_RANGE_FUNCTION_ID u256:$NEXT_HEADER_FUNCTION_ID $HERODOTUS_FACTS_REGISTRY_ADDRESS $BLOBSTREAMX_L1_ADDRESS" >> debug_blobstreamx.log
+    fi
+
+    output=$(starkli deploy --network sepolia --keystore $STARKNET_KEYSTORE --account $STARKNET_ACCOUNT --watch $class_hash "$GATEWAY_ADDRESS" "$OWNER" "$HEIGHT" u256:"$HEADER" u256:"$HEADER_RANGE_FUNCTION_ID" u256:"$NEXT_HEADER_FUNCTION_ID" "$HERODOTUS_FACTS_REGISTRY_ADDRESS" "$BLOBSTREAMX_L1_ADDRESS" 2>&1)
+
+    if [ "$DEBUG" = true ]; then
+        echo "$output" >> debug_blobstreamx.log
     fi
-    output=$(starkli deploy --network sepolia --keystore $STARKNET_KEYSTORE --keystore-password $KEYSTORE_PASSWORD --account $STARKNET_ACCOUNT --watch $class_hash "$GATEWAY_ADDRESS" "$OWNER" "$HEIGHT" u256:"$HEADER" u256:"$HEADER_RANGE_FUNCTION_ID" u256:"$NEXT_HEADER_FUNCTION_ID" "$HERODOTUS_FACT_REGISTRY_ADDRESS" "$BLOBSTREAMX_L1_ADDRESS" 2>&1)
 
     if [[ $output == *"Error"* ]]; then
         echo "Error: $output"
@@ -176,4 +185,4 @@ deploy() {
 }
 
 contract_address=$(deploy)
-echo "Deployed at : $contract_address"
+echo "Deployed at: $contract_address"