Add some overview documentation about what we're building; update README #351
Conversation
… README to be less out of date, but still not complete
buddhisthead
requested review from
Copilot and
sandtreader
and removed request for
Copilot
|
|
||
| **Components Required:** | ||
| - All components from Archival Node, plus: | ||
| - Network: Multi-peer Basic, Multi-peer Consensus |
There was a problem hiding this comment.
The external runtime requirements of the Archival Node already require reaching multiple relay nodes for chain-fetch, so I think "multi-peer basic" is already covered
|
|
||
| **External Runtime Requirements:** | ||
| - **Needs to connect to:** Multiple diverse relay nodes for redundancy (5-10 peers recommended) | ||
| - **Network access:** Bidirectional TCP connections, can accept incoming connections from trusted peers |
There was a problem hiding this comment.
What does "trusted" peers mean? Will the first iteration of miniprotocol servers have an allowlist of peers or something?
I ask because I'm used to the node-to-node miniprotocols being described as "trustless" (as opposed to node-to-client miniprotocols, which don't attempt to avoid e.g. excess resource consumption)
| - All components from Relay Node, plus: | ||
| - Network: Multi-peer Auto P2P, OP N164 Protocols, EB Distribution | ||
| - Consensus: Full block production capability, Leios MemPool | ||
| - Ledger: Leios Voting |
There was a problem hiding this comment.
Why does this need Leios components if the goal isn't participating in Leios? The "what it does" mentions voting on governance actions, but Leios voting isn't needed for that.
Description
Update the README to be less out of date, though still not complete.
Update the PR template to be less annoying and busy.
Related Issue(s)
none
How was this tested?
Visually look at the rendered MD, maybe try and follow some links to verity them.
Checklist
Impact / Side effects
none
Reviewer notes / Areas to focus
nope