p2p

Documentation

Index

• func DecodeENR(enrStr string) (enr.Record, error)
• func EncodeENR(record enr.Record) (string, error)
• func KeyPath(datadir string) string
• func LoadPrivKey(dataDir string) (*ecdsa.PrivateKey, error)
• func NewLocalEnode(config Config, key *ecdsa.PrivateKey) (*enode.LocalNode, *enode.DB, error)
• func NewPingService(h host.Host, peers []peer.ID, callback func(peer.ID)) func(context.Context)
• func NewRelayReserver(tcpNode host.Host, relay Peer) lifecycle.HookFunc
• func NewSavedPrivKey(datadir string) (*ecdsa.PrivateKey, error)
• func NewTCPNode(cfg Config, key *ecdsa.PrivateKey, connGater ConnGater, ...) (host.Host, error)
• func NewUDPBootnodes(ctx context.Context, config Config, peers []Peer, localEnode enode.ID) ([]*enode.Node, error)
• func NewUDPNode(config Config, ln *enode.LocalNode, key *ecdsa.PrivateKey, ...) (*discover.UDPv5, error)
• func PeerName(id peer.ID) string
• func SendAsync(ctx context.Context, tcpNode host.Host, protoID protocol.ID, peerID peer.ID, ...)
• type Config
  • func (c Config) Multiaddrs() ([]ma.Multiaddr, error)
  • func (c Config) ParseTCPAddrs() ([]*net.TCPAddr, error)
• type ConnGater
  • func NewConnGater(peers []peer.ID, relays []Peer) (ConnGater, error)
  • func NewOpenGater() ConnGater
  • func (ConnGater) InterceptAccept(_ network.ConnMultiaddrs) (allow bool)
  • func (ConnGater) InterceptAddrDial(_ peer.ID, _ multiaddr.Multiaddr) (allow bool)
  • func (ConnGater) InterceptPeerDial(_ peer.ID) (allow bool)
  • func (c ConnGater) InterceptSecured(_ network.Direction, id peer.ID, _ network.ConnMultiaddrs) bool
  • func (ConnGater) InterceptUpgraded(_ network.Conn) (bool, control.DisconnectReason)
• type Peer
  • func NewPeer(record enr.Record, index int) (Peer, error)
  • func NewRelays(conf Config, bootnodes []*enode.Node) ([]Peer, error)
• type UDPNode

Functions

func DecodeENR

func DecodeENR(enrStr string) (enr.Record, error)

DecodeENR returns a enr record decoded from the string. See reference github.com/ethereum/go-ethereum@v1.10.10/p2p/dnsdisc/tree.go:378.

func EncodeENR

func EncodeENR(record enr.Record) (string, error)

EncodeENR returns an encoded string format of the enr record.

func KeyPath

func KeyPath(datadir string) string

KeyPath returns the p2pkey path relative to the data dir.

func LoadPrivKey

func LoadPrivKey(dataDir string) (*ecdsa.PrivateKey, error)

LoadPrivKey returns the ecdsa k1 key saved in the directory.

func NewLocalEnode

func NewLocalEnode(config Config, key *ecdsa.PrivateKey) (*enode.LocalNode, *enode.DB, error)

NewLocalEnode returns a local enode and a peer DB or an error.

func NewPingService

func NewPingService(h host.Host, peers []peer.ID, callback func(peer.ID)) func(context.Context)

NewPingService returns a start function of a p2p ping service that pings all peers every second and collects metrics. TODO(corver): Cluster wide req/resp doesn't scale since it is O(n^2).

func NewRelayReserver

func NewRelayReserver(tcpNode host.Host, relay Peer) lifecycle.HookFunc

NewRelayReserver returns a life cycle hook function that continuously reserves a relay circuit until the context is closed.

func NewSavedPrivKey

func NewSavedPrivKey(datadir string) (*ecdsa.PrivateKey, error)

NewSavedPrivKey generates a new ecdsa k1 key and saves it to the directory.

func NewTCPNode

func NewTCPNode(cfg Config, key *ecdsa.PrivateKey, connGater ConnGater,
	udpNode *discover.UDPv5, peers, relays []Peer) (host.Host, error,
)

NewTCPNode returns a started tcp-based libp2p host.

func NewUDPBootnodes

func NewUDPBootnodes(ctx context.Context, config Config, peers []Peer,
	localEnode enode.ID,
) ([]*enode.Node, error)

NewUDPBootnodes returns the udp bootnodes from the config.

func NewUDPNode

func NewUDPNode(config Config, ln *enode.LocalNode,
	key *ecdsa.PrivateKey, bootnodes []*enode.Node,
) (*discover.UDPv5, error)

NewUDPNode starts and returns a discv5 UDP implementation.

func PeerName

func PeerName(id peer.ID) string

PeerName calculates the polynomial rolling hash of the peerID string.

func SendAsync

func SendAsync(ctx context.Context, tcpNode host.Host, protoID protocol.ID, peerID peer.ID, msg proto.Message)

SendAsync sends a libp2p message and logs a warning on error.

Usage: go p2p.SendAsync(ctx, tcpNode, protoId, peerId, msg)

Types

type Config

type Config struct {
	// UDPBootnodes defines the discv5 boot node URLs.
	UDPBootnodes []string
	// UDPBootLock enables using cluster-lock ENRs as discv5 boot nodes.
	UDPBootLock bool
	// UDPAddr defines the discv5 udp listen address.
	UDPAddr string
	// ExternalIP is the IP advertised by libp2p.
	ExternalIP string
	// ExternalHost is the DNS hostname advertised by libp2p.
	ExternalHost string
	// TCPAddrs defines the lib-p2p tcp listen addresses.
	TCPAddrs []string
	// Allowlist defines csv CIDR blocks for lib-p2p allowed connections.
	Allowlist string
	// Allowlist defines csv CIDR blocks for lib-p2p denied connections.
	Denylist string
	// BootnodeRelay enables circuit relay via bootnodes if direct connections fail.
	// Only applicable to charon nodes not bootnodes.
	BootnodeRelay bool
}

func (Config) Multiaddrs

func (c Config) Multiaddrs() ([]ma.Multiaddr, error)

Multiaddrs returns the configured addresses as libp2p multiaddrs.

func (Config) ParseTCPAddrs

func (c Config) ParseTCPAddrs() ([]*net.TCPAddr, error)

ParseTCPAddrs returns the configured tcp addresses as typed net tcp addresses.

type ConnGater

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

ConnGater filters incoming connections by the cluster peers.

func NewConnGater

func NewConnGater(peers []peer.ID, relays []Peer) (ConnGater, error)

NewConnGater return a new connection gater that limits access to the cluster peers and relays.

func NewOpenGater

func NewOpenGater() ConnGater

NewOpenGater returns a connection gater that is open, not gating any connections.

func (ConnGater) InterceptAccept

func (ConnGater) InterceptAccept(_ network.ConnMultiaddrs) (allow bool)

func (ConnGater) InterceptAddrDial

func (ConnGater) InterceptAddrDial(_ peer.ID, _ multiaddr.Multiaddr) (allow bool)

func (ConnGater) InterceptPeerDial

func (ConnGater) InterceptPeerDial(_ peer.ID) (allow bool)

InterceptPeerDial does nothing.

func (ConnGater) InterceptSecured

func (c ConnGater) InterceptSecured(_ network.Direction, id peer.ID, _ network.ConnMultiaddrs) bool

InterceptSecured rejects nodes with a peer ID that isn't part of any known DV.

func (ConnGater) InterceptUpgraded

func (ConnGater) InterceptUpgraded(_ network.Conn) (bool, control.DisconnectReason)

InterceptUpgraded does nothing.

type Peer

type Peer struct {
	// ENR defines the networking information of the peer.
	ENR enr.Record

	// Enode represents the networking host of the peer.
	Enode enode.Node

	// ID is a libp2p peer identity. It is inferred from the ENR.
	ID peer.ID

	// Index is the order of this node in the cluster.
	// This is only applicable to charon nodes, not relays.
	Index int

	// Name represents a human friendly name for the peer.
	Name string
}

Peer represents a peer in the libp2p network, either a charon node or a relay.

func NewPeer

func NewPeer(record enr.Record, index int) (Peer, error)

NewPeer returns a new charon peer.

func NewRelays

func NewRelays(conf Config, bootnodes []*enode.Node) ([]Peer, error)

NewRelays returns the libp2p circuit relays from bootnodes if enabled.

type UDPNode

type UDPNode struct {
	*discover.UDPv5
	Relays []Peer
}

UDPNode wraps a discv5 udp node and adds the bootnodes relays.