ac86547b01
* p2p/discover: remove ReadRandomNodes Even though it's public, this method is not callable by code outside of package p2p/discover because one can't get a valid instance of Table. * p2p/discover: add Table.Nodes * p2p/discover: make Table settings configurable In unit tests and externally developed cmd/devp2p test runs, it can be useful to tune the timer intervals used by Table.
102 lines
3.0 KiB
Go
102 lines
3.0 KiB
Go
// Copyright 2019 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 discover
|
|
|
|
import (
|
|
"crypto/ecdsa"
|
|
"net"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/common/mclock"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/p2p/enode"
|
|
"github.com/ethereum/go-ethereum/p2p/enr"
|
|
"github.com/ethereum/go-ethereum/p2p/netutil"
|
|
)
|
|
|
|
// UDPConn is a network connection on which discovery can operate.
|
|
type UDPConn interface {
|
|
ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error)
|
|
WriteToUDP(b []byte, addr *net.UDPAddr) (n int, err error)
|
|
Close() error
|
|
LocalAddr() net.Addr
|
|
}
|
|
|
|
// Config holds settings for the discovery listener.
|
|
type Config struct {
|
|
// These settings are required and configure the UDP listener:
|
|
PrivateKey *ecdsa.PrivateKey
|
|
|
|
// All remaining settings are optional.
|
|
|
|
// Packet handling configuration:
|
|
NetRestrict *netutil.Netlist // list of allowed IP networks
|
|
Unhandled chan<- ReadPacket // unhandled packets are sent on this channel
|
|
|
|
// Node table configuration:
|
|
Bootnodes []*enode.Node // list of bootstrap nodes
|
|
PingInterval time.Duration // speed of node liveness check
|
|
RefreshInterval time.Duration // used in bucket refresh
|
|
|
|
// The options below are useful in very specific cases, like in unit tests.
|
|
V5ProtocolID *[6]byte
|
|
Log log.Logger // if set, log messages go here
|
|
ValidSchemes enr.IdentityScheme // allowed identity schemes
|
|
Clock mclock.Clock
|
|
}
|
|
|
|
func (cfg Config) withDefaults() Config {
|
|
// Node table configuration:
|
|
if cfg.PingInterval == 0 {
|
|
cfg.PingInterval = 10 * time.Second
|
|
}
|
|
if cfg.RefreshInterval == 0 {
|
|
cfg.RefreshInterval = 30 * time.Minute
|
|
}
|
|
|
|
// Debug/test settings:
|
|
if cfg.Log == nil {
|
|
cfg.Log = log.Root()
|
|
}
|
|
if cfg.ValidSchemes == nil {
|
|
cfg.ValidSchemes = enode.ValidSchemes
|
|
}
|
|
if cfg.Clock == nil {
|
|
cfg.Clock = mclock.System{}
|
|
}
|
|
return cfg
|
|
}
|
|
|
|
// ListenUDP starts listening for discovery packets on the given UDP socket.
|
|
func ListenUDP(c UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv4, error) {
|
|
return ListenV4(c, ln, cfg)
|
|
}
|
|
|
|
// ReadPacket is a packet that couldn't be handled. Those packets are sent to the unhandled
|
|
// channel if configured.
|
|
type ReadPacket struct {
|
|
Data []byte
|
|
Addr *net.UDPAddr
|
|
}
|
|
|
|
func min(x, y int) int {
|
|
if x > y {
|
|
return y
|
|
}
|
|
return x
|
|
}
|