d625cc9287
- Add new command to the cli/node: `serveapi` that alows serving the API just
by connecting to the PostgreSQL database. The mode flag should me passed in
order to select whether we are connecting to a synchronizer database or a
coordinator database. If `coord` is chosen as mode, the coordinator
endpoints can be activated in order to allow inserting l2txs and
authorizations into the L2DB.
Summary of the implementation details
- New SQL table with 3 columns (plus `item_id` pk). The table only contains a
single row with `item_id` = 1. Columns:
- state: historydb.StateAPI in JSON. This is the struct that is served via
the `/state` API endpoint. The node will periodically update this struct
and store it int he DB. The api server will query it from the DB to
serve it.
- config: historydb.NodeConfig in JSON. This struct contains node
configuration parameters that the API needs to be aware of. It's updated
once every time the node starts.
- constants: historydb.Constants in JSON. This struct contains all the
hermez network constants gathered via the ethereum client by the node.
It's written once every time the node starts.
- The HistoryDB contains methods to get and update each one of these columns
individually.
- The HistoryDB contains all methods that query the DB and prepare objects that
will appear in the StateAPI endpoint.
- The configuration used in for the `serveapi` cli/node command is defined in
`config.APIServer`, and is a subset of `node.Config` in order to allow
reusing the same configuration file of the node if desired.
- A new object is introduced in the api: `StateAPIUpdater`, which contains all
the necessary information to update the StateAPI in the DB periodically by
the node.
- Moved the types `SCConsts`, `SCVariables` and `SCVariablesPtr` from
`syncrhonizer` to `common` for convenience.
hermez-node 
Go implementation of the Hermez node.
Developing
Go version
The hermez-node has been tested with go version 1.14
Unit testing
Running the unit tests requires a connection to a PostgreSQL database. You can
start PostgreSQL with docker easily this way (where yourpasswordhere should
be your password):
POSTGRES_PASS=yourpasswordhere; sudo docker run --rm --name hermez-db-test -p 5432:5432 -e POSTGRES_DB=hermez -e POSTGRES_USER=hermez -e POSTGRES_PASSWORD="$POSTGRES_PASS" -d postgres
Afterwards, run the tests with the password as env var:
POSTGRES_PASS=yourpasswordhere go test -p 1 ./...
NOTE: -p 1 forces execution of package test in serial. Otherwise they may be
executed in paralel and the test may find unexpected entries in the SQL databse
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. This will be removed once the API can be properly initialized, with data from the synchronizer and so on. To use this, run:
FAKE_SERVER=yes POSTGRES_PASS=yourpasswordhere go test -timeout 0 ./api -p 1 -count 1 -v`
Lint
All Pull Requests need to pass the configured linter.
To run the linter locally, first install golangci-lint. Afterwards you can check the lints with this command:
golangci-lint run --timeout=5m -E whitespace -E gosec -E gci -E misspell -E gomnd -E gofmt -E goimports -E golint --exclude-use-default=false --max-same-issues 0
Usage
Node
Proof Server
The node in mode coordinator requires a proof server (a server that is capable
of calculating proofs from the zkInputs). For testing purposes there is a mock
proof server cli at test/proofserver/cli.
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)
/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 unecessary reads an 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