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 Config
- type ReadPacket
- type Table
- type TalkRequestHandler
- type UDPConn
- type UDPv4
- func (t *UDPv4) Close()
- func (t *UDPv4) Errors() map[string]uint
- func (t *UDPv4) FindNode(toNode *enode.Node, targetKey *ecdsa.PublicKey) ([]*enode.Node, error)
- func (t *UDPv4) LenUnsolicited() int
- 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) Version() string
- type UDPv5
- func (t *UDPv5) AllNodes() []*enode.Node
- func (t *UDPv5) Close()
- func (t *UDPv5) Errors() map[string]uint
- func (t *UDPv5) LenUnsolicited() int
- 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) Version() string
- type UnhandledPacket
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
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
ValidSchemes enr.IdentityScheme // allowed identity schemes
Clock mclock.Clock
ReplyTimeout time.Duration
PingBackDelay time.Duration
PrivateKeyGenerator func() (*ecdsa.PrivateKey, error)
TableRevalidateInterval time.Duration
}
Config holds settings for the discovery listener.
type ReadPacket ¶
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.
type TalkRequestHandler ¶
TalkRequestHandler callback processes a talk request and optionally returns a reply
type UDPConn ¶
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
}
UDPConn is a network connection on which discovery can operate.
type UDPv4 ¶
type UDPv4 struct {
// contains filtered or unexported fields
}
UDPv4 implements the v4 wire protocol.
func ListenUDP ¶
func ListenUDP(ctx context.Context, protocol string, c UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv4, error)
ListenUDP starts listening for discovery packets on the given UDP socket.
func (*UDPv4) Close ¶
func (t *UDPv4) Close()
Close shuts down the socket and aborts any running queries.
func (*UDPv4) FindNode ¶
FindNode sends a "FindNode" request to the given node and waits until the node has sent up to bucketSize neighbors or a respTimeout has passed.
func (*UDPv4) LenUnsolicited ¶
func (*UDPv4) LookupPubkey ¶
LookupPubkey finds the closest nodes to the given public key.
func (*UDPv4) RandomNodes ¶
RandomNodes is an iterator yielding nodes from a random walk of the DHT.
func (*UDPv4) RequestENR ¶
RequestENR sends enrRequest to the given node and waits for a response.
type UDPv5 ¶
type UDPv5 struct {
// contains filtered or unexported fields
}
UDPv5 is the implementation of protocol version 5.
func ListenV5 ¶
func ListenV5(ctx context.Context, protocol string, conn UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv5, error)
ListenV5 listens on the given connection.
func (*UDPv5) LenUnsolicited ¶
func (*UDPv5) Lookup ¶
Lookup performs a recursive lookup for the given target. It returns the closest nodes to target.
func (*UDPv5) RandomNodes ¶
RandomNodes returns an iterator that finds random nodes in the DHT.
func (*UDPv5) RegisterTalkHandler ¶
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 ¶
requestENR requests n's record.
func (*UDPv5) Resolve ¶
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 ¶
TalkRequest sends a talk request to n and waits for a response.
type UnhandledPacket ¶
type UnhandledPacket struct {
ReadPacket
Reason error
}
Source Files
Directories