chore: add readme

This commit is contained in:
Richard Ramos 2024-05-16 19:22:32 -04:00
parent e66441b027
commit 9983b65505
No known key found for this signature in database
GPG Key ID: 1CE87DB518195760
1 changed files with 24 additions and 0 deletions

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# Storenode Message Counter
used to compare the number of Status messages across Status nodes to understand the potential discrepancies and odd behaviour of messages being inserted in the past in a given pubsub topic.
# Development
You need to setup a postgres db as such:
1) Create an user with a password
2) Create a db
3) Execute `make build`
Then you can run the program with
```
./build/storeverif --storenode=some_multiaddress --storenode=some_multiaddress --pubsub-topic=some_pubsubtopic --cluster-id=16 --db-url=postgres://user:password@127.0.0.1:5432/telemetry
```
A dockerfile is also available for ease of setup
```
docker build -t wakuorg/storenode-messages:latest .
docker run wakuorg/storenode-messages:latest --help
```