You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+57-25Lines changed: 57 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -63,48 +63,73 @@ TRON is a project dedicated to building the infrastructure for a truly decentral
63
63
TRON enables large-scale development and engagement. With over 2000 transactions per second (TPS), high concurrency, low latency, and massive data transmission. It is ideal for building decentralized entertainment applications. Free features and incentive systems allow developers to create premium app experiences for users.
64
64
65
65
# Building the source
66
-
Building java-tron requires `git` and `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. It is recommended to operate on `Linux` and `OSX` operating systems.
66
+
Building java-tron requires `git` and `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
then run the following command to build java-tron, the `FullNode.jar` file can be found in `java-tron/build/libs/` after build successful.
77
76
```bash
78
-
$ cd java-tron
79
77
$ ./gradlew clean build -x test
80
78
```
81
79
82
-
The `FullNode.jar` file can be found in `java-tron/build/libs/FullNode.jar` after build successful.
83
80
84
81
# Running java-tron
82
+
Running java-tron requires `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
85
83
86
84
Get the mainnet configurate file: [main_net_config.conf](https://github.com/tronprotocol/tron-deployment/blob/master/main_net_config.conf), other network configuration files can be find [here](https://github.com/tronprotocol/tron-deployment).
85
+
## Hardware Requirements
86
+
Minimum:
87
+
* CPU with 8 cores
88
+
* 16GB RAM
89
+
* 1TB free storage space to sync the Mainnet
87
90
91
+
Recommended:
92
+
* CPU with 16+ cores(32+ cores for a super representative)
93
+
* 32GB+ RAM(64GB+ for a super representative)
94
+
* High Performance SSD with at least 1.5TB free space
95
+
* 100+ MB/s download Internet service
88
96
89
-
***Running a full node for mainnet**
90
-
Full node has full historical data, it is the entry point into the TRON network , it can be used by other processes as a gateway into the TRON network via HTTP and GRPC endpoints. You can interact with the TRON network through full node:transfer assets, deploy contracts, interact with contracts and so on. `-c ` parameter specifies a configuration file to run a full node:
97
+
98
+
## Running a full node for mainnet
99
+
Full node has full historical data, it is the entry point into the TRON network , it can be used by other processes as a gateway into the TRON network via HTTP and GRPC endpoints. You can interact with the TRON network through full node:transfer assets, deploy contracts, interact with contracts and so on. `-c ` parameter specifies a configuration file to run a full node:
***Running a super representative node for mainnet**
95
-
Adding the `--witness` parameter to the startup command, full node will run as a super representative node. The super representative node supports all the functions of the full node and also supports block production. Before running, make sure you have a super representative account and get votes from others,once the number of obtained votes ranks in the top 27, your super representative node will participate in block production.
111
+
## Running a super representative node for mainnet
112
+
Adding the `--witness` parameter to the startup command, full node will run as a super representative node. The super representative node supports all the functions of the full node and also supports block production. Before running, make sure you have a super representative account and get votes from others,once the number of obtained votes ranks in the top 27, your super representative node will participate in block production.
96
113
97
-
Fill in the private key of super representative address into the `localwitness` list in the `main_net_config.conf`, here is an example:
114
+
Fill in the private key of super representative address into the `localwitness` list in the `main_net_config.conf`, here is an example:
An easier way to build and run java-tron is to use `start.sh`, `start.sh` is a quick start script written in shell language, you can use it to build and run java-tron quickly and easily.
@@ -116,16 +141,16 @@ Here are some common use cases of the scripting tool
116
141
117
142
For more details, please refer to the tool [guide](./shell.md).
118
143
119
-
## Run inside Docker container
144
+
## Run inside Docker container
120
145
121
146
One of the quickest ways to get `java-tron` up and running on your machine is by using Docker:
This will mount the `output-directory` and `logs` directories on the host, the docker.sh tool can also be used to simplify the use of docker, see more [here](docker/docker.md).
@@ -138,9 +163,8 @@ This will mount the `output-directory` and `logs` directories on the host, the d
138
163
[tronprotocol/allcoredev](https://gitter.im/tronprotocol/allcoredev) is the official Gitter channel for developers.
139
164
140
165
# Contribution
141
-
If you'd like to contribute to java-tron, please read the following instructions.
166
+
Thank you for considering to help out with the source code! If you'd like to contribute to java-tron, please see the [Contribution Guide](./CONTRIBUTING.md) for more details.
142
167
143
-
- [Contribution](./CONTRIBUTING.md)
144
168
145
169
# Resources
146
170
*[Medium](https://medium.com/@coredevs) java-tron's official technical articles are published there.
@@ -153,3 +177,11 @@ If you'd like to contribute to java-tron, please read the following instructions
153
177
154
178
# License
155
179
java-tron is released under the [LGPLv3 license](https://github.com/tronprotocol/java-tron/blob/master/LICENSE).
180
+
181
+
182
+
183
+
The minimum hardware requirements are `CPU with 8 cores`,`16GB RAM` and `1TB free storage space` to sync the Mainnet, the recommended hardware requirements:
184
+
* CPU with 16+ cores(32+ cores for a super representative)
185
+
* 32+ GB RAM(64+ GB for a super representative)
186
+
* High Performance SSD with at least 1.5TB free space
0 commit comments