arnaucube/hermez-node
1
0
Fork 0
mirror of https://github.com/arnaucube/hermez-node.git synced 2026-02-06 19:06:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Eduard S
2021-02-01 12:21:17 +01:00
parent 7559991f7f
commit 49610330c4
2 changed files with 102 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
cli/node/README.md
View File

@@ -16,6 +16,7 @@ VERSION:
COMMANDS:
importkey Import ethereum private key
genbjj Generate a new BabyJubJub key
wipesql Wipe the SQL DB (HistoryDB and L2DB), leaving the DB in a clean state
run Run the hermez-node in the indicated mode
help, h Shows a list of commands or help for one command
@@ -27,11 +28,66 @@ GLOBAL OPTIONS:
--version, -v print the version (default: false)
```
The node has two main modes of running:
- `sync`: Synchronizer mode. In this mode the node will only synchronize the
state of the hermez smart contracts, mainly processing the transactions in
the batches.
- `coord`: Coordinator mode. In this mode, apart from doing all the
synchronization work, the node will also act as a coordinator, accepting L2
transactions in the pool, and trying to forge batches when the proper
conditions arise.
## Configuration
The node requires a single configuration file to run.
You can find a testing working configuration example at
[cfg.buidler.toml](./cfg.buidler.toml)
To read the documentation of each configuration parameter, please check the
`type Node` and `type Coordinator` at
[config/config.go](../../config/config.go)
[config/config.go](../../config/config.go). All the sections that are prefixed
with `Coordinator` are only used in coord mode, and don't need to be defined
when running the coordinator in sync mode
### Notes
- The private key corresponding to the parameter `Coordinator.ForgerAddress` needs to be imported in the ethereum keystore
- The private key corresponding to the parameter `Coordinator.FeeAccount.Address` needs to be imported in the ethereum keystore
- The public key corresponding to the parameter `Coordinator.FeeAccount.BJJ` can be generated with the command `genbjj`
- There are two sets of debug parameters (`Debug` for all modes, and
`Coordinator.Debug` for `coord` mode). Some of these parameters may not be
suitable for production.
- The parameter `Coordinator.Debug.BatchPath`, when set, causes the coordinator
to store dumps of a lot of information related to batches in json files.
This files can be around 2MB big. If this parameter is set, be careful to
monitor the size of the folder to avoid running out of space.
- The node requires a PostgreSQL database. The parameters of the server and
database must be set in the `PostgreSQL` section.
## Usage Examples
Run the node in mode synchronizer:
```
go run . --mode sync --cfg cfg.buidler.toml run
```
Run the node in mode coordinator:
```
go run . --mode coord --cfg cfg.buidler.toml run
```
Import an ethereum private key into the keystore:
```
go run . --mode coord --cfg cfg.buidler.toml importkey --privatekey 0x618b35096c477aab18b11a752be619f0023a539bb02dd6c813477a6211916cde
```
Generate a new BabyJubJub key pair:
```
go run . --mode coord --cfg cfg.buidler.toml genbjj
```
Wipe the entier SQL database (this will destroy all synchronized and pool data):
```
go run . --mode coord --cfg cfg.buidler.toml wipesql
```