f544fc3b46
Add `quic` entry to the ENR as proposed in https://github.com/ethereum/consensus-specs/pull/3644 --------- Co-authored-by: lightclient <lightclient@protonmail.com>
262 lines
6.6 KiB
Go
262 lines
6.6 KiB
Go
// Copyright 2017 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package enr
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net"
|
|
"net/netip"
|
|
|
|
"github.com/ethereum/go-ethereum/rlp"
|
|
)
|
|
|
|
// 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 Entry interface {
|
|
ENRKey() string
|
|
}
|
|
|
|
type generic struct {
|
|
key string
|
|
value interface{}
|
|
}
|
|
|
|
func (g generic) ENRKey() string { return g.key }
|
|
|
|
func (g generic) EncodeRLP(w io.Writer) error {
|
|
return rlp.Encode(w, g.value)
|
|
}
|
|
|
|
func (g *generic) DecodeRLP(s *rlp.Stream) error {
|
|
return s.Decode(g.value)
|
|
}
|
|
|
|
// WithEntry wraps any value with a key name. It can be used to set and load arbitrary values
|
|
// in a record. The value v must be supported by rlp. To use WithEntry with Load, the value
|
|
// must be a pointer.
|
|
func WithEntry(k string, v interface{}) Entry {
|
|
return &generic{key: k, value: v}
|
|
}
|
|
|
|
// TCP is the "tcp" key, which holds the TCP port of the node.
|
|
type TCP uint16
|
|
|
|
func (v TCP) ENRKey() string { return "tcp" }
|
|
|
|
// TCP6 is the "tcp6" key, which holds the IPv6-specific tcp6 port of the node.
|
|
type TCP6 uint16
|
|
|
|
func (v TCP6) ENRKey() string { return "tcp6" }
|
|
|
|
// UDP is the "udp" key, which holds the UDP port of the node.
|
|
type UDP uint16
|
|
|
|
func (v UDP) ENRKey() string { return "udp" }
|
|
|
|
// UDP6 is the "udp6" key, which holds the IPv6-specific UDP port of the node.
|
|
type UDP6 uint16
|
|
|
|
func (v UDP6) ENRKey() string { return "udp6" }
|
|
|
|
// QUIC is the "quic" key, which holds the QUIC port of the node.
|
|
type QUIC uint16
|
|
|
|
func (v QUIC) ENRKey() string { return "quic" }
|
|
|
|
// QUIC6 is the "quic6" key, which holds the IPv6-specific quic6 port of the node.
|
|
type QUIC6 uint16
|
|
|
|
func (v QUIC6) ENRKey() string { return "quic6" }
|
|
|
|
// ID is the "id" key, which holds the name of the identity scheme.
|
|
type ID string
|
|
|
|
const IDv4 = ID("v4") // the default identity scheme
|
|
|
|
func (v ID) ENRKey() string { return "id" }
|
|
|
|
// 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 IP net.IP
|
|
|
|
func (v IP) ENRKey() string {
|
|
if net.IP(v).To4() == nil {
|
|
return "ip6"
|
|
}
|
|
return "ip"
|
|
}
|
|
|
|
// EncodeRLP implements rlp.Encoder.
|
|
func (v IP) EncodeRLP(w io.Writer) error {
|
|
if ip4 := net.IP(v).To4(); ip4 != nil {
|
|
return rlp.Encode(w, ip4)
|
|
}
|
|
if ip6 := net.IP(v).To16(); ip6 != nil {
|
|
return rlp.Encode(w, ip6)
|
|
}
|
|
return fmt.Errorf("invalid IP address: %v", net.IP(v))
|
|
}
|
|
|
|
// DecodeRLP implements rlp.Decoder.
|
|
func (v *IP) DecodeRLP(s *rlp.Stream) error {
|
|
if err := s.Decode((*net.IP)(v)); err != nil {
|
|
return err
|
|
}
|
|
if len(*v) != 4 && len(*v) != 16 {
|
|
return fmt.Errorf("invalid IP address, want 4 or 16 bytes: %v", *v)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// IPv4 is the "ip" key, which holds the IP address of the node.
|
|
type IPv4 net.IP
|
|
|
|
func (v IPv4) ENRKey() string { return "ip" }
|
|
|
|
// EncodeRLP implements rlp.Encoder.
|
|
func (v IPv4) EncodeRLP(w io.Writer) error {
|
|
ip4 := net.IP(v).To4()
|
|
if ip4 == nil {
|
|
return fmt.Errorf("invalid IPv4 address: %v", net.IP(v))
|
|
}
|
|
return rlp.Encode(w, ip4)
|
|
}
|
|
|
|
// DecodeRLP implements rlp.Decoder.
|
|
func (v *IPv4) DecodeRLP(s *rlp.Stream) error {
|
|
if err := s.Decode((*net.IP)(v)); err != nil {
|
|
return err
|
|
}
|
|
if len(*v) != 4 {
|
|
return fmt.Errorf("invalid IPv4 address, want 4 bytes: %v", *v)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// IPv6 is the "ip6" key, which holds the IP address of the node.
|
|
type IPv6 net.IP
|
|
|
|
func (v IPv6) ENRKey() string { return "ip6" }
|
|
|
|
// EncodeRLP implements rlp.Encoder.
|
|
func (v IPv6) EncodeRLP(w io.Writer) error {
|
|
ip6 := net.IP(v).To16()
|
|
if ip6 == nil {
|
|
return fmt.Errorf("invalid IPv6 address: %v", net.IP(v))
|
|
}
|
|
return rlp.Encode(w, ip6)
|
|
}
|
|
|
|
// DecodeRLP implements rlp.Decoder.
|
|
func (v *IPv6) DecodeRLP(s *rlp.Stream) error {
|
|
if err := s.Decode((*net.IP)(v)); err != nil {
|
|
return err
|
|
}
|
|
if len(*v) != 16 {
|
|
return fmt.Errorf("invalid IPv6 address, want 16 bytes: %v", *v)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// IPv4Addr is the "ip" key, which holds the IP address of the node.
|
|
type IPv4Addr netip.Addr
|
|
|
|
func (v IPv4Addr) ENRKey() string { return "ip" }
|
|
|
|
// EncodeRLP implements rlp.Encoder.
|
|
func (v IPv4Addr) EncodeRLP(w io.Writer) error {
|
|
addr := netip.Addr(v)
|
|
if !addr.Is4() {
|
|
return errors.New("address is not IPv4")
|
|
}
|
|
enc := rlp.NewEncoderBuffer(w)
|
|
bytes := addr.As4()
|
|
enc.WriteBytes(bytes[:])
|
|
return enc.Flush()
|
|
}
|
|
|
|
// DecodeRLP implements rlp.Decoder.
|
|
func (v *IPv4Addr) DecodeRLP(s *rlp.Stream) error {
|
|
var bytes [4]byte
|
|
if err := s.ReadBytes(bytes[:]); err != nil {
|
|
return err
|
|
}
|
|
*v = IPv4Addr(netip.AddrFrom4(bytes))
|
|
return nil
|
|
}
|
|
|
|
// IPv6Addr is the "ip6" key, which holds the IP address of the node.
|
|
type IPv6Addr netip.Addr
|
|
|
|
func (v IPv6Addr) ENRKey() string { return "ip6" }
|
|
|
|
// EncodeRLP implements rlp.Encoder.
|
|
func (v IPv6Addr) EncodeRLP(w io.Writer) error {
|
|
addr := netip.Addr(v)
|
|
if !addr.Is6() {
|
|
return errors.New("address is not IPv6")
|
|
}
|
|
enc := rlp.NewEncoderBuffer(w)
|
|
bytes := addr.As16()
|
|
enc.WriteBytes(bytes[:])
|
|
return enc.Flush()
|
|
}
|
|
|
|
// DecodeRLP implements rlp.Decoder.
|
|
func (v *IPv6Addr) DecodeRLP(s *rlp.Stream) error {
|
|
var bytes [16]byte
|
|
if err := s.ReadBytes(bytes[:]); err != nil {
|
|
return err
|
|
}
|
|
*v = IPv6Addr(netip.AddrFrom16(bytes))
|
|
return nil
|
|
}
|
|
|
|
// KeyError is an error related to a key.
|
|
type KeyError struct {
|
|
Key string
|
|
Err error
|
|
}
|
|
|
|
// Error implements error.
|
|
func (err *KeyError) Error() string {
|
|
if err.Err == errNotFound {
|
|
return fmt.Sprintf("missing ENR key %q", err.Key)
|
|
}
|
|
return fmt.Sprintf("ENR key %q: %v", err.Key, err.Err)
|
|
}
|
|
|
|
func (err *KeyError) Unwrap() error {
|
|
return err.Err
|
|
}
|
|
|
|
// IsNotFound reports whether the given error means that a key/value pair is
|
|
// missing from a record.
|
|
func IsNotFound(err error) bool {
|
|
var ke *KeyError
|
|
if errors.As(err, &ke) {
|
|
return ke.Err == errNotFound
|
|
}
|
|
return false
|
|
}
|