forked from router-protocol/validator-onboard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
validator_onboard.py
988 lines (860 loc) · 39.1 KB
/
validator_onboard.py
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
from enum import Enum
import os
import subprocess
import platform
import json
import requests
import argparse
import sys
import time
import shutil
import random
import traceback
from subprocess import check_call
# self-destruct file after first call
# os.remove(sys.argv[0])
class NetworkVersion(str, Enum):
TESTNET = "v1.0.0-rc2"
version = NetworkVersion.TESTNET
script_version = "v1.0.1"
snapshot_url="https://routerchain-testnet-snapshot.s3.ap-south-1.amazonaws.com/routerd_snapshot_285479_20230828194247.tar.lz4"
class NetworkType(str, Enum):
MAINNET = "1"
TESTNET = "2"
class ServiceStatus(str, Enum):
ACTIVE = "active"
INACTIVE = "inactive"
FAILED = "failed"
GENESIS_JSON="https://tm.rpc.testnet-eu.routerchain.dev/genesis"
ROUTERD_FILE = "routerd.tar"
ORCHESTRATORD_FILE = "router-orchestrator"
ROUTER_REPO = "https://raw.githubusercontent.com/router-protocol/router-chain-releases/main/linux/"
ORCHESTRATOR_REPO = "https://raw.githubusercontent.com/router-protocol/router-chain-releases/main/linux/"
CHAIN_ID="router_9601-1"
ORCHESTRATOR_TEMPLATE="""
{
"chains": [
{
"chainId": "<CHAIN_ID>",
"chainType": "<CHAIN_TYPE>",
"chainName": "<CHAIN_NAME>",
"chainRpc": "<CHAIN_RPC>",
"blocksToSearch": 1000,
"blockTime": "10s"
}
],
"globalConfig": {
"networkType": "<NETWORK_TYPE>",
"dbPath": "processedblock.db",
"ethPrivateKey": "<ETH_PRIVATE_KEY>",
"cosmosPrivateKey": "<COSMOS_PRIVATE_KEY>",
"batchSize": 100,
"batchWaitTime": 20
}
}"""
ENABLE_SNAPSHOT = True
ENABLE_GENESIS_SYNC = False
HOME_DIR = os.path.expanduser("~")
SYSTEM_RAM_REQUIRED = 16
os_name = platform.system()
machine = platform.machine()
def clear_screen(showTitle=True):
'''
Clear the screen and optionally show a title.
'''
print("clear screen")
subprocess.run(["clear"], shell=True)
if showTitle:
print('''Router Chain Installer \n''')
def colorprint(message):
print(message)
class CustomHelpFormatter(argparse.HelpFormatter):
def _format_action_invocation(self, action):
if not action.option_strings or action.nargs == 0:
return super()._format_action_invocation(action)
return ', '.join(action.option_strings)
def _split_lines(self, text, width):
if text.startswith('R|'):
return text[2:].splitlines()
# this is the RawTextHelpFormatter._split_lines
return argparse.HelpFormatter._split_lines(self, text, width)
def fmt(prog): return CustomHelpFormatter(prog, max_help_position=30)
parser = argparse.ArgumentParser(
description="Router Installer", formatter_class=fmt)
parser._optionals.title = 'Optional Arguments'
if not len(sys.argv) > 1:
parser.set_defaults(mainnetDefault=False, testnetDefault=False, swapOn=None, installHome=None, nodeName=None, ports=None, nodeType=None, network=None, pruning=None, cosmovisorService=None,
dataSyncTestnet=None, snapshotTypeTestnet=None, dataSync=None, snapshotType=None, snapshotLocation=None, replayDbBackend=None, extraSwap=None, startReplay=None)
args = parser.parse_args()
if args.testnetDefault == True:
args.network = 'router_9601-1'
class bcolors:
HEADER = '\033[95m'
OKBLUE = '\033[94m'
OKCYAN = '\033[96m'
OKGREEN = '\033[92m'
WARNING = '\033[93m'
FAIL = '\033[91m'
ENDC = '\033[0m'
BOLD = '\033[1m'
UNDERLINE = '\033[4m'
pruning_settings_choices = [
{
"name": "Default",
"description": "The last 362880 states are kept, pruning at 10 block intervals"
},
{
"name": "Nothing",
"description": "All historic states will be saved, nothing will be deleted (i.e. archiving node)"
},
{
"name": "Everything",
"description": "Allow pruning options to be manually specified through 'pruning-keep-recent', and 'pruning-interval'"
},
{
"name": "Custom",
"description": "Store the most recent 10,000 states and prune at random prime block interval"
}
]
snapshot_options = [
{
"name": "Download a snapshot (recommended)",
"description": "Download a pre-built snapshot of the blockchain for faster synchronization."
},
{
"name": "Sync from genesis",
"description": "Synchronize the blockchain from the beginning (slow but secure)."
},
{
"name": "Exit now, I only wanted to install the daemon",
"description": "Exit the installer without synchronizing the blockchain."
}
]
def get_service_status(service_name):
try:
status = subprocess.check_output(
["systemctl is-active " + service_name], shell=True).decode().strip()
if status == "active":
return ServiceStatus.ACTIVE
else:
return ServiceStatus.INACTIVE
except:
return ServiceStatus.FAILED
def init_node_name():
global nodeName
nodeName = NetworkType.TESTNET
print("testnet running: "+nodeName, " home: "+routerd_home)
clear_screen()
# remove old routerd home
remove_directory(routerd_home)
# remove old config
remove_directory(os.path.join(HOME_DIR, ".routerd"))
print(bcolors.OKGREEN + "Initializing Router Node " + nodeName + bcolors.ENDC)
setup_testnet()
def remove_directory(path):
# check if directory already exists? if yes prompt to delete
if os.path.isdir(path):
response = input(f"The directory {path} exists. Do you want to delete it? (y/n): ")
if response.lower() in ["y", "yes"]:
subprocess.run(["rm -r " + path], stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL, shell=True, env=my_env)
print(f"Directory {path} has been deleted.")
else:
print("Directory not deleted.")
exit(1)
def setup_testnet():
print(bcolors.OKGREEN + "Initializing Router Node " + nodeName + bcolors.ENDC)
clear_screen()
setup_router_node()
download_replace_genesis()
def setup_router_node():
clear_config_files()
subprocess.run(["routerd init " + nodeName + " --chain-id="+ CHAIN_ID +" -o --home " + routerd_home],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True, env=my_env)
def clear_config_files():
for file in ["config/config.toml", "config/app.toml", "config/addrbook.json"]:
remove_file(os.path.join(routerd_home, file))
def remove_file(file_path):
subprocess.run(["rm " + file_path], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True, env=my_env)
def download_replace_genesis():
try:
colorprint("Downloading and Replacing Genesis")
download_genesis()
replace_genesis()
unsafe_reset()
find_replace_seeds()
update_config_settings()
pruning_settings()
except Exception as e:
print("error in download_replace_genesis: ", e)
raise e
def start_routerd_service():
# ask user confirmation to add service file and start
# if yes, add service file and start
# else, exit
print(bcolors.OKGREEN + """Do you want to setup routerd as a service?:
1) Yes (recommended)
2) No (you will have to manually start routerd)
""" + bcolors.ENDC)
choice = input("Enter your choice: ")
if choice == "1":
print(bcolors.OKGREEN + "Setting up routerd as a service" + bcolors.ENDC)
setup_service()
start_service()
elif choice == "2":
print(bcolors.OKGREEN + "Skipping routerd service setup" + bcolors.ENDC)
else:
print(bcolors.FAIL + "Invalid choice. Please try again." + bcolors.ENDC)
start_routerd_service()
def setup_service():
# stop if already running
routerd_service_file_content = f'''
[Unit]
Description=routerd
After=network.target
[Service]
User={USER}
Type=simple
ExecStart=/usr/bin/routerd start --json-rpc.api eth,txpool,personal,net,debug,web3,miner --api.enable start --trace "true"
[Install]
WantedBy=multi-user.target
'''
subprocess.run(["sudo systemctl stop routerd.service"], stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL, shell=True, env=my_env)
with open("routerd.service", "w") as service_file:
service_file.write(routerd_service_file_content)
# shutil.copy("routerd.service", "/etc/systemd/system/")
subprocess.run(
["sudo mv routerd.service /lib/systemd/system/routerd.service"], shell=True, env=my_env)
subprocess.run(["sudo systemctl daemon-reload"], shell=True, env=my_env)
def start_service():
subprocess.run(["systemctl daemon-reload"], stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL, shell=True, env=my_env)
subprocess.run(["systemctl enable routerd.service"], stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL, shell=True, env=my_env)
subprocess.run(["systemctl start routerd.service"], stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL, shell=True, env=my_env)
subprocess.run(["systemctl status routerd.service"], stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL, shell=True, env=my_env)
def unsafe_reset():
print(bcolors.OKGREEN + "Resetting routerd" + bcolors.ENDC)
subprocess.run(["routerd unsafe-reset-all --home " + routerd_home],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True, env=my_env)
def download_genesis():
subprocess.run(["wget -O " + os.path.join(routerd_home, "config/genesis.json") + " wget "+GENESIS_JSON],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True, env=my_env)
def replace_genesis():
print("replacing genesis")
genesis_filepath=os.path.join(routerd_home, "config/genesis.json")
if not os.path.isfile(genesis_filepath):
error_msg="Genesis file not found. Please try again."
print(bcolors.FAIL + error_msg + bcolors.ENDC)
raise Exception(error_msg)
with open(genesis_filepath, "r") as json_file:
data = json.load(json_file)
result_genesis = data.get("result", {}).get("genesis")
with open(os.path.join(routerd_home, "config/genesis.json"), "w") as json_file:
json.dump(result_genesis, json_file, indent=4)
def find_replace_seeds():
colorprint("Finding and Replacing Seeds")
replace_seeds(SEED_PEERS)
# def update_state_sync(tmrpc):
# config_toml = os.path.join(routerd_home, "config/config.toml")
# subprocess.run(["sed -i -E 's/persistent_peers = \"\"/persistent_peers = \"" + peers + "\"/g' " + config_toml], shell=True)
def replace_seeds(peers):
config_toml = os.path.join(routerd_home, "config/config.toml")
subprocess.run(["sed -i -E 's/persistent_peers = \"\"/persistent_peers = \"" + peers + "\"/g' " + config_toml], shell=True)
subprocess.run(["sed -i -E 's/seeds = \"\"/seeds = \"" + peers + "\"/g' " + config_toml], shell=True)
clear_screen()
def update_config_settings():
config_toml = os.path.join(routerd_home, "config/config.toml")
subprocess.run(["sed -i \'s/timeout_commit = \".*\"/timeout_commit = \"1s\"/g\' "+ config_toml], shell=True)
clear_screen()
def pruning_settings():
print(f"{bcolors.OKGREEN}Please choose your desired pruning settings:")
for i, setting in enumerate(pruning_settings_choices, start=1):
print(f"{i}) {setting['name']}: ({setting['description']})")
# 1 - default
# 2 - nothing
# 3 - everything
# 4 - custom
pruneAns = input(bcolors.OKGREEN + 'Enter Choice: ' + bcolors.ENDC)
if pruneAns == "1":
clear_screen()
dataSyncSelectionTest()
elif pruneAns == "2":
clear_screen()
subprocess.run(["sed -i -E 's/pruning = \"default\"/pruning = \"nothing\"/g' " +
routerd_home+"/config/app.toml"], shell=True)
dataSyncSelectionTest()
elif pruneAns == "3":
clear_screen()
subprocess.run(["sed -i -E 's/pruning = \"default\"/pruning = \"everything\"/g' " +
routerd_home+"/config/app.toml"], shell=True)
dataSyncSelectionTest()
elif pruneAns == "4":
primeNum = random.choice([x for x in range(11, 97) if not [
t for t in range(2, x) if not x % t]])
clear_screen()
subprocess.run(["sed -i -E 's/pruning = \"default\"/pruning = \"custom\"/g' " +
routerd_home+"/config/app.toml"], shell=True)
subprocess.run(["sed -i -E 's/pruning-keep-recent = \"0\"/pruning-keep-recent = \"10000\"/g' " +
routerd_home+"/config/app.toml"], shell=True)
subprocess.run(["sed -i -E 's/pruning-interval = \"0\"/pruning-interval = \"" +
str(primeNum)+"\"/g' "+routerd_home+"/config/app.toml"], shell=True)
dataSyncSelectionTest()
else:
clear_screen()
pruning_settings()
def dataSyncSelectionTest():
print(f"{bcolors.OKGREEN}Please choose from the following options:")
for i, option in enumerate(snapshot_options, start=1):
print(f"{i}) {option['name']}: ({option['description']})")
dataTypeAns = input(bcolors.OKGREEN + 'Enter Choice: ' + bcolors.ENDC)
# 1 - Download snapshot
# 2 - Sync from genesis
# 3 - exit
if dataTypeAns == "1":
clear_screen()
download_and_extract_snapshot()
elif dataTypeAns == "2":
clear_screen()
if ENABLE_GENESIS_SYNC == False:
print(bcolors.OKGREEN + "Sync from Genesis is disabled. Please select Snapshot" + bcolors.ENDC)
dataSyncSelectionTest()
# cosmovisor_init()
elif dataTypeAns == "3":
clear_screen()
partComplete()
else:
clear_screen()
dataSyncSelectionTest()
def partComplete():
print(bcolors.OKGREEN +
"Congratulations! You have successfully completed setting up the Router daemon!")
print(bcolors.OKGREEN +
"The routerd service is NOT running in the background, and your data directory is empty")
print(bcolors.OKGREEN + "If you intend to use routerd without syncing, you must include the '--node' flag after cli commands with the address of a public RPC node" + bcolors.ENDC)
quit()
def download_and_extract_snapshot():
if ENABLE_SNAPSHOT == False:
print(bcolors.OKGREEN + "Snapshot is disabled. Please choose another option" + bcolors.ENDC)
dataSyncSelectionTest()
colorprint("Installing packages for snapshot extraction")
if os_name == "Linux":
subprocess.run(["sudo apt-get install wget liblz4-tool aria2 -y"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True)
colorprint("Downloading Snapshot from " + snapshot_url + " ")
os.chdir(os.path.expanduser(routerd_home))
subprocess.run(["wget -O - "+snapshot_url +
" | lz4 -d | tar -xvf -"], shell=True, env=my_env)
cosmovisor_init()
def complete():
print(bcolors.OKGREEN +
"Congratulations! You have successfully completed setting up an Routerd full node!")
print(bcolors.OKGREEN + "The routerd service is NOT running in the background")
print(bcolors.OKGREEN +
"You can start routerd with the following command: 'routerd start'" + bcolors.ENDC)
quit()
# restart orchestrator if its running
def restart_orchestrator():
orchestrator_status = get_service_status("orchestrator.service")
if orchestrator_status == ServiceStatus.ACTIVE:
print(bcolors.OKGREEN + "Restarting orchestrator" + bcolors.ENDC)
subprocess.run(["sudo systemctl restart orchestrator.service"], shell=True)
else:
print(bcolors.OKGREEN + "Orchestrator is not running, skipping" + bcolors.ENDC)
def user_confirm(prompt):
print(f'{bcolors.OKGREEN}{prompt} (y/n){bcolors.ENDC}')
return input(f'{bcolors.OKGREEN}Enter Choice: {bcolors.ENDC}') == "y"
def run_command(command, error_message=None):
result = subprocess.run(command, capture_output=True, shell=True, text=True)
if result.returncode != 0 and error_message:
raise Exception(error_message)
return result.stdout.strip()
def download_file(url, target_dir):
response = requests.get(url)
if response.status_code != 200:
raise Exception(f'Error downloading from {url}')
with open(target_dir, 'wb') as f:
f.write(response.content)
def upgrade_routerd():
global upgrade_orchestrator
try:
if not user_confirm("Do you want to upgrade routerd?") or \
not user_confirm("Have you taken a backup of your node before proceeding?"):
print(f'{bcolors.OKGREEN}Exiting{bcolors.ENDC}')
return
cosmovisor_status = get_service_status("cosmovisor.service")
if cosmovisor_status == ServiceStatus.ACTIVE:
print(f'{bcolors.OKGREEN}Stopping cosmovisor{bcolors.ENDC}')
run_command(["sudo systemctl stop cosmovisor.service"], "Error stopping cosmovisor")
routerd_dir = os.path.join(HOME_DIR, "routerd_upgrade")
os.makedirs(routerd_dir, exist_ok=True)
os.chdir(routerd_dir)
print(f'{bcolors.OKGREEN}Downloading routerd{bcolors.ENDC}')
download_file(ROUTER_REPO + ROUTERD_FILE, os.path.join(routerd_dir, ROUTERD_FILE))
run_command(["tar -xvf routerd.tar -C ."], "Error extracting routerd.tar")
run_command(["sudo chmod +x routerd"], "Error setting routerd as executable")
routerd_home = run_command(["which routerd"], "Error finding routerd binary location")
if routerd_home == "":
if not user_confirm("routerd is not installed in default location. Do you want to install in default location?"):
print(f'{bcolors.OKGREEN}Exiting{bcolors.ENDC}')
return
routerd_home = "/usr/bin/routerd"
run_command(["sudo rm -rf " + routerd_home], "Error deleting old routerd binary")
run_command(["sudo cp routerd " + routerd_home], "Error moving new routerd binary to current location")
routerd_home = os.path.join(HOME_DIR, ".routerd")
if not os.path.exists(routerd_home):
routerd_home = input(f'{bcolors.OKGREEN}Enter routerd home directory: {bcolors.ENDC}')
if not os.path.exists(routerd_home):
raise Exception("Invalid routerd home directory")
print(f'{bcolors.OKGREEN}Upgrading binary{bcolors.ENDC}')
run_command(["cp routerd "+routerd_home +"/cosmovisor/current/bin"], "Error copying new routerd binary")
run_command(["sudo chmod +x " + routerd_home], "Error setting new routerd binary as executable")
ORCHESTRATOR_DIR = ".router-orchestrator"
ORCHESTRATOR_PATH = os.path.join(HOME_DIR, ORCHESTRATOR_DIR)
if os.path.exists(ORCHESTRATOR_PATH):
print(f"Upgrading orchestrator")
upgrade_orchestrator=True
setup_orchestrator()
print(f'{bcolors.OKGREEN}Starting cosmovisor (routerd service){bcolors.ENDC}')
run_command(["sudo systemctl start cosmovisor.service"], "Error starting cosmovisor.service")
time.sleep(10)
if get_service_status("cosmovisor.service") != ServiceStatus.ACTIVE:
raise Exception("Error starting cosmovisor")
if os.path.exists(ORCHESTRATOR_PATH):
print(f'{bcolors.OKGREEN}Restarting orchestrator{bcolors.ENDC}')
restart_orchestrator()
print(f'{bcolors.OKGREEN}routerd upgrade completed successfully{bcolors.ENDC}')
print(f'{bcolors.OKGREEN}To see logs, run the following command: "journalctl -u cosmovisor.service -f"{bcolors.ENDC}')
except Exception as e:
print(f'{bcolors.OKGREEN}Error upgrading routerd{bcolors.ENDC}')
raise e
def install_location():
global routerd_home
print(bcolors.OKGREEN + """Do you want to install routerd in the default location?:
1) Yes, use default location (recommended)
2) No, specify custom location
""" + bcolors.ENDC)
if args.installHome:
location_choice = '2'
else:
location_choice = input(
bcolors.OKGREEN + 'Enter Choice for location: ' + bcolors.ENDC)
print("location choice: " + location_choice)
if location_choice == "1":
clear_screen()
routerd_home = subprocess.run(
["echo $HOME/.routerd"], capture_output=True, shell=True, text=True).stdout.strip()
elif location_choice == "2":
clear_screen()
locationChoice = input(bcolors.OKGREEN + 'Enter Choice for 2: ' + bcolors.ENDC)
if locationChoice.strip() == "":
locationChoice = "$HOME/.routerd"
routerd_home = subprocess.run(
[f"echo {locationChoice}"], capture_output=True, shell=True, text=True).stdout.strip()
else:
clear_screen()
install_location()
init_node_name()
def install_location_handler():
print("Not implemented yet")
def download_and_copy_libs():
if os.path.exists("routerd-libs"):
shutil.rmtree("routerd-libs")
check_call(["git", "clone", "https://github.com/router-protocol/routerd-libs"])
for src_file in os.listdir("routerd-libs"):
src_path = os.path.join("routerd-libs", src_file)
if os.path.isfile(src_path):
subprocess.run(["sudo cp "+src_path +
" /lib"], shell=True, env=my_env)
subprocess.run(["sudo cp "+src_path +
" /lib64"], shell=True, env=my_env)
def cosmovisor_init():
print(bcolors.OKGREEN + "Initializing cosmovisor" + bcolors.ENDC)
clear_screen()
os.chdir(os.path.expanduser(HOME))
colorprint("Setting Up Cosmovisor")
subprocess.run(["go install github.com/cosmos/cosmos-sdk/cosmovisor/cmd/[email protected]"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True, env=my_env)
subprocess.run(["mkdir -p "+routerd_home+"/cosmovisor"],
shell=True, env=my_env)
subprocess.run(
["mkdir -p "+routerd_home+"/cosmovisor/genesis"], shell=True, env=my_env)
subprocess.run(
["mkdir -p "+routerd_home+"/cosmovisor/genesis/bin"], shell=True, env=my_env)
subprocess.run(
["mkdir -p "+routerd_home+"/cosmovisor/upgrades"], shell=True, env=my_env)
subprocess.run(
["mkdir -p "+routerd_home+"/cosmovisor/upgrades/v1/bin"], shell=True, env=my_env)
subprocess.run(["cp /usr/bin/routerd "+routerd_home+"/cosmovisor/upgrades/v1/bin"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True, env=my_env)
subprocess.run(["cp /usr/bin/routerd "+routerd_home +
"/cosmovisor/genesis/bin"], shell=True, env=my_env)
cosmovisor_service()
clear_screen()
completeCosmovisor()
def cosmovisor_service():
colorprint("Creating Cosmovisor Service")
os.chdir(os.path.expanduser(HOME))
subprocess.run(["echo '# Setup Cosmovisor' >> "+HOME +
"/.profile"], shell=True, env=my_env)
subprocess.run(["echo 'export DAEMON_NAME=routerd' >> " +
HOME+"/.profile"], shell=True, env=my_env)
subprocess.run(["echo 'export DAEMON_HOME="+routerd_home +
"' >> "+HOME+"/.profile"], shell=True, env=my_env)
subprocess.run(["echo 'export DAEMON_ALLOW_DOWNLOAD_BINARIES=false' >> " +
HOME+"/.profile"], shell=True, env=my_env)
subprocess.run(["echo 'export DAEMON_LOG_BUFFER_SIZE=512' >> " +
HOME+"/.profile"], shell=True, env=my_env)
subprocess.run(["echo 'export DAEMON_RESTART_AFTER_UPGRADE=true' >> " +
HOME+"/.profile"], shell=True, env=my_env)
subprocess.run(["echo 'export UNSAFE_SKIP_BACKUP=true' >> " +
HOME+"/.profile"], shell=True, env=my_env)
#print HOME
subprocess.run(["echo $HOME - "+HOME], shell=True, env=my_env)
subprocess.run(["""echo '[Unit]
Description=Cosmovisor daemon
After=network-online.target
[Service]
Environment=\"DAEMON_NAME=routerd\"
Environment=\"DAEMON_HOME=""" + routerd_home+"""\"
Environment=\"DAEMON_RESTART_AFTER_UPGRADE=true\"
Environment=\"DAEMON_ALLOW_DOWNLOAD_BINARIES=false\"
Environment=\"DAEMON_LOG_BUFFER_SIZE=512\"
Environment=\"UNSAFE_SKIP_BACKUP=true\"
User =""" + USER+"""
ExecStart="""+HOME+"""/go/bin/cosmovisor start --log_level "error" --json-rpc.api eth,txpool,personal,net,debug,web3,miner --api.enable start --home """+routerd_home+"""
Restart=always
RestartSec=3
LimitNOFILE=infinity
LimitNPROC=infinity
[Install]
WantedBy=multi-user.target
' >cosmovisor.service
"""], shell=True, env=my_env)
subprocess.run(
["sudo mv cosmovisor.service /lib/systemd/system/cosmovisor.service"], shell=True, env=my_env)
subprocess.run(["sudo systemctl daemon-reload"], shell=True, env=my_env)
clear_screen()
def completeCosmovisor():
print(bcolors.OKGREEN + "Cosmovisor Service Created" + bcolors.ENDC)
print(bcolors.OKGREEN + "Start service by running 'sudo systemctl start cosmovisor.service'" + bcolors.ENDC)
print(bcolors.OKGREEN + "To see the status of cosmovisor, run the following command: 'systemctl status cosmovisor'")
colorprint(
"To see the live logs from cosmovisor, run the following command: 'journalctl -u cosmovisor -f'")
if install_option == 2:
quit()
def get_go_executable_path():
result = subprocess.run(['which', 'go'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
if result.returncode != 0:
print('GO Installation complete. Please restart your terminal or run `source ~/.bashrc` to apply changes.')
# exit if not installed
exit(1)
# return None
go_executable_path = result.stdout.strip()
return go_executable_path
def get_gopath(go_executable_path):
result = subprocess.run([go_executable_path, 'env', 'GOPATH'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
if result.returncode != 0:
print("Error getting GOPATH.")
return None
gopath = result.stdout.strip()
return gopath
def get_linux_distribution():
try:
with open('/etc/os-release', 'r') as f:
for line in f:
if line.startswith('ID='):
distro_id = line.split('=')[1].strip().strip('"')
return distro_id
except FileNotFoundError:
error_msg = "Error getting Linux distribution."
print(error_msg)
raise Exception(error_msg)
def get_ubuntu_version():
try:
version = subprocess.check_output(['lsb_release', '-rs'], universal_newlines=True)
return float(version)
except Exception as e:
error_msg = "Error getting Ubuntu version: {}".format(e)
print(error_msg)
raise Exception(error_msg)
def init_setup():
global my_env
global GOPATH
clear_screen()
print(bcolors.OKGREEN + "Installing Dependencies" + bcolors.ENDC)
if os_name == "Linux":
colorprint("(1/4) Updating Packages")
subprocess.run(["sudo apt-get update"],
stdout=subprocess.DEVNULL, shell=True)
subprocess.run(["sudo DEBIAN_FRONTEND=noninteractive apt-get -y upgrade"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True)
colorprint("(2/4) Installing make and GCC")
subprocess.run(["sudo apt install git build-essential ufw curl jq snapd --yes"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True)
colorprint("(3/4) Installing Go")
subprocess.run(["wget -q -O - https://git.io/vQhTU | bash -s -- --remove"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True)
subprocess.run(["wget -q -O - https://git.io/vQhTU | bash -s -- --version 1.19"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, shell=True)
os.chdir(os.path.expanduser(HOME_DIR))
print(bcolors.OKGREEN +
"(4/4) Installing Router {v} Binary".format(v=version) + bcolors.ENDC)
routerd_url = ROUTER_REPO + ROUTERD_FILE
response = requests.get(routerd_url)
if response.status_code != 200:
print("Error downloading routerd.tar")
raise Exception("Error downloading routerd.tar")
with open(os.path.join(HOME_DIR, ROUTERD_FILE), "wb") as f:
f.write(response.content)
subprocess.run(["tar -xvf routerd.tar -C ."], shell=True)
subprocess.run(["sudo cp routerd /usr/bin"], shell=True)
subprocess.run(["sudo chmod +x /usr/bin/routerd"], shell=True)
clear_screen()
colorprint("Router {v} Installed Successfully!".format(v=version))
colorprint("Installing dependencies")
my_env = os.environ.copy()
my_env["PATH"] = "/"+HOME+"/go/bin:/"+HOME + \
"/go/bin:/"+HOME+"/.go/bin:" + my_env["PATH"]
download_and_copy_libs()
else:
print("Unknown OS")
def setup():
global HOME
global GOPATH
HOME = subprocess.run(
["echo $HOME"], capture_output=True, shell=True, text=True).stdout.strip()
GOPATH = HOME+"/go"
if os_name == "Linux":
print(bcolors.OKGREEN + "System Detected: Linux" + bcolors.ENDC)
mem_bytes = os.sysconf('SC_PAGE_SIZE') * os.sysconf('SC_PHYS_PAGES')
mem_gib = mem_bytes/(1024.**3)
print(bcolors.OKGREEN + "RAM Detected: " +
str(round(mem_gib))+"GB" + bcolors.ENDC)
if mem_gib < SYSTEM_RAM_REQUIRED:
print(bcolors.FAIL + "Not enough RAM to run routerd" + bcolors.ENDC)
print(bcolors.OKCYAN + "Do you want to continue? (y/n)" + bcolors.ENDC)
choice = input().lower()
if choice == "n":
exit(1)
elif choice == "y":
pass
os.chdir(os.path.expanduser(HOME))
init_setup()
install_location()
elif os_name == "Darwin":
print("Mac OS is not supported yet \n")
exit(1)
elif os_name == "Windows":
print("Windows is not supported yet \n")
exit(1)
else:
print("Unknown OS")
exit(1)
def setup_orchestrator():
global HOME
global GOPATH
HOME = subprocess.run(
["echo $HOME"], capture_output=True, shell=True, text=True).stdout.strip()
GOPATH = HOME+"/go"
if os_name == "Linux":
install_orchestrator()
if upgrade_orchestrator == False:
configure_orchestrator()
elif os_name == "Darwin":
print("Mac not supported yet")
elif os_name == "Windows":
print("Windows not supported yet")
else:
print("Unknown OS, exiting")
def install_orchestrator():
# stop if already running
# cd to path HOME_DIR
os.chdir(HOME_DIR)
orchestrator_status = get_service_status("orchestrator.service")
if orchestrator_status == ServiceStatus.ACTIVE:
print(bcolors.OKGREEN + "Stopping orchestrator" + bcolors.ENDC)
subprocess.run(["sudo systemctl stop orchestrator.service"], shell=True)
subprocess.run(["sudo rm -rf /lib/systemd/system/orchestrator.service"], shell=True)
if os.path.exists(os.path.join(HOME_DIR, ORCHESTRATORD_FILE)):
os.remove(os.path.join(HOME_DIR, ORCHESTRATORD_FILE))
orchestrator_home = subprocess.run(["which router-orchestrator"], capture_output=True, shell=True, text=True).stdout.strip()
if orchestrator_home != "":
subprocess.run(["sudo rm -rf " + orchestrator_home], shell=True)
print(bcolors.OKGREEN + "Installing Orchestrator" + bcolors.ENDC)
response = requests.get(f"{ORCHESTRATOR_REPO}/{ORCHESTRATORD_FILE}")
with open(os.path.join(HOME_DIR, ORCHESTRATORD_FILE), "wb") as f:
f.write(response.content)
subprocess.run(["sudo cp router-orchestrator /usr/bin"], shell=True)
subprocess.run(["sudo chmod +x /usr/bin/router-orchestrator"], shell=True)
download_and_copy_libs()
setup_orchestrator_service()
def setup_orchestrator_service():
# stop if already running
global ORCHESTRATOR_PATH
global ORCHESTRATOR_DIR
print(bcolors.OKGREEN + "Setting up Orchestrator Service" + bcolors.ENDC)
ORCHESTRATOR_DIR = ".router-orchestrator"
ORCHESTRATOR_PATH = os.path.join(HOME_DIR, ORCHESTRATOR_DIR)
orchestrator_service_file_content = f'''[Unit]
Description=orchestrator
After=network.target
[Service]
User={USER}
Type=simple
WorkingDirectory={ORCHESTRATOR_PATH}
ExecStart=/usr/bin/router-orchestrator start --reset --config {ORCHESTRATOR_PATH}/config.json
Restart=on-failure
RestartSec=10s
StartLimitInterval=90s
StartLimitBurst=3
StartLimitAction=none
[Install]
WantedBy=multi-user.target
'''
with open("orchestrator.service", "w") as service_file:
service_file.write(orchestrator_service_file_content)
subprocess.run(
["sudo mv orchestrator.service /lib/systemd/system/orchestrator.service"], shell=True, env=my_env)
subprocess.run(["sudo systemctl daemon-reload"], shell=True, env=my_env)
'''
Prints system information required for logging
'''
def print_system_info():
# prints all system information
print(bcolors.OKGREEN + "\nSystem Information" + bcolors.ENDC)
print("=========================================")
arch = subprocess.run(['uname', '-m'], stdout=subprocess.PIPE)
arch = arch.stdout.decode('utf-8').strip()
mem_bytes = os.sysconf('SC_PAGE_SIZE') * os.sysconf('SC_PHYS_PAGES')
mem_gib = mem_bytes/(1024.**3)
space_available = shutil.disk_usage("/").free / (1024.**3)
cores = subprocess.run(['lscpu | grep "CPU(s):" | head -1 | cut -d":" -f2'], stdout=subprocess.PIPE, shell=True)
print("OS: " + os_name)
print("Architecture: " + arch)
print("RAM: " + str(round(mem_gib))+"GB")
print("Cores: " + cores.stdout.decode('utf-8').strip())
print("Memory: " + str(round(space_available))+"GB")
print("=========================================")
def configure_orchestrator():
print(bcolors.OKGREEN + "Configuring Orchestrators" + bcolors.ENDC)
print(f"Current directory: {os.getcwd()}")
print(f"Checking if directory '{ORCHESTRATOR_DIR}' exists")
if not os.path.exists(ORCHESTRATOR_PATH):
print(f"Creating directory '{ORCHESTRATOR_DIR}'")
os.mkdir(ORCHESTRATOR_PATH)
else:
print(f"Directory '{ORCHESTRATOR_DIR}' exists")
os.chdir(os.path.expanduser(ORCHESTRATOR_PATH))
config_data = json.loads(ORCHESTRATOR_TEMPLATE)
with open("config.json", "w") as f:
json.dump(config_data, f, indent='', separators=(',', ':'))
print("\nOrchestrator config created successfully. Please edit config to add chains and private keys")
print("Run 'sudo systemctl start orchestrator.service' to start orchestrator")
print("Run 'journalctl -fu orchestrator.service -u -f' to see logs")
def handle_debian():
print("debian distribution")
return "debian/"
def handle_ubuntu():
ubuntu_version = get_ubuntu_version()
print(f"ubuntu distribution {ubuntu_version}")
if ubuntu_version and ubuntu_version < 22:
return "debian/"
return ""
os_handlers = {
"debian": handle_debian,
"ubuntu": handle_ubuntu,
}
def start():
global my_env
global version
global install_option
global upgrade_orchestrator
global os_distribution
global USER
global ROUTER_REPO
global ORCHESTRATOR_REPO
my_env = os.environ.copy()
upgrade_orchestrator=False
USER = subprocess.run(
["echo $USER"], capture_output=True, shell=True, text=True).stdout.strip()
clear_screen(False)
print(bcolors.OKGREEN + """
██████╗░░█████╗░██╗░░░██╗████████╗███████╗██████╗░ ░█████╗░██╗░░██╗░█████╗░██╗███╗░░██╗
██╔══██╗██╔══██╗██║░░░██║╚══██╔══╝██╔════╝██╔══██╗ ██╔══██╗██║░░██║██╔══██╗██║████╗░██║
██████╔╝██║░░██║██║░░░██║░░░██║░░░█████╗░░██████╔╝ ██║░░╚═╝███████║███████║██║██╔██╗██║
██╔══██╗██║░░██║██║░░░██║░░░██║░░░██╔══╝░░██╔══██╗ ██║░░██╗██╔══██║██╔══██║██║██║╚████║
██║░░██║╚█████╔╝╚██████╔╝░░░██║░░░███████╗██║░░██║ ╚█████╔╝██║░░██║██║░░██║██║██║░╚███║
╚═╝░░╚═╝░╚════╝░░╚═════╝░░░░╚═╝░░░╚══════╝╚═╝░░╚═╝ ░╚════╝░╚═╝░░╚═╝╚═╝░░╚═╝╚═╝╚═╝░░╚══╝
ROUTER CHAIN INSTALLER
Testnet version: {t}
""".format(
t=NetworkVersion.TESTNET.value) + bcolors.ENDC)
os_distribution = get_linux_distribution()
print(f"os_distribution: ", os_distribution)
# check if os_distribution is unknown or none
if not os_distribution:
print("Unknown distribution: ", os_distribution)
exit(1)
handler = os_handlers.get(os_distribution)
if handler:
append_path = handler()
ROUTER_REPO += append_path
ORCHESTRATOR_REPO += append_path
else:
print(f"Unknown distribution {os_distribution}")
# select to install router or orchestrator
print("Select an option:")
print("1. Install Validator (routerd) & Orchestrator")
print("2. Install Validator (routerd)")
print("3. Install Orchestrator")
print("4. Upgrade Orchestrator")
print("5. Upgrade Router (routerd)")
print("6. Exit")
option = input("Enter option: ")
try:
if option == "1":
install_option=1
print(bcolors.OKBLUE + "Installing Router and Orchestrator" + bcolors.ENDC)
setup()
setup_orchestrator()
configure_orchestrator()
print(bcolors.OKGREEN + "Run validator (routerd) using" + bcolors.ENDC)
install_option=2
completeCosmovisor()
elif option == "2":
install_option=2
print("Installing Router")
setup()
elif option == "3":
install_option=3
setup_orchestrator()
elif option == "4":
install_option=4
upgrade_orchestrator=True
setup_orchestrator()
elif option == "5":
install_option=5
print("Upgrading Router")
upgrade_routerd()
elif option == "6":
print("Exiting")
exit(0)
else:
print("Invalid option")
exit(1)
except Exception as e:
print_system_info()
print(f"\nError (Script version: {script_version})")
print("=========================================")
print("msg: ", e)
print("traceback: ", traceback.format_exc())
print("=========================================\n")
print("Error while installing. Please connect with us on Discord for support with a screenshot of the error.\n")
exit(1)
if __name__ == '__main__':
start()