Objective

Document (visually) the current & future state of consensus orchestration and block validation

Origin Document

• [Consensus] Consensus Onboarding & Knowledge Transfer #890
• Notes on consensus internal orchestration

Goals

• Leverage fresh 👀: As a new member of the team, a fresh perspective without context diving deep into the code is the best time to document how things work
• Reduce cognitive load: Lower the barrier to entry to understand how relay validation currently works (on the client and servicer)
• Accessible documentation: Make the documentation accessible to both technical and non-technical individuals
• Identify gaps: Document future work w.r.t what we have in the context of relay validation today and what we need in the future

Deliverable

• Use diagrams & bullet points (not lengthy paragraphs) to document the following:
  • Consensus orchestration (e.g. components involved and their order)
  • Block validation (.e.g basic validation, byte consistency check, certificate check, etc...)
  • Other elements (open-ended) that are difficult to understand for a newcomer to the code base
• Optional: The diagrams can be sketched by hand and formalized using mermaid syntax in the future

Non-goals / Non-deliverables

• Making any code modifications
• Creating/documenting an exhaustive list of everything we need to implement in the future and identifying all possible issues in the codebase

Creator: @Olshansk
Co-Owners: @red-0ne