libp2p

package
v0.9.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 30, 2020 License: AGPL-3.0 Imports: 53 Imported by: 0

Documentation

Overview

Package libp2p encapsulates the libp2p library

Index

Constants

View Source 
const (
	// A unique Libp2p protocol ID prefix for Flow (https://docs.libp2p.io/concepts/protocols/)
	// All nodes communicate with each other using this protocol id suffixed with the id of the root block
	FlowLibP2PProtocolIDPrefix = "/flow/push/"

	// Maximum time to wait for a ping reply from a remote node
	PingTimeoutSecs = time.Second * 4
)
View Source 
const (
	NoOp communicationMode = iota
	OneToOne
	OneToK
)
View Source 
const (
	// defines maximum message size in publish and multicast modes
	DefaultMaxPubSubMsgSize = 1 << 21 // 2 mb

	// defines maximum message size in unicast mode
	DefaultMaxUnicastMsgSize = 5 * DefaultMaxPubSubMsgSize // 10 mb
)
View Source 
const InboundMessageQueueSize = 100

the inbound message queue size for One to One and One to K messages (each)

Variables

This section is empty.

Functions

func ConnectednessToString 

func ConnectednessToString(connectedness network.Connectedness) (string, bool)

ConnectednessToString reverse translates libp2p network connectedness to string

func CountStream 

func CountStream(host host.Host, targetID peer.ID, protocol core.ProtocolID, dir network.Direction) int

CountStream finds total number of outbound stream to the target id

func DirectionToString 

func DirectionToString(direction network.Direction) (string, bool)

DirectionToString reverse translates libp2p network direction to string

func FindOutboundStream 

func FindOutboundStream(host host.Host, targetID peer.ID, protocol core.ProtocolID) (network.Stream, bool)

FindOutboundStream finds an existing outbound stream to the target id if it exists by querying libp2p

func GetPeerInfo 

func GetPeerInfo(p NodeAddress) (peer.AddrInfo, error)

GetPeerInfo generates the libp2p peer.AddrInfo for a Node/Peer given its node address

func GetPeerInfos 

func GetPeerInfos(addrs ...NodeAddress) ([]peer.AddrInfo, error)

func IPPortFromMultiAddress 

func IPPortFromMultiAddress(addrs ...multiaddr.Multiaddr) (string, string, error)

IPPortFromMultiAddress returns the IP/hostname and the port for the given multi-addresses associated with a libp2p host

func MultiaddressStr 

func MultiaddressStr(address NodeAddress) string

MultiaddressStr receives a node address and returns its corresponding Libp2p Multiaddress in string format in current implementation IP part of the node address is either an IP or a dns4 https://docs.libp2p.io/concepts/addressing/

func NetworkPayloadFixture 

func NetworkPayloadFixture(t *testing.T, size uint) []byte

NetworkPayloadFixture creates a blob of random bytes with the given size (in bytes) and returns it. The primary goal of utilizing this helper function is to apply stress tests on the network layer by sending large messages to transmit.

func PrivKey 

func PrivKey(fpk fcrypto.PrivateKey) (lcrypto.PrivKey, error)

PrivKey converts a Flow private key to a LibP2P Private key

func PublicKey 

func PublicKey(fpk fcrypto.PublicKey) (lcrypto.PubKey, error)

PublicKey converts a Flow public key to a LibP2P public key

Types

type CloseFunc 

type CloseFunc func(channelID string) error

CloseFunc is a function that unsubscribes the conduit from the channel

type Conduit 

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

Conduit is a helper of the overlay layer which functions as an accessor for sending messages within a single engine process. It sends all messages to what can be considered a bus reserved for that specific engine.

func (*Conduit) Close 

func (c *Conduit) Close() error

func (*Conduit) Multicast 

func (c *Conduit) Multicast(event interface{}, num uint, targetIDs ...flow.Identifier) error

Multicast unreliably sends the specified event to the specified number of recipients selected from the specified subset. The recipients are selected randomly from targetIDs

func (*Conduit) Publish 

func (c *Conduit) Publish(event interface{}, targetIDs ...flow.Identifier) error

Publish sends an event to the network layer for unreliable delivery to subscribers of the given event on the network layer. It uses a publish-subscribe layer and can thus not guarantee that the specified recipients received the event.

func (*Conduit) Submit 

func (c *Conduit) Submit(event interface{}, targetIDs ...flow.Identifier) error

Submit will submit an event for delivery on the engine bus that is reserved for events of the engine it was initialized with.

func (*Conduit) Unicast 

func (c *Conduit) Unicast(event interface{}, targetID flow.Identifier) error

Unicast sends an event in a reliable way to the given recipient. It uses 1-1 direct messaging over the underlying network to deliver the event. It returns an error if the unicast fails.

type ConnManager 

type ConnManager struct {
	connmgr.NullConnMgr // a null conn mgr provided by libp2p to allow implementing only the functions needed
	// contains filtered or unexported fields
}

ConnManager provides an implementation of Libp2p's ConnManager interface (https://godoc.org/github.com/libp2p/go-libp2p-core/connmgr#ConnManager) It is called back by libp2p when certain events occur such as opening/closing a stream, opening/closing connection etc. This implementation only logs the call back for debugging purposes.

func NewConnManager 

func NewConnManager(log zerolog.Logger) ConnManager

func (ConnManager) Connected 

func (c ConnManager) Connected(n network.Network, con network.Conn)

called by libp2p when a connection opened

func (ConnManager) Disconnected 

func (c ConnManager) Disconnected(n network.Network, con network.Conn)

called by libp2p when a connection closed

func (ConnManager) ListenCloseNotifee 

func (c ConnManager) ListenCloseNotifee(n network.Network, m multiaddr.Multiaddr)

called by libp2p when network stops listening on an addr * This is never called back by libp2p currently and may be a bug on their side

func (ConnManager) ListenNotifee 

func (c ConnManager) ListenNotifee(n network.Network, m multiaddr.Multiaddr)

called by libp2p when network starts listening on an addr

func (ConnManager) Notifee 

func (c ConnManager) Notifee() network.Notifiee

type Discovery 

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

Discovery implements the discovery.Discovery interface to provide libp2p a way to discover other nodes

func NewDiscovery 

func NewDiscovery(log zerolog.Logger, overlay middleware.Overlay, me flow.Identifier, done chan struct{}) *Discovery

func (*Discovery) Advertise 

func (d *Discovery) Advertise(_ context.Context, _ string, _ ...discovery.Option) (time.Duration, error)

Advertise is suppose to advertise this node's interest in a topic to a discovery service. However, we are not using a discovery service hence this function just returns a long duration to reduce the frequency with which libp2p calls it.

func (*Discovery) FindPeers 

func (d *Discovery) FindPeers(_ context.Context, _ string, _ ...discovery.Option) (<-chan peer.AddrInfo, error)

FindPeers returns a channel providing all peers of the node. No parameters are needed as of now since the overlay.Identity provides all the information about the other nodes.

type Middleware 

type Middleware struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Middleware handles the input & output on the direct connections we have to our neighbours on the peer-to-peer network.

func NewMiddleware 

func NewMiddleware(log zerolog.Logger, codec network.Codec, address string, flowID flow.Identifier,
	key crypto.PrivateKey, metrics module.NetworkMetrics, maxUnicastMsgSize int, maxPubSubMsgSize int,
	rootBlockID string, validators ...validators.MessageValidator) (*Middleware, error)

NewMiddleware creates a new middleware instance with the given config and using the given codec to encode/decode messages to our peers.

func (*Middleware) GetIPPort 

func (m *Middleware) GetIPPort() (string, string, error)

GetIPPort returns the ip address and port number associated with the middleware

func (*Middleware) Me 

func (m *Middleware) Me() flow.Identifier

Me returns the flow identifier of the this middleware

func (*Middleware) Ping 

func (m *Middleware) Ping(targetID flow.Identifier) (time.Duration, error)

Ping pings the target node and returns the ping RTT or an error

func (*Middleware) PublicKey 

func (m *Middleware) PublicKey() crypto.PublicKey

func (*Middleware) Publish 

func (m *Middleware) Publish(msg *message.Message, channelID string) error

Publish publishes msg on the channel. It models a distributed broadcast where the message is meant for all or a many nodes subscribing to the channel ID. It does not guarantee the delivery though, and operates on a best effort.

func (*Middleware) Send deprecated 

func (m *Middleware) Send(channelID string, msg *message.Message, targetIDs ...flow.Identifier) error

Send sends the message to the set of target ids If there is only one target NodeID, then a direct 1-1 connection is used by calling middleware.SendDirect Otherwise, middleware.Publish is used, which uses the PubSub method of communication.

Deprecated: Send exists for historical compatibility, and should not be used on new developments. It is planned to be cleaned up in near future. Proper utilization of Dispatch or Publish are recommended instead.

func (*Middleware) SendDirect 

func (m *Middleware) SendDirect(msg *message.Message, targetID flow.Identifier) error

Dispatch sends msg on a 1-1 direct connection to the target ID. It models a guaranteed delivery asynchronous direct one-to-one connection on the underlying network. No intermediate node on the overlay is utilized as the router.

Dispatch should be used whenever guaranteed delivery to a specific target is required. Otherwise, Publish is a more efficient candidate.

func (*Middleware) Start 

func (m *Middleware) Start(ov middleware.Overlay) error

Start will start the middleware.

func (*Middleware) Stop 

func (m *Middleware) Stop()

Stop will end the execution of the middleware and wait for it to end.

func (*Middleware) Subscribe 

func (m *Middleware) Subscribe(channelID string) error

Subscribe will subscribe the middleware for a topic with the fully qualified channel ID name

func (*Middleware) Unsubscribe 

func (m *Middleware) Unsubscribe(channelID string) error

Unsubscribe will unsubscribe the middleware for a topic with the fully qualified channel ID name

func (*Middleware) UpdateAllowList 

func (m *Middleware) UpdateAllowList() error

UpdateAllowList fetches the most recent identity of the nodes from overlay and updates the underlying libp2p node.

type MulticastFunc 

type MulticastFunc func(channelID string, event interface{}, num uint, targetIDs ...flow.Identifier) error

MulticastFunc is a function that unreliably sends the event in the underlying network to randomly chosen subset of nodes from targetIDs

type Network 

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

Network represents the overlay network of our peer-to-peer network, including the protocols for handshakes, authentication, gossiping and heartbeats.

func NewNetwork 

func NewNetwork(
	log zerolog.Logger,
	codec network.Codec,
	ids flow.IdentityList,
	me module.Local,
	mw middleware.Middleware,
	csize int,
	top topology.Topology,
	metrics module.NetworkMetrics,
) (*Network, error)

NewNetwork creates a new naive overlay network, using the given middleware to communicate to direct peers, using the given codec for serialization, and using the given state & cache interfaces to track volatile information. csize determines the size of the cache dedicated to keep track of received messages

func (*Network) Done 

func (n *Network) Done() <-chan struct{}

Done returns a channel that will close when shutdown is complete.

func (*Network) Identity 

func (n *Network) Identity() (map[flow.Identifier]flow.Identity, error)

Identity returns a map of all flow.Identifier to flow identity by querying the flow state

func (*Network) Ready 

func (n *Network) Ready() <-chan struct{}

Ready returns a channel that will close when the network stack is ready.

func (*Network) Receive 

func (n *Network) Receive(nodeID flow.Identifier, msg *message.Message) error

func (*Network) Register 

func (n *Network) Register(channelID string, engine network.Engine) (network.Conduit, error)

Register will register the given engine with the given unique engine engineID, returning a conduit to directly submit messages to the message bus of the engine.

func (*Network) SetIDs 

func (n *Network) SetIDs(ids flow.IdentityList)

func (*Network) Topology 

func (n *Network) Topology() (map[flow.Identifier]flow.Identity, error)

Topology returns the identities of a uniform subset of nodes in protocol state using the topology provided earlier

type NodeAddress 

type NodeAddress struct {
	// Name is the friendly node Name e.g. "node1" (not to be confused with the libp2p node id)
	Name   string
	IP     string
	Port   string
	PubKey lcrypto.PubKey
}

NodeAddress is used to define a libp2p node

type P2PNode 

type P2PNode struct {
	sync.Mutex
	// contains filtered or unexported fields
}

P2PNode manages the the libp2p node.

func (*P2PNode) AddPeer 

func (p *P2PNode) AddPeer(ctx context.Context, peer NodeAddress) error

AddPeer adds a peer to this node by adding it to this node's peerstore and connecting to it

func (*P2PNode) CreateStream 

func (p *P2PNode) CreateStream(ctx context.Context, n NodeAddress) (network.Stream, error)

CreateStream returns an existing stream connected to n if it exists or adds node n as a peer and creates a new stream with it

func (*P2PNode) GetIPPort 

func (p *P2PNode) GetIPPort() (string, string, error)

GetIPPort returns the IP and Port the libp2p node is listening on.

func (*P2PNode) Ping 

func (p *P2PNode) Ping(ctx context.Context, target NodeAddress) (time.Duration, error)

Ping pings a remote node and returns the time it took to ping the remote node if successful or the error

func (*P2PNode) Publish 

func (p *P2PNode) Publish(ctx context.Context, topic string, data []byte) error

Publish publishes the given payload on the topic

func (*P2PNode) RemovePeer 

func (p *P2PNode) RemovePeer(ctx context.Context, peer NodeAddress) error

RemovePeer closes the connection with the peer

func (*P2PNode) Start 

func (p *P2PNode) Start(ctx context.Context,
	n NodeAddress,
	logger zerolog.Logger,
	key lcrypto.PrivKey,
	handler network.StreamHandler,
	rootBlockID string,
	allowList bool,
	allowListAddrs []NodeAddress,
	psOption ...pubsub.Option) error

Start starts a libp2p node on the given address.

func (*P2PNode) Stop 

func (p *P2PNode) Stop() (chan struct{}, error)

Stop stops the libp2p node.

func (*P2PNode) Subscribe 

func (p *P2PNode) Subscribe(ctx context.Context, topic string) (*pubsub.Subscription, error)

Subscribe subscribes the node to the given topic and returns the subscription Currently only one subscriber is allowed per topic. NOTE: A node will receive its own published messages.

func (*P2PNode) UnSubscribe 

func (p *P2PNode) UnSubscribe(topic string) error

UnSubscribe cancels the subscriber and closes the topic.

func (*P2PNode) UpdateAllowlist 

func (p *P2PNode) UpdateAllowlist(allowListAddrs ...NodeAddress) error

UpdateAllowlist allows the peer allowlist to be updated

type PublishFunc 

type PublishFunc func(channelID string, event interface{}, targetIDs ...flow.Identifier) error

PublishFunc is a function that broadcasts the specified event to all participants on the given channel.

type SubmitFunc 

type SubmitFunc func(channelID string, event interface{}, targetIDs ...flow.Identifier) error

SubmitFunc is a function that submits the given event for the given engine to the overlay network, which should take care of delivering it to the given recipients.

type UnicastFunc 

type UnicastFunc func(channelID string, event interface{}, targetID flow.Identifier) error

UnicastFunc is a function that reliably sends the event via reliable 1-1 direct connection in the underlying network to the target ID.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.