Trons

README.md

@@ -1,3 +1,7 @@
+## Scope of use
+This script could be used on Linux/MacOS, but not on Windows.
+Just Support FullNode and SolidityNode.
+
 ## Download and run script
 
 ```shell
@@ -7,15 +11,17 @@ wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy
 ## Parameter Illustration
 
 ```shell
-bash deploy_tron.sh --app [FullNode|SolidityNode] --net [mainnet|testnet|privatenet] --db [keep|remove|backup] 
+bash deploy_tron.sh --app [FullNode|SolidityNode] --net [mainnet|testnet|privatenet] --db [keep|remove|backup] --heap-size <heapsize>
 
---app	Running application. The default node is Fullnode and it could be FullNode or SolidityNode.
---net	Connecting network. The default network is mainnet and it could be mainnet, testnet, privatenet .
---db	The way of data processing could be keep, remove and backup. If you launch two different networks, like from mainnet to testnet or from testnet to mainnet, you need to delete database. 
---trust-node	It only works when deploying SolidityNode. The specified gRPC service of Fullnode, like 127.0.0.1:50051 or 13.125.249.129:50051.
---rpc-port	Port of grp. If you deploy SolidityNode and FullNode on the same host，you need to configure different ports.
---commit	Optional， commitid of project.
---branch	Optional，branch of project.
+--app	Optional, Running application. The default node is Fullnode and it could be FullNode or SolidityNode.
+--net	Optional, Connecting network. The default network is mainnet and it could be mainnet, testnet.
+--db	Optional, The way of data processing could be keep, remove and backup. Default is keep. If you launch two different networks, like from mainnet to testnet or from testnet to mainnet, you need to delete database.
+--trust-node	Optional, It only works when deploying SolidityNode. Default is 127.0.0.1:50051. The specified gRPC service of Fullnode, like 127.0.0.1:50051 or 13.125.249.129:50051.
+--rpc-port	Optional, Port of grpc. Default is 50051. If you deploy SolidityNode and FullNode on the same host，you need to configure different ports.
+--commit	Optional, commitid of project.
+--branch	Optional, branch of project.  Mainnet default is latest release and Testnet default is master.
+--heap-size  Optional, jvm option: Xmx. The default heap-size is 0.8 * memory size.
+--work_space  Optional, default is current directory.
 ```
 
 ## Examples
@@ -24,30 +30,24 @@ bash deploy_tron.sh --app [FullNode|SolidityNode] --net [mainnet|testnet|private
 
 ```shell
 wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy_tron.sh -O deploy_tron.sh
-bash deploy_tron.sh --app FullNode --net mainnet
+bash deploy_tron.sh
 ```
 
 ### Deployment of SolidityNode on the one host.
 
 ```shell
 wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy_tron.sh -O deploy_tron.sh
-# User can self-configure the IP and Port of GRPC service in the turst-node field of SolidityNode.
-bash deploy_tron.sh --app SolidityNode --net mainnet --trust-node <grpc-ip:grpc-port>
+# User can self-configure the IP and Port of GRPC service in the turst-node field of SolidityNode. trust-node is the fullnode you just deploy.
+bash deploy_tron.sh --app SolidityNode --trust-node <grpc-ip:grpc-port>
 ```
 
-### Deployment of FullNode(PrivateNet: Just one witness node) on the one host.
-
-```shell
-wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy_tron.sh -O deploy_tron.sh
-bash deploy_tron.sh --app FullNode --branch develop --net privatenet
-```
 ### Deployment of FullNode and SolidityNode on the same host.
 
 ```shell
+# You need to configure different gRPC ports on the same host because gRPC port is available on SolidityNode and FullNodeConfigure and it cannot be set as default value 50051. In this case the default value of rpc port is set as 50041.
 wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy_tron.sh -O deploy_tron.sh
-bash deploy_tron.sh --app FullNode --net mainnet
-# You need to configure different gRPC ports on the same host because gRPC port is available on SolidityNode and FullNodeConfigure and it cannot be set as default value 50051. In this case the default value of rpc port is set as 50041. 
-bash deploy_tron.sh --app SolidityNode --net mainnet --trust-node 127.0.0.1:50051 --rpc-port 50041
+bash deploy_tron.sh --app FullNode
+bash deploy_tron.sh --app SolidityNode --rpc-port 50041
 ```
 
 ## Deployment of grpc gateway

README_CN.md

@@ -38,12 +38,6 @@ wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy
 # 这里自己指定SolidityNode的trust-node的gRPC服务的ip和端口号
 bash deploy_tron.sh --app SolidityNode --net mainnet --trust-node <grpc-ip:grpc-port>
 ```
-### 单独启动私有链FullNode（仅仅运行一个产块节点）
-
-```shell
-wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/deploy_tron.sh -O deploy_tron.sh
-bash deploy_tron.sh --app FullNode --branch develop --net privatenet
-```
 
 ### 启动主网FullNode和SolidityNode在同一台机器
 

check-machine-config.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/Benchmark.jar -O Benchmark.jar
+java -jar Benchmark.jar
+
+if [ $? == 1 ]; then
+ echo "-----------------------------------------------------"
+ echo "--------------------FAIL RESULT----------------------"
+ echo "Start fail! Please upgrade server configuration."
+ echo "CPU needs at least 16 cores"
+ echo "Memory needs at least 30GB"
+ echo "Java MUST be oracle jdk, and version >= 1.8"
+ echo "-----------------------------------------------------" 
+ exit 1
+fi

deploy_tron.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+
+# default config
 APP="FullNode"
 PROJECT="java-tron"
 WORK_SPACE=$PWD
@@ -8,6 +10,9 @@ DB="keep"
 RPC_PORT=50051
 TRUST_NODE="127.0.0.1:50051"
 
+# compute default heap size
+# total=`cat /proc/meminfo  |grep MemTotal |awk -F ' ' '{print $2}'`
+# HEAP_SIZE=`echo "$total/1024/1024*0.8" | bc |awk -F. '{print $1"g"}'`
 
 
 while [ -n "$1" ] ;do
@@ -18,11 +23,11 @@ while [ -n "$1" ] ;do
             ;;
         --app)
             APP=$2
-            shift 2 
+            shift 2
             ;;
         --db)
             DB=$2
-            shift 2 
+            shift 2
             ;;
         --work_space)
             WORK_SPACE=$2
@@ -44,23 +49,34 @@ while [ -n "$1" ] ;do
             RPC_PORT=$2
             shift 2
             ;;
+        --heap-size)
+                  HEAP_SIZE=$2
+                  shift 2
+                  ;;
         *)
             ;;
     esac
 done
 
-if [ $APP == "Witness" ]; then
-  JAR_NAME="FullNode"
-else
-  JAR_NAME=$APP
+
+if [ -z $HEAP_SIZE ]; then
+        if [ "$(uname)" == "Darwin" ]; then
+      total=`top -l 1 | head -n 10 | grep PhysMem | awk -F " " '{a=substr($2,0,length($2)-1);b=substr($6,0,length($6)-1);if(match($2,/[0-9]+G/)) a=a*1024;if(match($6,/[0-9]+G/)) b=b*1024;print a+b}'`
+      HEAP_SIZE=`echo "$total/1024*0.8" | bc |awk -F. '{print $1"g"}'`
+  elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+      total=`cat /proc/meminfo  |grep MemTotal |awk -F ' ' '{print $2}'`
+      HEAP_SIZE=`echo "$total/1024/1024*0.8" | bc |awk -F. '{print $1"g"}'`
+  fi
 fi
 
+JAR_NAME=$APP
+
 BIN_PATH="$WORK_SPACE/$APP"
 
 
 CONF_PATH=""
 
-echo 'download code from git repositorie'
+echo 'download code from git repository'
 if [ ! -e $BIN_PATH ]; then
   mkdir -p $BIN_PATH
   cd $BIN_PATH
@@ -70,20 +86,17 @@ fi
 cd $BIN_PATH
 if [ $NET == "mainnet" ]; then
   wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/main_net_config.conf -O main_net_config.conf
+  RELEASE=`curl --silent "https://api.github.com/repos/tronprotocol/java-tron/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/'`
   CONF_PATH=$BIN_PATH/main_net_config.conf
 elif [ $NET == "testnet" ]; then
   wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/test_net_config.conf -O test_net_config.conf
-  BRANCH="develop"
   CONF_PATH=$BIN_PATH/test_net_config.conf
-elif [ $NET == "privatenet" ]; then
-  wget https://raw.githubusercontent.com/tronprotocol/TronDeployment/master/private_net_config.conf -O private_net_config.conf
-  CONF_PATH=$BIN_PATH/private_net_config.conf
 fi
 
 if [ -n $RPC_PORT ]; then
   sed "s/port = 50051/port = $RPC_PORT/g" $CONF_PATH > tmp
   cat tmp > $CONF_PATH
-fi 
+fi
 # checkout branch or commitid
 if [ -n  "$BRANCH" ]; then
   cd $BIN_PATH/$PROJECT && git fetch && git checkout $BRANCH;  git reset --hard origin/$BRANCH
@@ -93,6 +106,11 @@ if [ -n "$COMMITID" ]; then
   cd $BIN_PATH/$PROJECT && git fetch && git checkout $COMMITID
 fi
 
+if [ -n "$RELEASE" ]; then
+  cd $BIN_PATH/$PROJECT && git fetch && git checkout tags/$RELEASE -b release
+  BRANCH='release'
+fi
+
 if [ $DB == "remove" ]; then
   rm -rf $BIN_PATH/output-directory
   echo "remove db success"
@@ -112,50 +130,50 @@ elif [ $APP == "FullNode" ]; then
   START_OPT=""
 fi
 
+JVM_OPT="-Xmx$HEAP_SIZE -XX:+HeapDumpOnOutOfMemoryError"
+
 count=1
-while [ $count -le 60 ]; do
+while [ $count -le 360 ]; do
   pid=`ps -ef |grep  $JAR_NAME.jar | grep java | grep -v grep |awk '{print $2}'`
   if [ -n "$pid" ]; then
     kill -15 $pid
     echo "kill -15 java-tron, counter $count"
-    sleep 1
+    sleep 5
   else
     echo "$APP killed"
     break
   fi
   count=$[$count+1]
-  if [ $count -ge 60 ]; then
-    kill -9 $pid
+  if [ $count -ge 360 ]; then
+    echo "deploy failure because of kill process fails!"
+    exit 1
   fi
 done
 
 echo "starting $APP"
 cd $BIN_PATH
-if [ $NET == "mainnet" ]; then
-  nohup java -jar "$JAR_NAME.jar" $START_OPT -c $CONF_PATH  >> start.log 2>&1 &
-  echo "process : nohup java -jar $JAR_NAME.jar $START_OPT -c $CONF_PATH  >> start.log 2>&1 &"
-elif [ $NET == "testnet" ]; then
-  nohup java -jar "$JAR_NAME.jar" $START_OPT -c $CONF_PATH  >> start.log 2>&1 &
-  echo "process : nohup java -jar $JAR_NAME.jar $START_OPT -c $CONF_PATH  >> start.log 2>&1 &"
-elif [ $NET == "privatenet" ]; then
-  nohup java -jar "$JAR_NAME.jar" $START_OPT -c $CONF_PATH  --witness>> start.log 2>&1 &
-  echo "process : nohup java -jar $JAR_NAME.jar $START_OPT -c $CONF_PATH --witness >> start.log 2>&1 &"
-fi
 
+nohup java $JVM_OPT -jar $JAR_NAME.jar -c $CONF_PATH $START_OPT >> start.log 2>&1 &
 
 pid=`ps ax |grep $JAR_NAME.jar |grep -v grep | awk '{print $1}'`
 echo $pid
 
-echo "application : $APP"
-echo "pid : $pid"
-echo "tron net : $NET"
+if [ -z $pid ]; then
+        echo "run $JAR_NAME failed, please check your parameters"
+        exit 2
+fi
 
-echo "deploy path : $BIN_PATH"
+echo "process    : nohup java $JVM_OPT -jar $JAR_NAME.jar $START_OPT -c $CONF_PATH  >> start.log 2>&1 &"
+echo "pid        : $pid"
+echo "application: $APP"
+echo "tron net   : $NET"
+echo "deploy path: $BIN_PATH"
 echo "git commit : "`cd $BIN_PATH/$PROJECT; git rev-parse HEAD`
 echo "git branch : $BRANCH"
-echo "db path : $BIN_PATH/output-directory"
-echo "log path : $BIN_PATH/logs"
-echo "grpc port : $RPC_PORT"
+echo "db path    : $BIN_PATH/output-directory"
+echo "log path   : $BIN_PATH/logs"
+echo "heap-size  : $HEAP_SIZE"
+echo "grpc port  : $RPC_PORT"
 if [ $APP == "SolidityNode" ]; then
-  echo "trust-node : $TRUST_NODE"
+        echo "trust-node : $TRUST_NODE"
 fi

how_to_config.txt

@@ -0,0 +1 @@
+### This document is used to explain the features of configuration items in the *.conf file and help you understand how to use them.