Formal Ledger Specifications

This repository contains the formal ledger specifications that are intended to eventually replace the existing formal specifications of the Cardano ledger found here. This project is currently incomplete and work in progress.

This repository currently contains the work-in-progress specification for Cardano (up to and including the Conway era). The specification is executable and contains some documentation in the form of a PDF document. It can be built by following the steps in Building.

Formal Specification	HTML Version
Full Cardano Ledger	Ledger
Conway	Ledger

---

Building

Clone this repository and enter its directory

git clone https://github.com/IntersectMBO/formal-ledger-specifications.git
cd formal-ledger-specifications

Using nix-build

Invoke the following nix-build commands from inside the formal-ledger-specifications directory:

nix-build -A ledger.docs      # generate the PDF spec of the Cardano ledger
nix-build -A ledger.hsSrc     # extract the Haskell code of the Cardano ledger

Conformance-testing example

For an example on how to use the Agda-generated Haskell code for conformance testing see conformance-example

Contributions and Feedback

If you would like more detailed information and/or you want to contribute to the Agda formalization of the spec, please see the CONTRIBUTING.md file.

Please submit a new issue if you find problems with, and/or wish to comment on, this repository.