Version: v1.9.3 Latest Latest

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

Go to latest
Published: Aug 29, 2019 License: GPL-3.0 Imports: 22 Imported by: 0



Package discover implements the Node Discovery Protocol.

The Node Discovery protocol provides a way to find RLPx nodes that can be connected to. It uses a Kademlia-like protocol to maintain a distributed database of the IDs and endpoints of all listening nodes.



This section is empty.


This section is empty.


This section is empty.


type Config added in v1.8.0

type Config struct {
	// These settings are required and configure the UDP listener:
	PrivateKey *ecdsa.PrivateKey

	// These settings are optional:
	NetRestrict *netutil.Netlist  // network whitelist
	Bootnodes   []*enode.Node     // list of bootstrap nodes
	Unhandled   chan<- ReadPacket // unhandled packets are sent on this channel
	Log         log.Logger        // if set, log messages go here

Config holds Table-related settings.

type ReadPacket added in v1.8.0

type ReadPacket struct {
	Data []byte
	Addr *net.UDPAddr

ReadPacket is a packet that couldn't be handled. Those packets are sent to the unhandled channel if configured.

type Table

type Table struct {
	// contains filtered or unexported fields

Table is the 'node table', a Kademlia-like index of neighbor nodes. The table keeps itself up-to-date by verifying the liveness of neighbors and requesting their node records when announcements of a new record version are received.

func (*Table) ReadRandomNodes

func (tab *Table) ReadRandomNodes(buf []*enode.Node) (n int)

ReadRandomNodes fills the given slice with random nodes from the table. The results are guaranteed to be unique for a single invocation, no node will appear twice.

type UDPConn added in v1.9.0

type UDPConn interface {
	ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error)
	WriteToUDP(b []byte, addr *net.UDPAddr) (n int, err error)
	Close() error
	LocalAddr() net.Addr

type UDPv4 added in v1.9.0

type UDPv4 struct {
	// contains filtered or unexported fields

UDPv4 implements the v4 wire protocol.

func ListenUDP

func ListenUDP(c UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv4, error)

ListenUDP starts listening for discovery packets on the given UDP socket.

func ListenV4 added in v1.9.0

func ListenV4(c UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv4, error)

func (*UDPv4) Close added in v1.9.0

func (t *UDPv4) Close()

Close shuts down the socket and aborts any running queries.

func (*UDPv4) LookupPubkey added in v1.9.0

func (t *UDPv4) LookupPubkey(key *ecdsa.PublicKey) []*enode.Node

func (*UDPv4) LookupRandom added in v1.9.0

func (t *UDPv4) LookupRandom() []*enode.Node

LookupRandom finds random nodes in the network.

func (*UDPv4) Ping added in v1.9.0

func (t *UDPv4) Ping(n *enode.Node) error

Ping sends a ping message to the given node.

func (*UDPv4) ReadRandomNodes added in v1.9.0

func (t *UDPv4) ReadRandomNodes(buf []*enode.Node) int

ReadRandomNodes reads random nodes from the local table.

func (*UDPv4) RequestENR added in v1.9.0

func (t *UDPv4) RequestENR(n *enode.Node) (*enode.Node, error)

RequestENR sends enrRequest to the given node and waits for a response.

func (*UDPv4) Resolve added in v1.9.0

func (t *UDPv4) Resolve(n *enode.Node) *enode.Node

Resolve searches for a specific node with the given ID and tries to get the most recent version of the node record for it. It returns n if the node could not be resolved.

func (*UDPv4) Self added in v1.9.0

func (t *UDPv4) Self() *enode.Node

Self returns the local node.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL