Crate libp2p::core

source ·
Expand description

Transports, upgrades, multiplexing and node handling of libp2p.

The main concepts of libp2p-core are:

  • A PeerId is a unique global identifier for a node on the network. Each node must have a different PeerId. Normally, a PeerId is the hash of the public key used to negotiate encryption on the communication channel, thereby guaranteeing that they cannot be spoofed.
  • The Transport trait defines how to reach a remote node or listen for incoming remote connections. See the transport module.
  • The StreamMuxer trait is implemented on structs that hold a connection to a remote and can subdivide this connection into multiple substreams. See the muxing module.
  • The UpgradeInfo, InboundUpgrade and OutboundUpgrade traits define how to upgrade each individual substream to use a protocol. See the upgrade module.

Modules

Structs

  • DecodeError
  • Multiaddr
    Representation of a Multiaddr.
  • PeerRecord
    Represents a peer routing record.
  • SignedEnvelope
    A signed envelope contains an arbitrary byte string payload, a signature of the payload, and the public key that can be used to verify the signature.

Enums

  • ConnectedPoint
    The endpoint roles associated with an established peer-to-peer connection.
  • Endpoint
    The endpoint roles associated with a peer-to-peer communication channel.
  • UpgradeError
    Error that can happen when upgrading a connection or substream to use a protocol.

Traits

  • InboundUpgrade
    Possible upgrade on an inbound connection or substream.
  • OutboundUpgrade
    Possible upgrade on an outbound connection or substream.
  • ProtocolName
    Types serving as protocol names.
  • StreamMuxer
    Provides multiplexing for a connection by allowing users to open substreams.
  • Transport
    A transport provides connection-oriented communication between two peers through ordered streams of data (i.e. connections).
  • UpgradeInfo
    Common trait for upgrades that can be applied on inbound substreams, outbound substreams, or both.

Functions

Type Definitions