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.

47 lines
2.2 KiB

4 years ago
  1. # hermez-node [![Go Report Card](https://goreportcard.com/badge/github.com/hermeznetwork/hermez-node)](https://goreportcard.com/report/github.com/hermeznetwork/hermez-node) [![Test Status](https://github.com/hermeznetwork/hermez-node/workflows/Test/badge.svg)](https://github.com/hermeznetwork/hermez-node/actions?query=workflow%3ATest) [![Lint Status](https://github.com/hermeznetwork/hermez-node/workflows/Lint/badge.svg)](https://github.com/hermeznetwork/hermez-node/actions?query=workflow%3ALint) [![GoDoc](https://godoc.org/github.com/hermeznetwork/hermez-node?status.svg)](https://godoc.org/github.com/hermeznetwork/hermez-node)
  2. Go implementation of the Hermez node.
  3. ## Test
  4. - First run a docker instance of the PostgresSQL (where `yourpasswordhere` should be your password)
  5. ```
  6. 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
  7. ```
  8. - Then, run the tests with the password as env var
  9. ```
  10. POSTGRES_PASS=yourpasswordhere go test -p 1 ./...
  11. ```
  12. NOTE: `-p 1` forces execution of package test in serial. Otherwise they may be
  13. executed in paralel and the test may find unexpected entries in the SQL
  14. databse because it's shared among all tests.
  15. - 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`
  16. ## Lint
  17. - Install [golangci-lint](https://golangci-lint.run)
  18. - Once installed, to check the lints
  19. ```
  20. 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
  21. ```
  22. ## Usage Details
  23. ### `/tmp` as tmpfs
  24. For every processed batch, the node builds a temporary exit tree in a key-value
  25. DB stored in `/tmp`. It is highly recommended that `/tmp` is mounted as a RAM
  26. file system in production to avoid unecessary reads an writes to disk. This
  27. can be done by mounting `/tmp` as tmpfs; for example, by having this line in
  28. `/etc/fstab`:
  29. ```
  30. tmpfs /tmp tmpfs defaults,noatime,mode=1777 0 0
  31. ```