Awesome

Toychain

A Coq implementation of a minimalistic blockchain-based consensus protocol.

Building the Project

Requirements

Coq definitions and proofs:

• Coq 8.9 or later
• Mathematical Components (ssreflect, 1.10)
• FCSL PCM library

Executable node:

• OCaml 4.06.0 or later
• OCamlbuild
• cryptokit
• ipaddr

Building Definitions and Proofs

We recommend installing the Coq requirements via OPAM:

opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq coq-mathcomp-ssreflect.1.10.0 coq-fcsl-pcm

Then, run make clean; make from the root folder. This will build all the libraries and check all the proofs.

Building an Executable Node

The additional OCaml dependencies for the executable node can also be installed via OPAM:

opam install ocamlbuild cryptokit ipaddr

Then, run make node from the root folder. This will produce an executable named node.native.

Project Structure

The top-level structure consists of the following folders:

• Structures - implementations of block forests and chain properties;

• Systems - definition of the protocol, its state, and network semantics;

• Properties - proved properties of the protocol, e.g., eventual consistency for a clique-like network topology;