hotstuff

package module

v0.3.1 Latest Latest Go to latest Published: Aug 29, 2021 License: MIT Imports: 1 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/relab/hotstuff

Links

Open Source Insights

README ¶

hotstuff

relab/hotstuff is a framework for experimenting with HotStuff and similar consensus protocols. It provides a set of modules and interfaces that make it easy to test different algorithms. It also provides a tool for deploying and running experiments on multiple servers via SSH.

Build Dependencies

Go (at least version 1.16)
Protobuf compiler
Make

Getting Started

Install required go tools by running make tools.
Compile command line utilities by running make.

Running Experiments

The hotstuff command line utility can be used to run experiments locally, or on remote servers using SSH. For a list of options, run ./hotstuff help run.

The plot command line utility can be used to create graphs from measurements. Run ./plot --help for a list of options.

Modules

The following components are modular:

Consensus
- The "core" of the consensus protocol, which decides when a replica should vote for a proposal, and when a block should be committed.
- 3 implementations:
  - chainedhotstuff: The three-phase pipelined HotStuff protocol presented in the HotStuff paper [1].
  - fasthotstuff: A two-chain version of HotStuff designed to prevent forking attacks [3].
  - simplehotstuff: A simplified version of chainedhotstuff [4].
Crypto
- Implements the cryptographic primitives used by HotStuff, namely quorum certificates.
- 2 implementations:
  - ecdsa: A very simple implementation where quorum certificates are represented by arrays of ECDSA signatures.
  - bls12: An implementation of threshold signatures based on BLS12-381 aggregated signatures.
Synchronizer
- Implements a view-synchronization algorithm. It is responsible for synchronizing replicas to the same view number.
- Current implementation based on DiemBFT's RoundState [5].
Blockchain
- Implements storage for the block chain. Currently we have an in-memory cache of a fixed size.
Leader rotation
- Decides which replica should be the leader of a view.
- Currently either a fixed leader or round-robin.
Networking/Backend
- Using Gorums [2]

These modules are designed to be interchangeable and simple to implement. It is also possible to add custom modules that can interact with the modules we listed above.

Consensus Interfaces

There are two ways to implement a new consensus protocol, depending on the requirements of the new protocol. The Consensus module interface is the most general, but also the most difficult to implement. That is because it is oriented towards the other modules, and the other modules rely on it to perform certain operations, such as verifying proposals, interacting with the BlockChain, Acceptor, Executor, and Synchronizer modules, and so on. That is why we provide a simplified Rules interface and the optional ProposeRuler interface. These interfaces are only required to implement the core rules of the consensus protocol, namely deciding whether or not to vote for a proposal, whether or not it is safe to commit a block, and optionally how to create new blocks. These interfaces do not require any interaction with other modules, as that is taken care of by a default implementation of the Consensus interface.

The Consensus and Rules interfaces can also be used to override the behavior of other consensus implementations. The consensus/byzantine package contains some examples of byzantine behaviors that can be implemented by wrapping implementations of these interfaces.

Crypto Interfaces

In a similar way to the Consensus interface, the Crypto interface also introduces a simplified, lower-level interface that should be used to implement new crypto algorithms. The Crypto interface itself provides methods for working with the high-level structures such as quorum certificates. However, to make it easy to implement new crypto algorithms, the CryptoImpl interface can be used instead. This interface deals with signatures and threshold signatures directly, which are used by the Crypto interface to implement quorum certificates.

References

[1] M. Yin, D. Malkhi, M. K. Reiter, G. Golan Gueta, and I. Abraham, “HotStuff: BFT Consensus in the Lens of Blockchain,” Mar 2018.

[2] Tormod Erevik Lea, Leander Jehl, and Hein Meling. Towards New Abstractions for Implementing Quorum-based Systems. In 37th International Conference on Distributed Computing Systems (ICDCS), Jun 2017.

[3] Mohammad M. Jalalzai, Jianyu Niu, Chen Feng, Fangyu Gai. Fast-HotStuff: A Fast and Resilient HotStuff Protocol, Oct 2020.

[4] Leander Jehl. Formal Verification of HotStuff, Jun 2021.

[5] Baudet, Mathieu, et al. "State machine replication in the libra blockchain." The Libra Assn., Tech. Rep (2019).

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NumFaulty ¶ added in v0.3.0

func NumFaulty(n int) int

NumFaulty calculates 'f', which is the number of replicas that can be faulty for a configuration of size 'n'.

func QuorumSize ¶ added in v0.3.0

func QuorumSize(n int) int

QuorumSize calculates '2f + 1', which is the quorum size for a configuration of size 'n'.

Types ¶

type ID ¶ added in v0.2.0

type ID uint32

ID uniquely identifies a replica

func (ID) ToBytes ¶ added in v0.3.0

func (id ID) ToBytes() []byte

ToBytes returns the ID as bytes.

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
backend
gorums Package gorums implements a networking backend for HotStuff using the gorums framework.	Package gorums implements a networking backend for HotStuff using the gorums framework.
blockchain Package blockchain provides an implementation of the consensus.BlockChain interface.	Package blockchain provides an implementation of the consensus.BlockChain interface.
client Package client implements a simple client for testing HotStuff.	Package client implements a simple client for testing HotStuff.
cmd
hotstuff
plot
config Package config contains structs that are useful for initializing consensus.	Package config contains structs that are useful for initializing consensus.
consensus Package consensus defines the types and interfaces that are used to implement consensus.	Package consensus defines the types and interfaces that are used to implement consensus.
byzantine Package byzantine contiains byzantine behaviors that can be applied to the consensus protocols.	Package byzantine contiains byzantine behaviors that can be applied to the consensus protocols.
chainedhotstuff Package chainedhotstuff implements the pipelined three-chain version of the HotStuff protocol.	Package chainedhotstuff implements the pipelined three-chain version of the HotStuff protocol.
fasthotstuff Package fasthotstuff implements the two-chain Fast-HotStuff protocol.	Package fasthotstuff implements the two-chain Fast-HotStuff protocol.
simplehotstuff Package simplehotstuff implements a simplified version of the three-chain HotStuff protocol.	Package simplehotstuff implements a simplified version of the three-chain HotStuff protocol.
crypto Package crypto provides implementations of the Crypto interface.	Package crypto provides implementations of the Crypto interface.
bls12 Package bls12 implements the crypto primitives used by HotStuff using curve BLS12-381.	Package bls12 implements the crypto primitives used by HotStuff using curve BLS12-381.
ecdsa Package ecdsa provides a crypto implementation for HotStuff using Go's 'crypto/ecdsa' package.	Package ecdsa provides a crypto implementation for HotStuff using Go's 'crypto/ecdsa' package.
keygen Package keygen provides helper methods for generating, serializing, and deserializing public keys, private keys and certificates.	Package keygen provides helper methods for generating, serializing, and deserializing public keys, private keys and certificates.
eventloop Package eventloop provides an event loop which is widely used by modules.	Package eventloop provides an event loop which is widely used by modules.
internal
cli
logging
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
orchestration Package orchestration implements deployment and orchestration of hotstuff replicas and clients on remote hosts.	Package orchestration implements deployment and orchestration of hotstuff replicas and clients on remote hosts.
profiling Package profiling provides helpers for using various profilers.	Package profiling provides helpers for using various profilers.
proto/clientpb
proto/hotstuffpb
proto/orchestrationpb
protostream Package protostream implements reading and writing of protobuf messages to data streams.	Package protostream implements reading and writing of protobuf messages to data streams.
testutil Package testutil provides helper methods that are useful for implementing tests.	Package testutil provides helper methods that are useful for implementing tests.
leaderrotation
metrics Package metrics contains modules that collect data or metrics from other modules.	Package metrics contains modules that collect data or metrics from other modules.
plotting Package plotting provides functions and structures for plotting measurement data collected from running an experiment.	Package plotting provides functions and structures for plotting measurement data collected from running an experiment.
types
modules Package modules contains the base of the module system used in the hotstuff project.	Package modules contains the base of the module system used in the hotstuff project.
replica Package replica provides the required code for starting and running a replica and handling client requests.	Package replica provides the required code for starting and running a replica and handling client requests.
synchronizer