Documentation
¶
Overview ¶
Package enr implements Ethereum Node Records as defined in EIP-778. A node record holds arbitrary information about a node on the peer-to-peer network. Node information is stored in key/value pairs. To store and retrieve key/values in a record, use the Entry interface.
Signature Handling ¶
Records must be signed before transmitting them to another node.
Decoding a record doesn't check its signature. Code working with records from an untrusted source must always verify two things: that the record uses an identity scheme deemed secure, and that the signature is valid according to the declared scheme.
When creating a record, set the entries you want and use a signing function provided by the identity scheme to add the signature. Modifying a record invalidates the signature.
Package enr supports the "secp256k1-keccak" identity scheme.
Index ¶
- Constants
- Variables
- func IsNotFound(err error) bool
- type Entry
- type ID
- type IP
- type IPv4
- type IPv4Addr
- type IPv6
- type IPv6Addr
- type IdentityScheme
- type KeyError
- type QUIC
- type QUIC6
- type Record
- func (r *Record) AppendElements(list []interface{}) []interface{}
- func (r *Record) DecodeRLP(s *rlp.Stream) error
- func (r Record) EncodeRLP(w io.Writer) error
- func (r *Record) IdentityScheme() string
- func (r *Record) Load(e Entry) error
- func (r *Record) Seq() uint64
- func (r *Record) Set(e Entry)
- func (r *Record) SetSeq(s uint64)
- func (r *Record) SetSig(s IdentityScheme, sig []byte) error
- func (r *Record) Signature() []byte
- func (r *Record) Size() uint64
- func (r *Record) VerifySignature(s IdentityScheme) error
- type SchemeMap
- type TCP
- type TCP6
- type UDP
- type UDP6
Constants ¶
const IDv4 = ID("v4") // the default identity scheme
const SizeLimit = 300 // maximum encoded size of a node record in bytes
Variables ¶
var (
ErrInvalidSig = errors.New("invalid signature on node record")
)
Functions ¶
func IsNotFound ¶
IsNotFound reports whether the given error means that a key/value pair is missing from a record.
Types ¶
type Entry ¶
type Entry interface {
ENRKey() string
}
Entry is implemented by known node record entry types.
To define a new entry that is to be included in a node record, create a Go type that satisfies this interface. The type should also implement rlp.Decoder if additional checks are needed on the value.
type IP ¶
IP is either the "ip" or "ip6" key, depending on the value. Use this value to encode IP addresses that can be either v4 or v6. To load an address from a record use the IPv4 or IPv6 types.
type IPv4 ¶
IPv4 is the "ip" key, which holds the IP address of the node.
type IPv4Addr ¶
IPv4Addr is the "ip" key, which holds the IP address of the node.
type IPv6 ¶
IPv6 is the "ip6" key, which holds the IP address of the node.
type IPv6Addr ¶
IPv6Addr is the "ip6" key, which holds the IP address of the node.
type IdentityScheme ¶
An IdentityScheme is capable of verifying record signatures and deriving node addresses.
type QUIC6 ¶
type QUIC6 uint16
QUIC6 is the "quic6" key, which holds the IPv6-specific quic6 port of the node.
type Record ¶
type Record struct {
// contains filtered or unexported fields
}
Record represents a node record. The zero value is an empty record.
func (*Record) AppendElements ¶
func (r *Record) AppendElements(list []interface{}) []interface{}
AppendElements appends the sequence number and entries to the given slice.
func (Record) EncodeRLP ¶
EncodeRLP implements rlp.Encoder. Encoding fails if the record is unsigned.
func (*Record) IdentityScheme ¶
IdentityScheme returns the name of the identity scheme in the record.
func (*Record) Load ¶
Load retrieves the value of a key/value pair. The given Entry must be a pointer and will be set to the value of the entry in the record.
Errors returned by Load are wrapped in KeyError. You can distinguish decoding errors from missing keys using the IsNotFound function.
func (*Record) Set ¶
Set adds or updates the given entry in the record. It panics if the value can't be encoded. If the record is signed, Set increments the sequence number and invalidates the sequence number.
func (*Record) SetSeq ¶
SetSeq updates the record sequence number. This invalidates any signature on the record. Calling SetSeq is usually not required because setting any key in a signed record increments the sequence number.
func (*Record) SetSig ¶
func (r *Record) SetSig(s IdentityScheme, sig []byte) error
SetSig sets the record signature. It returns an error if the encoded record is larger than the size limit or if the signature is invalid according to the passed scheme.
You can also use SetSig to remove the signature explicitly by passing a nil scheme and signature.
SetSig panics when either the scheme or the signature (but not both) are nil.
func (*Record) VerifySignature ¶
func (r *Record) VerifySignature(s IdentityScheme) error
VerifySignature checks whether the record is signed using the given identity scheme.
type SchemeMap ¶
type SchemeMap map[string]IdentityScheme
SchemeMap is a registry of named identity schemes.
type TCP6 ¶
type TCP6 uint16
TCP6 is the "tcp6" key, which holds the IPv6-specific tcp6 port of the node.
Source Files