Documentation
¶
Index ¶
- Variables
- func DistCmp(target, a, b ID) int
- func LogDist(a, b ID) int
- func SignV4(r *enr.Record, privkey *ecdsa.PrivateKey) error
- type DB
- func (db *DB) Close()
- func (db *DB) DeleteNode(id ID) error
- func (db *DB) FindFails(id ID) int
- func (db *DB) LastPingReceived(id ID) time.Time
- func (db *DB) LastPongReceived(id ID) time.Time
- func (db *DB) Node(id ID) *Node
- func (db *DB) NodeSeq(id ID) uint64
- func (db *DB) QuerySeeds(n int, maxAge time.Duration) []*Node
- func (db *DB) Resolve(n *Node) *Node
- func (db *DB) UpdateFindFails(id ID, fails int) error
- func (db *DB) UpdateLastPingReceived(id ID, instance time.Time) error
- func (db *DB) UpdateLastPongReceived(id ID, instance time.Time) error
- func (db *DB) UpdateNode(node *Node) error
- type ID
- type LocalNode
- func (ln *LocalNode) Database() *DB
- func (ln *LocalNode) Delete(e enr.Entry)
- func (ln *LocalNode) ID() ID
- func (ln *LocalNode) Node() *Node
- func (ln *LocalNode) Set(e enr.Entry)
- func (ln *LocalNode) SetFallbackIP(ip net.IP)
- func (ln *LocalNode) SetFallbackUDP(port int)
- func (ln *LocalNode) SetStaticIP(ip net.IP)
- func (ln *LocalNode) UDPContact(toaddr *net.UDPAddr)
- func (ln *LocalNode) UDPEndpointStatement(fromaddr, endpoint *net.UDPAddr)
- type Node
- func (n *Node) ID() ID
- func (n *Node) IP() net.IP
- func (n *Node) Incomplete() bool
- func (n *Node) Load(k enr.Entry) error
- func (n *Node) MarshalText() ([]byte, error)
- func (n *Node) Pubkey() *ecdsa.PublicKey
- func (n *Node) Record() *enr.Record
- func (n *Node) Seq() uint64
- func (n *Node) String() string
- func (n *Node) TCP() int
- func (n *Node) UDP() int
- func (n *Node) UnmarshalText(text []byte) error
- func (n *Node) ValidateComplete() error
- type NullID
- type Secp256k1
- type V4ID
Constants ¶
This section is empty.
Variables ¶
var ValidSchemes = enr.SchemeMap{ "v4": V4ID{}, }
List of known secure identity schemes.
var ValidSchemesForTesting = enr.SchemeMap{ "v4": V4ID{}, "null": NullID{}, }
Functions ¶
func DistCmp ¶
DistCmp compares the distances a->target and b->target. Returns -1 if a is closer to target, 1 if b is closer to target and 0 if they are equal.
used to determine which node is closer to the target node based on the node id
Types ¶
type DB ¶
type DB struct {
// contains filtered or unexported fields
}
DB is the node database, storing previously seen nodes and any collected metadata about them for QoS purposes.
func OpenDB ¶
OpenDB opens a node database for storing and retrieving infos about known peers in the network. If no path is given an in-memory, temporary database is constructed.
NOTE: if the db existed, it will open the db only, otherwise, it will create and then open the db. For the leveldb, the key is byte slice, and the blob is byte slice as well
func (*DB) DeleteNode ¶
DeleteNode deletes all information/keys associated with a node. any key has n:nodeID as prefix
func (*DB) LastPingReceived ¶
LastPingReceived retrieves the time of the last ping packet received from a remote node.
func (*DB) LastPongReceived ¶
LastPongReceived retrieves the time of the last successful pong from remote node.
func (*DB) QuerySeeds ¶
QuerySeeds retrieves random nodes to be used as potential seed nodes for bootstrapping. n defines how many bootstrap nodes want to retrieve 5 * n defines the max number of loops can run, after this time, even if I did not get the desired number of nodes, still exit the for loop maxAge is used to determine if the node is active based on the last pong message received
func (*DB) Resolve ¶
Resolve returns the stored record of the node if it has a larger sequence number than n.
if the node sequence is greater than the node sequence stored in DB, return the original node otherwise, return the node from the db Resolve returns the node with newest node record sequence
func (*DB) UpdateFindFails ¶
UpdateFindFails updates the number of findnode failures since bonding.
func (*DB) UpdateLastPingReceived ¶
UpdateLastPingReceived updates the last time we tried contacting a remote node.
func (*DB) UpdateLastPongReceived ¶
UpdateLastPongReceived updates the last pong time of a node.
func (*DB) UpdateNode ¶
UpdateNode inserts - potentially overwriting - a node into the peer database. update both node record and node sequence number (node record is encoded by RLP) node sequence number is used to indicate if the record is the newest record
type ID ¶
type ID [32]byte
ID is a unique identifier for each node.
func HexID ¶
HexID converts a hex string to an ID. The string may be prefixed with 0x. It panics if the string is not a valid ID.
func PubkeyToIDV4 ¶
PubkeyToIDV4 derives the v4 node address from the given public key. based on the public key, get the node address, which is also the node id
func (ID) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface
Hex Encode the ID. hex.EncodeToString is equivalent to String() function
func (ID) String ¶
ID prints as a long hexadecimal number. convert the ID from byte slice to hexadecimal string
func (ID) TerminalString ¶
TerminalString returns a shortened hex string for terminal logging. encode and return the first 7 bytes to hexadecimal string
func (*ID) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
Parse the text passed in, update the ID with the one passed in
type LocalNode ¶
type LocalNode struct {
// contains filtered or unexported fields
}
LocalNode produces the signed node record of a local node, i.e. a node run in the current process. Setting ENR entries via the Set method updates the record. A new version of the record is signed on demand when the Node method is called.
func NewLocalNode ¶
func NewLocalNode(db *DB, key *ecdsa.PrivateKey) *LocalNode
NewLocalNode creates a local node. set the id = public key cur = nil Node key = private key set up updTracker and allocates space for entries
func (*LocalNode) Node ¶
Node returns current Node Object If the cur is pointed to a nil node then sign() function will be called to create new Node based on the information stored in the LocalNode object and the Node pointer will be stored in the cur object
func (*LocalNode) Set ¶
Set puts the given entry into the local record, overwriting any existing value.
func (*LocalNode) SetFallbackIP ¶
SetFallbackIP sets the last-resort IP address. This address is used if no endpoint prediction can be made and no static IP is set.
func (*LocalNode) SetFallbackUDP ¶
SetFallbackUDP sets the last-resort UDP port. This port is used if no endpoint prediction can be made.
func (*LocalNode) SetStaticIP ¶
SetStaticIP sets the local IP to the given one unconditionally. This disables endpoint prediction.
func (*LocalNode) UDPContact ¶
UDPContact should be called whenever the local node has announced itself to another node via UDP. It feeds the local endpoint predictor.
func (*LocalNode) UDPEndpointStatement ¶
UDPEndpointStatement should be called whenever a statement about the local node's UDP endpoint is received. It feeds the local endpoint predictor.
type Node ¶
type Node struct {
// contains filtered or unexported fields
}
Node represents a host on the network.
func MustParseV4 ¶
MustParseV4 parses a node URL. It panics if the URL is not valid.
func New ¶
New wraps a node record. The record must be valid according to the given identity scheme (contains functions on verifying node signatures stored in node record, and deriving node addresses --> Creating and initializing new Node object (node record and node address)
func NewV4 ¶
NewV4 creates a node from discovery v4 node information. The record contained in the node has a zero-length signature.
create node record and stores information inside create Node based on the information retrieved from the URL
func ParseV4 ¶
ParseV4 parses a node URL.
There are two basic forms of node URLs:
- 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
enode://<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.
enode://<hex node id>@10.3.58.6:30303?discport=30301
node after parsing will have empty signature
func SignNull ¶
set everything to null, including node ID, node record entries, node record signature
func (*Node) Incomplete ¶
Incomplete returns true for nodes with no IP address.
func (*Node) Load ¶
Load retrieves an entry from the underlying record. entry is a key value pair getting from Record.pair value is RLP encoded
func (*Node) MarshalText ¶
MarshalText implements encoding.TextMarshaler.
Convert the node URL to byte slice
func (*Node) Record ¶
Record returns the node's record. The return value is a copy and may be modified by the caller.
func (*Node) String ¶
The string representation of a Node is a URL. Please see ParseNode for a description of the format.
Get the node's URL
func (*Node) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler.
Update the node to the new node created using Node URL
func (*Node) ValidateComplete ¶
checks whether n is a valid complete node. Complete Node Criteria: 1. IP address 2. UDP Port 3. IP cannot be multicast or unspecified 4. Public Key
type NullID ¶
type NullID struct{}
NullID is the "null" ENR identity scheme. This scheme stores the node ID in the record without any signature.
Source Files