forked from eth-educators/eth-docker
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ethd
executable file
·1899 lines (1763 loc) · 71.9 KB
/
ethd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
#set -euo pipefail
set -uo pipefail
__docker_exe="docker"
__compose_exe="docker-compose"
dodocker() {
$__docker_exe "$@"
}
docompose() {
$__compose_exe "$@"
}
determine_distro() {
# Determine OS platform
__uname=$(uname | tr "[:upper:]" "[:lower:]")
# If Linux, try to determine specific distribution
if [ "$__uname" == "linux" ]; then
# If available, use LSB to identify distribution
if [ -n "$(command -v lsb_release 2>/dev/null)" ]; then
__distro=$(lsb_release -i | cut -d: -f2 | sed s/'^\t'//)
# Otherwise, use release info file
else
#__distro=$(ls -d /etc/[A-Za-z]*[_-][rv]e[lr]* | grep -v "lsb" | cut -d'/' -f3 | cut -d'-' -f1 | cut -d'_' -f1)
__distro=$(find /etc -maxdepth 1 -type f -name '[A-Za-z]*[_-][rv]e[lr]*' | grep -v "lsb" | cut -d'/' -f3 | cut -d'-' -f1 | cut -d'_' -f1)
fi
else
__distro=""
fi
# For everything else (or if above failed), just use generic identifier
[ "$__distro" == "" ] && __distro=$__uname
unset __uname
__distro=$(echo "$__distro" | tr "[:upper:]" "[:lower:]")
}
determine_sudo() {
__maybe_sudo=""
if ! docker images >/dev/null 2>&1; then
echo "Will use sudo to access docker"
__maybe_sudo="sudo"
fi
}
determine_docker() {
if [ -n "$__maybe_sudo" ]; then
__docker_exe="sudo $__docker_exe"
fi
}
determine_compose() {
# This is mainly for Debian and docker-ce, where docker-compose does not exist
if ! type -P docker-compose >/dev/null 2>&1; then
__compose_exe="docker compose"
else
__compose_version=$($__maybe_sudo docker-compose --version | sed -n -E -e "s/.*version [v]?([0-9.-]*).*/\1/ip")
__compose_version_major=$(echo "$__compose_version" | cut -f1 -d.)
__compose_version_minor=$(echo "$__compose_version" | cut -f2 -d.)
if ! [ "$__compose_version_major" -eq "$__compose_version_major" ] && [ "$__compose_version_minor" -eq "$__compose_version_minor" ] 2> /dev/null; then
echo "docker-compose version detection failed. Please report this output so it can be fixed."
$__maybe_sudo docker-compose --version
elif [ "$__compose_version_major" -eq 1 ] && [ "$__compose_version_minor" -lt 28 ]; then
echo "Error: Outdated docker-compose version detected ($__compose_version). Please upgrade to version 1.28.0 or later." >&2
if [[ "$__distro" = "ubuntu" ]]; then
__major_version=$(lsb_release -r | cut -d: -f2 | sed s/'^\t'// | cut -d. -f1)
if [ "${__major_version}" -lt 22 ]; then
echo
while true; do
read -rp "Do you want to update docker-compose to v1.29.2? (yes/no) " yn
case $yn in
[Nn]* ) echo "Please be sure to update docker-compose yourself!"; exit 1;;
* ) upgrade_compose; break;;
esac
done
fi
else
echo >&2
echo "On Debian 11, using docker-ce instead of docker.io, with the compose plugin, will work." >&2
exit 1
fi
fi
__compose_exe="docker-compose"
fi
if [ -n "$__maybe_sudo" ]; then
__compose_exe="sudo $__compose_exe"
fi
}
upgrade_compose() {
if type -P docker-compose >/dev/null 2>&1; then
__compose_version=$($__maybe_sudo docker-compose --version | sed -n -e "s/.*version \([0-9.-]*\).*/\1/p")
__compose_version_major=$(echo "$__compose_version" | cut -f1 -d.)
__compose_version_minor=$(echo "$__compose_version" | cut -f2 -d.)
if [ "$__compose_version_major" -eq 1 ] && [ "$__compose_version_minor" -lt 28 ]; then
echo "Found docker-compose version $__compose_version_major.$__compose_version_minor, upgrading to 1.29.2"
${__auto_sudo} apt-get install -y curl
${__auto_sudo} curl -fsSL "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/bin/docker-compose
${__auto_sudo} chmod +x /usr/bin/docker-compose
fi
__compose_version=$($__maybe_sudo docker-compose --version | sed -n -e "s/.*version \([0-9.-]*\).*/\1/p")
__compose_version_major=$(echo "$__compose_version" | cut -f1 -d.)
__compose_version_minor=$(echo "$__compose_version" | cut -f2 -d.)
if [ "$__compose_version_major" -eq 1 ] && [ "$__compose_version_minor" -lt 28 ]; then
echo "Updating docker-compose failed. It is still version $__compose_version_major.$__compose_version_minor."
echo "Please manually update docker-compose to version 1.29.2. These commands should do it:"
echo "sudo curl -fsSL \"https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/bin/docker-compose"
echo "sudo chmod +x /usr/bin/docker-compose"
exit 1
fi
fi
}
prep_prometheus() {
# Create custom-prom.yml if it doesn't exist
if [ ! -f "./prometheus/custom-prom.yml" ]; then
$__as_owner touch "./prometheus/custom-prom.yml"
fi
}
handle_root() {
if [ "${EUID}" -eq 0 ]; then
__as_owner="sudo -u ${OWNER}"
__auto_sudo=""
else
__as_owner=""
__auto_sudo="sudo"
fi
}
check_for_snap() {
if [[ "$__distro" = "ubuntu" && -n "$(command -v snap)" ]] && snap list 2>/dev/null | grep -qw 'docker'; then
echo
echo "WARNING! Snap docker package detected. This WILL result in issues."
echo "Removing the package will delete volumes and require a resync,"
echo "as well as re-import of all validator keys."
echo
echo "Doing so is still highly recommended however."
echo
echo "The exact steps depend a little on whether there already is"
echo "an apt version of docker installed as well, but in a nutshell"
echo '"./ethd stop" followed by "sudo snap remove --purge docker"'
echo "and then a reboot, and as needed install docker.io or docker-ce with apt,"
echo "re-import keys and restart eth-docker."
echo
echo "Do join us on EthStaker Discord to work through this issue."
echo
echo "Aborting, this is not safe"
exit 1
fi
}
install() {
check_for_snap
while true; do
read -rp "This will attempt to install docker and make your user part of the docker group. Do you wish to continue? (no/yes) " yn
case $yn in
[Yy]* ) break;;
* ) echo "Aborting, no changes made"; exit 0;;
esac
done
if [[ "$__distro" = "ubuntu" ]]; then
__major_version=$(lsb_release -r | cut -d: -f2 | sed s/'^\t'// | cut -d. -f1)
if [ "${__major_version}" -lt 18 ]; then
echo "This script cannot install docker on Ubuntu ${__major_version}. Consider upgrading to 22.04 or 20.04"
fi
if [ -z "$(command -v docker)" ]; then
${__auto_sudo} apt-get update && ${__auto_sudo} apt-get install -y ca-certificates curl gnupg lsb-release whiptail bc chrony
${__auto_sudo} mkdir -p /etc/apt/keyrings
${__auto_sudo} curl -fsSL https://download.docker.com/linux/ubuntu/gpg | ${__auto_sudo} gpg --dearmor -o /etc/apt/keyrings/docker.gpg
${__auto_sudo} echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) stable" | ${__auto_sudo} tee /etc/apt/sources.list.d/docker.list > /dev/null
${__auto_sudo} apt-get update
${__auto_sudo} apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
echo "Installed docker-ce and docker-compose-plugin"
else
echo "Docker is already installed"
fi
__groups=$(${__as_owner} groups)
if [[ ! "$__groups" =~ "docker" ]]; then
echo "Making your user part of the docker group"
${__auto_sudo} usermod -aG docker "${OWNER}"
echo "Please run newgrp docker or log out and back in"
else
echo "Your user is already part of the docker group"
fi
elif [[ "$__distro" =~ "debian" ]]; then
if [ -z "$(command -v docker)" ]; then
${__auto_sudo} apt-get update
${__auto_sudo} apt-get -y install ca-certificates curl gnupg lsb-release whiptail bc chrony
${__auto_sudo} mkdir -p /etc/apt/keyrings
${__auto_sudo} curl -fsSL https://download.docker.com/linux/debian/gpg | ${__auto_sudo} gpg --dearmor -o /etc/apt/keyrings/docker.gpg
${__auto_sudo} echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
$(lsb_release -cs) stable" | ${__auto_sudo} tee /etc/apt/sources.list.d/docker.list > /dev/null
${__auto_sudo} apt-get update
${__auto_sudo} apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
echo "Installed docker-ce and docker-compose-plugin"
else
echo "Docker is already installed"
fi
__groups=$(${__as_owner} groups)
if [[ ! "$__groups" =~ "docker" ]]; then
echo "Making your user part of the docker group"
${__auto_sudo} usermod -aG docker "${OWNER}"
echo "Please run newgrp docker or log out and back in"
else
echo "Your user is already part of the docker group"
fi
else
echo "This script does not know how to install docker on $__distro"
fi
return 0
}
check_for_apparmor() {
# This function could be removed once https://github.com/moby/moby/issues/44970 is resolved
# Only relevant to ubuntu or debian
if [[ ! "$__distro" = "ubuntu" ]] && [[ ! "$__distro" =~ "debian" ]]; then
return 0
fi
# Docker-CE 23.0.x has an issue where containers will fail if apparmor
# is not installed. Remedy.
if [ "$(dpkg-query -W -f='${Status}' apparmor 2>/dev/null | grep -c "ok installed")" = "0" ]; then
echo "apparmor is required for docker-ce 23.0.x to function"
echo
while true; do
read -rp "Do you consent to installation of apparmor? (yes/no) " yn
case $yn in
[Nn]* ) echo "No changes made"; return 0;;
* ) break;;
esac
done
${__auto_sudo} apt-get update
${__auto_sudo} apt-get -y install apparmor
fi
return 0
}
# Arguments are passed, but shellcheck doesn't recognize that
# shellcheck disable=SC2120
update() {
if [[ $(${__as_owner} git status --porcelain) ]]; then
__dirty=1
else
__dirty=0
fi
if [ -z "${ETHDSECUNDO-}" ]; then
if ${__as_owner} git branch | grep -q master; then
${__as_owner} git branch -m master main
${__as_owner} git fetch origin
${__as_owner} git branch -u origin/main main
${__as_owner} git remote set-head origin -a
fi
# Do not track changes to ext-network.yml
${__as_owner} git update-index --assume-unchanged ext-network.yml
${__as_owner} git config pull.rebase false
${__as_owner} git pull
# BASH_SOURCE so newer code gets to do the update. Use an ENV var
# to avoid infinite loop
export ETHDSECUNDO=1
exec "${BASH_SOURCE[0]}" update "$@"
fi
__keeptargets=1
__targetcli=""
while :
do
if [ -z ${1+x} ]; then
break
fi
case "$1" in
--keep-targets)
if [ -n "${__targetcli}" ]; then
echo "Error: --keep-targets and --refresh-targets cannot be used together; use either option once only"
exit 1
fi
__keeptargets=1
__targetcli="--keep-targets"
shift
;;
--refresh-targets)
if [ -n "${__targetcli}" ]; then
echo "Error: --keep-targets and --refresh-targets cannot be used together; use either option once only"
exit 1
fi
__keeptargets=0
__targetcli="--refresh-targets"
shift
;;
*)
echo "Error: Unknown option: $1" >&2
exit 1
;;
esac
done
# docker-ce 23.0.x has this as a dependency
check_for_apparmor
# envmigrate used to be called w/ arguments and checks for that
# shellcheck disable=SC2119
envmigrate
if [ "${__switched_branch-}" -eq 1 ]; then
# This code has changed, run it again on the new branch
export ETHDSECUNDO=1 #Not strictly necessary but this way we don't rely on what happens earlier
export ETHDSWITCHED=1
exec "${BASH_SOURCE[0]}" update $__targetcli
fi
dodocker system prune --force
docompose --profile tools build --pull
exec 3>&1
exec 4>&2
exec 1> /dev/null
exec 2> /dev/null
docompose --profile tools pull --ignore-pull-failures || true
exec 1>&3
exec 2>&4
echo
if ! cmp -s "${ENV_FILE}" "${ENV_FILE}".bak; then
echo "List of changes made to ${ENV_FILE} during migration - current on left, original on right:"
echo
diff -y --suppress-common-lines "${ENV_FILE}" "${ENV_FILE}".bak
echo
if [ "$__pre_merge" -eq 1 ]; then
echo "You appear to be coming from a pre-merge setup."
echo "A copy of your original settings is in .env.premerge"
echo
echo "Pay special attention to EL_NODE, as failover is no longer supported."
echo
echo "Decide whether to use mev-boost. Please see MEV_BOOST in .env for details."
fi
else
echo "No changes made to ${ENV_FILE} during migration"
fi
if [ "$__el_infura" -eq 1 ]; then
echo
echo "Detected use of an Infura project as an EL or failover EL. This is no longer supported with merge."
echo "Please adjust your EL_NODE variable manually."
fi
if [ "$__el_adjusted" -eq 1 ]; then
echo
echo "Your EL_NODE variable has been adjusted to use the new Engine API port"
elif [ "$__pre_merge" -eq 1 ]; then
echo
echo "Your EL_NODE variable has not been adjusted to use the new Engine API port, as you had a non-standard value."
echo "Please take a look and adjust manually."
fi
echo
echo "Your ${ENV_FILE} configuration settings have been migrated to a fresh copy. You can \
find the original contents in ${ENV_FILE}.bak."
if [ $__keeptargets = "0" ]; then
echo "NB: If you made changes to the source or binary build targets, these have been \
reset to defaults."
fi
echo
echo "An ./ethd up command will start using the new images and configuration."
if [[ "$__distro" = "ubuntu" ]]; then
__major_version=$(lsb_release -r | cut -d: -f2 | sed s/'^\t'// | cut -d. -f1)
if [ "${__major_version}" -lt 20 ]; then
echo
echo "Ubuntu ${__major_version} is older than the recommended 22.04 or 20.04 version"
echo
fi
fi
unset ETHDSECUNDO
if [[ "${ETHDSWITCHED-}" -eq 1 ]]; then
unset ETHDSWITCHED
echo
echo "You were migrated to the $(${__as_owner} git name-rev --name-only HEAD) branch of eth-docker"
echo
fi
delete_erigon
# If this is called by an older version of ethd, envmigrate
# is in its own bash instance: Need to kill the ethd parent
# shellcheck disable=SC2009
if ps $PPID | grep -q "ethd"; then
echo
echo "Updated from an older version of eth-docker. You'll see \"Terminated\","
echo "which keeps the update from running twice. This is normal and will"
echo "only happen this once."
echo
kill $PPID
fi
check_for_snap
if [ "${__dirty}" -eq 1 ]; then
echo
echo "WARNING"
echo
echo "You have uncommitted local changes to eth-docker, which keeps updates from coming in."
echo "Please undo these changes or \"git commit\" them."
echo "These are the files with local changes:"
echo
${__as_owner} git status --porcelain
fi
}
# envmigrate used to be called w/ arguments and checks for that
# shellcheck disable=SC2120
envmigrate() {
if [ -z "${ETHDSECUNDO-}" ]; then
# We'd only ever hit this if called from an older version of ethd, so let's
# get the new version executed.
export ETHDSECUNDO=1
# Account for different ways that envmigrate was called in older code and
# set keep-targets correctly regardless
if [ -z "${KEEPTARGETS-}" ]; then
__keep=""
for var in "$@"; do
if [ "$var" = "--keep-targets" ]; then
__keep="--keep-targets"
fi
done
else
__keep=""
if [ "${KEEPTARGETS-}" -eq 1 ]; then
__keep="--keep-targets"
fi
fi
exec "${BASH_SOURCE[0]}" update ${__keep}
fi
if [ ! -f "./${ENV_FILE}" ]; then
return
fi
ALL_VARS=( COMPOSE_FILE FEE_RECIPIENT EL_NODE GRAFFITI NETWORK MEV_BOOST MEV_RELAYS MEV_MIN_BID MEV_NODE \
CL_MAX_PEER_COUNT CL_MIN_PEER_COUNT EL_MAX_PEER_COUNT EL_MIN_PEER_COUNT DOMAIN ACME_EMAIL \
CF_EMAIL CF_API_TOKEN AWS_PROFILE AWS_HOSTED_ZONE_ID GRAFANA_HOST DISTRIBUTED BESU_HEAP TEKU_HEAP \
PROM_HOST HOST_IP PRYSM_HOST EE_HOST EL_HOST EL_LB EL_WS_HOST EL_WS_LB CL_HOST CL_LB DDNS_SUBDOMAIN \
DDNS_PROXY RAPID_SYNC_URL CL_NODE BEACON_STATS_API BEACON_STATS_MACHINE EL_P2P_PORT CL_P2P_PORT \
PRYSM_PORT DOPPELGANGER PRYSM_UDP_PORT GRAFANA_PORT KEY_API_PORT TRAEFIK_WEB_PORT TRAEFIK_WEB_HTTP_PORT \
CL_REST_PORT EL_RPC_PORT EL_WS_PORT EE_PORT ERIGON_TORRENT_PORT LOG_LEVEL JWT_SECRET EL_EXTRAS CL_EXTRAS \
VC_EXTRAS ARCHIVE_NODE SSV_P2P_PORT SSV_P2P_PORT_UDP ERIGON_P2P_PORT_2 ERIGON_P2P_PORT_3 )
TARGET_VARS=( NIM_SRC_BUILD_TARGET NIM_DOCKER_TAG NIM_DOCKER_VC_TAG NIM_DOCKERFILE TEKU_SRC_BUILD_TARGET TEKU_DOCKER_TAG \
TEKU_DOCKERFILE LH_SRC_BUILD_TARGET LH_DOCKER_TAG LH_DOCKERFILE PRYSM_SRC_BUILD_TARGET \
PRYSM_DOCKER_TAG PRYSM_DOCKER_VC_TAG PRYSM_DOCKERFILE ERIGON_SRC_BUILD_TARGET ERIGON_DOCKER_TAG \
ERIGON_DOCKERFILE MEV_DOCKERFILE MEV_DOCKER_TAG NIMEL_SRC_BUILD_TARGET NIMEL_DOCKER_TAG NIMEL_DOCKERFILE \
LS_SRC_BUILD_TARGET LS_DOCKER_TAG LS_DOCKERFILE GETH_SRC_BUILD_TARGET GETH_DOCKER_TAG \
GETH_DOCKERFILE NM_SRC_BUILD_TARGET NM_DOCKER_TAG NM_DOCKERFILE BESU_SRC_BUILD_TARGET \
BESU_DOCKER_TAG BESU_DOCKERFILE SSV2_NODE_TAG DEPCLI_SRC_BUILD_TARGET DEPCLI_DOCKER_TAG \
RETH_SRC_BUILD_TARGET RETH_DOCKER_TAG RETH_DOCKERFILE NODE_EXPORTER_IGNORE_MOUNT_REGEX )
OLD_VARS=( LH_PORT PRYSM_WEB_PORT EC_NODE REWARDS_TO GETH_CACHE \
EC_HOST EC_LB EC_WS_HOST EC_WS_LB CC_HOST CC_LB EC_P2P_PORT CC_NODE CC_P2P_PORT EC_RPC_PORT EC_WS_PORT )
NEW_VARS=( CL_P2P_PORT KEY_API_PORT EL_NODE FEE_RECIPIENT EL_EXTRAS \
EL_HOST EL_LB EL_WS_HOST EL_WS_LB CL_HOST CL_LB EL_P2P_PORT CL_NODE CL_P2P_PORT EL_RPC_PORT EL_WS_PORT )
if [ "${EUID}" -eq 0 ]; then
# Previous version of this tool when run as root may have created a root-owned .env.bak
if [ -f ./"${ENV_FILE}".bak ]; then
rm "${ENV_FILE}".bak
fi
sudo -u "${OWNER}" cp "${ENV_FILE}" "${ENV_FILE}".bak
sudo -u "${OWNER}" cp default.env "${ENV_FILE}"
sudo -u "${OWNER}" cp "${ENV_FILE}".bak .env.source
else
cp "${ENV_FILE}" "${ENV_FILE}".bak
cp default.env "${ENV_FILE}"
cp "${ENV_FILE}".bak .env.source
fi
# Detect pre-merge
if grep -q "FALLBACK_NODE1" ".env.source"; then
__pre_merge=1
cp .env.source .env.premerge
else
__pre_merge=0
fi
# Migrate over user settings
for var in "${ALL_VARS[@]}"; do
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env.source" || true)
if [ -n "${value}" ] || [ "${var}" = "GRAFFITI" ] || [ "${var}" = "MEV_RELAYS" ]; then
if [ "${var}" = "COMPOSE_FILE" ]; then
migrate_compose_file
fi
if [[ "${var}" = "NETWORK" && "${value}" =~ "prater" ]]; then
value="goerli"
fi
sed -i'.original' -e "s~^\(${var}\s*=\s*\).*$~\1${value}~" "${ENV_FILE}"
fi
done
if [ $__keeptargets = "1" ]; then
# Migrate over build targets
for var in "${TARGET_VARS[@]}"; do
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env.source" || true)
if [ -n "${value}" ]; then
sed -i'.original' -e "s~^\(${var}\s*=\s*\).*$~\1${value}~" "${ENV_FILE}"
fi
done
fi
# Move value from old variable name(s) to new one(s)
for index in "${!OLD_VARS[@]}"; do
var=${OLD_VARS[index]}
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env.source" || true)
if [ -n "${value}" ]; then
sed -i'.original' -e "s~^\(${NEW_VARS[index]}\s*=\s*\).*$~\1${value}~" "${ENV_FILE}"
fi
done
# Check whether we run a CL or VC, if so nag about FEE_RECIPIENT
var="COMPOSE_FILE"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
# It's CL&VC, CL-only, or VC-only
# I do mean to match literally
# shellcheck disable=SC2076
if [[ "${value}" =~ "prysm.yml" || "${value}" =~ "lighthouse.yml" || "${value}" =~ "teku.yml" || "${value}" =~ "nimbus.yml" || "${value}" =~ "lodestar.yml" || \
"${value}" =~ "-cl-only.yml" || "${value}" =~ "-vc-only.yml" ]]; then
# Check for rewards
var="FEE_RECIPIENT"
#value=$(grep --color=never -Po "^${var}=\K.*" ".env" || true)
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
if [[ -z "${value}" || ${value} != 0x* || ${#value} -ne 42 ]]; then
whiptail --msgbox "A fee recipient ETH wallet address is required in order to start the client. This is for post-merge priority fees and, optionally, MEV. Please enter a valid ETH address in the next screen. Refer to eth-docker docs (https://eth-docker.net/docs/About/Rewards) for more information.\n\nCAUTION: \"./ethd up\" will fail if no valid address is set" 16 75
__during_update=1
query_coinbase
set_value_in_env
fi
fi
# Check for Blox SSV 1 and auto migrate
var="COMPOSE_FILE"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
# I do mean to match literally
# shellcheck disable=SC2076
if [[ "${value}" =~ "blox-ssv.yml" ]]; then
query_blox_switch
fi
# User signals it's a distributed setup and not to nag
# Ditto do not nag if we switched branch, as the code that does
# the check won't be accurate
var="DISTRIBUTED"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
if [[ "${value}" = "true" || "${__switched_branch-}" -eq 1 ]]; then
rm .env.source
rm .env.original
return
fi
# Check for CL and EL, nag if we have only one without the other
var="COMPOSE_FILE"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
# Case 1 ... CL, do we have an EL?
# I do mean to match literally
# shellcheck disable=SC2076
if [[ "${value}" =~ "prysm.yml" || "${value}" =~ "lighthouse.yml" || "${value}" =~ "teku.yml" || "${value}" =~ "nimbus.yml" || "${value}" =~ "lodestar.yml" || "${value}" =~ "-cl-only.yml" ]]; then
if [[ ! "${value}" =~ "geth.yml" && ! "${value}" =~ "besu.yml" && ! "${value}" =~ "erigon.yml" && ! "${value}" =~ "nethermind.yml" && ! "${value}" =~ "nimbus-el.yml" && ! "${value}" =~ "reth.yml" ]]; then
whiptail --msgbox "An Execution Layer client is required alongside your Consensus Layer client come Ethereum Merge. Refer to eth-docker docs (https://eth-docker.net/docs/About/MergePrep) for more information.\n\nPlease start running your own EL soonest, as Infura will no longer be usable as an EL after The Merge.\n\nIf you run a distributed setup, you can shut off this nag screen by setting DISTRIBUTED=true in .env" 16 75
fi
# Case 2 ... EL, do we have a CL?
elif [[ "${value}" =~ "geth.yml" || "${value}" =~ "besu.yml" || "${value}" =~ "erigon.yml" || "${value}" =~ "nethermind.yml" || "${value}" =~ "nimbus-el.yml" || "${value}" =~ "reth.yml" ]]; then
if [[ ! "${value}" =~ "prysm.yml" && ! "${value}" =~ "lighthouse.yml" && ! "${value}" =~ "teku.yml" && ! "${value}" =~ "nimbus.yml" && ! "${value}" =~ "lodestar.yml" && ! "${value}" =~ "-cl-only.yml" ]]; then
whiptail --msgbox "A Consensus Layer client is required alongside your Execution Layer client come Ethereum Merge. Refer to eth-docker docs (https://eth-docker.net/docs/About/MergePrep) for more information.\n\nPlease start running your own CL soonest, as an EL alone will no longer be usable after The Merge.\n\nIf you run a distributed setup, you can shut off this nag screen by setting DISTRIBUTED=true in .env" 16 75
fi
fi
# Adjust EL_NODE as needed
__el_adjusted=0
__el_infura=0
var="EL_NODE"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
# I do mean to match literally
# shellcheck disable=SC2076
if [[ "${value}" =~ "infura.io" ]]; then
__el_infura=1
fi
if [[ "${value}" =~ "http://execution:8545" ]]; then
EL_NODE="http://execution:8551"
set_value_in_env
__el_adjusted=1
elif [[ "${value}" =~ "ws://execution:8546" || "${value}" =~ "ws://execution:8545" ]]; then
EL_NODE="ws://execution:8551"
set_value_in_env
__el_adjusted=1
fi
rm .env.source
rm .env.original
}
migrate_compose_file() {
# When this gets called $var is COMPOSE_FILE and $value is what is set in .env for it
# Some files have been renamed and others removed altogether
FROM_YML=( ec-shared.yml ec-traefik.yml cc-shared.yml grafana-insecure.yml prysm-web-insecure.yml lh-base-notz.yml lh-validator-notz.yml lh-slasher.yml teku-base-notz.yml teku-validator-notz.yml lh-consensus.yml lh-validator.yml lodestar-consensus.yml lodestar-validator.yml nimbus-consensus.yml prysm-consensus.yml prysm-consensus-rest.yml prysm-validator.yml teku-consensus.yml teku-validator.yml lh-base.yml lh-vc-only.yml lh-cl-only.yml nm.yml lighthouse-base.yml teku-base.yml nimbus-base.yml prysm-base.yml lodestar-base.yml prysm-web.yml blank-grafana.yml lh-grafana.yml lhcc-grafana.yml nimbus-grafana.yml prysm-grafana.yml teku-grafana.yml geth-grafana.yml erigon-grafana.yml oe.yml teku-stats.yml lh-stats.yml lh-stats-consensus.yml lh-stats-validator.yml traefik-shared.yml lighthouse-slasher.yml prysm-slasher.yml )
TO_YML=( el-shared.yml el-traefik.yml cl-shared.yml grafana-shared.yml prysm-web-shared.yml lighthouse-base.yml lighthouse-vc-only.yml lighthouse-slasher.yml teku-base.yml teku-vc-only.yml lighthouse-cl-only.yml lighthouse-vc-only.yml lodestar-cl-only.yml lodestar-vc-only.yml nimbus-cl-only.yml prysm-cl-only.yml prysm-cl-only.yml prysm-vc-only.yml teku-cl-only.yml teku-vc-only.yml lighthouse-base.yml lighthouse-vc-only.yml lighthouse-cl-only.yml nethermind.yml lighthouse.yml teku.yml nimbus.yml prysm.yml lodestar.yml "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" )
__old_grafana=0
__new_grafana=0
__grafana_regex=".+-grafana\.yml"
__switched_branch=0
__old_ifs="$IFS"
IFS=":"
set -o noglob
# Globbing is off
# shellcheck disable=SC2206
__ymlarray=($value) # split+glob with glob disabled, and split using : as delimiter
set +o noglob
IFS="$__old_ifs"
value=""
for n in "${!__ymlarray[@]}"; do
__ymlfile="${__ymlarray[n]}"
if [[ "${__ymlfile}" =~ $__grafana_regex ]]; then
__old_grafana=1
fi
if [ "${__ymlfile}" = "grafana.yml" ]; then
__new_grafana=1
fi
for index in "${!FROM_YML[@]}"; do
if [ "${FROM_YML[index]}" = "${__ymlfile}" ]; then
__ymlfile=${TO_YML[index]}
break
fi
done
if [ -n "${__ymlfile}" ]; then
if [ -z "${value}" ]; then
value="${__ymlfile}"
else
value="${value}:${__ymlfile}"
fi
fi
done
if [ "${__new_grafana}" = 0 ] && [ "${__old_grafana}" = 1 ]; then
value="${value}:grafana.yml"
fi
}
delete_erigon() {
# Check for Erigon
var="COMPOSE_FILE"
#value=$(grep --color=never -Po "^${var}=\K.*" ".env" || true)
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
# I do mean to match literally
# shellcheck disable=SC2076
if [[ ! "${value}" =~ "erigon.yml" ]]; then
return
fi
if ! dodocker volume ls -q | grep -q "$(basename "$(realpath .)")[_-]erigon-ec-data"; then
return
fi
echo "Detected Erigon. For merge, it will need to be re-synced from scratch"
echo
while true; do
read -rp "WARNING - About to delete the Erigon database. Do you wish to continue? (Y/n) " yn
case $yn in
[Nn]o | [Nn] ) echo "Aborting, no changes made"; exit 1;;
* ) break;;
esac
done
echo "Stopping Erigon container"
dodocker stop "$(dodocker ps -q -f "name=erigon")" && dodocker rm -f "$(dodocker ps -a -q -f "name=erigon")"
docompose stop execution && docompose rm -f execution
dodocker volume rm "$(dodocker volume ls -q -f "name=erigon-ec-data")"
echo ""
echo "Erigon stopped and database deleted."
echo ""
}
query_blox_switch() {
echo "Detected SSV Node v1. SSV v2 testnet is the new hotness."
echo
echo "Stopping SSV Node container"
dodocker stop "$(dodocker ps -q -f "name=ssv-node")" && dodocker rm -f "$(dodocker ps -a -q -f "name=ssv-node")"
docompose stop ssv-node && docompose rm -f ssv-node
dodocker volume rm "$(dodocker volume ls -q -f "name=ssv-data")"
echo ""
echo "SSV Node stopped and database deleted."
echo ""
cp blox-ssv-config.yaml blox-ssv-config.yaml.bak
echo "Backup copy blox-ssv-config.yaml.bak created"
echo "Making changes to blox-ssv-config.yaml"
sed -i 's/blox-ssv.yml/blox-ssv2.yml/' .env
sed -i '/RegistryContractAddr/d' blox-ssv-config.yaml
sed -i '/RegistryContractABI/d' blox-ssv-config.yaml
sed -i '/ETH1SyncOffset/d' blox-ssv-config.yaml
sed -i '/AbiVersion/d' blox-ssv-config.yaml
sed -i '/Bootnodes/d' blox-ssv-config.yaml
sed -i '/NetworkID/d' blox-ssv-config.yaml
}
attach-geth() {
if [ ! -f "./${ENV_FILE}" ]; then
echo "${ENV_FILE} configuration file not found, aborting."
exit 1
fi
if ! grep -q '^COMPOSE_FILE=.*geth\.yml' "${ENV_FILE}" 2>/dev/null ; then
echo "You do not appear to be using Geth, aborting."
exit 1
fi
docompose exec -it execution bash -c "geth attach /var/lib/goethereum/geth.ipc"
}
prune-geth() {
__non_interactive=0
while :
do
if [ -z ${1+x} ]; then
break
fi
case "$1" in
--non-interactive)
__non_interactive=1
shift
;;
*)
echo "Error: Unknown option: $1" >&2
exit 1
;;
esac
done
if [ ! -f "./${ENV_FILE}" ]; then
echo "${ENV_FILE} configuration file not found, aborting."
exit 1
fi
if ! grep -q '^COMPOSE_FILE=.*geth\.yml' "${ENV_FILE}" 2>/dev/null ; then
echo "You do not appear to be using Geth, aborting."
exit 1
fi
# Check for archive node
var="ARCHIVE_NODE"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
if [[ "${value}" = "true" ]]; then
echo "Geth is an archive node: Aborting."
return
fi
__docker_dir=$(docker system info --format '{{.DockerRootDir}}')
if [ "$(df -P ${__docker_dir} | awk '/[0-9]%/{print $(NF-2)}')" -lt 41943040 ]; then
echo "You do not have enough free disk space. Make sure this reads at least 40G free (Avail):"
df -h "${__docker_dir}"
echo ""
echo "Aborting."
exit 1
fi
rpc_line=$(grep '^EL_RPC_PORT=' "${ENV_FILE}")
regex='^EL_RPC_PORT=([0-9]+)'
if [[ ! "${rpc_line}" =~ ${regex} ]]; then
echo "Unable to determine EL_RPC_PORT, aborting."
exit 1
else
rpc_port="${BASH_REMATCH[1]}"
fi
sync_status=$(docompose exec -T execution wget -qO- "http://localhost:$rpc_port" --header 'Content-Type: application/json' --post-data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}')
exitstatus=$?
if [ $exitstatus -ne 0 ]; then
echo "Unable to connect to Geth: Is it running?"
echo "Output: ${sync_status}"
echo "Aborting."
exit 1
fi
if [[ ! "${sync_status}" =~ "false" ]]; then
echo "Geth is not done syncing yet. Sync status:"
echo "${sync_status}"
echo ""
echo "Aborting."
exit 1
fi
node_logs=$(docompose logs --no-color --tail 1000 execution)
if [[ "${node_logs}" =~ "snapshot generation" && ! "${node_logs}" =~ "Generated state" ]]; then
echo "Geth has not finished generating a state snapshot yet, aborting."
exit 1
fi
regex='\[([0-9][0-9]-[0-9][0-9])\|([0-9][0-9]:[0-9][0-9]):[0-9.]*\][[:space:]]*Generated state'
if [[ "${node_logs}" =~ $regex ]]; then
snap_time=$(date -d "1970-${BASH_REMATCH[1]} ${BASH_REMATCH[2]}" +"%s")
now_time=$(date +"%s")
if [ $((snap_time+2100)) -gt "$now_time" ]; then
echo "Please wait 35 minutes after snapshot generation finished. Aborting."
exit 1
fi
fi
if [ $__non_interactive = 0 ]; then
while true; do
read -rp "WARNING - this will stop Geth and prune its database. Do you wish to continue? (No/Yes) " yn
case $yn in
[Yy][Ee][Ss] ) break;;
* ) echo "Aborting, no changes made"; exit 1;;
esac
done
fi
echo ""
echo "Starting Geth prune"
echo ""
docompose run --rm set-prune-marker "touch /var/lib/goethereum/prune-marker"
docompose stop execution && docompose rm -f execution
start
echo ""
echo "Prune is running, you can observe it with './ethd logs -f execution'"
echo ""
echo "There should be three stages: \"Iterating state snapshot\", \"Pruning state data\", and \"Compacting database\". During \
the \"Compacting database\" stage it may not output logs for an hour or so, that is normal."
echo ""
echo "When prune is done, which takes 4-5 hours, Geth will automatically start again."
echo ""
}
prune-nethermind() {
__non_interactive=0
while :
do
if [ -z ${1+x} ]; then
break
fi
case "$1" in
--non-interactive)
__non_interactive=1
shift
;;
*)
echo "Error: Unknown option: $1" >&2
exit 1
;;
esac
done
if [ ! -f "./${ENV_FILE}" ]; then
echo "${ENV_FILE} configuration file not found, aborting."
exit 1
fi
if ! grep -q '^COMPOSE_FILE=.*nethermind\.yml' "${ENV_FILE}" 2>/dev/null ; then
echo "You do not appear to be using Nethermind, aborting."
exit 1
fi
# Check for archive node
var="ARCHIVE_NODE"
value=$(sed -n -e "s/^${var}=\(.*\)/\1/p" ".env" || true)
if [[ "${value}" = "true" ]]; then
echo "Nethermind is an archive node: Aborting."
return
fi
__docker_dir=$(docker system info --format '{{.DockerRootDir}}')
if [ "$(df -P ${__docker_dir} | awk '/[0-9]%/{print $(NF-2)}')" -lt 209715200 ]; then
echo "You do not have enough free disk space. Make sure this reads at least 200G free (Avail):"
df -h "${__docker_dir}"
echo ""
echo "Aborting."
exit 1
fi
rpc_line=$(grep '^EL_RPC_PORT=' "${ENV_FILE}")
regex='^EL_RPC_PORT=([0-9]+)'
if [[ ! "${rpc_line}" =~ ${regex} ]]; then
echo "Unable to determine EL_RPC_PORT, aborting."
exit 1
else
rpc_port="${BASH_REMATCH[1]}"
fi
sync_status=$(docompose exec -T execution wget -qO- "http://localhost:$rpc_port" --header 'Content-Type: application/json' --post-data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}')
exitstatus=$?
if [ $exitstatus -ne 0 ]; then
echo "Unable to connect to Nethermind: Is it running?"
echo "Output: ${sync_status}"
echo "Aborting."
exit 1
fi
if [[ ! "${sync_status}" =~ "false" ]]; then
echo "Nethermind is not done syncing yet. Sync status:"
echo "${sync_status}"
echo ""
echo "Aborting."
exit 1
fi
if [ $__non_interactive = 0 ]; then
while true; do
read -rp "WARNING - this will prune Nethermind's database in the background. Do you wish to continue? (No/Yes) " yn
case $yn in
[Yy][Ee][Ss] ) break;;
* ) echo "Aborting, no changes made"; exit 1;;
esac
done
fi
echo ""
echo "Starting Nethermind prune"
echo ""
prune_result=$(docompose exec -T execution wget -qO- "http://localhost:1337" --header 'Content-Type: application/json' --post-data '{"jsonrpc":"2.0","method":"admin_prune","params":[],"id":1}')
exitstatus=$?
if [ $exitstatus -ne 0 ]; then
echo "Unable to start prune, error code ${exitstatus}. This is likely a bug."
echo "An attempt to run it returned this: ${prune_result}"
echo 'The command attempted was: docker-compose run --rm set-prune-marker "curl -s --data {\\\"method\\\":\\\"admin_prune\\\",\\\"params\\\":[],\\\"id\\\":1,\\\"jsonrpc\\\":\\\"2.0\\\"} -H Content-Type:\ application/json http://execution:8545"'
exit ${exitstatus}
fi
echo "Nethermind returns ${prune_result}"
if [[ ! "${prune_result}" =~ "Starting" ]]; then
echo "Unable to start prune. This is likely a bug."
exit 1
fi
echo ""
echo "Prune is running, you can observe it with './ethd logs -f --tail 50 execution'"
echo ""
echo "Please do not restart the node or restart Nethermind until prune is done."
echo ""
echo "When prune is done, Nethermind will automatically re-start."
echo ""
}
prep-keyimport() {
set -Eeuo pipefail
if [ ! -f "./${ENV_FILE}" ]; then
echo "${ENV_FILE} configuration file not found, aborting."
exit 1
fi
if grep -q '^COMPOSE_FILE=.*cl-only\.yml' "${ENV_FILE}" 2>/dev/null ; then
echo "eth-docker is configured to run consensus client only, key import not possible"
exit 1
fi
__prysm=0
__path=''
__non_interactive=0
if grep -q '^COMPOSE_FILE=.*prysm.*\.yml' "${ENV_FILE}" 2>/dev/null ; then
__prysm=1
fi
while :
do
if [ -z ${1+x} ]; then
break
fi
case "$1" in
--path)
if [ -z "${2+x}" ]; then
echo "--path requires a directory path, aborting"
exit 1
fi
if [ ! -d "$2" ]; then
echo "$2 is not a directory"
exit 1
fi
if [ "$(realpath "$2")" = "$(realpath ".eth/validator_keys")" ]; then
echo "$2 is the default path, doing nothing special"
shift 2
continue
fi
IFS=$'\n'
files=$(find "$2" -maxdepth 1 -name '*.json')
unset IFS
if [ -z "$files" ]; then
echo "No .json files found in $2, aborting"
exit 1
fi
IFS=$'\n'
files=$(find ./.eth/validator_keys -maxdepth 1 -name '*.json')
unset IFS
if [ -n "$files" ]; then
mkdir -p ./.eth/validator_keys/keybackup
mv -uf ./.eth/validator_keys/*.json ./.eth/validator_keys/keybackup
rm -f ./.eth/validator_keys/*.json
echo "Moved existing json files to .eth/validator_keys/keybackup"
fi
cp "$2"/*.json .eth/validator_keys/
shift 2
;;
--non-interactive)
if [ -z ${KEYSTORE_PASSWORD+x} ]; then
echo "KEYSTORE_PASSWORD not set, aborting"
exit 1
fi
if [ "${__oldskool:-}" = 1 ] && [ "${__prysm}" = 1 ]; then
if [ -z "${WALLET_PASSWORD+x}" ]; then
echo "Using Prysm and WALLET_PASSWORD not set, aborting"
exit 1
fi
fi
__non_interactive=1
shift
;;
*)
echo "Error: Unknown option: $1" >&2
exit 1
;;
esac
done
}