Merge pull request #3493 from mxinden/patch-1

fix(sepcs/p2p): link to libp2p Yamux specification
This commit is contained in:
Hsiao-Wei Wang 2023-09-15 16:00:27 +08:00 committed by GitHub
commit d26dac9121
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions

View File

@ -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). and is omitted for capable transports (e.g. QUIC).
Two multiplexers are commonplace in libp2p implementations: 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`. 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) 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. If both are supported by the client, yamux MUST take precedence during negotiation.
See the [Rationale](#design-decision-rationale) section below for tradeoffs. See the [Rationale](#design-decision-rationale) section below for tradeoffs.