Skip to content

Commit 86b680a

Browse files
committed
Create a roadmap page for the website
Contains a first set of objectives and can be used to add more detail as we go.
1 parent edaf8ce commit 86b680a

File tree

4 files changed

+111
-2
lines changed

4 files changed

+111
-2
lines changed

nix/outputs.nix

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,21 @@
33
let
44

55
project = repoRoot.nix.project;
6-
agda = import ./agda.nix {inherit pkgs lib inputs;};
7-
artifacts = import ./artifacts.nix {inherit pkgs;};
6+
agda = import ./agda.nix { inherit pkgs lib inputs; };
7+
artifacts = import ./artifacts.nix { inherit pkgs; };
88

99
in
1010

1111
[
1212
(project.flake)
1313
{
1414
packages = agda // artifacts;
15+
16+
devShells.docs = pkgs.mkShell {
17+
packages = [
18+
# To format *.md files
19+
pkgs.nodePackages.prettier
20+
];
21+
};
1522
}
1623
]

site/docs/roadmap.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Roadmap
2+
3+
This document lays out the vision, mission, strategy and key objectives of the
4+
Leios consensus upgrade for Cardano. It outlines _why_ we are doing this, _how_
5+
we aim to succeed and _what_ we plan to do.
6+
7+
## Vision & mission
8+
9+
Leios supports the vision of Cardano to be known as the best-in-class
10+
blockchain, recognized for performance, reliability, and scalability.
11+
Consequently, our mission is to empower developers, businesses, and communities
12+
by delivering a scalable, reliable, and economically sustainable blockchain
13+
network that fuels innovation and growth.
14+
15+
## Strategy
16+
17+
There are three key pillars to how we approach this project:
18+
19+
- **Technical leadership**: Continuously enhance core protocol and
20+
infrastructure to achieve and sustain top-tier transaction throughput and
21+
reliability.
22+
- **Market repositioning**: Publish engaging benchmark results and
23+
visualizations to overcome any perceptions of capacity limitations.
24+
- **Sustainable decentralisation**: Meet throughput demands, but keep costs low
25+
and hardware requirements reasonable, to help SPOs stay profitable and
26+
ultimately preserve market leading levels of decentralization.
27+
28+
<!-- TODO: provide more detail and incorporate more/other principles
29+
30+
- Validate early (as this is novel work)
31+
- Continously deliver (value to the community)
32+
- Transparency to ensure acceptance (decentralized governance)
33+
34+
-->
35+
36+
<!-- TODO KPIs
37+
Several key performance indicators (KPI) will help us guide our design and
38+
measure progress along the way:
39+
40+
### Performance
41+
42+
- **Data throughput**: The amount of transactions the system can process measured by transaction bytes per second (TxB/s) added to the ledger.
43+
- **Script throughput**: Amount of computation that can be done on transactions measured by possible script execution units.
44+
- **Inclusion latency**:: The time it takes for a transaction to reach the ledger in times of high and low demand.
45+
46+
### Efficiency
47+
### Security
48+
### Decentralization
49+
### Adoption
50+
### Sustainability
51+
### Future-proofing
52+
-->
53+
54+
## Objectives
55+
56+
As also mentioned in the [introduction](./overview.md), Leios is about maturing
57+
a consensus protocol design from a research paper through multiple [software
58+
readiness
59+
levels](https://committees.docs.intersectmbo.org/intersect-technical-steering-committee/technical-roadmap/project-cards-explained/software-readiness-level)
60+
and ultimately deploy it as a consensus upgrade onto the Cardano network.
61+
62+
Following our strategy outlined above, we identified several key objectives
63+
along the way which are roughly in order, but not strictly sequential. Instead,
64+
each will give rise to a list of _marketable features_, which we going to
65+
identify, progress and deliver throughout the whole lifecycle of this project.
66+
These objectives and features make up the actual product roadmap, which we are
67+
going to update and report on every month via [this github
68+
project](https://github.com/orgs/input-output-hk/projects/167).
69+
70+
<!-- TODO: go into more detail on why each objective is important and also what's in scope -->
71+
72+
### Improvement Proposal (CIP)
73+
74+
> As the Cardano community, we want to learn as early as possible about what is proposed to change, so that it can be discussed across various groups and committees, and referenced in later on-chain governance.
75+
76+
Create a Cardano Improvement Proposal (CIP) that addresses the [Cardano Problem Statement (CPS) about Greater Transaction Throughput (CPS-18)](https://github.com/cardano-scaling/CIPs/blob/master/CPS-0018/README.md). The proposed protocol design shall be applicable to Cardano and feasibility is proven by relevant analysis and simulations.
77+
78+
### Technical specification
79+
80+
> As a node developer, I want to understand in detail how the Leios protocol works and whether my node implementation is correct.
81+
82+
Create design documents, formal specifications and conformance test suites usable by developers of all relevant Cardano node implementations.
83+
84+
### Showcase 1k TPS
85+
86+
> As a potential builder, I want to experience the capability of the proposed consensus upgrade and be convinced that it is as secure as claimed.
87+
88+
Demonstrate 200 TkB/s in a controlled environment using a network prototype, but also validate any assumptions and threat mitigations.
89+
90+
### Leios testnet
91+
92+
> As an SPO and Cardano developer, we want a dedicated network for testing and measuring the perfomance of Leios, so that we can update relevant infrastructure and ensure it can handle increased throughput reliably without compromising security.
93+
94+
A larger scale public network that can be used to validate parameter selection, continuous load tests and allow everyone to integrate with Leios changes.
95+
96+
### Hard fork
97+
98+
> As an SPO and dRep, we want to have a mature Cardano node implementation that enables Leios and have it made available to all users of Cardano.
99+
100+
Create a `cardano-node` release candidate and mature the feature set through `preview`, `preprod` and eventually enable it with a hard-fork on `mainnet`.

site/docusaurus.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ const config: Config = {
9898
label: "Formal Specification",
9999
position: "left",
100100
},
101+
{ to: "/docs/roadmap", label: "Roadmap", position: "right" },
101102
{ to: "/news", label: "Weekly updates", position: "right" },
102103
{
103104
type: "dropdown",

site/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
1212
*/
1313
const sidebars: SidebarsConfig = {
1414
documentationSidebar: [
15+
"roadmap",
1516
"resources",
1617
"faq",
1718
"glossary",

0 commit comments

Comments
 (0)