From b4d10b5b91069a8e930b2b135bb7cd5709b4a2ca Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Wed, 23 May 2018 09:41:54 -0400 Subject: [PATCH] consensus: link to spec from readme (#1609) --- consensus/README.md | 19 +------------------ 1 file changed, 1 insertion(+), 18 deletions(-) diff --git a/consensus/README.md b/consensus/README.md index 182e30bfa..8afaa0814 100644 --- a/consensus/README.md +++ b/consensus/README.md @@ -1,18 +1 @@ -# The core consensus algorithm. - -* state.go - The state machine as detailed in the whitepaper -* reactor.go - A reactor that connects the state machine to the gossip network - -# Go-routine summary - -The reactor runs 2 go-routines for each added peer: gossipDataRoutine and gossipVotesRoutine. - -The consensus state runs two persistent go-routines: timeoutRoutine and receiveRoutine. -Go-routines are also started to trigger timeouts and to avoid blocking when the internalMsgQueue is really backed up. - -# Replay/WAL - -A write-ahead log is used to record all messages processed by the receiveRoutine, -which amounts to all inputs to the consensus state machine: -messages from peers, messages from ourselves, and timeouts. -They can be played back deterministically at startup or using the replay console. +See the [consensus spec](https://github.com/tendermint/tendermint/tree/master/docs/spec/consensus)