arnaucube 6f1a44df02 TxSel avoid L1CoordTx for L2Tx that have a L1UserTx in the frozen queue
For the L2Txs of TransferToEthAddr & TransferToBJJ for a not-yet
existing accounts, in the TxSelector check if L2Tx receiver account will
be created by a L1UserFrozenTxs (in the next batch, the current frozen
queue). In that case, the L2Tx will be discarded at the current batch,
even if there is an AccountCreationAuth for the account, as there is a
L1UserTx in the frozen queue that will create the receiver Account.  The
L2Tx is discarded to avoid the Coordinator creating a new
L1CoordinatorTx to create the receiver account, which will be also
created in the next batch from the L1UserFrozenTx, ending with the user
having 2 different accounts for the same TokenID.
The double account creation is supported by the Hermez zkRollup
specification, but it was decided to mitigate it at the TxSelector level
for the explained cases.
2021-03-31 13:02:51 +02:00
2021-03-01 18:02:10 +01:00
2021-03-04 18:26:00 -03:00
2021-03-22 09:26:58 -03:00

hermez-node Go Report Card Test Status Lint Status GoDoc

Go implementation of the Hermez node.

Developing

Go version

The hermez-node has been tested with go version 1.14

Build

Build the binary and check the current version:

$ make build
$ bin/node version

Run

First you must edit the default/template config file into cli/node/cfg.buidler.toml, there are more information about the config file into cli/node/README.md

After setting the config, you can build and run the Hermez Node as a synchronizer:

$ make run-node

Or build and run as a coordinator, and also passing the config file from other location:

$ MODE=sync CONFIG=cli/node/cfg.buidler.toml make run-node

To check the useful make commands:

$ make help

Unit testing

Running the unit tests requires a connection to a PostgreSQL database. You can run PostgreSQL with docker easily this way (where yourpasswordhere should be your password):

$ POSTGRES_PASS="yourpasswordhere" make run-database-container

Afterward, run the tests with the password as env var:

$ POSTGRES_PASS="yourpasswordhere" make test

NOTE: -p 1 forces execution of package test in serial. Otherwise, they may be executed in parallel, and the test may find unexpected entries in the SQL database because it's shared among all tests.

There is an extra temporary option that allows you to run the API server using the Go tests. It will be removed once the API can be properly initialized with data from the synchronizer. To use this, run:

$ POSTGRES_PASS="yourpasswordhere" make test-api-server

Lint

All Pull Requests need to pass the configured linter.

To run the linter locally, first, install golangci-lint.
Afterward, you can check the lints with this command:

$ make gocilint

Usage

Node

See cli/node/README.md

Proof Server

The node in mode coordinator requires a proof server (a server capable of calculating proofs from the zkInputs). There is a mock proof server CLI at test/proofserver/cli for testing purposes.

Usage of test/proofserver/cli:

USAGE:
    go run ./test/proofserver/cli OPTIONS

OPTIONS:
  -a string
        listen address (default "localhost:3000")
  -d duration
        proving time duration (default 2s)

Also, the Makefile commands can be used to run and stop the proof server in the background:

$ make run-proof-mock
$ make stop-proof-mock

/tmp as tmpfs

For every processed batch, the node builds a temporary exit tree in a key-value DB stored in /tmp. It is highly recommended that /tmp is mounted as a RAM file system in production to avoid unnecessary reads a writes to disk. This can be done by mounting /tmp as tmpfs; for example, by having this line in /etc/fstab:

tmpfs			/tmp		tmpfs		defaults,noatime,mode=1777	0 0
Description
No description provided
Readme AGPL-3.0 2.8 MiB
Languages
Go 98.6%
PLpgSQL 1.1%
Makefile 0.2%