Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete README.md #102

Merged
merged 3 commits into from
Jan 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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