Skip to content

Commit

Permalink
fix(sepcs/p2p): link to libp2p Yamux specification
Browse files Browse the repository at this point in the history
Previously the specification would link to the Hashicorp Yamux specification.

https://github.com/hashicorp/yamux/blob/master/spec.md

Since adoption by libp2p, there have been multiple refinements to the original specification. The improved specification can be found in the libp2p specification repository.

https://github.com/libp2p/specs/blob/master/yamux/README.md
  • Loading branch information
mxinden committed Sep 14, 2023
1 parent c5c7233 commit 909388b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions specs/phase0/p2p-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,11 @@ This applies to transports that are natively incapable of multiplexing (e.g. TCP
and is omitted for capable transports (e.g. QUIC).

Two multiplexers are commonplace in libp2p implementations:
[mplex](https://github.com/libp2p/specs/tree/master/mplex) and [yamux](https://github.com/hashicorp/yamux/blob/master/spec.md).
[mplex](https://github.com/libp2p/specs/tree/master/mplex) and [yamux](https://github.com/libp2p/specs/blob/master/yamux/README.md).
Their protocol IDs are, respectively: `/mplex/6.7.0` and `/yamux/1.0.0`.

Clients MUST support [mplex](https://github.com/libp2p/specs/tree/master/mplex)
and MAY support [yamux](https://github.com/hashicorp/yamux/blob/master/spec.md).
and MAY support [yamux](https://github.com/libp2p/specs/blob/master/yamux/README.md).
If both are supported by the client, yamux MUST take precedence during negotiation.
See the [Rationale](#design-decision-rationale) section below for tradeoffs.

Expand Down

0 comments on commit 909388b

Please sign in to comment.