Better web3signer handling for Teku and Prysm (eth-educators#1387)

haurog · May 9, 2023 · eb5cd1c · eb5cd1c
1 parent 08e4204
commit eb5cd1c
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 7 deletions.
diff --git a/prysm-vc-only.yml b/prysm-vc-only.yml
@@ -32,6 +32,7 @@ services:
       - VC_EXTRAS=${VC_EXTRAS:-}
       - GRAFFITI=${GRAFFITI:-}
       - DEFAULT_GRAFFITI=${DEFAULT_GRAFFITI:-false}
+      - WEB3SIGNER=${WEB3SIGNER:-false}
     <<: *logging
     entrypoint:
       - docker-entrypoint-vc.sh
@@ -80,6 +81,7 @@ services:
     user: prysmvalidator
     environment:
       - NETWORK=${NETWORK}
+      - WEB3SIGNER=${WEB3SIGNER:-false}
     volumes:
       - prysmvalidator-data:/var/lib/prysm
       - /etc/localtime:/etc/localtime:ro

diff --git a/prysm.yml b/prysm.yml
@@ -96,6 +96,7 @@ services:
       - VC_EXTRAS=${VC_EXTRAS:-}
       - GRAFFITI=${GRAFFITI:-}
       - DEFAULT_GRAFFITI=${DEFAULT_GRAFFITI:-false}
+      - WEB3SIGNER=${WEB3SIGNER:-false}
     <<: *logging
     entrypoint:
       - docker-entrypoint-vc.sh
@@ -145,6 +146,7 @@ services:
     user: prysmvalidator
     environment:
       - NETWORK=${NETWORK}
+      - WEB3SIGNER=${WEB3SIGNER:-false}
     volumes:
       - prysmvalidator-data:/var/lib/prysm
       - /etc/localtime:/etc/localtime:ro

diff --git a/prysm/create-wallet.sh b/prysm/create-wallet.sh
@@ -6,7 +6,14 @@ __password=$(head -c 8 /dev/urandom | od -A n -t u8 | tr -d '[:space:]' | sha256
 echo "$__password" >/tmp/password.txt
 echo "Wallet password created"
 set +e
-__result=$(validator --datadir=/var/lib/prysm wallet create --"${NETWORK}" --wallet-dir=/var/lib/prysm --keymanager-kind=imported --accept-terms-of-use --wallet-password-file=/tmp/password.txt 2>&1)
+if [ "${WEB3SIGNER}" = "true" ]; then
+    __kind=web3signer
+    echo "No need to create a permanent wallet when using web3signer with Prysm. Aborting."
+    exit 0
+else
+    __kind=imported
+fi
+__result=$(validator --datadir=/var/lib/prysm wallet create --"${NETWORK}" --wallet-dir=/var/lib/prysm --keymanager-kind=${__kind} --accept-terms-of-use --wallet-password-file=/tmp/password.txt 2>&1)
 if echo "$__result" | grep -qi error; then
     echo "An error occurred while attempting to create a Prysm wallet"
     echo "$__result"

diff --git a/prysm/docker-entrypoint-vc.sh b/prysm/docker-entrypoint-vc.sh
@@ -22,12 +22,19 @@ else
   __doppel=""
 fi
 
+# Web3signer URL
+if [ "${WEB3SIGNER}" = "true" ]; then
+  __w3s_url="--validators-external-signer-url http://web3signer:9000"
+else
+  __w3s_url=""
+fi
+
 if [ "${DEFAULT_GRAFFITI}" = "true" ]; then
 # Word splitting is desired for the command line parameters
 # shellcheck disable=SC2086
-  exec "$@" ${__mev_boost} ${__doppel} ${VC_EXTRAS}
+  exec "$@" ${__w3s_url} ${__mev_boost} ${__doppel} ${VC_EXTRAS}
 else
 # Word splitting is desired for the command line parameters
 # shellcheck disable=SC2086
-  exec "$@" "--graffiti" "${GRAFFITI}" ${__mev_boost} ${__doppel} ${VC_EXTRAS}
+  exec "$@" "--graffiti" "${GRAFFITI}" ${__w3s_url} ${__mev_boost} ${__doppel} ${VC_EXTRAS}
 fi
diff --git a/teku-cl-only.yml b/teku-cl-only.yml
@@ -40,6 +40,8 @@ services:
       - ARCHIVE_NODE=${ARCHIVE_NODE:-}
       - GRAFFITI=${GRAFFITI:-}
       - DEFAULT_GRAFFITI=true
+      - WEB3SIGNER=false
+      - EMBEDDED_VC=false
     ports:
       - ${HOST_IP:-}${CL_P2P_PORT:-9000}:${CL_P2P_PORT:-9000}/tcp
       - ${HOST_IP:-}${CL_P2P_PORT:-9000}:${CL_P2P_PORT:-9000}/udp

diff --git a/teku-vc-only.yml b/teku-vc-only.yml
@@ -31,6 +31,7 @@ services:
       - DOPPELGANGER=${DOPPELGANGER:-}
       - GRAFFITI=${GRAFFITI:-}
       - DEFAULT_GRAFFITI=${DEFAULT_GRAFFITI:-false}
+      - WEB3SIGNER=${WEB3SIGNER:-false}
     <<: *logging
     entrypoint:
       - docker-entrypoint-vc.sh

diff --git a/teku.yml b/teku.yml
@@ -40,6 +40,8 @@ services:
       - DOPPELGANGER=${DOPPELGANGER:-}
       - GRAFFITI=${GRAFFITI:-}
       - DEFAULT_GRAFFITI=${DEFAULT_GRAFFITI:-false}
+      - WEB3SIGNER=${WEB3SIGNER:-false}
+      - EMBEDDED_VC=true
     ports:
       - ${HOST_IP:-}${CL_P2P_PORT:-9000}:${CL_P2P_PORT:-9000}/tcp
       - ${HOST_IP:-}${CL_P2P_PORT:-9000}:${CL_P2P_PORT:-9000}/udp

diff --git a/teku/docker-entrypoint-vc.sh b/teku/docker-entrypoint-vc.sh
@@ -40,12 +40,19 @@ else
   __mev_boost=""
 fi
 
+# Web3signer URL
+if [ "${WEB3SIGNER}" = "true" ]; then
+  __w3s_url="--validators-external-signer-url http://web3signer:9000"
+else
+  __w3s_url=""
+fi
+
 if [ "${DEFAULT_GRAFFITI}" = "true" ]; then
 # Word splitting is desired for the command line parameters
 # shellcheck disable=SC2086
-  exec "$@" ${__mev_boost} ${__doppel} ${VC_EXTRAS}
+  exec "$@" ${__w3s_url} ${__mev_boost} ${__doppel} ${VC_EXTRAS}
 else
 # Word splitting is desired for the command line parameters
 # shellcheck disable=SC2086
-  exec "$@" "--validators-graffiti=${GRAFFITI}" ${__mev_boost} ${__doppel} ${VC_EXTRAS}
+  exec "$@" "--validators-graffiti=${GRAFFITI}" ${__w3s_url} ${__mev_boost} ${__doppel} ${VC_EXTRAS}
 fi
diff --git a/teku/docker-entrypoint.sh b/teku/docker-entrypoint.sh
@@ -81,12 +81,19 @@ else
   __prune="--data-storage-mode=MINIMAL"
 fi
 
+# Web3signer URL
+if [[ "${EMBEDDED_VC}" = "true" && "${WEB3SIGNER}" = "true" ]]; then
+  __w3s_url="--validators-external-signer-url http://web3signer:9000"
+else
+  __w3s_url=""
+fi
+
 if [ "${DEFAULT_GRAFFITI}" = "true" ]; then
 # Word splitting is desired for the command line parameters
 # shellcheck disable=SC2086
-  exec "$@" ${__mev_boost} ${__rapid_sync} ${__prune} ${__beacon_stats} ${__doppel} ${CL_EXTRAS} ${VC_EXTRAS}
+  exec "$@" ${__w3s_url} ${__mev_boost} ${__rapid_sync} ${__prune} ${__beacon_stats} ${__doppel} ${CL_EXTRAS} ${VC_EXTRAS}
 else
 # Word splitting is desired for the command line parameters
 # shellcheck disable=SC2086
-  exec "$@" "--validators-graffiti=${GRAFFITI}" ${__mev_boost} ${__rapid_sync} ${__prune} ${__beacon_stats} ${__doppel} ${CL_EXTRAS} ${VC_EXTRAS}
+  exec "$@" "--validators-graffiti=${GRAFFITI}" ${__w3s_url} ${__mev_boost} ${__rapid_sync} ${__prune} ${__beacon_stats} ${__doppel} ${CL_EXTRAS} ${VC_EXTRAS}
 fi