p2p

Documentation

Index

• type Client
  • func NewClient(conf config.P2PConfig, privKey crypto.PrivKey, chainID string, ...) (*Client, error)
  • func (c *Client) Addrs() []multiaddr.Multiaddr
  • func (c *Client) Close() error
  • func (c *Client) ConnectionGater() *conngater.BasicConnectionGater
  • func (c *Client) GossipFraudProof(ctx context.Context, fraudProof []byte) error
  • func (c *Client) GossipSignedHeader(ctx context.Context, headerBytes []byte) error
  • func (c *Client) GossipTx(ctx context.Context, tx []byte) error
  • func (c *Client) Host() host.Host
  • func (c *Client) Info() (p2p.ID, string, string)
  • func (c *Client) PeerIDs() []peer.ID
  • func (c *Client) Peers() []PeerConnection
  • func (c *Client) PubSub() *pubsub.PubSub
  • func (c *Client) SetFraudProofValidator(validator GossipValidator)
  • func (c *Client) SetHeaderValidator(validator GossipValidator)
  • func (c *Client) SetTxValidator(val GossipValidator)
  • func (c *Client) Start(ctx context.Context) error
• type GossipMessage
• type GossipValidator
• type Gossiper
  • func NewGossiper(host host.Host, ps *pubsub.PubSub, topicStr string, logger log.Logger, ...) (*Gossiper, error)
  • func (g *Gossiper) Close() error
  • func (g *Gossiper) ProcessMessages(ctx context.Context)
  • func (g *Gossiper) Publish(ctx context.Context, data []byte) error
• type GossiperOption
  • func WithValidator(validator GossipValidator) GossiperOption
• type PeerConnection

Types

type Client

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

Client is a P2P client, implemented with libp2p.

Initially, client connects to predefined seed nodes (aka bootnodes, bootstrap nodes). Those seed nodes serve Kademlia DHT protocol, and are agnostic to ORU chain. Using DHT peer routing and discovery clients find other peers within ORU network.

func NewClient

func NewClient(conf config.P2PConfig, privKey crypto.PrivKey, chainID string, ds datastore.Datastore, logger log.Logger) (*Client, error)

NewClient creates new Client object.

Basic checks on parameters are done, and default parameters are provided for unset-configuration TODO(tzdybal): consider passing entire config, not just P2P config, to reduce number of arguments

func (*Client) Addrs

func (c *Client) Addrs() []multiaddr.Multiaddr

Addrs returns listen addresses of Client.

func (*Client) Close

func (c *Client) Close() error

Close gently stops Client.

func (*Client) ConnectionGater

func (c *Client) ConnectionGater() *conngater.BasicConnectionGater

func (*Client) GossipFraudProof

func (c *Client) GossipFraudProof(ctx context.Context, fraudProof []byte) error

GossipHeader sends a fraud proof to the P2P network.

func (*Client) GossipSignedHeader

func (c *Client) GossipSignedHeader(ctx context.Context, headerBytes []byte) error

GossipSignedHeader sends the block header to the P2P network.

func (*Client) GossipTx

func (c *Client) GossipTx(ctx context.Context, tx []byte) error

GossipTx sends the transaction to the P2P network.

func (*Client) Host

func (c *Client) Host() host.Host

Host returns the libp2p node in a peer-to-peer network

func (*Client) Info

func (c *Client) Info() (p2p.ID, string, string)

Info returns client ID, ListenAddr, and Network info

func (*Client) PeerIDs

func (c *Client) PeerIDs() []peer.ID

PeerIDs returns list of peer IDs of connected peers excluding self and inactive

func (*Client) Peers

func (c *Client) Peers() []PeerConnection

Peers returns list of peers connected to Client.

func (*Client) PubSub

func (c *Client) PubSub() *pubsub.PubSub

PubSub returns the libp2p node pubsub for adding future subscriptions

func (*Client) SetFraudProofValidator

func (c *Client) SetFraudProofValidator(validator GossipValidator)

SetFraudProofValidator sets the callback function, that will be invoked after a fraud proof is received from P2P network.

func (*Client) SetHeaderValidator

func (c *Client) SetHeaderValidator(validator GossipValidator)

SetHeaderValidator sets the callback function, that will be invoked after block header is received from P2P network.

func (*Client) SetTxValidator

func (c *Client) SetTxValidator(val GossipValidator)

SetTxValidator sets the callback function, that will be invoked during message gossiping.

func (*Client) Start

func (c *Client) Start(ctx context.Context) error

Start establish Client's P2P connectivity.

Following steps are taken: 1. Setup libp2p host, start listening for incoming connections. 2. Setup gossibsub. 3. Setup DHT, establish connection to seed nodes and initialize peer discovery. 4. Use active peer discovery to look for peers from same ORU network.

type GossipMessage

type GossipMessage struct {
	Data []byte
	From peer.ID
}

GossipMessage represents message gossiped via P2P network (e.g. transaction, Block etc).

type GossipValidator

type GossipValidator func(*GossipMessage) bool

GossipValidator is a callback function type.

type Gossiper

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

Gossiper is an abstraction of P2P publish subscribe mechanism.

func NewGossiper

func NewGossiper(host host.Host, ps *pubsub.PubSub, topicStr string, logger log.Logger, options ...GossiperOption) (*Gossiper, error)

NewGossiper creates new, ready to use instance of Gossiper.

Returned Gossiper object can be used for sending (Publishing) and receiving messages in topic identified by topicStr.

func (*Gossiper) Close

func (g *Gossiper) Close() error

Close is used to disconnect from topic and free resources used by Gossiper.

func (*Gossiper) ProcessMessages

func (g *Gossiper) ProcessMessages(ctx context.Context)

ProcessMessages waits for messages published in the topic and execute handler.

func (*Gossiper) Publish

func (g *Gossiper) Publish(ctx context.Context, data []byte) error

Publish publishes data to gossip topic.

type GossiperOption

type GossiperOption func(*Gossiper) error

GossiperOption sets optional parameters of Gossiper.

func WithValidator

func WithValidator(validator GossipValidator) GossiperOption

WithValidator options registers topic validator for Gossiper.

type PeerConnection

type PeerConnection struct {
	NodeInfo         p2p.DefaultNodeInfo  `json:"node_info"`
	IsOutbound       bool                 `json:"is_outbound"`
	ConnectionStatus p2p.ConnectionStatus `json:"connection_status"`
	RemoteIP         string               `json:"remote_ip"`
}

PeerConnection describe basic information about P2P connection. TODO(tzdybal): move it somewhere