libp2p package

Subpackages

• libp2p.crypto package
  • Subpackages
    • libp2p.crypto.pb package
      • Submodules
      • libp2p.crypto.pb.crypto_pb2 module
      • Module contents
  • Submodules
  • libp2p.crypto.authenticated_encryption module
  • libp2p.crypto.ecc module
  • libp2p.crypto.ed25519 module
  • libp2p.crypto.exceptions module
  • libp2p.crypto.key_exchange module
  • libp2p.crypto.keys module
  • libp2p.crypto.rsa module
  • libp2p.crypto.secp256k1 module
  • libp2p.crypto.serialization module
  • Module contents
• libp2p.host package
  • Submodules
  • libp2p.host.basic_host module
  • libp2p.host.defaults module
  • libp2p.host.exceptions module
  • libp2p.host.host_interface module
  • libp2p.host.ping module
  • libp2p.host.routed_host module
  • Module contents
• libp2p.identity package
  • Subpackages
    • libp2p.identity.identify package
      • Subpackages
        • libp2p.identity.identify.pb package
          • Submodules
          • libp2p.identity.identify.pb.identify_pb2 module
          • Module contents
      • Submodules
      • libp2p.identity.identify.protocol module
      • Module contents
  • Module contents
• libp2p.io package
  • Submodules
  • libp2p.io.abc module
  • libp2p.io.exceptions module
  • libp2p.io.msgio module
  • libp2p.io.utils module
  • Module contents
• libp2p.network package
  • Subpackages
    • libp2p.network.connection package
      • Submodules
      • libp2p.network.connection.exceptions module
      • libp2p.network.connection.net_connection_interface module
      • libp2p.network.connection.raw_connection module
      • libp2p.network.connection.raw_connection_interface module
      • libp2p.network.connection.swarm_connection module
      • Module contents
    • libp2p.network.stream package
      • Submodules
      • libp2p.network.stream.exceptions module
      • libp2p.network.stream.net_stream module
      • libp2p.network.stream.net_stream_interface module
      • Module contents
  • Submodules
  • libp2p.network.exceptions module
  • libp2p.network.network_interface module
  • libp2p.network.notifee_interface module
  • libp2p.network.swarm module
  • Module contents
• libp2p.peer package
  • Submodules
  • libp2p.peer.addrbook_interface module
  • libp2p.peer.id module
  • libp2p.peer.peerdata module
  • libp2p.peer.peerdata_interface module
  • libp2p.peer.peerinfo module
  • libp2p.peer.peermetadata_interface module
  • libp2p.peer.peerstore module
  • libp2p.peer.peerstore_interface module
  • Module contents
• libp2p.protocol_muxer package
  • Submodules
  • libp2p.protocol_muxer.exceptions module
  • libp2p.protocol_muxer.multiselect module
  • libp2p.protocol_muxer.multiselect_client module
  • libp2p.protocol_muxer.multiselect_client_interface module
  • libp2p.protocol_muxer.multiselect_communicator module
  • libp2p.protocol_muxer.multiselect_communicator_interface module
  • libp2p.protocol_muxer.multiselect_muxer_interface module
  • Module contents
• libp2p.pubsub package
  • Subpackages
    • libp2p.pubsub.pb package
      • Submodules
      • libp2p.pubsub.pb.rpc_pb2 module
      • Module contents
  • Submodules
  • libp2p.pubsub.abc module
  • libp2p.pubsub.exceptions module
  • libp2p.pubsub.floodsub module
  • libp2p.pubsub.gossipsub module
  • libp2p.pubsub.mcache module
  • libp2p.pubsub.pubsub module
  • libp2p.pubsub.pubsub_notifee module
  • libp2p.pubsub.subscription module
  • libp2p.pubsub.validators module
  • Module contents
• libp2p.routing package
  • Submodules
  • libp2p.routing.interfaces module
  • Module contents
• libp2p.security package
  • Subpackages
    • libp2p.security.insecure package
      • Subpackages
        • libp2p.security.insecure.pb package
          • Submodules
          • libp2p.security.insecure.pb.plaintext_pb2 module
          • Module contents
      • Submodules
      • libp2p.security.insecure.transport module
      • Module contents
    • libp2p.security.noise package
      • Subpackages
        • libp2p.security.noise.pb package
          • Submodules
          • libp2p.security.noise.pb.noise_pb2 module
          • Module contents
      • Submodules
      • libp2p.security.noise.exceptions module
      • libp2p.security.noise.io module
      • libp2p.security.noise.messages module
      • libp2p.security.noise.patterns module
      • libp2p.security.noise.transport module
      • Module contents
    • libp2p.security.secio package
      • Subpackages
        • libp2p.security.secio.pb package
          • Submodules
          • libp2p.security.secio.pb.spipe_pb2 module
          • Module contents
      • Submodules
      • libp2p.security.secio.exceptions module
      • libp2p.security.secio.transport module
      • Module contents
  • Submodules
  • libp2p.security.base_session module
  • libp2p.security.base_transport module
  • libp2p.security.exceptions module
  • libp2p.security.secure_conn_interface module
  • libp2p.security.secure_transport_interface module
  • libp2p.security.security_multistream module
  • Module contents
• libp2p.stream_muxer package
  • Subpackages
    • libp2p.stream_muxer.mplex package
      • Submodules
      • libp2p.stream_muxer.mplex.constants module
      • libp2p.stream_muxer.mplex.datastructures module
      • libp2p.stream_muxer.mplex.exceptions module
      • libp2p.stream_muxer.mplex.mplex module
      • libp2p.stream_muxer.mplex.mplex_stream module
      • Module contents
  • Submodules
  • libp2p.stream_muxer.abc module
  • libp2p.stream_muxer.exceptions module
  • libp2p.stream_muxer.muxer_multistream module
  • Module contents
• libp2p.tools package
  • Subpackages
    • libp2p.tools.pubsub package
      • Submodules
      • libp2p.tools.pubsub.dummy_account_node module
      • libp2p.tools.pubsub.floodsub_integration_test_settings module
      • libp2p.tools.pubsub.utils module
      • Module contents
  • Submodules
  • libp2p.tools.constants module
  • libp2p.tools.factories module
  • libp2p.tools.utils module
  • Module contents
• libp2p.transport package
  • Subpackages
    • libp2p.transport.tcp package
      • Submodules
      • libp2p.transport.tcp.tcp module
      • Module contents
  • Submodules
  • libp2p.transport.exceptions module
  • libp2p.transport.listener_interface module
  • libp2p.transport.transport_interface module
  • libp2p.transport.typing module
  • libp2p.transport.upgrader module
  • Module contents

Submodules

libp2p.exceptions module

exception libp2p.exceptions.BaseLibp2pError

Bases: Exception

exception libp2p.exceptions.MultiError

Bases: libp2p.exceptions.BaseLibp2pError

Raised with multiple exceptions.

exception libp2p.exceptions.ParseError

Bases: libp2p.exceptions.BaseLibp2pError

exception libp2p.exceptions.ValidationError

Bases: libp2p.exceptions.BaseLibp2pError

Raised when something does not pass a validation check.

libp2p.typing module

libp2p.utils module

async libp2p.utils.decode_uvarint_from_stream(reader: libp2p.io.abc.Reader) → int

https://en.wikipedia.org/wiki/LEB128.

libp2p.utils.encode_delim(msg: bytes) → bytes

libp2p.utils.encode_uvarint(number: int) → bytes

Pack number into varint bytes.

libp2p.utils.encode_varint_prefixed(msg_bytes: bytes) → bytes

async libp2p.utils.read_delim(reader: libp2p.io.abc.Reader) → bytes

async libp2p.utils.read_varint_prefixed_bytes(reader: libp2p.io.abc.Reader) → bytes

Module contents

libp2p.generate_new_rsa_identity() → libp2p.crypto.keys.KeyPair

libp2p.generate_peer_id_from(key_pair: libp2p.crypto.keys.KeyPair) → libp2p.peer.id.ID

libp2p.new_host(key_pair: libp2p.crypto.keys.KeyPair = None, muxer_opt: Mapping[NewType.<locals>.new_type, Type[libp2p.stream_muxer.abc.IMuxedConn]] = None, sec_opt: Mapping[NewType.<locals>.new_type, libp2p.security.secure_transport_interface.ISecureTransport] = None, peerstore_opt: libp2p.peer.peerstore_interface.IPeerStore = None, disc_opt: libp2p.routing.interfaces.IPeerRouting = None) → libp2p.host.host_interface.IHost

Create a new libp2p host based on the given parameters.

Parameters

• key_pair – optional choice of the KeyPair

• muxer_opt – optional choice of stream muxer

• sec_opt – optional choice of security upgrade

• peerstore_opt – optional peerstore

• disc_opt – optional discovery

Returns

return a host instance

libp2p.new_swarm(key_pair: libp2p.crypto.keys.KeyPair = None, muxer_opt: Mapping[NewType.<locals>.new_type, Type[libp2p.stream_muxer.abc.IMuxedConn]] = None, sec_opt: Mapping[NewType.<locals>.new_type, libp2p.security.secure_transport_interface.ISecureTransport] = None, peerstore_opt: libp2p.peer.peerstore_interface.IPeerStore = None) → libp2p.network.network_interface.INetworkService

Create a swarm instance based on the parameters.

Parameters

• key_pair – optional choice of the KeyPair

• muxer_opt – optional choice of stream muxer

• sec_opt – optional choice of security upgrade

• peerstore_opt – optional peerstore

Returns

return a default swarm instance