-
Notifications
You must be signed in to change notification settings - Fork 989
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Roadmap.md: Discuss the near term future of rust-libp2p (#2997)
The items in this roadmap are ordered by importance where importance is defined as:
- Enable others to build with rust-libp2p before building components ourself.
- e.g.[cross behaviour communication](#cross-behaviour-communication) over[Kademlia client
mode](#kademlia-client-mode) where the former enables the latter
- Invest into tools that enable us to work more efficiently
- e.g.[Testground](#testground-abstraction) and [release process](#release-process)
- Better do one thing well than many things close to right.
- e.g. deprioritize [BitSwap implementation](#bitswap-implementation) and continue on
[QUIC](#quic-support) even once first ieration is merged. That does not imply that we won't
support community members implementing it.
- Improve existing components before introducing new ones.
- e.g.[Kademlia client mode](#kademlia-client-mode) before [WebTransport](#webtransport)- Loading branch information
Showing
1 changed file
with
189 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| # rust-libp2p Roadmap | ||
|
|
||
| Below is a high level roadmap for the rust-libp2p project. Items are ordered by priority (high to | ||
| low). | ||
|
|
||
| For a more detailed view see https://github.com/orgs/libp2p/projects/4/views/1. | ||
|
|
||
| <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> | ||
| **Table of Contents** | ||
|
|
||
| - [rust-libp2p Roadmap](#rust-libp2p-roadmap) | ||
| - [TLS support](#tls-support) | ||
| - [Experimental QUIC support](#experimental-quic-support) | ||
| - [WebRTC support (browser-to-server)](#webrtc-support-browser-to-server) | ||
| - [Cross Behaviour communication](#cross-behaviour-communication) | ||
| - [Generic connection management](#generic-connection-management) | ||
| - [Kademlia efficient querying](#kademlia-efficient-querying) | ||
| - [Kademlia client mode](#kademlia-client-mode) | ||
| - [Optimize Hole punching](#optimize-hole-punching) | ||
| - [Streaming response protocol aka. the ultimate escape hatch](#streaming-response-protocol-aka-the-ultimate-escape-hatch) | ||
| - [Improved WASM support](#improved-wasm-support) | ||
| - [Handshake optimizations](#handshake-optimizations) | ||
| - [Bitswap implementation](#bitswap-implementation) | ||
| - [WebTransport](#webtransport) | ||
|
|
||
| <!-- markdown-toc end --> | ||
|
|
||
| ## TLS support | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|-------------|-------------------|-------------------------------------------------|------------------------------------|------------| | ||
| | Connectivity | In progress | Q4/2022 | https://github.com/libp2p/rust-libp2p/pull/2945 | [QUIC](#experimental-quic-support) | | | ||
|
|
||
|
|
||
| This allows us to secure both TCP and QUIC connections using TLS. This is a requirement for QUIC | ||
| support. Running TLS on top of TCP is a nice to have, since we already have noise. | ||
|
|
||
| ## Experimental QUIC support | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|-------------|-------------------|---------------------------------------------------|---------------------------------------------------------------------|------------| | ||
| | Connectivity | In progress | Q4/2022 | https://github.com/libp2p/rust-libp2p/issues/2883 | [TLS](#tls-support), https://github.com/libp2p/test-plans/issues/53 | | | ||
|
|
||
| QUIC has been on the roadmap for a long time. It enables various performance improvements as well as | ||
| higher hole punching success rates. We are close to finishing a first version with | ||
| https://github.com/libp2p/rust-libp2p/pull/2289. | ||
|
|
||
| Long term there is lots more to do, see tracking issue | ||
| https://github.com/libp2p/rust-libp2p/issues/2883. Though this will be tackled as a new roadmap | ||
| item. | ||
|
|
||
| ## WebRTC support (browser-to-server) | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|-------------|-------------------|------------------------------------------|------------------------------------------------|------------| | ||
| | Connectivity | In progress | Q4/2022 | https://github.com/libp2p/specs/pull/412 | https://github.com/libp2p/test-plans/issues/53 | | | ||
|
|
||
|
|
||
| We are currently implementing WebRTC for **browser-to-server** connectivity in | ||
| https://github.com/libp2p/rust-libp2p/pull/2622. More specifically the server side. This will enable | ||
| browser nodes to connect to rust-libp2p nodes where the latter only have self-signed TLS | ||
| certificates. See https://github.com/libp2p/specs/pull/412 for in-depth motivation. | ||
|
|
||
| Long term we should enable rust-libp2p running in the browser via WASM to use the browser's WebRTC | ||
| stack. Though that should only happen after improved WASM support, see below. | ||
|
|
||
| ## Cross Behaviour communication | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |----------------------|--------|-------------------|---------------------------------------------------|---------------------------------------------------|-----------------------------------------------| | ||
| | Developer ergonomics | todo | Q1/2023 | https://github.com/libp2p/rust-libp2p/issues/2680 | https://github.com/libp2p/rust-libp2p/issues/2832 | [Kademlia client mode](#kademlia-client-mode) | | ||
|
|
||
| Today `NetworkBehaviour` implementations like Kademlia, GossipSub or Circuit Relay v2 can not | ||
| communicate with each other, i.e. can not make use of information known by another | ||
| `NetworkBehaviour` implementation. Users need to write the wiring code by hand to e.g. enable | ||
| Kademlia to learn protocols supported by a remote peer from Identify. | ||
|
|
||
| This roadmap item contains exchanging standard information about remote peers (e.g. supported | ||
| protocols) between `NetworkBehaviour` implementations. | ||
|
|
||
| Long term we might consider a generic approach for `NetworkBehaviours` to exchange data. Though that | ||
| would deserve its own roadmap item. | ||
|
|
||
| ## Generic connection management | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |----------------------|--------|-------------------|---------------------------------------------------|--------------|------------| | ||
| | Developer Ergonomics | todo | Q1/2023 | https://github.com/libp2p/rust-libp2p/issues/2824 | | | | ||
|
|
||
| Today connection management functionality in rust-libp2p is limited. Building abstractions on top is | ||
| cumbersome and inefficient. See https://github.com/libp2p/rust-libp2p/issues/2824. Making connection | ||
| management generic allows users to build advanced and efficient abstractions on top of rust-libp2p | ||
|
|
||
| First draft is in https://github.com/libp2p/rust-libp2p/pull/2828 | ||
|
|
||
| ## Kademlia efficient querying | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|-------------|-------------------|-------------------------------------------------|--------------|------------| | ||
| | Optimization | in progress | Q1/2023 | https://github.com/libp2p/rust-libp2p/pull/2712 | | | | ||
|
|
||
| Users of rust-libp2p like [iroh](https://github.com/n0-computer/iroh) need this for low latency | ||
| usage of `libp2p-kad`. The rust-libp2p maintainers can pick this up unless iroh folks finish the | ||
| work before that. | ||
|
|
||
| ## Kademlia client mode | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|--------|-------------------|---------------------------------------------------|-----------------------------------------------------------------|------------| | ||
| | Optimization | todo | Q1/2023 | https://github.com/libp2p/rust-libp2p/issues/2032 | [Cross behaviour communication](#cross-behaviour-communication) | | | ||
|
|
||
| Kademlia client mode will enhance routing table health and thus have a positive impact on all | ||
| Kademlia operations. | ||
|
|
||
| ## Optimize Hole punching | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|--------|-------------------|----------|--------------|------------| | ||
| | Optimization | todo | Q1/2023 | | | | | ||
|
|
||
| We released hole punching support with [rust-libp2p | ||
| `v0.43.0`](https://github.com/libp2p/rust-libp2p/releases/tag/v0.43.0), see also | ||
| https://github.com/libp2p/rust-libp2p/issues/2052. We are currently collecting data via the | ||
| [punchr](https://github.com/dennis-tra/punchr) project on the hole punching success rate. See also | ||
| [call for | ||
| action](https://discuss.libp2p.io/t/decentralized-nat-hole-punching-measurement-campaign/1616) in | ||
| case you want to help. Based on this data we will likely find many optimizations we can do to our | ||
| hole punching stack. | ||
|
|
||
| ## Streaming response protocol aka. the ultimate escape hatch | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |----------------------|--------|-------------------|---------------------------------------------------|--------------|------------| | ||
| | Developer ergonomics | todo | Q1/2023 | https://github.com/libp2p/rust-libp2p/issues/2657 | | | | ||
|
|
||
| rust-libp2p is very opinionated on how to write peer-to-peer protocols. There are many good reasons | ||
| for this, and I think we should not change directions here. That said, the ultimate escape hatch - | ||
| allowing users to create a stream and do whatever they want with it - will make it easier for | ||
| newcomers to get started. | ||
|
|
||
| ## Improved WASM support | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |----------------------|--------|-------------------|---------------------------------------------------|--------------|--------------------------------------------| | ||
| | Developer ergonomics | todo | Q2/2023 | https://github.com/libp2p/rust-libp2p/issues/2617 | | WebRTC browser-to-browser and browser side | | ||
|
|
||
| The project supports WASM already today, though the developer experience is cumbersome at best. | ||
| Properly supporting WASM opens rust-libp2p to hole new set of use-cases. I would love for this to | ||
| happen earlier. Though (a) I think we should prioritize improving existing functionality over new | ||
| functionality and (b) we don't have high demand for this feature from the community. (One could | ||
| argue that that demand follows this roadmap item and not the other way round.) | ||
|
|
||
| ## Handshake optimizations | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |--------------|--------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|------------| | ||
| | Optimization | todo | Q2/2023 | Security protocol in multiaddr https://github.com/libp2p/specs/pull/353 and early muxer negotiation https://github.com/libp2p/rust-libp2p/issues/2994 | | | | ||
|
|
||
| Short term, investing into rust-libp2p's QUIC support will likely give us a larger performance win, | ||
| thus neither of the two optimizations is planned for 2022. While great to have, it has not been | ||
| requested from any rust-libp2p users. | ||
|
|
||
| Long term, given that this will give us a great performance gain, we should definitely tackle it. It | ||
| also allows us to catch up and thus be consistent with go-libp2p. | ||
|
|
||
| ## Bitswap implementation | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |----------|--------|-------------------|---------------------------------------------------|--------------|------------| | ||
| | | todo | | https://github.com/libp2p/rust-libp2p/issues/2632 | | | | ||
|
|
||
| I think this is a common component that many users need to build peer-to-peer applications. In | ||
| addition, it is very performance critical and thus likely challenges many of our existing designs in | ||
| rust-libp2p. | ||
|
|
||
| I would prioritize it below [handshake optimization](#handshake-optimizations) following the | ||
| convention of improving existing components over introducing new ones. Users have and can implement | ||
| their own implementations and are thus not blocked on the rust-libp2p project. | ||
|
|
||
| ## WebTransport | ||
|
|
||
| | Category | Status | Target Completion | Tracking | Dependencies | Dependents | | ||
| |-----------------------------|--------|-------------------|---------------------------------------------------|------------------------------------|------------| | ||
| | Connectivity / optimization | todo | | https://github.com/libp2p/rust-libp2p/issues/2993 | [QUIC](#experimental-quic-support) | | | ||
|
|
||
| A WebTransport implementation in rust-libp2p will enable browsers to connect to rust-libp2p nodes | ||
| where the latter only have a self-signed TLS certificate. Compared to WebRTC, this would likely be | ||
| more performant. It is dependent on QUIC support in rust-libp2p. Given that we will support WebRTC | ||
| (browser-to-server) this is not a high priority. |