From ee8da3a019e57b8a07e08579dfb91857087da095 Mon Sep 17 00:00:00 2001 From: Dave Hrycyszyn Date: Tue, 28 Jan 2020 12:47:16 +0000 Subject: [PATCH] validator: starting a README so docs will be easier to write when we switch from Go --- validator/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 validator/README.md diff --git a/validator/README.md b/validator/README.md new file mode 100644 index 0000000000..3f6dcb7b2a --- /dev/null +++ b/validator/README.md @@ -0,0 +1,18 @@ +Nym Validator +============= + +The Nym Validator has several jobs: + +* use Tendermint (v0.33.0) to maintain a total global ordering of incoming transactions +* track quality of service for mixnet nodes (mixmining) +* generate Coconut credentials and ensure they're not double spent +* maintain a decentralized directory of all Nym nodes that have staked into the system + +Some of these functions may be moved away to their own node types in the future, for example to increase scalability or performance. At the moment, we'd like to keep deployments simple, so they're all in the validator node. + +Running the validator +--------------------- + +1. Download and install [Tendermint 0.33.0](https://github.com/tendermint/tendermint/releases/tag/v0.33.0) +2. `tendermint init` +3. `tendermint run` \ No newline at end of file