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

Extend preflight guide #887

Open
1 of 3 tasks
amesgen opened this issue Jan 16, 2024 · 0 comments
Open
1 of 3 tasks

Extend preflight guide #887

amesgen opened this issue Jan 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@amesgen
Copy link
Member

amesgen commented Jan 16, 2024

#879 added a preflight guide, with two initial topics. This epic collects further potential steps in that guide.

  • Use basic cardano-cli commands, and do sth simple with the result (this maybe should be split across several steps)
    • get current tip
    • use cardano-cli ping to see/explain network versions and handshaking
    • get protocol parameters, explain values relevant for Consensus, in particular the on-chain protocol version (intra-era HFs, obsolete node check)
    • get stake distribution, explain decentralization parameter $k$ for why so many pools have roughly the same stake
      • Synergy with the leader schedule section: concrete calculations with the stake distribution, eg regarding multi leader slots
    • get protocol state, explain nonces
  • Explore some Cardano-related resources/website
  • (✅ done in PreflightGuide: new section on the leader schedule #1096) First exploration of leadership probability stuff
    • Introduce $\varphi(\alpha) = 1 - {(1-f)}^\alpha$ and basic properties
    • Some calculations around multi leader slots
    • Some applications of (negative) binomial distributions to get the probability of a specific number of blocks in a range of slots etc.
@amesgen amesgen added the documentation Improvements or additions to documentation label Jan 16, 2024
github-merge-queue bot pushed a commit that referenced this issue Jan 22, 2024
Prompted by a suggestion by @RenateEilers, this PR initializes a
"preflight guide" that strives to outline various steps (potentially
with some dependencies) with the goal to build understanding of the
overall Cardano system, with a focus on tasks that are relevant for
working in the Consensus team.

I also opened a companion epic at #887 which contains ideas for further
steps.

[Rendered](https://github.com/IntersectMBO/ouroboros-consensus/blob/amesgen/preflight/docs/website/contents/for-developers/PreflightGuide.md)
@amesgen amesgen self-assigned this Mar 19, 2024
github-merge-queue bot pushed a commit that referenced this issue May 13, 2024
@amesgen amesgen removed their assignment May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant