libp2p

Documentation

Index

• Constants
• func NewConnectableHost(h host.Host) *connectableHost
• func NewDirectSender(ctx context.Context, h host.Host, ...) (*directSender, error)
• func NewIdentityProvider(host host.Host, networkShardingCollector p2p.NetworkShardingCollector, ...) (*identityProvider, error)
• func NewMessage(msg *pubsub.Message, marshalizer p2p.Marshalizer) (*message.Message, error)
• func NewMockMessenger(args ArgsNetworkMessenger, mockNet mocknet.Mocknet) (*networkMessenger, error)
• func NewNetworkMessenger(args ArgsNetworkMessenger) (*networkMessenger, error)
• type ArgsNetworkMessenger
• type ConnectableHost
• type ConnectionMonitor
• type LocalSyncTimer
  • func (lst *LocalSyncTimer) CurrentTime() time.Time
  • func (lst *LocalSyncTimer) IsInterfaceNil() bool
• type MutexHolder
  • func NewMutexHolder(mutexesCapacity int) (*MutexHolder, error)
  • func (mh *MutexHolder) Get(key string) *sync.Mutex
• type Option
  • func WithAuthentication(networkShardingCollector p2p.NetworkShardingCollector, ...) Option
• type PeerDiscovererWithSharder
• type PeerInfoHandler
• type Sharder

Constants

const DirectSendID = protocol.ID("/erd/directsend/1.0.0")

DirectSendID represents the protocol ID for sending and receiving direct P2P messages

const ListenAddrWithIp4AndTcp = "/ip4/0.0.0.0/tcp/"

ListenAddrWithIp4AndTcp defines the listening address with ip v.4 and TCP

const ListenLocalhostAddrWithIp4AndTcp = "/ip4/127.0.0.1/tcp/"

ListenLocalhostAddrWithIp4AndTcp defines the local host listening ip v.4 address and TCP

Functions

func NewConnectableHost

func NewConnectableHost(h host.Host) *connectableHost

NewConnectableHost creates a new connectable host implementation

func NewDirectSender

func NewDirectSender(
	ctx context.Context,
	h host.Host,
	messageHandler func(msg *pubsub.Message, fromConnectedPeer core.PeerID) error,
) (*directSender, error)

NewDirectSender returns a new instance of direct sender object

func NewIdentityProvider

func NewIdentityProvider(
	host host.Host,
	networkShardingCollector p2p.NetworkShardingCollector,
	signerVerifier p2p.SignerVerifier,
	marshalizer p2p.Marshalizer,
	receiveTimeout time.Duration,
) (*identityProvider, error)

NewIdentityProvider creates a wrapper over libp2p's network.Notifiee implementation that is able to do a supplemental authentication against each peer connected

func NewMessage

func NewMessage(msg *pubsub.Message, marshalizer p2p.Marshalizer) (*message.Message, error)

NewMessage returns a new instance of a Message object

func NewMockMessenger

func NewMockMessenger(
	args ArgsNetworkMessenger,
	mockNet mocknet.Mocknet,
) (*networkMessenger, error)

NewMockMessenger creates a new sandbox testable instance of libP2P messenger It should not open ports on current machine Should be used only in testing!

func NewNetworkMessenger

func NewNetworkMessenger(args ArgsNetworkMessenger) (*networkMessenger, error)

NewNetworkMessenger creates a libP2P messenger by opening a port on the current machine

Types

type ArgsNetworkMessenger

type ArgsNetworkMessenger struct {
	ListenAddress string
	Marshalizer   p2p.Marshalizer
	P2pConfig     config.P2PConfig
	SyncTimer     p2p.SyncTimer
}

ArgsNetworkMessenger defines the options used to create a p2p wrapper

type ConnectableHost

type ConnectableHost interface {
	host.Host
	ConnectToPeer(ctx context.Context, address string) error
	IsInterfaceNil() bool
}

ConnectableHost is an enhanced Host interface that has the ability to connect to a string address

type ConnectionMonitor

type ConnectionMonitor interface {
	network.Notifiee
	IsConnectedToTheNetwork(netw network.Network) bool
	SetThresholdMinConnectedPeers(thresholdMinConnectedPeers int, netw network.Network)
	ThresholdMinConnectedPeers() int
	IsInterfaceNil() bool
}

ConnectionMonitor defines the behavior of a connection monitor

type LocalSyncTimer

type LocalSyncTimer struct {
}

LocalSyncTimer uses the local system to provide the current time

func (*LocalSyncTimer) CurrentTime

func (lst *LocalSyncTimer) CurrentTime() time.Time

CurrentTime returns the local current time

func (*LocalSyncTimer) IsInterfaceNil

func (lst *LocalSyncTimer) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

type MutexHolder

type MutexHolder struct {
	// contains filtered or unexported fields
}

MutexHolder holds a cache of mutexes: pairs of (key, *sync.Mutex)

func NewMutexHolder

func NewMutexHolder(mutexesCapacity int) (*MutexHolder, error)

NewMutexHolder creates a new instance of MutexHolder with specified capacity.

func (*MutexHolder) Get

func (mh *MutexHolder) Get(key string) *sync.Mutex

Get returns a mutex for the provided key. If the key was not found, it will create a new mutex, save it in the cache and returns it.

type Option

type Option func(*networkMessenger) error

Option represents a functional configuration parameter that can operate

over the networkMessenger struct.

func WithAuthentication

func WithAuthentication(
	networkShardingCollector p2p.NetworkShardingCollector,
	signerVerifier p2p.SignerVerifier,
	marshalizer p2p.Marshalizer,
) Option

WithAuthentication sets up the authentication mechanism and peer id - public key collection

type PeerDiscovererWithSharder

type PeerDiscovererWithSharder interface {
	p2p.PeerDiscoverer
	SetSharder(sharder Sharder) error
}

PeerDiscovererWithSharder extends the PeerDiscoverer with the possibility to set the sharder

type PeerInfoHandler

type PeerInfoHandler func(pInfo peer.AddrInfo)

PeerInfoHandler is the signature of the handler that gets called whenever an action for a peerInfo is triggered

type Sharder

type Sharder interface {
	ComputeEvictionList(pidList []peer.ID) []peer.ID
	Has(pid peer.ID, list []peer.ID) bool
	IsInterfaceNil() bool
}

Sharder defines the eviction computing process of unwanted peers