Skip to content

Commit 2cc8456

Browse files
ch1boyveshauser
authored andcommitted
Add some introductory sentences
1 parent 7ae5659 commit 2cc8456

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

docs/leios-design/README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,20 @@ Authors:
88

99
# Introduction
1010

11-
This technical design document bridges the gap between the protocol-level specification (CIP-164) and its concrete implementation in cardano-node. While CIP-164 defines *what* the Leios protocol is and *why* it benefits Cardano, this document addresses *how* to implement it reliably and serve as a practical guide for implementation teams.
11+
This technical design document bridges the gap between the protocol-level specification ([CIP-164](https://github.com/cardano-foundation/CIPs/pull/1078)) and its concrete implementation in [`cardano-node`](https://github.com/IntersectMBO/cardano-node). While CIP-164 defines *what* the Leios protocol is and *why* it benefits Cardano, this document addresses *how* to implement it reliably and serve as a practical guide for implementation teams.
1212

13-
This document extends:
14-
- [CIP-164](https://github.com/cardano-foundation/CIPs/pull/1078): Protocol-level specification of Leios consensus mechanism
15-
- [Impact Analysis](../ImpactAnalysis.md): High-level requirements and potential changes to ecosystem and node components
13+
This document builds on the [impact analysis](../ImpactAnalysis.md) and [early threat modelling](../threat-model.md) conducted. The document outlines the necessary architecture changes, highlights key risks and mitigation strategies, and proposes an implementation roadmap. As the implementation plan itself contains exploratory tasks, this document can be considered a living document and reflects our current understanding of the protocol, as well as design decisions taken during implementation.
1614

17-
> [!WARNING]
18-
> TODO: Introduce general approach, that this is a living document: architecture reflects our current design understanding, which is driven by protocol requirements (CIP), but also by identified risks (for the implementation); From this, we sketch a (current) implementation plan that includes fact-finding, which also means potentially updating that plan as we learn things
15+
Besides collecting node-specific details in this document, we intend to contribute implementation-independent specifications to the [cardano-blueprint](https://cardano-scaling.github.io/cardano-blueprint/) initiative and also update the CIP-164 specification through pull requests as needed.
1916

2017
#### Key Design Principles
2118

2219
> [!WARNING]
2320
> TODO: Needed, useful? What else to "front-load" before going into detail about architecture changes?
2421
2522
- **Security First**: Preserve Praos security guarantees throughout deployment
26-
- **Incremental Delivery**: Enable phased rollout with measurable milestones
2723
- **Early Validation**: Test critical assumptions before full implementation
24+
- **Incremental Delivery**: Enable phased rollout with measurable milestones
2825
- **Ecosystem Compatibility**: Minimize disruption to existing infrastructure
2926

3027
# Architecture
@@ -38,7 +35,7 @@ This document extends:
3835
> TODO: How to structure the changes best? No need to group them by layer?
3936
4037
> [!CAUTION]
41-
> FIXME: The next few sections are AI generated based on the impact analysis contents and the (pseudo-)Haskell code are meant to be replaced other, similar level of detail specifications (barely scratching the code-level)
38+
> FIXME: The next few sections are AI generated based on the impact analysis contents and the (pseudo-)Haskell code should be be replaced by other, similar level of detail specifications (barely scratching the code-level)
4239
4340
## Consensus
4441
#### Block Production Thread (Updated)

0 commit comments

Comments
 (0)