From 909388ba8d2e9f24f827f4edce08912aae7c11cd Mon Sep 17 00:00:00 2001 From: Max Inden Date: Mon, 4 Sep 2023 20:09:33 +0200 Subject: [PATCH] fix(sepcs/p2p): link to libp2p Yamux specification 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 --- specs/phase0/p2p-interface.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specs/phase0/p2p-interface.md b/specs/phase0/p2p-interface.md index bbb4c4d42..a374443b8 100644 --- a/specs/phase0/p2p-interface.md +++ b/specs/phase0/p2p-interface.md @@ -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.