fix(doc): fix trond tools guidance (#40)

Author: Sunny6889

tools/trond/README.md

@@ -5,7 +5,16 @@
 
 ## Prerequisites
 - Shell Environment: Required for running shell scripts.
-- Golang Build Environment: The [build_trond.sh](../../build_trond.sh) script will attempt to install the necessary Golang environment.
+- **Go Language (v1.21.4+)**
+    - Official download: <https://go.dev/dl>
+    - Note: If Go is not installed, the [build_trond.sh](../../build_trond.sh) script will attempt to install it automatically, but it is recommended to configure it manually in advance.
+- **Docker and Docker Compose**
+    - Minimum version requirements:
+        - Docker Engine ≥ 20.10.13
+        - Docker Compose ≥ 1.29.2
+    - Official installation guides: Check [prerequiesites](../../README.md#prerequisites)
+- **Python 3.11.0+**
+    - Official download: <https://www.python.org/downloads/release/python-3110/>
 
 ## Installation
 
@@ -41,7 +50,7 @@ Now it supports the following commands:
 ### Examples
 
 Here we show examples of downloading the mainnet database snapshot, then deploy a java-tron node based on it.
-It is recommended to run these commands in `tron-docker` root directory.
+You need to run these commands in `tron-docker` root directory.
 
 #### 1. Download the Mainnet database snapshot
 
@@ -56,22 +65,41 @@ After the download completes, the database will be extracted to `./output-direct
 Notice: The snapshot is large(46G on 24-Jan-2025). It may take above 1 hour to finish. You could add `nohup` to make it continue running even after you log out of your terminal session.
 The full command will be `nohup ./trond snapshot download default-main &`
 
-#### 2. Deploy a java-tron node on Mainnet
+#### 2. Check configure files
+Next, check the configuration files and Docker compose files required for deploying a node:
+```
+./trond node env
+```
+As running a mainnet node,
+you need file [docker-compose.fullnode.main.yml](../../single_node/docker-compose.fullnode.main.yml) and [main_net_config.conf](../../conf/main_net_config.conf).
+
+#### 3. Deploy a java-tron node on Mainnet
 
-Next, start a node connecting to the Mainnet:
+Then, start a node connecting to the Mainnet:
 
 ```
 ./trond node run-single -t full-main
 ```
 
-This command will trigger execution of the [docker-compose](../../single_node/docker-compose.fullnode.main.yml). It will use the database at `./output-directory/mainnet/database`.
+This command will trigger execution of the [docker-compose](../../single_node/docker-compose.fullnode.main.yml).
+It will use the database at `./output-directory/mainnet/database` of the command trigger directory.
 If the directory is empty, the node will sync transaction data from the genesis block. If you don’t need the snapshot, you can skip the download step.
 
 To view the node logs, you can access them at `./logs/mainnet`, or you can use the command `docker exec tron-node tail -f ./logs/tron.log`.
 
-For more detailed usage instructions, refer to the help command or the [command documentation](./docs/trond.md).
+#### 4. Stop the java-tron node
+As java-tron service supports application shutdown with `kill -15`, which sends a `SIGTERM` signal to the application, allowing it to gracefully shut down. java-tron is also compatible with force shutdown using `kill -9`, which sends a `SIGKILL` signal.
+You could stop the node in multiple ways.
 
+Here is an example of stopping the node using `trond`:
+```
+./trond node run-single stop -t full-main
+```
+
+
+For more detailed usage instructions, refer to the help command or the [command documentation](./docs/trond.md).
 
-## Note
+## TroubleShooting
+If you have any issues starting a java-tron node, please refer to the corresponding [TroubleShooting](../../single_node/README.md#troubleshot) guide.
 
-This tool has been tested on **macOS** and **Linux** only. If you encounter any issues, please report them on [GitHub](https://github.com/tronprotocol/tron-docker/issues).
+This tool has been tested on **macOS** and **Linux** only. If you encounter any other issues, please report them on [GitHub](https://github.com/tronprotocol/tron-docker/issues).

tools/trond/cmd/node/node.go

@@ -28,17 +28,26 @@ var NodeCmd = &cobra.Command{
 			# Help information for node command
 			$ ./trond node
 
-			# Check and configure node local environment
+			# Check and configure node local environment. Make sure run this first before starting the node.
 			$ ./trond node env
 
 			# Run single java-tron fullnode for main network
 			$ ./trond node run-single -t full-main
 
+			# Stop
+			$ ./trond node run-single stop -t full-main
+
 			# Run single java-tron fullnode for nile network
 			$ ./trond node run-single -t full-nile
 
+			# Stop
+			$ ./trond node run-single stop -t full-nile
+
 			# Run single java-tron witness node for private network
 			$ ./trond node run-single -t witness-private
+
+			# Stop
+			$ ./trond node run-single stop -t witness-private
 		`),
 }
 

tools/trond/cmd/node/runSingle.go

@@ -36,11 +36,20 @@ var runSingleCmd = &cobra.Command{
 			# Run single java-tron fullnode for main network
 			$ ./trond node run-single -t full-main
 
+			# Stop
+			$ ./trond node run-single stop -t full-main
+
 			# Run single java-tron fullnode for nile network
 			$ ./trond node run-single -t full-nile
 
+			# Stop
+			$ ./trond node run-single stop -t full-nile
+
 			# Run single java-tron witness node for private network
 			$ ./trond node run-single -t witness-private
+
+			# Stop
+			$ ./trond node run-single stop -t witness-private
 		`),
 	Run: func(cmd *cobra.Command, args []string) {
 		if checkEnvFailed() {
@@ -95,14 +104,14 @@ var runSingleStopCmd = &cobra.Command{
 	Long: heredoc.Doc(`
 			The following configuration files are required:
 
-				- Configuration file(by default, these exist in the current repository directory)
-					main network: ./conf/main_net_config.conf
-					nile network: ./conf/nile_net_config.conf
-					private network: ./conf/private_net_config_*.conf
 				- Docker compose file(by default, these exist in the current repository directory)
 					main network: ./single_node/docker-compose.fullnode.main.yml
 					nile network: ./single_node/docker-compose.fullnode.nile.yml
 					private network: ./single_node/docker-compose.witness.private.yml
+				- Configuration file(by default, these exist in the current repository directory)
+					main network: ./conf/main_net_config.conf, used by main network
+					nile network: ./conf/nile_net_config.conf, used by nile network
+					private network: ./conf/private_net_config_*.conf, used by private network
 		`),
 	Example: heredoc.Doc(`
 			# Stop single java-tron fullnode for main network

tools/trond/docs/trond_node.md

@@ -31,12 +31,21 @@ $ ./trond node env
 # Run single java-tron fullnode for main network
 $ ./trond node run-single -t full-main
 
+# Stop
+$ ./trond node run-single stop -t full-main
+
 # Run single java-tron fullnode for nile network
 $ ./trond node run-single -t full-nile
 
+# Stop
+$ ./trond node run-single stop -t full-nile
+
 # Run single java-tron witness node for private network
 $ ./trond node run-single -t witness-private
 
+# Stop
+$ ./trond node run-single stop -t witness-private
+
 ```
 
 ### Options

tools/trond/docs/trond_node_run-single.md

@@ -8,14 +8,14 @@ You need to make sure the local environment is ready before running the node. Ru
 
 The following files are required:
 
-	- Configuration file(by default, these exist in the current repository directory)
-		main network: ./conf/main_net_config.conf
-		nile network: ./conf/nile_net_config.conf
-		private network: ./conf/private_net_config_*.conf
 	- Docker compose file(by default, these exist in the current repository directory)
 		main network: ./single_node/docker-compose.fullnode.main.yml
 		nile network: ./single_node/docker-compose.fullnode.nile.yml
 		private network: ./single_node/docker-compose.witness.private.yml
+	- Configuration file(by default, these exist in the current repository directory)
+		main network: ./conf/main_net_config.conf, used by main network
+		nile network: ./conf/nile_net_config.conf, used by nile network
+		private network: ./conf/private_net_config_*.conf, used by private network
 
 
 The following directory will be created after you start any type of java-tron fullnode:
@@ -34,12 +34,21 @@ trond node run-single [flags]
 # Run single java-tron fullnode for main network
 $ ./trond node run-single -t full-main
 
+# Stop
+$ ./trond node run-single stop -t full-main
+
 # Run single java-tron fullnode for nile network
 $ ./trond node run-single -t full-nile
 
+# Stop
+$ ./trond node run-single stop -t full-nile
+
 # Run single java-tron witness node for private network
 $ ./trond node run-single -t witness-private
 
+# Stop
+$ ./trond node run-single stop -t witness-private
+
 ```
 
 ### Options