feat: Open-source the repository

[romac]

Essentials

Code

• code: MVP for Blocksync #439
• code: WAL for crash recovery with f+1 faulty #607
• code: Vote synchronization protocol #616
• chore: Define a more appropriate name for Blocksync protocol #606
• feat(code/discovery): Kademlia-based discovery #525
• code: Restructure the repository and crates #373
• project: Namespace crates under informalsystems- prefix #652
• docs: Write documentation for building channel-based apps #651 + docs

Examples

• Add example channel-based app @greg-szabo

General documentation

• Add a SECURITY.md file
• chore(docs): Add first version of architecture doc #697 (ARCHITECTURE.md file)
• Add a LICENSE file
• Add a CODE_OF_CONDUCT.md file
• chore: Add a CONTRIBUTING.md file with guidelines #558
• Pimp up the readme.md @adizere
  • Add a WIP (no crates yet) disclaimer
  • Have a logo + banners
  • Add link to Farcaster application

Non-essentials

Code

• Draw new diagrams for actor system and flow within
• code: Write tests for malachite-consensus #431
• docs: Write documentation for the malachitebft-core-consensus crate #320
• code: Ensure consistency in terminology & improve discoverability of APIs #466
• code: Extract Starknet-specific code into its own repository #376

App examples (in priority order)

• Prerequisites
  • code: De-couple the app from the config #459 @greg-szabo
  • Streamline the process of creating a Malachite-based application #549
• code: Add basic kvstore example app #418
• Out-of-process (gRPC) KV app @romac @greg-szabo
• code: Add basic loopback example #649

QA @greg-szabo

• multi DC setup, 100 nodes - generate QA report

Specs

• spec: MVP for Blocksync #425
• spec: Re-organize the specs directory #250
• docs: Define a standard terminology for specs, docs, and public interfaces #468
• spec: New-height logic in Quint for fast track through rounds #408

See open-source

[cason]

Should we add #250 as well?

Or are we planning to have a spec directory separated from the main one?

[adizere]

Should we add an architecture.md or too early ?

[ancazamfir]

Should we add an architecture.md or too early ?

Before we opensouce, yes. Should be part of ensuring comprehensive documentation.

[ancazamfir]

Should we also add more integration examples, like:

• Starknet example, when we finish papyrus integration
• ABCI app integration example, Jasmina's work
• REth integration, if/ when finished
• Farcaster integration, if/ when finished
• Simple example apps, maybe Andy's work (haven't seen it yet). Maybe have one in-process and one out-of process, the latter would require some RPC comm, maybe can be reused for other integrations.

Also, we should make blocksync and discovery pluggable, i.e. should be able to build consensus (core and gossip) without them.

[ancazamfir]

I think we will also need a minimum consensus level-sync along with the blocksync.

[cason]

I think we will also need a minimum consensus level-sync along with the blocksync.

What exactly do you mean with that?