Feat: Adding Yamux as default multiplexer, keeping Mplex as fallback (#538)

* feat: Replace mplex with yamux as default multiplexer in py-libp2p

* Retain Mplex alongside Yamux in new_swarm with messaging that Yamux is preferred

* moved !BBHII to a constant YAMUX_HEADER_FORMAT at the top of yamux.py with a comment explaining its structure

* renamed the news fragment to 534.feature.rst and updated the description

* renamed the news fragment to 534.feature.rst and updated the description

* added a docstring to clarify that Yamux does not support deadlines natively

* Remove the __main__ block entirely from test_yamux.py

* Replaced the print statements in test_yamux.py with logging.debug

* Added a comment linking to the spec for clarity

* Raise NotImplementedError in YamuxStream.set_deadline per review

* Add muxed_conn to YamuxStream and test deadline NotImplementedError

* Fix Yamux implementation to meet libp2p spec

* Fix None handling in YamuxStream.read and Yamux.read_stream

* Fix test_connected_peers.py to correctly handle peer connections

* fix: Ensure StreamReset is raised on read after local reset in yamux

* fix: Map MuxedStreamError to StreamClosed in NetStream.write for Yamux

* fix: Raise MuxedStreamReset in Yamux.read_stream for closed streams

* fix: Correct Yamux stream read behavior for NetStream tests

Fixed 	est_net_stream_read_after_remote_closed by updating NetStream.read to raise StreamEOF when the stream is remotely closed and no data is available, aligning with test expectations and Fixed 	est_net_stream_read_until_eof by modifying YamuxStream.read to block until the stream is closed (
ecv_closed=True) for
=-1 reads, ensuring data is only returned after remote closure.

* fix: Correct Yamux stream read behavior for NetStream tests

Fixed 	est_net_stream_read_after_remote_closed by updating NetStream.read to raise StreamEOF when the stream is remotely closed and no data is available, aligning with test expectations and Fixed 	est_net_stream_read_until_eof by modifying YamuxStream.read to block until the stream is closed (
ecv_closed=True) for
=-1 reads, ensuring data is only returned after remote closure.

* fix: raise StreamEOF when reading from closed stream with empty buffer

* fix: prioritize returning buffered data even after stream reset

* fix: prioritize returning buffered data even after stream reset

* fix: Ensure test_net_stream_read_after_remote_closed_and_reset passes in full suite

* fix: Add __init__.py to yamux module to fix documentation build

* fix: Add __init__.py to yamux module to fix documentation build

* fix: Add libp2p.stream_muxer.yamux to libp2p.stream_muxer.rst toctree

* fix: Correct title underline length in libp2p.stream_muxer.yamux.rst

* fix: Add a = so that is matches the libp2p.stream\_muxer.yamux length

* fix(tests): Resolve race condition in network notification test

* fix: fixing failing tests and examples with yamux and noise

* refactor: remove debug logging and improve x25519 tests

* fix: Add functionality for users to choose between Yamux and Mplex

* fix: increased trio sleep to 0.1 sec for slow environment

* feat: Add test for switching between Yamux and mplex

* refactor: move host fixtures to interop tests

* chore: Update __init__.py removing unused import

removed unused
```python
import os
import logging
```

* lint: fix import order

* fix: Resolve conftest.py conflict by removing trio test support

* fix: Resolve test skipping by keeping trio test support

* Fix: add a newline at end of the file

---------

Co-authored-by: acul71 <luca.pisani@birdo.net>
Co-authored-by: acul71 <34693171+acul71@users.noreply.github.com>

libp2p/crypto/keys.py

@@ -1,3 +1,5 @@
+"""Key types and interfaces."""
+
 from abc import (
     ABC,
     abstractmethod,
@@ -9,17 +11,24 @@ from enum import (
     Enum,
     unique,
 )
+from typing import (
+    cast,
+)
 
-from .pb import crypto_pb2 as protobuf
+from libp2p.crypto.pb import (
+    crypto_pb2,
+)
 
 
 @unique
 class KeyType(Enum):
-    RSA = protobuf.KeyType.RSA
-    Ed25519 = protobuf.KeyType.Ed25519
-    Secp256k1 = protobuf.KeyType.Secp256k1
-    ECDSA = protobuf.KeyType.ECDSA
-    ECC_P256 = protobuf.KeyType.ECC_P256
+    RSA = crypto_pb2.KeyType.RSA
+    Ed25519 = crypto_pb2.KeyType.Ed25519
+    Secp256k1 = crypto_pb2.KeyType.Secp256k1
+    ECDSA = crypto_pb2.KeyType.ECDSA
+    ECC_P256 = crypto_pb2.KeyType.ECC_P256
+    # X25519 is added for Noise protocol
+    X25519 = cast(crypto_pb2.KeyType.ValueType, 5)
 
 
 class Key(ABC):
@@ -52,11 +61,11 @@ class PublicKey(Key):
         """
         ...
 
-    def _serialize_to_protobuf(self) -> protobuf.PublicKey:
+    def _serialize_to_protobuf(self) -> crypto_pb2.PublicKey:
         """Return the protobuf representation of this ``Key``."""
         key_type = self.get_type().value
         data = self.to_bytes()
-        protobuf_key = protobuf.PublicKey(key_type=key_type, data=data)
+        protobuf_key = crypto_pb2.PublicKey(key_type=key_type, data=data)
         return protobuf_key
 
     def serialize(self) -> bytes:
@@ -64,8 +73,8 @@ class PublicKey(Key):
         return self._serialize_to_protobuf().SerializeToString()
 
     @classmethod
-    def deserialize_from_protobuf(cls, protobuf_data: bytes) -> protobuf.PublicKey:
-        return protobuf.PublicKey.FromString(protobuf_data)
+    def deserialize_from_protobuf(cls, protobuf_data: bytes) -> crypto_pb2.PublicKey:
+        return crypto_pb2.PublicKey.FromString(protobuf_data)
 
 
 class PrivateKey(Key):
@@ -79,11 +88,11 @@ class PrivateKey(Key):
     def get_public_key(self) -> PublicKey:
         ...
 
-    def _serialize_to_protobuf(self) -> protobuf.PrivateKey:
+    def _serialize_to_protobuf(self) -> crypto_pb2.PrivateKey:
         """Return the protobuf representation of this ``Key``."""
         key_type = self.get_type().value
         data = self.to_bytes()
-        protobuf_key = protobuf.PrivateKey(key_type=key_type, data=data)
+        protobuf_key = crypto_pb2.PrivateKey(key_type=key_type, data=data)
         return protobuf_key
 
     def serialize(self) -> bytes:
@@ -91,8 +100,8 @@ class PrivateKey(Key):
         return self._serialize_to_protobuf().SerializeToString()
 
     @classmethod
-    def deserialize_from_protobuf(cls, protobuf_data: bytes) -> protobuf.PrivateKey:
-        return protobuf.PrivateKey.FromString(protobuf_data)
+    def deserialize_from_protobuf(cls, protobuf_data: bytes) -> crypto_pb2.PrivateKey:
+        return crypto_pb2.PrivateKey.FromString(protobuf_data)
 
 
 @dataclass(frozen=True)