From 1e086b63e8698b832bfe86e0dc8ea6e36c62f051 Mon Sep 17 00:00:00 2001 From: Raul Jordan Date: Fri, 13 Sep 2019 12:03:14 -0500 Subject: [PATCH] Add Fork Choice Package Docs (#3463) --- beacon-chain/blockchain/forkchoice/doc.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/beacon-chain/blockchain/forkchoice/doc.go b/beacon-chain/blockchain/forkchoice/doc.go index 0db126384..e4841b72c 100644 --- a/beacon-chain/blockchain/forkchoice/doc.go +++ b/beacon-chain/blockchain/forkchoice/doc.go @@ -1,4 +1,9 @@ /* -Package forkchoice TODO(3219): Add details on how this forkchoice service works. +Package forkchoice implements the Latest Message Driven GHOST (Greediest Heaviest Observed +Sub-Tree) algorithm as the Ethereum Serenity beacon chain fork choice rule. This algorithm is designed to +properly detect the canonical chain based on validator votes even in the presence of high network +latency, network partitions, and many conflicting blocks. To read more about fork choice, read the +official accompanying document: +https://github.com/ethereum/eth2.0-specs/blob/v0.8.3/specs/core/0_fork-choice.md */ package forkchoice