moved all interfaces and typing files

Co-authored-by: mystical-prog <[email protected]>

docs/libp2p.host.rst

@@ -28,14 +28,6 @@ libp2p.host.exceptions module
    :undoc-members:
    :show-inheritance:
 
-libp2p.host.host\_interface module
-----------------------------------
-
-.. automodule:: libp2p.host.host_interface
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 libp2p.host.ping module
 -----------------------
 

libp2p/__init__.py

@@ -13,7 +13,9 @@
     create_new_key_pair,
 )
 from libp2p.custom_types import (
+    TMuxerOptions,
     TProtocol,
+    TSecurityOptions,
 )
 from libp2p.host.basic_host import (
     BasicHost,
@@ -42,10 +44,6 @@
 from libp2p.transport.tcp.tcp import (
     TCP,
 )
-from libp2p.transport.typing import (
-    TMuxerOptions,
-    TSecurityOptions,
-)
 from libp2p.transport.upgrader import (
     TransportUpgrader,
 )

libp2p/abc.py

@@ -11,7 +11,6 @@
     AsyncContextManager,
 )
 
-import multiaddr
 from multiaddr import (
     Multiaddr,
 )
@@ -24,6 +23,7 @@
 )
 from libp2p.custom_types import (
     StreamHandlerFn,
+    THandler,
     TProtocol,
 )
 from libp2p.io.abc import (
@@ -40,7 +40,7 @@
     ServiceAPI,
 )
 
-# raw_connection_interface
+# -------------------------- raw_connection interface.py --------------------------
 
 
 class IRawConnection(ReadWriteCloser):
@@ -49,7 +49,9 @@ class IRawConnection(ReadWriteCloser):
     is_initiator: bool
 
 
-# secure_conn_interface
+# -------------------------- secure_conn interface.py --------------------------
+
+
 """
 Represents a secured connection object, which includes a connection and details about
 the security involved in the secured connection
@@ -80,7 +82,7 @@ class ISecureConn(AbstractSecureConn, IRawConnection):
     pass
 
 
-# stream_muxer abc.py
+# -------------------------- stream_muxer abc.py --------------------------
 
 
 class IMuxedConn(ABC):
@@ -152,7 +154,7 @@ def set_deadline(self, ttl: int) -> bool:
         """
 
 
-# net_stream_interface
+# -------------------------- net_stream interface.py --------------------------
 
 
 class INetStream(ReadWriteCloser):
@@ -175,7 +177,9 @@ async def reset(self) -> None:
         """Close both ends of the stream."""
 
 
-# net_connection_interface
+# -------------------------- net_connection interface.py --------------------------
+
+
 class INetConn(Closer):
     muxed_conn: IMuxedConn
     event_started: trio.Event
@@ -189,7 +193,9 @@ def get_streams(self) -> tuple[INetStream, ...]:
         ...
 
 
-# peermetadata_interface
+# -------------------------- peermetadata interface.py --------------------------
+
+
 class IPeerMetadata(ABC):
     @abstractmethod
     def get(self, peer_id: ID, key: str) -> Any:
@@ -210,7 +216,7 @@ def put(self, peer_id: ID, key: str, val: Any) -> None:
         """
 
 
-# addrbook_interface
+# -------------------------- addrbook interface.py --------------------------
 
 
 class IAddrBook(ABC):
@@ -259,7 +265,7 @@ def peers_with_addrs(self) -> list[ID]:
         """
 
 
-# peerstore_interface
+# -------------------------- peerstore interface.py --------------------------
 
 
 class IPeerStore(IAddrBook, IPeerMetadata):
@@ -391,7 +397,7 @@ def add_key_pair(self, peer_id: ID, key_pair: KeyPair) -> None:
         """
 
 
-# listener_interface
+# -------------------------- listener interface.py --------------------------
 
 
 class IListener(ABC):
@@ -417,7 +423,7 @@ async def close(self) -> None:
         ...
 
 
-# network_interface
+# -------------------------- network interface.py --------------------------
 
 
 class INetwork(ABC):
@@ -480,7 +486,7 @@ class INetworkService(INetwork, ServiceAPI):
     pass
 
 
-# notifee_interface
+# -------------------------- notifee interface.py --------------------------
 
 
 class INotifee(ABC):
@@ -527,7 +533,9 @@ async def listen_close(self, network: "INetwork", multiaddr: Multiaddr) -> None:
         """
 
 
-# host_interface
+# -------------------------- host interface.py --------------------------
+
+
 class IHost(ABC):
     @abstractmethod
     def get_id(self) -> ID:
@@ -561,7 +569,7 @@ def get_mux(self) -> Any:
         """
 
     @abstractmethod
-    def get_addrs(self) -> list[multiaddr.Multiaddr]:
+    def get_addrs(self) -> list[Multiaddr]:
         """
         :return: all the multiaddr addresses this host is listening to
         """
@@ -573,9 +581,7 @@ def get_connected_peers(self) -> list[ID]:
         """
 
     @abstractmethod
-    def run(
-        self, listen_addrs: Sequence[multiaddr.Multiaddr]
-    ) -> AsyncContextManager[None]:
+    def run(self, listen_addrs: Sequence[Multiaddr]) -> AsyncContextManager[None]:
         """
         Run the host instance and listen to ``listen_addrs``.
 
@@ -627,7 +633,9 @@ async def close(self) -> None:
         pass
 
 
-# peerdata_interface
+# -------------------------- peerdata interface.py --------------------------
+
+
 class IPeerData(ABC):
     @abstractmethod
     def get_protocols(self) -> list[str]:
@@ -705,7 +713,9 @@ def get_privkey(self) -> PrivateKey:
         """
 
 
-# multiselect_communicator_interface
+# ------------------ multiselect_communicator interface.py ------------------
+
+
 class IMultiselectCommunicator(ABC):
     """
     Communicator helper class that ensures both the client and multistream
@@ -726,7 +736,9 @@ async def read(self) -> str:
         """Reads message from stream until EOF."""
 
 
-# multiselect_client_interface
+# -------------------------- multiselect_client interface.py --------------------------
+
+
 class IMultiselectClient(ABC):
     """
     Client for communicating with receiver's multiselect module in order to
@@ -771,7 +783,9 @@ async def try_select(
         """
 
 
-# multiselect_muxer_interface
+# -------------------------- multiselect_muxer interface.py --------------------------
+
+
 class IMultiselectMuxer(ABC):
     """
     Multiselect module that is responsible for responding to a multiselect
@@ -806,7 +820,7 @@ async def negotiate(
         """
 
 
-# interfaces
+# -------------------------- routing interface.py --------------------------
 
 
 class IContentRouting(ABC):
@@ -837,7 +851,9 @@ async def find_peer(self, peer_id: ID) -> PeerInfo:
         """
 
 
-# security_transport_interface
+# -------------------------- security_transport interface.py --------------------------
+
+
 """
 Transport that is used to secure a connection. This transport is
 chosen by a security transport multistream module.
@@ -865,3 +881,28 @@ async def secure_outbound(self, conn: IRawConnection, peer_id: ID) -> ISecureCon
 
         :return: secure connection object (that implements secure_conn_interface)
         """
+
+
+# -------------------------- transport interface.py --------------------------
+
+
+class ITransport(ABC):
+    @abstractmethod
+    async def dial(self, maddr: Multiaddr) -> IRawConnection:
+        """
+        Dial a transport to peer listening on multiaddr.
+
+        :param multiaddr: multiaddr of peer
+        :param self_id: peer_id of the dialer (to send to receiver)
+        :return: list of multiaddrs
+        """
+
+    @abstractmethod
+    def create_listener(self, handler_function: THandler) -> IListener:
+        """
+        Create listener on transport.
+
+        :param handler_function: a function called when a new conntion is received
+            that takes a connection as argument which implements interface-connection
+        :return: a listener object that implements listener_interface.py
+        """

libp2p/custom_types.py

@@ -1,15 +1,49 @@
 from collections.abc import (
     Awaitable,
+    Mapping,
 )
 from typing import (
     TYPE_CHECKING,
     Callable,
     NewType,
+    Union,
 )
 
 if TYPE_CHECKING:
-    from libp2p.abc import IMuxedStream  # noqa: F401
-    from libp2p.abc import INetStream  # noqa: F401
+    from libp2p.abc import (
+        IMuxedConn,
+        INetStream,
+        ISecureTransport,
+    )
+else:
+
+    class INetStream:
+        pass
+
+    class IMuxedConn:
+        pass
+
+    class ISecureTransport:
+        pass
+
+
+from libp2p.io.abc import (
+    ReadWriteCloser,
+)
+from libp2p.peer.id import (
+    ID,
+)
+from libp2p.pubsub.pb import (
+    rpc_pb2,
+)
 
 TProtocol = NewType("TProtocol", str)
 StreamHandlerFn = Callable[["INetStream"], Awaitable[None]]
+THandler = Callable[[ReadWriteCloser], Awaitable[None]]
+TSecurityOptions = Mapping[TProtocol, "ISecureTransport"]
+TMuxerClass = type["IMuxedConn"]
+TMuxerOptions = Mapping[TProtocol, TMuxerClass]
+SyncValidatorFn = Callable[[ID, rpc_pb2.Message], bool]
+AsyncValidatorFn = Callable[[ID, rpc_pb2.Message], Awaitable[bool]]
+ValidatorFn = Union[SyncValidatorFn, AsyncValidatorFn]
+UnsubscribeFn = Callable[[], Awaitable[None]]

libp2p/network/swarm.py

@@ -16,6 +16,7 @@
     INetworkService,
     INotifee,
     IPeerStore,
+    ITransport,
 )
 from libp2p.custom_types import (
     StreamHandlerFn,
@@ -37,9 +38,6 @@
     OpenConnectionError,
     SecurityUpgradeFailure,
 )
-from libp2p.transport.transport_interface import (
-    ITransport,
-)
 from libp2p.transport.upgrader import (
     TransportUpgrader,
 )

libp2p/pubsub/abc.py

@@ -13,6 +13,7 @@
 
 from libp2p.custom_types import (
     TProtocol,
+    ValidatorFn,
 )
 from libp2p.peer.id import (
     ID,
@@ -24,9 +25,6 @@
 from .pb import (
     rpc_pb2,
 )
-from .typing import (
-    ValidatorFn,
-)
 
 if TYPE_CHECKING:
     from .pubsub import Pubsub  # noqa: F401

libp2p/pubsub/pubsub.py

@@ -31,7 +31,10 @@
     PrivateKey,
 )
 from libp2p.custom_types import (
+    AsyncValidatorFn,
+    SyncValidatorFn,
     TProtocol,
+    ValidatorFn,
 )
 from libp2p.exceptions import (
     ParseError,
@@ -72,11 +75,6 @@
 from .subscription import (
     TrioSubscriptionAPI,
 )
-from .typing import (
-    AsyncValidatorFn,
-    SyncValidatorFn,
-    ValidatorFn,
-)
 from .validators import (
     PUBSUB_SIGNING_PREFIX,
     signature_validator,