feat: Quick start. Run it all using docker and systemctl with ./scripts/run.sh

ltfschoen · ltfschoen · commit 92da9782b411 · 2024-12-27T14:03:43.000+11:00
diff --git a/_QUICKSTART.md b/_QUICKSTART.md
@@ -7,7 +7,62 @@ It may be used to create a script in future.
 It assumes that the Ethereum Local Network and Secret Local Network are being run on a remote machine running Linux, since macOS may not support SGX.
 The guide uses `scp` to copy file changes that are being made on a local machine across to the remote machine. Alternatively make the changes directly on the remote server using `vim` or similar, or otheriwse configure your code editor like Visual Studio Code to do so.
 
-### Local Machine
+### Super Quick Start
+
+* Clone https://github.com/svub/nunya into `~/nunya`
+* Fetch latest from branch 'submit-pubkey'
+	```
+	git fetch origin submit-pubkey:submit-pubkey
+	git checkout submit-pubkey
+	```
+* Clone https://github.com/ltfschoen/SecretPath into `~/ltfschoen`
+* Fetch latest from branch 'nunya'
+	```
+	git fetch origin nunya:nunya
+	git checkout nunya
+	```
+* Run the following on a remote server:
+	```
+	./scripts/run.sh
+	```
+* Wait for it to all load
+* Run
+	```
+	cd ~/nunya && nvm use && yarn run secret:submitRequestValue
+	```
+	OR 
+	```
+	cd ~/nunya && nvm use && yarn run secret:submitRetrievePubkey
+	```
+* Watch the logs
+	* Ethereum Local Node
+		```
+		journalctl -u ethlocal.service -f
+		```
+		* Optionally store in a file:
+			```
+			journalctl -u ethlocal.service -f | tee ~/nunya/ethlocal.service.log
+			```
+	* Secret Local Node
+		```
+		docker logs -f --tail 10 secretdev
+		```
+		* Optionally store in a file:
+			```
+			docker logs -f secretdev | tee ~/nunya/secret-docker.log
+			```
+	* Relayer
+		```
+		journalctl -u relayer.service -f
+		```
+		* Optionally store in a file:
+			```
+			journalctl -u relayer.service -f | tee ~/nunya/relayer.service.log
+			```
+
+### Slow Start
+
+#### Local Machine
 
 ```
 cd /Users/luke/code/clones/github/svub/nunya
@@ -26,9 +81,9 @@ DESTINATION=/root/nunya/packages/secret-contracts-scripts/src/config/config.ts
 scp -r $SOURCE root@$REMOTE_IP:$DESTINATION
 ```
 
-### Remote server
+#### Remote server
 
-#### Terminal Tab 1
+##### Terminal Tab 1
 
 	* Start here
 
@@ -59,7 +114,7 @@ scp -r $SOURCE root@$REMOTE_IP:$DESTINATION
 
 	* TODO - turn into service that can start and stop and reset
 
-#### Terminal Tab 2
+##### Terminal Tab 2
 
   ```bash
 	ssh root@172.105.184.209
@@ -72,7 +127,7 @@ scp -r $SOURCE root@$REMOTE_IP:$DESTINATION
 
 	* TODO - turn into service that can start and stop and reset
 
-#### Terminal Tab 3
+##### Terminal Tab 3
 
   ```bash
 	ssh root@172.105.184.209
@@ -175,7 +230,7 @@ scp -r $SOURCE root@$REMOTE_IP:$DESTINATION
 	docker exec -it secretdev secretcli query bank balances secret1glfedwlusunwly7q05umghzwl6nf2vj6wr38fg | jq
   ```
 
-#### Terminal Tab 4
+##### Terminal Tab 4
 
   ```bash
 	cd ~/nunya
@@ -215,7 +270,7 @@ scp -r $SOURCE root@$REMOTE_IP:$DESTINATION
 	python3 web_app.py
   ```
 
-#### Terminal Tab 3
+##### Terminal Tab 3
 
 * RUN AFTER RELAYER STARTED
 
@@ -247,6 +302,6 @@ scp -r root@$REMOTE_IP:$SOURCE $DESTINATION
 INFO  [enclave_contract_engine::wasm3] debug_print: "msg: PostExecutionMsg {\n    result: \"eyJfcmVxdWVzdF9pZCI6eyJuZXR3b3JrIjoiMzEzMzciLCJ0YXNrX2lkIjoiNCJ9LCJfa2V5IjpbMiwyNTEsMTg4LDE0MywxNjMsMTExLDM0LDE1OCwxNjcsODIsMTE1LDE4OSwyNSwyMzksMTcyLDEyNiw4LDY3LDIzMCwxMzgsNTAsNzcsODEsMTEzLDEyMiwyMDEsNzYsMjE5LDI0Myw1NSwxMzQsMjE0LDg2XSwiX2NvZGUiOjAsIl9udW55YV9idXNpbmVzc19jb250cmFjdF9hZGRyZXNzIjoiMHhBRkZGMzExODIxQzNGM0FGODYzQzcxMDNCQjE3QkRDMUJhMDQ2MDNEIn0=\"
 ```
 
-### Notes
+#### Notes
 
 * Note: Restart all nodes and re-do steps in Terminal Tab 2 if any of the changes are made since it's faster, otherwise the CODE_ID and CONTRACT_ADDRESS may change requiring updating the config file between uploading and instantiation, which is annoying.
diff --git a/_SETUP.md b/_SETUP.md
@@ -9,6 +9,8 @@
 
 ### Usage Guidelines <a id="usage"></a> 
 
+**Quick Start** with section: [_QUICKSTART.md](./_QUICKSTART.md), otherwise if that doesn't work:
+
 **Start Here** with section [Setup Secret](#setup-secret") and follow the instructions from there.
 
 Help judges and other developers understand the project.
@@ -613,9 +615,7 @@ cd SecretPath/TNLS-Relayers
   
   * Setup
     ```
-    conda create --name secretpath_env python=3.11
-    y
-    y
+    conda -y create --name secretpath_env python=3.11
     ```
 
     * Outputs:
diff --git a/scripts/ethlocal/node.sh b/scripts/ethlocal/node.sh
diff --git a/scripts/ethlocal/start.sh b/scripts/ethlocal/start.sh
@@ -3,20 +3,15 @@
 NAME="hardhat_ethereum_development_node"
 # FIXME: Permission denied
 # NODE_PATH="/opt/ethlocal/hardhat"
-# FIXME: Permission denied
 # Note: Check if can execute a file with a given user:
 # `sudo -u ethlocal_service test -x /opt/ethlocal/hardhat || {    echo "otheruser cannot execute the file"; }`
 NODE_PATH="/root/nunya/packages/hardhat/node_modules/.bin/hardhat"
 
 PORT="8545"
 
-# Note: Must be inside a hardhat project to run the command otherwise error
-# Error HH1: You are not inside a Hardhat project.
-# It runs this from directory root `/` hence the error. Suggest move into a script where can change directory.
-CMD="$NODE_PATH node --network hardhat \
-  --no-deploy \
-  --watch \
-  --port $PORT
+# Important: systemd service must be configured with the `WorkingDirectory` pointing to a Hardhat project
+# that you may debug here with `echo $PWD` if necessary
+CMD="$NODE_PATH node --network hardhat --no-deploy --watch --port $PORT
 "
 
 echo "-----------------------"
diff --git a/scripts/relayer/node.sh b/scripts/relayer/node.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+DIRECTORY=/root/miniconda3
+if [ ! -d "$DIRECTORY" ]; then
+  echo "$DIRECTORY does not exist."
+
+  mkdir -p ~/miniconda3
+  wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
+  bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
+  rm ~/miniconda3/miniconda.sh
+fi
+
+# activate miniconda
+source ~/miniconda3/bin/activate
+conda init --all
+source ~/.zshrc
+
+conda create -y --name secretpath_env python=3.11
+
+# install relayer dependencies and activate conda environment
+conda activate secretpath_env
+pip install -r requirements.txt --no-dependencies
+pip install --upgrade lru-dict
+
+python3 web_app.py
+
diff --git a/scripts/relayer/start.sh b/scripts/relayer/start.sh
@@ -1,10 +1,8 @@
 #!/usr/bin/env bash
 
 NAME="relayer_service"
-NODE_PATH="/opt/relayer"
-PORT="8545"
 
-CMD="python3 $NODE_PATH/web_app.py
+CMD="/root/nunya/scripts/relayer/node.sh
 "
 
 echo "-----------------------"
diff --git a/scripts/run.sh b/scripts/run.sh
@@ -142,8 +142,10 @@ mkdir -p $DB_STORAGE/.chains
 
 mkdir -p /opt/ethlocal
 cp ~/nunya/scripts/ethlocal/start.sh /opt/ethlocal
+cp ~/nunya/scripts/ethlocal/node.sh /opt/ethlocal
 sudo chown -R ethlocal_service /opt/ethlocal
 sudo chmod 755 /opt/ethlocal/start.sh
+sudo chmod 755 /opt/ethlocal/node.sh
 
 # create a soft link to this file in my present directory:
 
@@ -181,6 +183,10 @@ touch /etc/systemd/system/ethlocal.service
   echo 'SyslogFacility=local7'
   echo 'KillSignal=SIGHUP'
   echo 'ExecStart=/opt/ethlocal/start.sh'
+  # Note: Must be inside a hardhat project to run the command otherwise error
+  # Error HH1: You are not inside a Hardhat project.
+  # It runs this from directory root `/` hence the error. Suggest move into a script where can change directory.
+  echo 'WorkingDirectory=/root/nunya/packages/hardhat' # must be run inside a Hardhat project
   echo '[Install]'
   echo 'WantedBy=multi-user.target'
 } > /etc/systemd/system/ethlocal.service
@@ -238,29 +244,25 @@ docker exec -it secretdev secretcli tx bank send secret1ap26qrlp8mcq2pg6r47w43l0
 # Part 4
 
 # TODO - update to clone and checkout if folder not exist
-cd ~/nunya
-nvm use
 cd ~/ltfschoen/SecretPath/TNLS-Relayers
-git stash
-git pull origin nunya
-git checkout nunya
+# git stash
+# git pull origin nunya
+# git checkout nunya
 
-## TODO - configure thes files
+## TODO - configure these files
 # /root/ltfschoen/SecretPath/TNLS-Relayers/config.yml
 # /root/ltfschoen/SecretPath/TNLS-Relayers/.env
 
-conda activate secretpath_env
-pip install -r requirements.txt --no-dependencies
-pip install --upgrade lru-dict
-
 # Part 5
 
 sudo adduser relayer_service --system --no-create-home
 
 mkdir -p /opt/relayer
 cp ~/nunya/scripts/relayer/start.sh /opt/relayer
+cp ~/nunya/scripts/relayer/node.sh /opt/relayer
 sudo chown -R relayer_service /opt/relayer
 sudo chmod 755 /opt/relayer/start.sh
+sudo chmod 755 /opt/relayer/node.sh
 
 sudo rm /opt/relayer/web_app.py
 # create symlink in /opt/relayer to /root/ltfschoen/SecretPath/TNLS-Relayers/web_app.py
@@ -270,7 +272,6 @@ sudo chown -R relayer_service ~/ltfschoen/SecretPath/TNLS-Relayers
 # change permission to symlink and where it points to
 sudo chmod 755 /opt/relayer/web_app.py
 sudo chmod 755 ~/ltfschoen/SecretPath/TNLS-Relayers/web_app.py
-ls -al /opt/relayer
 
 # Create service file
 
@@ -291,6 +292,7 @@ touch /etc/systemd/system/relayer.service
   echo 'SyslogIdentifier=relayer'
   echo 'SyslogFacility=local7'
   echo 'KillSignal=SIGHUP'
+  echo 'WorkingDirectory=/root/ltfschoen/SecretPath/TNLS-Relayers' # run from inside the project where dependencies are installed
   echo 'ExecStart=/opt/relayer/start.sh'
   echo '[Install]'
   echo 'WantedBy=multi-user.target'
@@ -308,5 +310,5 @@ systemctl status relayer
 
 cd ~/nunya
 nvm use
-yarn run secret:submitRequestValue
-yarn run secret:submitRetrievePubkey
+# yarn run secret:submitRequestValue
+# yarn run secret:submitRetrievePubkey

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`
`3`	`3`	`NAME="relayer_service"`
`4`		`-NODE_PATH="/opt/relayer"`
`5`		`-PORT="8545"`
`6`	`4`
`7`		`-CMD="python3 $NODE_PATH/web_app.py`
	`5`	`+CMD="/root/nunya/scripts/relayer/node.sh`
`8`	`6`	`"`
`9`	`7`
`10`	`8`	`echo "-----------------------"`