From 9983b65505354300d1c12e341104ddba1ce894d8 Mon Sep 17 00:00:00 2001 From: Richard Ramos Date: Thu, 16 May 2024 19:22:32 -0400 Subject: [PATCH] chore: add readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..dac26f1 --- /dev/null +++ b/README.md @@ -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 +``` \ No newline at end of file