mirror of
https://gitlab.com/pulsechaincom/erigon-pulse.git
synced 2024-12-23 04:03:49 +00:00
0a48344dfe
This adds a few tiny fixes for les and the p2p simulation framework: LES Parts - Keep the LES-SERVER connection even it's non-synced We had this idea to reject the connections in LES protocol if the les-server itself is not synced. However, in LES protocol we will also receive the connection from another les-server. In this case even the local node is not synced yet, we should keep the tcp connection for other protocols(e.g. eth protocol). - Don't count "invalid message" for non-existing GetBlockHeadersMsg request In the eth syncing mechanism (full sync, fast sync, light sync), it will try to fetch some non-existent blocks or headers(to ensure we indeed download all the missing chain). In this case, it's possible that the les-server will receive the request for non-existent headers. So don't count it as the "invalid message" for scheduling dropping. - Copy the announce object in the closure Before the les-server pushes the latest headers to all connected clients, it will create a closure and queue it in the underlying request scheduler. In some scenarios it's problematic. E.g, in private networks, the block can be mined very fast. So before the first closure is executed, we may already update the latest_announce object. So actually the "announce" object we want to send is replaced. The downsize is the client will receive two announces with the same td and then drop the server. P2P Simulation Framework - Don't double register the protocol services in p2p-simulation "Start". The protocols upon the devp2p are registered in the "New node stage". So don't reigster them again when starting a node in the p2p simulation framework - Add one more new config field "ExternalSigner", in order to use clef service in the framework. # Conflicts: # les/server_handler.go
356 lines
9.4 KiB
Go
356 lines
9.4 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 adapters
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"math"
|
|
"net"
|
|
"sync"
|
|
|
|
"github.com/ledgerwatch/turbo-geth/event"
|
|
"github.com/ledgerwatch/turbo-geth/log"
|
|
"github.com/ledgerwatch/turbo-geth/node"
|
|
"github.com/ledgerwatch/turbo-geth/p2p"
|
|
"github.com/ledgerwatch/turbo-geth/p2p/enode"
|
|
"github.com/ledgerwatch/turbo-geth/p2p/simulations/pipes"
|
|
"github.com/ledgerwatch/turbo-geth/rpc"
|
|
|
|
"github.com/gorilla/websocket"
|
|
)
|
|
|
|
// SimAdapter is a NodeAdapter which creates in-memory simulation nodes and
|
|
// connects them using net.Pipe
|
|
type SimAdapter struct {
|
|
pipe func() (net.Conn, net.Conn, error)
|
|
mtx sync.RWMutex
|
|
nodes map[enode.ID]*SimNode
|
|
lifecycles LifecycleConstructors
|
|
}
|
|
|
|
// NewSimAdapter creates a SimAdapter which is capable of running in-memory
|
|
// simulation nodes running any of the given services (the services to run on a
|
|
// particular node are passed to the NewNode function in the NodeConfig)
|
|
// the adapter uses a net.Pipe for in-memory simulated network connections
|
|
func NewSimAdapter(services LifecycleConstructors) *SimAdapter {
|
|
return &SimAdapter{
|
|
pipe: pipes.NetPipe,
|
|
nodes: make(map[enode.ID]*SimNode),
|
|
lifecycles: services,
|
|
}
|
|
}
|
|
|
|
// Name returns the name of the adapter for logging purposes
|
|
func (s *SimAdapter) Name() string {
|
|
return "sim-adapter"
|
|
}
|
|
|
|
// NewNode returns a new SimNode using the given config
|
|
func (s *SimAdapter) NewNode(config *NodeConfig) (Node, error) {
|
|
s.mtx.Lock()
|
|
defer s.mtx.Unlock()
|
|
|
|
id := config.ID
|
|
// verify that the node has a private key in the config
|
|
if config.PrivateKey == nil {
|
|
return nil, fmt.Errorf("node is missing private key: %s", id)
|
|
}
|
|
|
|
// check a node with the ID doesn't already exist
|
|
if _, exists := s.nodes[id]; exists {
|
|
return nil, fmt.Errorf("node already exists: %s", id)
|
|
}
|
|
|
|
// check the services are valid
|
|
if len(config.Lifecycles) == 0 {
|
|
return nil, errors.New("node must have at least one service")
|
|
}
|
|
for _, service := range config.Lifecycles {
|
|
if _, exists := s.lifecycles[service]; !exists {
|
|
return nil, fmt.Errorf("unknown node service %q", service)
|
|
}
|
|
}
|
|
|
|
err := config.initDummyEnode()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
n, err := node.New(&node.Config{
|
|
P2P: p2p.Config{
|
|
PrivateKey: config.PrivateKey,
|
|
MaxPeers: math.MaxInt32,
|
|
NoDiscovery: true,
|
|
Dialer: s,
|
|
EnableMsgEvents: config.EnableMsgEvents,
|
|
},
|
|
ExternalSigner: config.ExternalSigner,
|
|
NoUSB: true,
|
|
Logger: log.New("node.id", id.String()),
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
simNode := &SimNode{
|
|
ID: id,
|
|
config: config,
|
|
node: n,
|
|
adapter: s,
|
|
running: make(map[string]node.Lifecycle),
|
|
}
|
|
s.nodes[id] = simNode
|
|
return simNode, nil
|
|
}
|
|
|
|
// Dial implements the p2p.NodeDialer interface by connecting to the node using
|
|
// an in-memory net.Pipe
|
|
func (s *SimAdapter) Dial(ctx context.Context, dest *enode.Node) (conn net.Conn, err error) {
|
|
node, ok := s.GetNode(dest.ID())
|
|
if !ok {
|
|
return nil, fmt.Errorf("unknown node: %s", dest.ID())
|
|
}
|
|
srv := node.Server()
|
|
if srv == nil {
|
|
return nil, fmt.Errorf("node not running: %s", dest.ID())
|
|
}
|
|
// SimAdapter.pipe is net.Pipe (NewSimAdapter)
|
|
pipe1, pipe2, err := s.pipe()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// this is simulated 'listening'
|
|
// asynchronously call the dialed destination node's p2p server
|
|
// to set up connection on the 'listening' side
|
|
go srv.SetupConn(pipe1, 0, nil)
|
|
return pipe2, nil
|
|
}
|
|
|
|
// DialRPC implements the RPCDialer interface by creating an in-memory RPC
|
|
// client of the given node
|
|
func (s *SimAdapter) DialRPC(id enode.ID) (*rpc.Client, error) {
|
|
node, ok := s.GetNode(id)
|
|
if !ok {
|
|
return nil, fmt.Errorf("unknown node: %s", id)
|
|
}
|
|
return node.node.Attach()
|
|
}
|
|
|
|
// GetNode returns the node with the given ID if it exists
|
|
func (s *SimAdapter) GetNode(id enode.ID) (*SimNode, bool) {
|
|
s.mtx.RLock()
|
|
defer s.mtx.RUnlock()
|
|
node, ok := s.nodes[id]
|
|
return node, ok
|
|
}
|
|
|
|
// SimNode is an in-memory simulation node which connects to other nodes using
|
|
// net.Pipe (see SimAdapter.Dial), running devp2p protocols directly over that
|
|
// pipe
|
|
type SimNode struct {
|
|
lock sync.RWMutex
|
|
ID enode.ID
|
|
config *NodeConfig
|
|
adapter *SimAdapter
|
|
node *node.Node
|
|
running map[string]node.Lifecycle
|
|
client *rpc.Client
|
|
registerOnce sync.Once
|
|
}
|
|
|
|
// Close closes the underlaying node.Node to release
|
|
// acquired resources.
|
|
func (sn *SimNode) Close() error {
|
|
return sn.node.Close()
|
|
}
|
|
|
|
// Addr returns the node's discovery address
|
|
func (sn *SimNode) Addr() []byte {
|
|
return []byte(sn.Node().String())
|
|
}
|
|
|
|
// Node returns a node descriptor representing the SimNode
|
|
func (sn *SimNode) Node() *enode.Node {
|
|
return sn.config.Node()
|
|
}
|
|
|
|
// Client returns an rpc.Client which can be used to communicate with the
|
|
// underlying services (it is set once the node has started)
|
|
func (sn *SimNode) Client() (*rpc.Client, error) {
|
|
sn.lock.RLock()
|
|
defer sn.lock.RUnlock()
|
|
if sn.client == nil {
|
|
return nil, errors.New("node not started")
|
|
}
|
|
return sn.client, nil
|
|
}
|
|
|
|
// ServeRPC serves RPC requests over the given connection by creating an
|
|
// in-memory client to the node's RPC server.
|
|
func (sn *SimNode) ServeRPC(conn *websocket.Conn) error {
|
|
handler, err := sn.node.RPCHandler()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
codec := rpc.NewFuncCodec(conn, conn.WriteJSON, conn.ReadJSON)
|
|
handler.ServeCodec(codec, 0)
|
|
return nil
|
|
}
|
|
|
|
// Snapshots creates snapshots of the services by calling the
|
|
// simulation_snapshot RPC method
|
|
func (sn *SimNode) Snapshots() (map[string][]byte, error) {
|
|
sn.lock.RLock()
|
|
services := make(map[string]node.Lifecycle, len(sn.running))
|
|
for name, service := range sn.running {
|
|
services[name] = service
|
|
}
|
|
sn.lock.RUnlock()
|
|
if len(services) == 0 {
|
|
return nil, errors.New("no running services")
|
|
}
|
|
snapshots := make(map[string][]byte)
|
|
for name, service := range services {
|
|
if s, ok := service.(interface {
|
|
Snapshot() ([]byte, error)
|
|
}); ok {
|
|
snap, err := s.Snapshot()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
snapshots[name] = snap
|
|
}
|
|
}
|
|
return snapshots, nil
|
|
}
|
|
|
|
// Start registers the services and starts the underlying devp2p node
|
|
func (sn *SimNode) Start(snapshots map[string][]byte) error {
|
|
// ensure we only register the services once in the case of the node
|
|
// being stopped and then started again
|
|
var regErr error
|
|
sn.registerOnce.Do(func() {
|
|
for _, name := range sn.config.Lifecycles {
|
|
ctx := &ServiceContext{
|
|
RPCDialer: sn.adapter,
|
|
Config: sn.config,
|
|
}
|
|
if snapshots != nil {
|
|
ctx.Snapshot = snapshots[name]
|
|
}
|
|
serviceFunc := sn.adapter.lifecycles[name]
|
|
service, err := serviceFunc(ctx, sn.node)
|
|
if err != nil {
|
|
regErr = err
|
|
break
|
|
}
|
|
// if the service has already been registered, don't register it again.
|
|
if _, ok := sn.running[name]; ok {
|
|
continue
|
|
}
|
|
sn.running[name] = service
|
|
}
|
|
})
|
|
if regErr != nil {
|
|
return regErr
|
|
}
|
|
|
|
if err := sn.node.Start(); err != nil {
|
|
return err
|
|
}
|
|
|
|
// create an in-process RPC client
|
|
client, err := sn.node.Attach()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
sn.lock.Lock()
|
|
sn.client = client
|
|
sn.lock.Unlock()
|
|
|
|
return nil
|
|
}
|
|
|
|
// Stop closes the RPC client and stops the underlying devp2p node
|
|
func (sn *SimNode) Stop() error {
|
|
sn.lock.Lock()
|
|
if sn.client != nil {
|
|
sn.client.Close()
|
|
sn.client = nil
|
|
}
|
|
sn.lock.Unlock()
|
|
return sn.node.Close()
|
|
}
|
|
|
|
// Service returns a running service by name
|
|
func (sn *SimNode) Service(name string) node.Lifecycle {
|
|
sn.lock.RLock()
|
|
defer sn.lock.RUnlock()
|
|
return sn.running[name]
|
|
}
|
|
|
|
// Services returns a copy of the underlying services
|
|
func (sn *SimNode) Services() []node.Lifecycle {
|
|
sn.lock.RLock()
|
|
defer sn.lock.RUnlock()
|
|
services := make([]node.Lifecycle, 0, len(sn.running))
|
|
for _, service := range sn.running {
|
|
services = append(services, service)
|
|
}
|
|
return services
|
|
}
|
|
|
|
// ServiceMap returns a map by names of the underlying services
|
|
func (sn *SimNode) ServiceMap() map[string]node.Lifecycle {
|
|
sn.lock.RLock()
|
|
defer sn.lock.RUnlock()
|
|
services := make(map[string]node.Lifecycle, len(sn.running))
|
|
for name, service := range sn.running {
|
|
services[name] = service
|
|
}
|
|
return services
|
|
}
|
|
|
|
// Server returns the underlying p2p.Server
|
|
func (sn *SimNode) Server() *p2p.Server {
|
|
return sn.node.Server()
|
|
}
|
|
|
|
// SubscribeEvents subscribes the given channel to peer events from the
|
|
// underlying p2p.Server
|
|
func (sn *SimNode) SubscribeEvents(ch chan *p2p.PeerEvent) event.Subscription {
|
|
srv := sn.Server()
|
|
if srv == nil {
|
|
panic("node not running")
|
|
}
|
|
return srv.SubscribeEvents(ch)
|
|
}
|
|
|
|
// NodeInfo returns information about the node
|
|
func (sn *SimNode) NodeInfo() *p2p.NodeInfo {
|
|
server := sn.Server()
|
|
if server == nil {
|
|
return &p2p.NodeInfo{
|
|
ID: sn.ID.String(),
|
|
Enode: sn.Node().String(),
|
|
}
|
|
}
|
|
return server.NodeInfo()
|
|
}
|