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 70482605c4 Update coordinator to work better under real net 3 years ago
.github/workflows Rm unused ETHCLIENT_DIAL_URL 4 years ago
api Set l1tx.EffectiveFromIdx in TxProcessor and til 4 years ago
apitypes mv of babyjub.PublicKey to babyjub.PublicKeyComp 4 years ago
batchbuilder Add circuit configuration to node config 4 years ago
cli/node Update coordinator to work better under real net 3 years ago
common Set l1tx.EffectiveFromIdx in TxProcessor and til 4 years ago
config Fix forging L1Batch too early 4 years ago
coordinator Update coordinator to work better under real net 3 years ago
db Update coordinator to work better under real net 3 years ago
eth Update coordinator to work better under real net 3 years ago
log Add opt to disable print logs but storing to file 4 years ago
node Update coordinator to work better under real net 3 years ago
priceupdater Add missing tracerr.Wrap 4 years ago
prover Fix ChainID in zkInputs empty TxCmpData 4 years ago
synchronizer Update coordinator to work better under real net 3 years ago
test Update coordinator to work better under real net 3 years ago
txprocessor Set l1tx.EffectiveFromIdx in TxProcessor and til 4 years ago
txselector Abstract txs generation for ZKInputs tests 4 years ago
.gitignore Implement first iteration of node 4 years ago
README.md Document that /tmp should be mounted as tmpfs 4 years ago
go.mod Update coordinator to work better under real net 3 years ago
go.sum Update coordinator to work better under real net 3 years ago

README.md

hermez-node Go Report Card Test Status Lint Status GoDoc

Go implementation of the Hermez node.

Test

  • First run a docker instance of the PostgresSQL (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
  • Then, 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 temporal option that allows to run the API server through the Go tests. This should 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

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 Details

/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