aboutsummaryrefslogtreecommitdiffstats
path: root/node
diff options
context:
space:
mode:
Diffstat (limited to 'node')
-rw-r--r--node/config.go91
-rw-r--r--node/config_test.go3
-rw-r--r--node/defaults.go26
-rw-r--r--node/node.go29
-rw-r--r--node/node_example_test.go20
-rw-r--r--node/node_test.go4
6 files changed, 58 insertions, 115 deletions
diff --git a/node/config.go b/node/config.go
index b060b05f2..7c17e707d 100644
--- a/node/config.go
+++ b/node/config.go
@@ -20,7 +20,6 @@ import (
"crypto/ecdsa"
"fmt"
"io/ioutil"
- "net"
"os"
"path/filepath"
"runtime"
@@ -32,10 +31,8 @@ import (
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/crypto"
"github.com/ethereum/go-ethereum/log"
+ "github.com/ethereum/go-ethereum/p2p"
"github.com/ethereum/go-ethereum/p2p/discover"
- "github.com/ethereum/go-ethereum/p2p/discv5"
- "github.com/ethereum/go-ethereum/p2p/nat"
- "github.com/ethereum/go-ethereum/p2p/netutil"
)
var (
@@ -53,14 +50,14 @@ type Config struct {
// Name sets the instance name of the node. It must not contain the / character and is
// used in the devp2p node identifier. The instance name of geth is "geth". If no
// value is specified, the basename of the current executable is used.
- Name string
+ Name string `toml:"-"`
// UserIdent, if set, is used as an additional component in the devp2p node identifier.
- UserIdent string
+ UserIdent string `toml:",omitempty"`
// Version should be set to the version number of the program. It is used
// in the devp2p node identifier.
- Version string
+ Version string `toml:"-"`
// DataDir is the file system folder the node should use for any data storage
// requirements. The configured data directory will not be directly shared with
@@ -69,6 +66,9 @@ type Config struct {
// in memory.
DataDir string
+ // Configuration of peer-to-peer networking.
+ P2P p2p.Config
+
// KeyStoreDir is the file system folder that contains private keys. The directory can
// be specified as a relative path, in which case it is resolved relative to the
// current directory.
@@ -76,106 +76,55 @@ type Config struct {
// If KeyStoreDir is empty, the default location is the "keystore" subdirectory of
// DataDir. If DataDir is unspecified and KeyStoreDir is empty, an ephemeral directory
// is created by New and destroyed when the node is stopped.
- KeyStoreDir string
+ KeyStoreDir string `toml:",omitempty"`
// UseLightweightKDF lowers the memory and CPU requirements of the key store
// scrypt KDF at the expense of security.
- UseLightweightKDF bool
+ UseLightweightKDF bool `toml:",omitempty"`
// IPCPath is the requested location to place the IPC endpoint. If the path is
// a simple file name, it is placed inside the data directory (or on the root
// pipe path on Windows), whereas if it's a resolvable path name (absolute or
// relative), then that specific path is enforced. An empty path disables IPC.
- IPCPath string
-
- // This field should be a valid secp256k1 private key that will be used for both
- // remote peer identification as well as network traffic encryption. If no key
- // is configured, the preset one is loaded from the data dir, generating it if
- // needed.
- PrivateKey *ecdsa.PrivateKey
-
- // NoDiscovery specifies whether the peer discovery mechanism should be started
- // or not. Disabling is usually useful for protocol debugging (manual topology).
- NoDiscovery bool
-
- // DiscoveryV5 specifies whether the the new topic-discovery based V5 discovery
- // protocol should be started or not.
- DiscoveryV5 bool
-
- // Listener address for the V5 discovery protocol UDP traffic.
- DiscoveryV5Addr string
-
- // Restrict communication to white listed IP networks.
- // The whitelist only applies when non-nil.
- NetRestrict *netutil.Netlist
-
- // BootstrapNodes used to establish connectivity with the rest of the network.
- BootstrapNodes []*discover.Node
-
- // BootstrapNodesV5 used to establish connectivity with the rest of the network
- // using the V5 discovery protocol.
- BootstrapNodesV5 []*discv5.Node
-
- // Network interface address on which the node should listen for inbound peers.
- ListenAddr string
-
- // If set to a non-nil value, the given NAT port mapper is used to make the
- // listening port available to the Internet.
- NAT nat.Interface
-
- // If Dialer is set to a non-nil value, the given Dialer is used to dial outbound
- // peer connections.
- Dialer *net.Dialer
-
- // If NoDial is true, the node will not dial any peers.
- NoDial bool
-
- // MaxPeers is the maximum number of peers that can be connected. If this is
- // set to zero, then only the configured static and trusted peers can connect.
- MaxPeers int
-
- // MaxPendingPeers is the maximum number of peers that can be pending in the
- // handshake phase, counted separately for inbound and outbound connections.
- // Zero defaults to preset values.
- MaxPendingPeers int
+ IPCPath string `toml:",omitempty"`
// HTTPHost is the host interface on which to start the HTTP RPC server. If this
// field is empty, no HTTP API endpoint will be started.
- HTTPHost string
+ HTTPHost string `toml:",omitempty"`
// HTTPPort is the TCP port number on which to start the HTTP RPC server. The
// default zero value is/ valid and will pick a port number randomly (useful
// for ephemeral nodes).
- HTTPPort int
+ HTTPPort int `toml:",omitempty"`
// HTTPCors is the Cross-Origin Resource Sharing header to send to requesting
// clients. Please be aware that CORS is a browser enforced security, it's fully
// useless for custom HTTP clients.
- HTTPCors string
+ HTTPCors string `toml:",omitempty"`
// HTTPModules is a list of API modules to expose via the HTTP RPC interface.
// If the module list is empty, all RPC API endpoints designated public will be
// exposed.
- HTTPModules []string
+ HTTPModules []string `toml:",omitempty"`
// WSHost is the host interface on which to start the websocket RPC server. If
// this field is empty, no websocket API endpoint will be started.
- WSHost string
+ WSHost string `toml:",omitempty"`
// WSPort is the TCP port number on which to start the websocket RPC server. The
// default zero value is/ valid and will pick a port number randomly (useful for
// ephemeral nodes).
- WSPort int
+ WSPort int `toml:",omitempty"`
// WSOrigins is the list of domain to accept websocket requests from. Please be
// aware that the server can only act upon the HTTP request the client sends and
// cannot verify the validity of the request header.
- WSOrigins string
+ WSOrigins string `toml:",omitempty"`
// WSModules is a list of API modules to expose via the websocket RPC interface.
// If the module list is empty, all RPC API endpoints designated public will be
// exposed.
- WSModules []string
+ WSModules []string `toml:",omitempty"`
}
// IPCEndpoint resolves an IPC endpoint based on a configured value, taking into
@@ -326,8 +275,8 @@ func (c *Config) instanceDir() string {
// data folder. If no key can be found, a new one is generated.
func (c *Config) NodeKey() *ecdsa.PrivateKey {
// Use any specifically configured key.
- if c.PrivateKey != nil {
- return c.PrivateKey
+ if c.P2P.PrivateKey != nil {
+ return c.P2P.PrivateKey
}
// Generate ephemeral key if no datadir is being used.
if c.DataDir == "" {
diff --git a/node/config_test.go b/node/config_test.go
index c0eda72c2..b81d3d612 100644
--- a/node/config_test.go
+++ b/node/config_test.go
@@ -25,6 +25,7 @@ import (
"testing"
"github.com/ethereum/go-ethereum/crypto"
+ "github.com/ethereum/go-ethereum/p2p"
)
// Tests that datadirs can be successfully created, be them manually configured
@@ -109,7 +110,7 @@ func TestNodeKeyPersistency(t *testing.T) {
if err != nil {
t.Fatalf("failed to generate one-shot node key: %v", err)
}
- config := &Config{Name: "unit-test", DataDir: dir, PrivateKey: key}
+ config := &Config{Name: "unit-test", DataDir: dir, P2P: p2p.Config{PrivateKey: key}}
config.NodeKey()
if _, err := os.Stat(filepath.Join(keyfile)); err == nil {
t.Fatalf("one-shot node key persisted to data directory")
diff --git a/node/defaults.go b/node/defaults.go
index bfe257c8e..d4e148683 100644
--- a/node/defaults.go
+++ b/node/defaults.go
@@ -21,16 +21,32 @@ import (
"os/user"
"path/filepath"
"runtime"
+
+ "github.com/ethereum/go-ethereum/p2p"
+ "github.com/ethereum/go-ethereum/p2p/nat"
)
const (
- DefaultIPCSocket = "geth.ipc" // Default (relative) name of the IPC RPC socket
- DefaultHTTPHost = "localhost" // Default host interface for the HTTP RPC server
- DefaultHTTPPort = 8545 // Default TCP port for the HTTP RPC server
- DefaultWSHost = "localhost" // Default host interface for the websocket RPC server
- DefaultWSPort = 8546 // Default TCP port for the websocket RPC server
+ DefaultHTTPHost = "localhost" // Default host interface for the HTTP RPC server
+ DefaultHTTPPort = 8545 // Default TCP port for the HTTP RPC server
+ DefaultWSHost = "localhost" // Default host interface for the websocket RPC server
+ DefaultWSPort = 8546 // Default TCP port for the websocket RPC server
)
+// DefaultConfig contains reasonable default settings.
+var DefaultConfig = Config{
+ DataDir: DefaultDataDir(),
+ HTTPPort: DefaultHTTPPort,
+ HTTPModules: []string{"net", "web3"},
+ WSPort: DefaultWSPort,
+ WSModules: []string{"net", "web3"},
+ P2P: p2p.Config{
+ ListenAddr: ":30303",
+ MaxPeers: 25,
+ NAT: nat.Any(),
+ },
+}
+
// DefaultDataDir is the default data directory to use for the databases and other
// persistence requirements.
func DefaultDataDir() string {
diff --git a/node/node.go b/node/node.go
index afb676b7f..2ecff2308 100644
--- a/node/node.go
+++ b/node/node.go
@@ -153,24 +153,17 @@ func (n *Node) Start() error {
// Initialize the p2p server. This creates the node key and
// discovery databases.
- n.serverConfig = p2p.Config{
- PrivateKey: n.config.NodeKey(),
- Name: n.config.NodeName(),
- Discovery: !n.config.NoDiscovery,
- DiscoveryV5: n.config.DiscoveryV5,
- DiscoveryV5Addr: n.config.DiscoveryV5Addr,
- BootstrapNodes: n.config.BootstrapNodes,
- BootstrapNodesV5: n.config.BootstrapNodesV5,
- StaticNodes: n.config.StaticNodes(),
- TrustedNodes: n.config.TrusterNodes(),
- NodeDatabase: n.config.NodeDB(),
- ListenAddr: n.config.ListenAddr,
- NetRestrict: n.config.NetRestrict,
- NAT: n.config.NAT,
- Dialer: n.config.Dialer,
- NoDial: n.config.NoDial,
- MaxPeers: n.config.MaxPeers,
- MaxPendingPeers: n.config.MaxPendingPeers,
+ n.serverConfig = n.config.P2P
+ n.serverConfig.PrivateKey = n.config.NodeKey()
+ n.serverConfig.Name = n.config.NodeName()
+ if n.serverConfig.StaticNodes == nil {
+ n.serverConfig.StaticNodes = n.config.StaticNodes()
+ }
+ if n.serverConfig.TrustedNodes == nil {
+ n.serverConfig.TrustedNodes = n.config.TrusterNodes()
+ }
+ if n.serverConfig.NodeDatabase == "" {
+ n.serverConfig.NodeDatabase = n.config.NodeDB()
}
running := &p2p.Server{Config: n.serverConfig}
log.Info("Starting peer-to-peer node", "instance", n.serverConfig.Name)
diff --git a/node/node_example_test.go b/node/node_example_test.go
index d2872cf38..ee06f4065 100644
--- a/node/node_example_test.go
+++ b/node/node_example_test.go
@@ -22,7 +22,6 @@ import (
"github.com/ethereum/go-ethereum/node"
"github.com/ethereum/go-ethereum/p2p"
- "github.com/ethereum/go-ethereum/p2p/discover"
"github.com/ethereum/go-ethereum/rpc"
)
@@ -42,23 +41,8 @@ func (s *SampleService) Start(*p2p.Server) error { fmt.Println("Service starti
func (s *SampleService) Stop() error { fmt.Println("Service stopping..."); return nil }
func ExampleService() {
- // Create a network node to run protocols with the default values. The below list
- // is only used to display each of the configuration options. All of these could
- // have been omitted if the default behavior is desired.
- nodeConfig := &node.Config{
- DataDir: "", // Empty uses ephemeral storage
- PrivateKey: nil, // Nil generates a node key on the fly
- Name: "", // Any textual node name is allowed
- NoDiscovery: false, // Can disable discovering remote nodes
- BootstrapNodes: []*discover.Node{}, // List of bootstrap nodes to use
- ListenAddr: ":0", // Network interface to listen on
- NAT: nil, // UPnP port mapper to use for crossing firewalls
- Dialer: nil, // Custom dialer to use for establishing peer connections
- NoDial: false, // Can prevent this node from dialing out
- MaxPeers: 0, // Number of peers to allow
- MaxPendingPeers: 0, // Number of peers allowed to handshake concurrently
- }
- stack, err := node.New(nodeConfig)
+ // Create a network node to run protocols with the default values.
+ stack, err := node.New(&node.Config{})
if err != nil {
log.Fatalf("Failed to create network node: %v", err)
}
diff --git a/node/node_test.go b/node/node_test.go
index 408d4cfcb..2880efa61 100644
--- a/node/node_test.go
+++ b/node/node_test.go
@@ -35,8 +35,8 @@ var (
func testNodeConfig() *Config {
return &Config{
- PrivateKey: testNodeKey,
- Name: "test node",
+ Name: "test node",
+ P2P: p2p.Config{PrivateKey: testNodeKey},
}
}
generated by cgit (git 2.34.1) at 2024-11-15 18:57:05 +0800