discover

package
v0.0.0-...-dee6c83 Latest Latest
Warning

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

 Go to latest Published: Apr 27, 2021 License: GPL-3.0, LGPL-3.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

View Source 
const NodeIDBits = 512
View Source 
const Version = 0x01

Variables

This section is empty.

Functions

func ListenUDP 

func ListenUDP(priv *ecdsa.PrivateKey, nodeType NodeType, laddr string, natm nat.Interface, nodeDBPath string, netrestrict *netutil.Netlist) (*Table, *EndPoint, error)

ListenUDP returns a new table that listens for UDP packets on laddr.

Types

type EndPoint 

type EndPoint struct {
	IP  net.IP // len 4 for IPv4 or 16 for IPv6
	UDP uint16 // for discovery protocol
	TCP uint16 // for RLPx protocol
}

type ExtData 

type ExtData struct {
	Loacation uint8
}

type Node 

type Node struct {
	IP       net.IP // len 4 for IPv4 or 16 for IPv6
	UDP, TCP uint16 // port numbers
	ID       NodeID // the node's public key

	TYPE NodeType
	Ext  ExtData
	// contains filtered or unexported fields
}

Node represents a host on the network. The fields of Node may not be modified.

func MustParseNode 

func MustParseNode(rawurl string) *Node

MustParseNode parses a node URL. It panics if the URL is not valid.

func NewNode 

func NewNode(id NodeID, ip net.IP, udpPort, tcpPort uint16) *Node

NewNode creates a new node. It is mostly meant to be used for testing purposes.

func ParseNode 

func ParseNode(rawurl string) (*Node, error)

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 

hnode://<hex node id>&<int8 node role>
<hex node id>&<int8 node role>

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 27000 and UDP discovery port 30301. 

hnode://<hex node id>&<int8 node role>@10.3.58.6:27000?discport=30301

func (*Node) Incomplete 

func (n *Node) Incomplete() bool

Incomplete returns true for nodes with no IP address.

func (*Node) MarshalText 

func (n *Node) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*Node) String 

func (n *Node) String() string

The string representation of a Node is a URL. Please see ParseNode for a description of the format.

func (*Node) UnmarshalText 

func (n *Node) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type NodeID 

type NodeID [NodeIDBits / 8]byte

NodeID is a unique identifier for each node. The node identifier is a marshaled elliptic curve public key.

func BytesID 

func BytesID(b []byte) (NodeID, error)

BytesID converts a byte slice to a NodeID

func HexID 

func HexID(in string) (NodeID, error)

HexID converts a hex string to a NodeID. The string may be prefixed with 0x.

func MustBytesID 

func MustBytesID(b []byte) NodeID

MustBytesID converts a byte slice to a NodeID. It panics if the byte slice is not a valid NodeID.

func MustHexID 

func MustHexID(in string) NodeID

MustHexID converts a hex string to a NodeID. It panics if the string is not a valid NodeID.

func PubkeyID 

func PubkeyID(pub *ecdsa.PublicKey) NodeID

PubkeyID returns a marshaled representation of the given public key.

func (NodeID) Bytes 

func (n NodeID) Bytes() []byte

Bytes returns a byte slice representation of the NodeID

func (NodeID) GoString 

func (n NodeID) GoString() string

The Go syntax representation of a NodeID is a call to HexID.

func (NodeID) MarshalText 

func (n NodeID) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (NodeID) Pubkey 

func (id NodeID) Pubkey() (*ecdsa.PublicKey, error)

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 (NodeID) String 

func (n NodeID) String() string

NodeID prints as a long hexadecimal number.

func (NodeID) TerminalString 

func (n NodeID) TerminalString() string

TerminalString returns a shortened hex string for terminal logging.

func (*NodeID) UnmarshalText 

func (n *NodeID) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type NodeReq 

type NodeReq struct {
	Version    uint
	Expiration uint64
}

getnodes is a query for nodes

type NodeRes 

type NodeRes struct {
	Version    uint
	Nodes      []RpcNode
	Expiration uint64
}

reply to getnodes

type NodeType 

type NodeType uint8
const (
	MineNode NodeType = 0x60
	BootNode NodeType = 0xA0
)

func (NodeType) ToString 

func (nt NodeType) ToString() string

type RpcNode 

type RpcNode struct {
	IP  net.IP // len 4 for IPv4 or 16 for IPv6
	UDP uint16 // for discovery protocol
	TCP uint16 // for RLPx protocol
	ID  NodeID
}

func NodeToRPC 

func NodeToRPC(n *Node) RpcNode

type Table 

type Table struct {
	// contains filtered or unexported fields
}

func (*Table) AddNode 

func (tab *Table) AddNode(node *Node)

func (*Table) Bondall 

func (tab *Table) Bondall(nodes []*Node) int

func (*Table) Close 

func (tab *Table) Close()

Close terminates the network listener and flushes the node database.

func (*Table) FindNodes 

func (tab *Table) FindNodes() (buf []*Node)

func (*Table) HasNode 

func (tab *Table) HasNode(nid NodeID) bool

func (*Table) RemoveNode 

func (tab *Table) RemoveNode(nid NodeID)

func (*Table) Self 

func (tab *Table) Self() *Node

Self returns the local node. The returned node should not be modified by the caller.

func (*Table) SetFallbackNodes 

func (tab *Table) SetFallbackNodes(nodes []*Node) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.