Documentation ¶
Overview ¶
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.
Index ¶
- type BucketNode
- type Config
- type ReadPacket
- type Table
- type TalkRequestHandler
- type UDPConn
- type UDPv4
- func (t *UDPv4) Close()
- func (t *UDPv4) LookupPubkey(key *ecdsa.PublicKey) []*enode.Node
- func (t *UDPv4) Ping(n *enode.Node) error
- func (t *UDPv4) RandomNodes() enode.Iterator
- func (t *UDPv4) RequestENR(n *enode.Node) (*enode.Node, error)
- func (t *UDPv4) Resolve(n *enode.Node) *enode.Node
- func (t *UDPv4) Self() *enode.Node
- func (t *UDPv4) TableBuckets() [][]BucketNode
- type UDPv5
- func (t *UDPv5) AllNodes() []*enode.Node
- func (t *UDPv5) Close()
- func (t *UDPv5) LocalNode() *enode.LocalNode
- func (t *UDPv5) Lookup(target enode.ID) []*enode.Node
- func (t *UDPv5) Ping(n *enode.Node) error
- func (t *UDPv5) RandomNodes() enode.Iterator
- func (t *UDPv5) RegisterTalkHandler(protocol string, handler TalkRequestHandler)
- func (t *UDPv5) RequestENR(n *enode.Node) (*enode.Node, error)
- func (t *UDPv5) Resolve(n *enode.Node) *enode.Node
- func (t *UDPv5) Self() *enode.Node
- func (t *UDPv5) TalkRequest(n *enode.Node, protocol string, request []byte) ([]byte, error)
- func (t *UDPv5) TalkRequestToID(id enode.ID, addr netip.AddrPort, protocol string, request []byte) ([]byte, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BucketNode ¶ added in v1.14.4
type Config ¶ added in v1.8.0
type Config struct { // These settings are required and configure the UDP listener: PrivateKey *ecdsa.PrivateKey // Packet handling configuration: NetRestrict *netutil.Netlist // list of allowed IP networks Unhandled chan<- ReadPacket // unhandled packets are sent on this channel // Node table configuration: Bootnodes []*enode.Node // list of bootstrap nodes PingInterval time.Duration // speed of node liveness check RefreshInterval time.Duration // used in bucket refresh NoFindnodeLivenessCheck bool // turns off validation of table nodes in FINDNODE handler // The options below are useful in very specific cases, like in unit tests. V5ProtocolID *[6]byte Log log.Logger // if set, log messages go here ValidSchemes enr.IdentityScheme // allowed identity schemes Clock mclock.Clock }
Config holds settings for the discovery listener.
type ReadPacket ¶ added in v1.8.0
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) Nodes ¶ added in v1.12.1
func (tab *Table) Nodes() [][]BucketNode
Nodes returns all nodes contained in the table.
type TalkRequestHandler ¶ added in v1.10.0
TalkRequestHandler callback processes a talk request and returns a response.
Note that talk handlers are expected to come up with a response very quickly, within at most 200ms or so. If the handler takes longer than that, the remote end may time out and wont receive the response.
type UDPConn ¶ added in v1.9.0
type UDPConn interface { ReadFromUDPAddrPort(b []byte) (n int, addr netip.AddrPort, err error) WriteToUDPAddrPort(b []byte, addr netip.AddrPort) (n int, err error) Close() error LocalAddr() net.Addr }
UDPConn is a network connection on which discovery can operate.
type UDPv4 ¶ added in v1.9.0
type UDPv4 struct {
// contains filtered or unexported fields
}
UDPv4 implements the v4 wire protocol.
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
LookupPubkey finds the closest nodes to the given public key.
func (*UDPv4) RandomNodes ¶ added in v1.9.7
RandomNodes is an iterator yielding nodes from a random walk of the DHT.
func (*UDPv4) RequestENR ¶ added in v1.9.0
RequestENR sends ENRRequest to the given node and waits for a response.
func (*UDPv4) Resolve ¶ added in v1.9.0
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) TableBuckets ¶ added in v1.14.4
func (t *UDPv4) TableBuckets() [][]BucketNode
type UDPv5 ¶ added in v1.9.13
type UDPv5 struct {
// contains filtered or unexported fields
}
UDPv5 is the implementation of protocol version 5.
func (*UDPv5) LocalNode ¶ added in v1.9.14
LocalNode returns the current local node running the protocol.
func (*UDPv5) Lookup ¶ added in v1.9.13
Lookup performs a recursive lookup for the given target. It returns the closest nodes to target.
func (*UDPv5) RandomNodes ¶ added in v1.9.13
RandomNodes returns an iterator that finds random nodes in the DHT.
func (*UDPv5) RegisterTalkHandler ¶ added in v1.9.23
func (t *UDPv5) RegisterTalkHandler(protocol string, handler TalkRequestHandler)
RegisterTalkHandler adds a handler for 'talk requests'. The handler function is called whenever a request for the given protocol is received and should return the response data or nil.
func (*UDPv5) RequestENR ¶ added in v1.9.13
RequestENR requests n's record.
func (*UDPv5) Resolve ¶ added in v1.9.13
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 (*UDPv5) TalkRequest ¶ added in v1.9.23
TalkRequest sends a talk request to a node and waits for a response.