You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Eduard S e460a7e58b
Merge pull request #608 from hermeznetwork/feature/txprocessor-doc
3 years ago
.github/workflows Add action to trigger tests in integration-testing 3 years ago
api Add forge delay to api get state 3 years ago
apitypes mv of babyjub.PublicKey to babyjub.PublicKeyComp 3 years ago
batchbuilder Add lll to linter checks 3 years ago
cli/node Update example config with working values 3 years ago
common Extend TxProcessor documentation and explanation 3 years ago
config check the forge address balance before starting the node 3 years ago
coordinator Merge pull request #603 from hermeznetwork/feature/update-linter-lll 3 years ago
db Merge pull request #603 from hermeznetwork/feature/update-linter-lll 3 years ago
eth Add lll to linter checks 3 years ago
log Fix TxSel sorting, TxManager geth err checking 3 years ago
node Add lll to linter checks 3 years ago
priceupdater Add lll to linter checks 3 years ago
prover Add lll to linter checks 3 years ago
synchronizer Add lll to linter checks 3 years ago
test Add lll to linter checks 3 years ago
txprocessor Extend TxProcessor documentation and explanation 3 years ago
txselector Add lll to linter checks 3 years ago
.gitignore Implement first iteration of node 4 years ago
README.md Add Prometheus initial setup 3 years ago
go.mod Add Prometheus initial setup 3 years ago
go.sum Add Prometheus initial setup 3 years ago

README.md

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

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

See cli/node/README.md

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