state-of-documentation.md

Current state of the Rust node documentation

By module

• Openmina Node

• The Mina Web Node

• P2P networking stack

  • P2P services
  • RPCs support - in progress
  • GossipSub

• Scan state

• SNARKs

• Developer tools

  • Debugger
  • Front End
    • Dashboard
    • Debugger

By use-case

• Why we are developing Open Mina

• Consensus logic - not documented yet

• Block production logic

  • Internal transition
  • External transition - not documented yet
  • VRF function - in progress

• Peer discovery/advertising

  • Peer discovery through kademlia - in progress
  • SNARK work - SNARK production is implemented (through OCaml). Node can complete and broadcast SNARK work.

• Compatible ledger implementation - not documented yet

• Transition frontier - not documented yet

• Bootstrapping process - in progress

• Block application - not documented yet

• How to run

  • Launch Openmina node
  • Launch Node with UI
  • Debugger
  • Web Node