Skip to content

Latest commit

 

History

History
109 lines (65 loc) · 8.18 KB

adr-061-p2p-refactor-scope.md

File metadata and controls

109 lines (65 loc) · 8.18 KB
Raw

ADR 061: P2P Refactor Scope

Changelog

  • 2020-10-30: Initial version (@erikgrinaker)

Context

The p2p package responsible for peer-to-peer networking is rather old and has a number of weaknesses, including tight coupling, leaky abstractions, lack of tests, DoS vulnerabilites, poor performance, custom protocols, and incorrect behavior. A refactor has been discussed for several years (#2067).

Informal Systems are also building a Rust implementation of Tendermint, Tendermint-rs, and plan to implement P2P networking support over the next year. As part of this work, they have requested adopting e.g. QUIC as a transport protocol instead of implementing the custom application-level MConnection stream multiplexing protocol that Tendermint currently uses.

This ADR summarizes recent discussion with stakeholders on the scope of a P2P refactor. Specific designs and implementations will be submitted as separate ADRs.

Alternative Approaches

There have been recurring proposals to adopt LibP2P instead of maintaining our own P2P networking stack (see #3696). While this appears to be a good idea in principle, it would be a highly breaking protocol change, there are indications that we might have to fork and modify LibP2P, and there are concerns about the abstractions used.

In discussions with Informal Systems we decided to begin with incremental improvements to the current P2P stack, add support for pluggable transports, and then gradually start experimenting with LibP2P as a transport layer. If this proves successful, we can consider adopting it for higher-level components at a later time.

Decision

The P2P stack will be refactored and improved iteratively, in several phases:

  • Phase 1: code and API refactoring, maintaining protocol compatibility as far as possible.

  • Phase 2: additional transports and incremental protocol improvements.

  • Phase 3: disruptive protocol changes.

The scope of phases 2 and 3 is still uncertain, and will be revisited once the preceding phases have been completed as we'll have a better sense of requirements and challenges.

Detailed Design

Separate ADRs will be submitted for specific designs and changes in each phase, following research and prototyping. Below are objectives in order of priority.

Phase 1: Code and API Refactoring

This phase will focus on improving the internal abstractions and implementations in the p2p package. As far as possible, it should not change the P2P protocol in a backwards-incompatible way.

The refactor should attempt to address the following secondary objectives: testability, observability, performance, security, quality-of-service, backpressure, and DoS resilience. Much of this will be revisited as explicit objectives in phase 2.

Ideally, the refactor should happen incrementally, with regular merges to master every few weeks. This will take more time overall, and cause frequent breaking changes to internal Go APIs, but it reduces the branch drift and gets the code tested sooner and more broadly.

Phase 2: Additional Transports and Protocol Improvements

This phase will focus on protocol improvements and other breaking changes. The following are considered proposals that will need to be evaluated separately once the refactor is done. Additional proposals are likely to be added during phase 1.

  • QUIC transport. #198
  • Noise protocol for secret connection handshake. #5589 #3340
  • Peer ID in connection handshake. #5590
  • Peer and service discovery (e.g. RPC nodes, state sync snapshots). #5481 #4583
  • Rate-limiting, backpressure, and QoS scheduling. #4753 #2338
  • Compression. #2375
  • Improved metrics and tracing. #3849 #2600
  • Simplified P2P configuration options.

Phase 3: Disruptive Protocol Changes

This phase covers speculative, wide-reaching proposals that are poorly defined and highly uncertain. They will be evaluated once the previous phases are done.

  • Adopt LibP2P. #3696
  • Allow cross-reactor communication, possibly without channels.
  • Dynamic channel advertisment, as reactors are enabled/disabled. #4394 #1148
  • Pubsub-style networking topology and pattern.
  • Support multiple chain IDs in the same network.

Status

Accepted

Consequences

Positive

  • Cleaner, simpler architecture that's easier to reason about and test, and thus hopefully less buggy.

  • Improved performance and robustness.

  • Reduced maintenance burden and increased interoperability by the possible adoption of standardized protocols such as QUIC and Noise.

  • Improved usability, with better observability, simpler configuration, and more automation (e.g. peer/service/address discovery, rate-limiting, and backpressure).

Negative

  • Maintaining our own P2P networking stack is resource-intensive.

  • Abstracting away the underlying transport may prevent usage of advanced transport features.

  • Breaking changes to APIs and protocols are disruptive to users.

References

See issue links above.