Skip to content

Commit

Permalink
Merge enhancement/readme-completion of pull request #102 into master
Browse files Browse the repository at this point in the history
Complete `README.md`
  • Loading branch information
jeltsch committed Jan 22, 2024
2 parents 78a3e59 + c117942 commit 122cd03
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
Overview
========

[]
The `ouroboros-high-assurance` library contains formalizations related
to the Ouroboros family of blockchain consensus protocols. Concretely,
it comprises the following:

* A proof of the chain selection property
* Draft specifications of the following consensus protocols, using the
[Þ-calculus][thorn-calculus]:
- [Ouroboros BFT][ouroboros-bft]
- [Ouroboros Praos][ouroboros-praos]
* A specification of the Chain-Sync mini-protocol, using the
Þ-calculus
* A framework for specifying [mini-protocols][networking-protocol]
* Specifications of the following mini-protocols, using the
above-mentioned framework:
- Chain-Sync
- Ping-Pong
- Request-Response

[thorn-calculus]:
https://github.com/input-output-hk/thorn-calculus
"A general-purpose process calculus with support for arbitrary data"
[ouroboros-bft]:
https://iohk.io/en/research/library/papers/ouroboros-bft-a-simple-byzantine-fault-tolerant-consensus-protocol/
"Ouroboros-BFT: A Simple Byzantine Fault Tolerant Consensus Protocol"
[ouroboros-praos]:
https://iohk.io/en/research/library/papers/ouroboros-praos-an-adaptively-secure-semi-synchronous-proof-of-stake-protocol/
"Ouroboros Praos: An Adaptively-Secure, Semi-Synchronous Proof-of-Stake Protocol"
[networking-protocol]:
https://ouroboros-network.cardano.intersectmbo.org/pdfs/network-spec
"The Shelley Networking Protocol"


Requirements
Expand All @@ -14,6 +43,11 @@ Isabelle2022 from the [Isabelle website][isabelle].
https://isabelle.in.tum.de/
"Isabelle"

In addition, you need the following Isabelle sessions:

* [`Finite-Map-Extras`](https://www.isa-afp.org/entries/Finite-Map-Extras.html)
* [`Thorn_Calculus`](https://github.com/input-output-hk/thorn-calculus)


Setup
=====
Expand Down

0 comments on commit 122cd03

Please sign in to comment.