Welcome to the ouroboros-consensus documentation
This site provides a comprehensive and detailed technical documentation for the Haskell implementation of the Consensus, Mempool, and Storage Layers of the cardano-node.
Work in Progress
This documentation is currently under development. Some sections may be incomplete or subject to change. We appreciate your patience and feedback.
We follow the Diátaxis framework, which helps you find the information you need based on your goal:
- Explanations: Understand core concepts, including implementation components, consensus protocols, and network-layer interactions.
- Tutorials: Follow step-by-step guides to get started and achieve a specific goal.
- HOWTOs: Get practical instructions for tasks like adding an era or working with stored chain data.
- References: Read technical descriptions of APIs, data structures, serialization, and reports.
This documentation focuses on the specific Haskell implementation of the Consensus, Mempool, and Storage components used by cardano-node. For an implementation-agnostic description of the Ouroboros protocols, network interactions, serialization formats, and others, refer to the Cardano Blueprints.