Skip to content

[Consensus][TECHDEBT] Consensus module techdebt consolidation #249

@Olshansk

Description

@Olshansk

Objective

Consolidate, remove and tend to minor TODOs across the consensus module.

Origin Document

A lot of learnings and changes have been made to our process since the first implementation of the consensus module, so there is room to do some general 🧹 at a module-level perspective before we change or improve the business logic.

Goals

  • Prepare the consensus module for a proper consensus <-> utility <-> persistence state hash computation
  • Remove unneeded TODOs
  • Consolidate repetitive TODOs

Deliverable

  • A PR tending to the goals above only touching the consensus module (not pacemaker, persistence, utility etc...)
  • A small sequence diagram showing cross-module context initialization

Non-goals / Non-deliverables

  • Changing any business logic in the consensus module
  • Changing cross-module interaction in the consensus module
  • Changes tending to major TODOs across the module

General issue deliverables

  • Update the appropriate CHANGELOG
  • Update any relevant READMEs (local and/or global)
  • Update any relevant global documentation & references
  • Update the source code tree explanation
  • Updated sequence diagram using mermaid for basic components

Testing Methodology

  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @Olshansk

Metadata

Metadata

Assignees

Labels

code healthNice to have code improvementconsensusConsensus specific changes

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions