adapters

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Jan 4, 2023 License: GPL-3.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterLifecycles

func RegisterLifecycles(lifecycles LifecycleConstructors)

RegisterLifecycles registers the given Services which can then be used to start devp2p nodes using either the Exec or Docker adapters.

It should be called in an init function so that it has the opportunity to execute the services before main() is called.

Types

type ExecAdapter

type ExecAdapter struct {
	// BaseDir is the directory under which the data directories for each
	// simulation node are created.
	BaseDir string
	// contains filtered or unexported fields
}

ExecAdapter is a NodeAdapter which runs simulation nodes by executing the current binary as a child process.

func NewExecAdapter

func NewExecAdapter(baseDir string) *ExecAdapter

NewExecAdapter returns an ExecAdapter which stores node data in subdirectories of the given base directory

func (*ExecAdapter) Name

func (e *ExecAdapter) Name() string

Name returns the name of the adapter for logging purposes

func (*ExecAdapter) NewNode

func (e *ExecAdapter) NewNode(config *NodeConfig) (Node, error)

NewNode returns a new ExecNode using the given config

type ExecNode

type ExecNode struct {
	ID     enode.ID
	Dir    string
	Config *execNodeConfig
	Cmd    *exec.Cmd
	Info   *p2p.NodeInfo
	// contains filtered or unexported fields
}

ExecNode starts a simulation node by exec'ing the current binary and running the configured services

func (*ExecNode) Addr

func (n *ExecNode) Addr() []byte

Addr returns the node's enode URL

func (*ExecNode) Client

func (n *ExecNode) Client() (*rpc.Client, error)

Client returns an rpc.Client which can be used to communicate with the underlying services (it is set once the node has started)

func (*ExecNode) NodeInfo

func (n *ExecNode) NodeInfo() *p2p.NodeInfo

NodeInfo returns information about the node

func (*ExecNode) ServeRPC

func (n *ExecNode) ServeRPC(clientConn *websocket.Conn) error

ServeRPC serves RPC requests over the given connection by dialling the node's WebSocket address and joining the two connections

func (*ExecNode) Snapshots

func (n *ExecNode) Snapshots() (map[string][]byte, error)

Snapshots creates snapshots of the services by calling the simulation_snapshot RPC method

func (*ExecNode) Start

func (n *ExecNode) Start(snapshots map[string][]byte) (err error)

Start exec's the node passing the ID and service as command line arguments and the node config encoded as JSON in an environment variable.

func (*ExecNode) Stop

func (n *ExecNode) Stop() error

Stop stops the node by first sending SIGTERM and then SIGKILL if the node doesn't stop within 5s

type LifecycleConstructor

type LifecycleConstructor func(ctx *ServiceContext, stack *node.Node) (node.Lifecycle, error)

LifecycleConstructor allows a Lifecycle to be constructed during node start-up. While the service-specific package usually takes care of Lifecycle creation and registration, for testing purposes, it is useful to be able to construct a Lifecycle on spot.

type LifecycleConstructors

type LifecycleConstructors map[string]LifecycleConstructor

LifecycleConstructors stores LifecycleConstructor functions to call during node start-up.

type Node

type Node interface {
	// Addr returns the node's address (e.g. an Enode URL)
	Addr() []byte

	// Client returns the RPC client which is created once the node is
	// up and running
	Client() (*rpc.Client, error)

	// ServeRPC serves RPC requests over the given connection
	ServeRPC(*websocket.Conn) error

	// Start starts the node with the given snapshots
	Start(snapshots map[string][]byte) error

	// Stop stops the node
	Stop() error

	// NodeInfo returns information about the node
	NodeInfo() *p2p.NodeInfo

	// Snapshots creates snapshots of the running services
	Snapshots() (map[string][]byte, error)
}

Node represents a node in a simulation network which is created by a NodeAdapter, for example:

* SimNode - An in-memory node * ExecNode - A child process node * DockerNode - A Docker container node

type NodeAdapter

type NodeAdapter interface {
	// Name returns the name of the adapter for logging purposes
	Name() string

	// NewNode creates a new node with the given configuration
	NewNode(config *NodeConfig) (Node, error)
}

NodeAdapter is used to create Nodes in a simulation network

type NodeConfig

type NodeConfig struct {
	// ID is the node's ID which is used to identify the node in the
	// simulation network
	ID enode.ID

	// PrivateKey is the node's private key which is used by the devp2p
	// stack to encrypt communications
	PrivateKey *ecdsa.PrivateKey

	// Enable peer events for Msgs
	EnableMsgEvents bool

	// Name is a human friendly name for the node like "node01"
	Name string

	// Use an existing database instead of a temporary one if non-empty
	DataDir string

	// Lifecycles are the names of the service lifecycles which should be run when
	// starting the node (for SimNodes it should be the names of service lifecycles
	// contained in SimAdapter.lifecycles, for other nodes it should be
	// service lifecycles registered by calling the RegisterLifecycle function)
	Lifecycles []string

	// Properties are the names of the properties this node should hold
	// within running services (e.g. "bootnode", "lightnode" or any custom values)
	// These values need to be checked and acted upon by node Services
	Properties []string

	// ExternalSigner specifies an external URI for a clef-type signer
	ExternalSigner string

	// ENR Record with entries to overwrite
	Record enr.Record

	// function to sanction or prevent suggesting a peer
	Reachable func(id enode.ID) bool

	Port uint16

	// LogFile is the log file name of the p2p node at runtime.
	//
	// The default value is empty so that the default log writer
	// is the system standard output.
	LogFile string

	// LogVerbosity is the log verbosity of the p2p node at runtime.
	//
	// The default verbosity is INFO.
	LogVerbosity log.Lvl
	// contains filtered or unexported fields
}

NodeConfig is the configuration used to start a node in a simulation network

func RandomNodeConfig

func RandomNodeConfig() *NodeConfig

RandomNodeConfig returns node configuration with a randomly generated ID and PrivateKey

func (*NodeConfig) MarshalJSON

func (n *NodeConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface by encoding the config fields as strings

func (*NodeConfig) Node

func (n *NodeConfig) Node() *enode.Node

Node returns the node descriptor represented by the config.

func (*NodeConfig) UnmarshalJSON

func (n *NodeConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface by decoding the json string values into the config fields

type RPCDialer

type RPCDialer interface {
	DialRPC(id enode.ID) (*rpc.Client, error)
}

RPCDialer is used when initialising services which need to connect to other nodes in the network (for example a simulated Swarm node which needs to connect to a Geth node to resolve ENS names)

type ServiceContext

type ServiceContext struct {
	RPCDialer

	Config   *NodeConfig
	Snapshot []byte
}

ServiceContext is a collection of options and methods which can be utilised when starting services

type SimAdapter

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

SimAdapter is a NodeAdapter which creates in-memory simulation nodes and connects them using net.Pipe

func NewSimAdapter

func NewSimAdapter(services LifecycleConstructors) *SimAdapter

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 (*SimAdapter) Dial

func (s *SimAdapter) Dial(ctx context.Context, dest *enode.Node) (conn net.Conn, err error)

Dial implements the p2p.NodeDialer interface by connecting to the node using an in-memory net.Pipe

func (*SimAdapter) DialRPC

func (s *SimAdapter) DialRPC(id enode.ID) (*rpc.Client, error)

DialRPC implements the RPCDialer interface by creating an in-memory RPC client of the given node

func (*SimAdapter) GetNode

func (s *SimAdapter) GetNode(id enode.ID) (*SimNode, bool)

GetNode returns the node with the given ID if it exists

func (*SimAdapter) Name

func (s *SimAdapter) Name() string

Name returns the name of the adapter for logging purposes

func (*SimAdapter) NewNode

func (s *SimAdapter) NewNode(config *NodeConfig) (Node, error)

NewNode returns a new SimNode using the given config

type SimNode

type SimNode struct {
	ID enode.ID
	// contains filtered or unexported fields
}

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

func (*SimNode) Addr

func (sn *SimNode) Addr() []byte

Addr returns the node's discovery address

func (*SimNode) Client

func (sn *SimNode) Client() (*rpc.Client, error)

Client returns an rpc.Client which can be used to communicate with the underlying services (it is set once the node has started)

func (*SimNode) Close

func (sn *SimNode) Close() error

Close closes the underlaying node.Node to release acquired resources.

func (*SimNode) Node

func (sn *SimNode) Node() *enode.Node

Node returns a node descriptor representing the SimNode

func (*SimNode) NodeInfo

func (sn *SimNode) NodeInfo() *p2p.NodeInfo

NodeInfo returns information about the node

func (*SimNode) ServeRPC

func (sn *SimNode) ServeRPC(conn *websocket.Conn) error

ServeRPC serves RPC requests over the given connection by creating an in-memory client to the node's RPC server.

func (*SimNode) Server

func (sn *SimNode) Server() *p2p.Server

Server returns the underlying p2p.Server

func (*SimNode) Service

func (sn *SimNode) Service(name string) node.Lifecycle

Service returns a running service by name

func (*SimNode) ServiceMap

func (sn *SimNode) ServiceMap() map[string]node.Lifecycle

ServiceMap returns a map by names of the underlying services

func (*SimNode) Services

func (sn *SimNode) Services() []node.Lifecycle

Services returns a copy of the underlying services

func (*SimNode) Snapshots

func (sn *SimNode) Snapshots() (map[string][]byte, error)

Snapshots creates snapshots of the services by calling the simulation_snapshot RPC method

func (*SimNode) Start

func (sn *SimNode) Start(snapshots map[string][]byte) error

Start registers the services and starts the underlying devp2p node

func (*SimNode) Stop

func (sn *SimNode) Stop() error

Stop closes the RPC client and stops the underlying devp2p node

func (*SimNode) SubscribeEvents

func (sn *SimNode) SubscribeEvents(ch chan *p2p.PeerEvent) event.Subscription

SubscribeEvents subscribes the given channel to peer events from the underlying p2p.Server

type SnapshotAPI

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

SnapshotAPI provides an RPC method to create snapshots of services

func (SnapshotAPI) Snapshot

func (api SnapshotAPI) Snapshot() (map[string][]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL