arnaucube/hermez-node
1
0
Fork 0
mirror of https://github.com/arnaucube/hermez-node.git synced 2026-02-07 19:36:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Eduard S
2021-02-01 12:21:17 +01:00
parent 7559991f7f
commit 49610330c4
2 changed files with 102 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@@ -2,36 +2,70 @@
Go implementation of the Hermez node.
## Test
## Developing
- First run a docker instance of the PostgresSQL (where `yourpasswordhere` should be your password)
### 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
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
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.
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`
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:
## Lint
```
FAKE_SERVER=yes POSTGRES_PASS=yourpasswordhere go test -timeout 0 ./api -p 1 -count 1 -v`
```
- Install [golangci-lint](https://golangci-lint.run)
- Once installed, to check the lints
### Lint
All Pull Requests need to pass the configured linter.
To run the linter locally, first install [golangci-lint](https://golangci-lint.run). 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 Details
## Usage
### Node
See [cli/node/README.md](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
@@ -43,5 +77,3 @@ can be done by mounting `/tmp` as tmpfs; for example, by having this line in
```
tmpfs /tmp tmpfs defaults,noatime,mode=1777 0 0
```