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 ¶
- Constants
- type Config
- type ESSNodeID
- func (n ESSNodeID) Bytes() []byte
- func (n ESSNodeID) GoString() string
- func (n ESSNodeID) MarshalText() ([]byte, error)
- func (id ESSNodeID) Pubkey() (*ecdsa.PublicKey, error)
- func (n ESSNodeID) String() string
- func (n ESSNodeID) TerminalString() string
- func (n *ESSNodeID) UnmarshalText(text []byte) error
- type Node
- type ReadPacket
- type Table
Examples ¶
Constants ¶
const ESSNodeIDBits = 512
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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:
AnnounceAddr *net.UDPAddr // local address announced in the DHT
NodeDBPath string // if set, the node database is stored at this filesystem location
NetRestrict *netutil.Netlist // network whitelist
Bootnodes []*Node // list of bootstrap nodes
Unhandled chan<- ReadPacket // unhandled packets are sent on this channel
}
Config holds Table-related settings.
type ESSNodeID ¶
type ESSNodeID [ESSNodeIDBits / 8]byte
ESSNodeID is a unique identifier for each node. The node identifier is a marshaled elliptic curve public key.
func MustBytesID ¶ added in v1.7.1
MustBytesID converts a byte slice to a ESSNodeID. It panics if the byte slice is not a valid ESSNodeID.
func MustHexID ¶
MustHexID converts a hex string to a ESSNodeID. It panics if the string is not a valid ESSNodeID.
func (ESSNodeID) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (ESSNodeID) Pubkey ¶
Pubkey returns the public key represented by the node ID. It returns an error if the ID is not a point on the curve.
func (ESSNodeID) TerminalString ¶
TerminalString returns a shortened hex string for terminal logging.
func (*ESSNodeID) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type Node ¶
type Node struct {
IP net.IP // len 4 for IPv4 or 16 for IPv6
UDP, TCP uint16 // port numbers
ID ESSNodeID // the node's public key
// contains filtered or unexported fields
}
Node represents a host on the network. The fields of Node may not be modified.
func MustParseNode ¶
MustParseNode parses a node URL. It panics if the URL is not valid.
func NewNode ¶ added in v1.4.0
NewNode creates a new node. It is mostly meant to be used for testing purposes.
Example ¶
id := MustHexID("1dd9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439")
// Complete nodes contain UDP and TCP endpoints:
n1 := NewNode(id, net.ParseIP("2001:db8:3c4d:15::abcd:ef12"), 52150, 30303)
fmt.Println("n1:", n1)
fmt.Println("n1.Incomplete() ->", n1.Incomplete())
// An incomplete node can be created by passing zero values
// for all parameters except id.
n2 := NewNode(id, nil, 0, 0)
fmt.Println("n2:", n2)
fmt.Println("n2.Incomplete() ->", n2.Incomplete())
Output: n1: essnode://1dd9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439@[2001:db8:3c4d:15::abcd:ef12]:30303?discport=52150 n1.Incomplete() -> false n2: essnode://1dd9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439 n2.Incomplete() -> true
func ParseNode ¶
ParseNode parses a node designator.
There are two basic forms of node designators
- incomplete nodes, which only have the public key (node ID)
- complete nodes, which contain the public key and IP/Port information
For incomplete nodes, the designator must look like one of these
essnode://<hex node id> <hex node id>
For complete nodes, the node ID is encoded in the username portion of the URL, separated from the host by an @ sign. The hostname can only be given as an IP address, DNS domain names are not allowed. The port in the host name section is the TCP listening port. If the TCP and UDP (discovery) ports differ, the UDP port is specified as query parameter "discport".
In the following example, the node URL describes a node with IP address 10.3.58.6, TCP listening port 30303 and UDP discovery port 30301.
essnode://<hex node id>@10.3.58.6:30303?discport=30301
func (*Node) Incomplete ¶ added in v1.4.0
Incomplete returns true for nodes with no IP address.
func (*Node) MarshalText ¶ added in v1.6.0
MarshalText implements encoding.TextMarshaler.
func (*Node) String ¶
The string representation of a Node is a URL. Please see ParseNode for a description of the format.
func (*Node) UnmarshalText ¶ added in v1.6.0
UnmarshalText implements encoding.TextUnmarshaler.
type ReadPacket ¶ added in v1.8.0
ReadPacket is sent to the unhandled channel when it could not be processed
type Table ¶
type Table struct {
// contains filtered or unexported fields
}
func (*Table) Close ¶
func (tab *Table) Close()
Close terminates the network listener and flushes the node database.
func (*Table) Lookup ¶
Lookup performs a network search for nodes close to the given target. It approaches the target by querying nodes that are closer to it on each iteration. The given target does not need to be an actual node identifier.
func (*Table) ReadRandomNodes ¶
ReadRandomNodes fills the given slice with random nodes from the table. It will not write the same node more than once. The nodes in the slice are copies and can be modified by the caller.
Source Files