2017-03-15 21:03:01 +00:00
|
|
|
package params
|
|
|
|
|
|
|
|
import (
|
|
|
|
"encoding/json"
|
2017-05-02 14:30:11 +00:00
|
|
|
"fmt"
|
2018-08-21 12:46:10 +00:00
|
|
|
"go/build"
|
2017-03-15 21:03:01 +00:00
|
|
|
"io/ioutil"
|
2018-09-13 16:31:29 +00:00
|
|
|
"net/url"
|
2017-03-15 21:03:01 +00:00
|
|
|
"os"
|
2018-08-21 12:46:10 +00:00
|
|
|
"path"
|
2017-03-15 21:03:01 +00:00
|
|
|
"path/filepath"
|
|
|
|
"strings"
|
|
|
|
|
2018-08-24 03:17:32 +00:00
|
|
|
"github.com/ethereum/go-ethereum/common"
|
2018-07-04 09:30:57 +00:00
|
|
|
"github.com/ethereum/go-ethereum/crypto"
|
2018-03-20 18:35:28 +00:00
|
|
|
"github.com/ethereum/go-ethereum/log"
|
2018-04-10 06:44:09 +00:00
|
|
|
"github.com/ethereum/go-ethereum/p2p/discv5"
|
2018-08-24 03:17:32 +00:00
|
|
|
"github.com/ethereum/go-ethereum/params"
|
2018-09-13 16:31:29 +00:00
|
|
|
"github.com/status-im/status-go/static"
|
|
|
|
validator "gopkg.in/go-playground/validator.v9"
|
2017-03-15 21:03:01 +00:00
|
|
|
)
|
|
|
|
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
|
|
|
// LightEthConfig
|
|
|
|
// ----------
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// LightEthConfig holds LES-related configuration
|
|
|
|
// Status nodes are always lightweight clients (due to mobile platform constraints)
|
|
|
|
type LightEthConfig struct {
|
2017-05-11 13:20:27 +00:00
|
|
|
// Enabled flag specifies whether protocol is enabled
|
2017-03-28 09:04:52 +00:00
|
|
|
Enabled bool
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// DatabaseCache is memory (in MBs) allocated to internal caching (min 16MB / database forced)
|
|
|
|
DatabaseCache int
|
|
|
|
}
|
|
|
|
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
|
|
|
// WhisperConfig
|
|
|
|
// ----------
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// WhisperConfig holds SHH-related configuration
|
2017-03-28 09:04:52 +00:00
|
|
|
type WhisperConfig struct {
|
2017-05-11 13:20:27 +00:00
|
|
|
// Enabled flag specifies whether protocol is enabled
|
2017-03-28 09:04:52 +00:00
|
|
|
Enabled bool
|
2017-04-09 22:16:05 +00:00
|
|
|
|
2018-03-02 09:25:30 +00:00
|
|
|
// LightClient should be true if the node should start with an empty bloom filter and not forward messages from other nodes
|
|
|
|
LightClient bool
|
|
|
|
|
2017-12-04 16:11:14 +00:00
|
|
|
// EnableMailServer is mode when node is capable of delivering expired messages on demand
|
|
|
|
EnableMailServer bool
|
2017-04-09 22:16:05 +00:00
|
|
|
|
|
|
|
// DataDir is the file system folder Whisper should use for any data storage needs.
|
2017-12-04 16:11:14 +00:00
|
|
|
// For instance, MailServer will use this directory to store its data.
|
2017-04-09 22:16:05 +00:00
|
|
|
DataDir string
|
|
|
|
|
|
|
|
// MinimumPoW minimum PoW for Whisper messages
|
|
|
|
MinimumPoW float64
|
|
|
|
|
2018-07-04 09:30:57 +00:00
|
|
|
// MailServerPassword for symmetric encryption with MailServer.
|
|
|
|
// (if no account file selected, then this password is used for symmetric encryption).
|
|
|
|
MailServerPassword string
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// MailServerAsymKey is an hex-encoded asymmetric key to decrypt messages sent to MailServer.
|
|
|
|
MailServerAsymKey string
|
2018-07-04 09:30:57 +00:00
|
|
|
|
2018-05-17 11:21:04 +00:00
|
|
|
// RateLimit minimum time between queries to mail server per peer
|
|
|
|
MailServerRateLimit int
|
|
|
|
|
|
|
|
// MailServerCleanupPeriod time in seconds to wait to run mail server cleanup
|
|
|
|
MailServerCleanupPeriod int
|
|
|
|
|
2017-04-09 22:16:05 +00:00
|
|
|
// TTL time to live for messages, in seconds
|
|
|
|
TTL int
|
2017-04-12 18:26:54 +00:00
|
|
|
|
2018-06-13 11:24:04 +00:00
|
|
|
// EnableNTPSync enables NTP synchronizations
|
|
|
|
EnableNTPSync bool
|
2017-03-28 09:04:52 +00:00
|
|
|
}
|
2017-03-15 21:03:01 +00:00
|
|
|
|
2017-07-13 06:54:10 +00:00
|
|
|
// String dumps config object as nicely indented JSON
|
|
|
|
func (c *WhisperConfig) String() string {
|
2018-01-17 16:46:21 +00:00
|
|
|
data, _ := json.MarshalIndent(c, "", " ") // nolint: gas
|
2017-07-13 06:54:10 +00:00
|
|
|
return string(data)
|
|
|
|
}
|
|
|
|
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
|
|
|
// SwarmConfig
|
|
|
|
// ----------
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// SwarmConfig holds Swarm-related configuration
|
2017-03-28 09:04:52 +00:00
|
|
|
type SwarmConfig struct {
|
2017-05-11 13:20:27 +00:00
|
|
|
// Enabled flag specifies whether protocol is enabled
|
2017-03-28 09:04:52 +00:00
|
|
|
Enabled bool
|
|
|
|
}
|
2017-03-15 21:03:01 +00:00
|
|
|
|
2017-07-13 06:54:10 +00:00
|
|
|
// String dumps config object as nicely indented JSON
|
|
|
|
func (c *SwarmConfig) String() string {
|
2018-01-17 16:46:21 +00:00
|
|
|
data, _ := json.MarshalIndent(c, "", " ") // nolint: gas
|
2017-07-13 06:54:10 +00:00
|
|
|
return string(data)
|
|
|
|
}
|
|
|
|
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
2018-03-20 14:05:21 +00:00
|
|
|
// ClusterConfig
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
|
|
|
|
2018-03-20 14:05:21 +00:00
|
|
|
// ClusterConfig holds configuration for supporting cluster peers, which is a temporary
|
2017-05-11 13:20:27 +00:00
|
|
|
// means for mobile devices to get connected to Ethereum network (UDP-based discovery
|
|
|
|
// may not be available, so we need means to discover the network manually).
|
2018-03-20 14:05:21 +00:00
|
|
|
type ClusterConfig struct {
|
2017-05-11 13:20:27 +00:00
|
|
|
// Enabled flag specifies whether feature is enabled
|
|
|
|
Enabled bool
|
|
|
|
|
2018-07-25 14:03:35 +00:00
|
|
|
// Fleet is a type of selected fleet.
|
|
|
|
Fleet string
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// StaticNodes is a list of static nodes for this fleet.
|
2018-03-20 14:05:21 +00:00
|
|
|
StaticNodes []string
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// BootNodes is a list of cluster peer nodes for this fleet.
|
2017-08-04 16:14:17 +00:00
|
|
|
BootNodes []string
|
2018-07-04 10:51:47 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// TrustedMailServers is a list of verified Mail Servers for this fleet.
|
2018-07-25 14:48:02 +00:00
|
|
|
TrustedMailServers []string
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// RendezvousNodes is a list rendezvous discovery nodes.
|
2018-07-04 10:51:47 +00:00
|
|
|
RendezvousNodes []string
|
2017-05-11 13:20:27 +00:00
|
|
|
}
|
|
|
|
|
2017-07-13 06:54:10 +00:00
|
|
|
// String dumps config object as nicely indented JSON
|
2018-03-20 14:05:21 +00:00
|
|
|
func (c *ClusterConfig) String() string {
|
2018-01-17 16:46:21 +00:00
|
|
|
data, _ := json.MarshalIndent(c, "", " ") // nolint: gas
|
2017-07-13 06:54:10 +00:00
|
|
|
return string(data)
|
|
|
|
}
|
|
|
|
|
2018-04-10 06:44:09 +00:00
|
|
|
// Limits represent min and max amount of peers
|
2018-04-20 07:39:31 +00:00
|
|
|
type Limits struct {
|
|
|
|
Min, Max int
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewLimits creates new Limits config with given min and max values.
|
|
|
|
func NewLimits(min, max int) Limits {
|
|
|
|
return Limits{
|
|
|
|
Min: min,
|
|
|
|
Max: max,
|
|
|
|
}
|
|
|
|
}
|
2018-04-10 06:44:09 +00:00
|
|
|
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
|
|
|
// UpstreamRPCConfig
|
|
|
|
// ----------
|
2017-08-15 10:27:12 +00:00
|
|
|
|
|
|
|
// UpstreamRPCConfig stores configuration for upstream rpc connection.
|
|
|
|
type UpstreamRPCConfig struct {
|
|
|
|
// Enabled flag specifies whether feature is enabled
|
|
|
|
Enabled bool
|
|
|
|
|
|
|
|
// URL sets the rpc upstream host address for communication with
|
|
|
|
// a non-local infura endpoint.
|
|
|
|
URL string
|
|
|
|
}
|
|
|
|
|
2018-03-19 16:22:09 +00:00
|
|
|
// ----------
|
|
|
|
// NodeConfig
|
|
|
|
// ----------
|
2017-08-15 10:27:12 +00:00
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// NodeConfig stores configuration options for a node
|
|
|
|
type NodeConfig struct {
|
2017-05-03 14:24:48 +00:00
|
|
|
// NetworkID sets network to use for selecting peers to connect to
|
2017-08-10 15:31:29 +00:00
|
|
|
NetworkID uint64 `json:"NetworkId" validate:"required"`
|
2017-03-15 21:03:01 +00:00
|
|
|
|
|
|
|
// DataDir is the file system folder the node should use for any data storage needs.
|
2017-08-10 15:31:29 +00:00
|
|
|
DataDir string `validate:"required"`
|
2017-03-15 21:03:01 +00:00
|
|
|
|
2017-04-28 08:49:15 +00:00
|
|
|
// KeyStoreDir is the file system folder that contains private keys.
|
2018-09-13 16:31:29 +00:00
|
|
|
KeyStoreDir string `validate:"required"`
|
2017-04-28 08:49:15 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// NodeKey is the hex-encoded node ID (private key). Should be a valid secp256k1 private key that will be used for both
|
2017-04-09 22:16:05 +00:00
|
|
|
// remote peer identification as well as network traffic encryption.
|
2018-09-13 16:31:29 +00:00
|
|
|
NodeKey string
|
2017-04-09 22:16:05 +00:00
|
|
|
|
2018-05-10 11:45:51 +00:00
|
|
|
// NoDiscovery set to true will disable discovery protocol.
|
|
|
|
NoDiscovery bool
|
2018-01-23 05:16:13 +00:00
|
|
|
|
2018-07-04 10:51:47 +00:00
|
|
|
// Rendezvous enables discovery protocol.
|
|
|
|
Rendezvous bool
|
|
|
|
|
2017-12-04 16:11:14 +00:00
|
|
|
// ListenAddr is an IP address and port of this node (e.g. 127.0.0.1:30303).
|
|
|
|
ListenAddr string
|
|
|
|
|
2018-08-17 06:25:55 +00:00
|
|
|
// AdvertiseAddr is a public IP address the node wants to be found with.
|
|
|
|
// It is especially useful when using floating IPs attached to a server.
|
|
|
|
AdvertiseAddr string
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// Name sets the instance name of the node. It must not contain the / character.
|
2017-08-10 15:31:29 +00:00
|
|
|
Name string `validate:"excludes=/"`
|
2017-03-15 21:03:01 +00:00
|
|
|
|
|
|
|
// Version exposes program's version. It is used in the devp2p node identifier.
|
|
|
|
Version string
|
|
|
|
|
|
|
|
// APIModules is a comma-separated list of API modules exposed via *any* (HTTP/WS/IPC) RPC interface.
|
|
|
|
APIModules string
|
|
|
|
|
|
|
|
// HTTPHost is the host interface on which to start the HTTP RPC server.
|
|
|
|
// Pass empty string if no HTTP RPC interface needs to be started.
|
|
|
|
HTTPHost string
|
|
|
|
|
2017-07-13 06:54:10 +00:00
|
|
|
// RPCEnabled specifies whether the http RPC server is to be enabled by default.
|
|
|
|
RPCEnabled bool
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// HTTPPort is the TCP port number on which to start the Geth's HTTP RPC server.
|
|
|
|
HTTPPort int
|
|
|
|
|
|
|
|
// IPCFile is filename of exposed IPC RPC Server
|
|
|
|
IPCFile string
|
|
|
|
|
|
|
|
// IPCEnabled specifies whether IPC-RPC Server is enabled or not
|
|
|
|
IPCEnabled bool
|
|
|
|
|
|
|
|
// TLSEnabled specifies whether TLS support should be enabled on node or not
|
|
|
|
// TLS support is only planned in go-ethereum, so we are using our own patch.
|
|
|
|
TLSEnabled bool
|
|
|
|
|
|
|
|
// MaxPeers is the maximum number of (global) peers that can be connected.
|
|
|
|
// Set to zero, if only static or trusted peers are allowed to 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.
|
|
|
|
MaxPendingPeers int
|
|
|
|
|
2018-03-20 18:35:28 +00:00
|
|
|
log log.Logger
|
|
|
|
|
2018-04-26 16:28:42 +00:00
|
|
|
// LogEnabled enables the logger
|
|
|
|
LogEnabled bool `json:"LogEnabled"`
|
|
|
|
|
2017-03-18 19:00:40 +00:00
|
|
|
// LogFile is filename where exposed logs get written to
|
|
|
|
LogFile string
|
|
|
|
|
2018-01-03 14:11:21 +00:00
|
|
|
// LogLevel defines minimum log level. Valid names are "ERROR", "WARN", "INFO", "DEBUG", and "TRACE".
|
|
|
|
LogLevel string `validate:"eq=ERROR|eq=WARN|eq=INFO|eq=DEBUG|eq=TRACE"`
|
2017-03-18 19:00:40 +00:00
|
|
|
|
2017-05-02 14:30:11 +00:00
|
|
|
// LogToStderr defines whether logged info should also be output to os.Stderr
|
|
|
|
LogToStderr bool
|
2017-03-15 21:03:01 +00:00
|
|
|
|
2017-08-15 10:27:12 +00:00
|
|
|
// UpstreamConfig extra config for providing upstream infura server.
|
|
|
|
UpstreamConfig UpstreamRPCConfig `json:"UpstreamConfig"`
|
|
|
|
|
2018-03-20 14:05:21 +00:00
|
|
|
// ClusterConfig extra configuration for supporting cluster peers.
|
2018-09-13 16:31:29 +00:00
|
|
|
ClusterConfig ClusterConfig `json:"ClusterConfig," validate:"structonly"`
|
2017-05-11 13:20:27 +00:00
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// LightEthConfig extra configuration for LES
|
2018-09-13 16:31:29 +00:00
|
|
|
LightEthConfig LightEthConfig `json:"LightEthConfig," validate:"structonly"`
|
2017-03-15 21:03:01 +00:00
|
|
|
|
|
|
|
// WhisperConfig extra configuration for SHH
|
2018-09-13 16:31:29 +00:00
|
|
|
WhisperConfig WhisperConfig `json:"WhisperConfig," validate:"structonly"`
|
2017-03-15 21:03:01 +00:00
|
|
|
|
|
|
|
// SwarmConfig extra configuration for Swarm and ENS
|
2018-09-13 16:31:29 +00:00
|
|
|
SwarmConfig SwarmConfig `json:"SwarmConfig," validate:"structonly"`
|
2018-04-10 06:44:09 +00:00
|
|
|
|
2018-07-16 07:40:40 +00:00
|
|
|
// RegisterTopics a list of specific topics where the peer wants to be
|
|
|
|
// discoverable.
|
|
|
|
RegisterTopics []discv5.Topic `json:"RegisterTopics"`
|
|
|
|
|
|
|
|
// RequiredTopics list of topics where a client wants to search for
|
|
|
|
// discoverable peers with the discovery limits.
|
|
|
|
RequireTopics map[discv5.Topic]Limits `json:"RequireTopics"`
|
2018-05-03 10:36:56 +00:00
|
|
|
|
|
|
|
// StatusServiceEnabled enables status service api
|
|
|
|
StatusServiceEnabled bool
|
2018-06-25 13:27:17 +00:00
|
|
|
|
|
|
|
// DebugAPIEnabled enables debug api
|
|
|
|
DebugAPIEnabled bool
|
2018-08-20 13:55:43 +00:00
|
|
|
|
|
|
|
// MailServerRegistryAddress is the MailServerRegistry contract address
|
|
|
|
MailServerRegistryAddress string
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// NewNodeConfigWithDefaults creates new node configuration object with some defaults suitable for adhoc use
|
|
|
|
func NewNodeConfigWithDefaults(dataDir, fleet string, networkID uint64) (*NodeConfig, error) {
|
|
|
|
nodeConfig, err := NewNodeConfig(dataDir, fleet, networkID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
if dataDir != "" {
|
|
|
|
nodeConfig.KeyStoreDir = path.Join(dataDir, "keystore")
|
|
|
|
nodeConfig.WhisperConfig.DataDir = path.Join(dataDir, "wnode")
|
|
|
|
}
|
|
|
|
|
|
|
|
if fleet != FleetUndefined {
|
|
|
|
statusConfigJSON, err := static.Asset(fmt.Sprintf("../config/cli/fleet-%s.json", fleet))
|
|
|
|
if err == nil {
|
|
|
|
err = LoadConfigFromJSON(string(statusConfigJSON), nodeConfig)
|
|
|
|
}
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("default config could not be loaded: %s", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
nodeConfig.HTTPHost = ""
|
|
|
|
nodeConfig.ListenAddr = ":30303"
|
|
|
|
nodeConfig.LogEnabled = true
|
|
|
|
nodeConfig.LogLevel = "INFO"
|
|
|
|
nodeConfig.LogToStderr = true
|
|
|
|
nodeConfig.WhisperConfig.Enabled = true
|
|
|
|
nodeConfig.WhisperConfig.EnableNTPSync = true
|
|
|
|
|
|
|
|
return nodeConfig, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewNodeConfig creates new node configuration object with bare-minimum defaults
|
|
|
|
func NewNodeConfig(dataDir, fleet string, networkID uint64) (*NodeConfig, error) {
|
2017-03-15 21:03:01 +00:00
|
|
|
nodeConfig := &NodeConfig{
|
2018-09-13 16:31:29 +00:00
|
|
|
NetworkID: networkID,
|
|
|
|
DataDir: dataDir,
|
|
|
|
Version: Version,
|
|
|
|
RPCEnabled: false,
|
|
|
|
HTTPHost: "localhost",
|
|
|
|
HTTPPort: 8545,
|
|
|
|
ListenAddr: ":0",
|
|
|
|
APIModules: "eth,net,web3,peer",
|
|
|
|
MaxPeers: 25,
|
|
|
|
MaxPendingPeers: 0,
|
|
|
|
IPCFile: "geth.ipc",
|
|
|
|
log: log.New("package", "status-go/params.NodeConfig"),
|
|
|
|
LogFile: "",
|
|
|
|
LogLevel: "ERROR",
|
|
|
|
UpstreamConfig: UpstreamRPCConfig{
|
|
|
|
URL: getUpstreamURL(networkID),
|
|
|
|
},
|
|
|
|
ClusterConfig: ClusterConfig{
|
|
|
|
Enabled: fleet != FleetUndefined,
|
2018-07-25 14:03:35 +00:00
|
|
|
Fleet: fleet,
|
2018-03-20 14:05:21 +00:00
|
|
|
StaticNodes: []string{},
|
|
|
|
BootNodes: []string{},
|
2017-08-04 16:14:17 +00:00
|
|
|
},
|
2018-09-13 16:31:29 +00:00
|
|
|
LightEthConfig: LightEthConfig{
|
|
|
|
Enabled: false,
|
|
|
|
DatabaseCache: 16,
|
2017-05-11 13:20:27 +00:00
|
|
|
},
|
2018-09-13 16:31:29 +00:00
|
|
|
WhisperConfig: WhisperConfig{
|
|
|
|
Enabled: false,
|
|
|
|
MinimumPoW: WhisperMinimumPoW,
|
|
|
|
TTL: WhisperTTL,
|
|
|
|
EnableNTPSync: false,
|
2017-03-28 09:04:52 +00:00
|
|
|
},
|
2018-09-13 16:31:29 +00:00
|
|
|
SwarmConfig: SwarmConfig{},
|
2018-04-20 12:23:18 +00:00
|
|
|
RegisterTopics: []discv5.Topic{},
|
|
|
|
RequireTopics: map[discv5.Topic]Limits{},
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nodeConfig, nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// NewConfigFromJSON parses incoming JSON and returned it as Config
|
|
|
|
func NewConfigFromJSON(configJSON string) (*NodeConfig, error) {
|
|
|
|
nodeConfig, err := NewNodeConfig("", FleetUndefined, 0)
|
2017-08-10 15:31:29 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := LoadConfigFromJSON(configJSON, nodeConfig); err != nil {
|
2017-08-10 15:31:29 +00:00
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return nodeConfig, nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// LoadConfigFromJSON parses incoming JSON and returned it as Config
|
|
|
|
func LoadConfigFromJSON(configJSON string, nodeConfig *NodeConfig) error {
|
|
|
|
if err := loadNodeConfig(configJSON, nodeConfig); err != nil {
|
|
|
|
return err
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := nodeConfig.Validate(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func loadNodeConfig(configJSON string, nodeConfig *NodeConfig) error {
|
2017-03-15 21:03:01 +00:00
|
|
|
decoder := json.NewDecoder(strings.NewReader(configJSON))
|
|
|
|
|
|
|
|
// override default configuration with values by JSON input
|
|
|
|
if err := decoder.Decode(&nodeConfig); err != nil {
|
2018-09-13 16:31:29 +00:00
|
|
|
return err
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func loadConfigConfigFromFile(path string, config *NodeConfig) error {
|
|
|
|
jsonConfig, err := ioutil.ReadFile(path)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
2017-05-02 14:30:11 +00:00
|
|
|
}
|
2017-03-15 21:03:01 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err = loadNodeConfig(string(jsonConfig), config); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// LoadConfigFromFiles reads the configuration files specified in configFilePaths,
|
|
|
|
// merging the values in order in the config argument
|
|
|
|
func LoadConfigFromFiles(configFilePaths []string, config *NodeConfig) error {
|
|
|
|
for _, path := range configFilePaths {
|
|
|
|
if err := loadConfigConfigFromFile(path, config); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
2017-08-10 15:31:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Validate checks if NodeConfig fields have valid values.
|
|
|
|
//
|
|
|
|
// It returns nil if there are no errors, otherwise one or more errors
|
|
|
|
// can be returned. Multiple errors are joined with a new line.
|
|
|
|
//
|
|
|
|
// A single error for a struct:
|
|
|
|
//
|
|
|
|
// type TestStruct struct {
|
|
|
|
// TestField string `validate:"required"`
|
|
|
|
// }
|
|
|
|
//
|
|
|
|
// has the following format:
|
|
|
|
//
|
|
|
|
// Key: 'TestStruct.TestField' Error:Field validation for 'TestField' failed on the 'required' tag
|
|
|
|
//
|
|
|
|
func (c *NodeConfig) Validate() error {
|
|
|
|
validate := NewValidator()
|
|
|
|
|
|
|
|
if err := validate.Struct(c); err != nil {
|
|
|
|
return err
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if c.NodeKey != "" {
|
|
|
|
if _, err := crypto.HexToECDSA(c.NodeKey); err != nil {
|
|
|
|
return fmt.Errorf("NodeKey is invalid (%s): %v", c.NodeKey, err)
|
2017-08-10 15:31:29 +00:00
|
|
|
}
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if c.UpstreamConfig.Enabled && c.LightEthConfig.Enabled {
|
|
|
|
return fmt.Errorf("both UpstreamConfig and LightEthConfig are enabled, but they are mutually exclusive")
|
2017-08-10 15:31:29 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := c.validateChildStructs(validate); err != nil {
|
|
|
|
return err
|
2017-08-10 15:31:29 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if !c.NoDiscovery && len(c.ClusterConfig.BootNodes) == 0 {
|
|
|
|
// No point in running discovery if we don't have bootnodes.
|
|
|
|
// In case we do have bootnodes, NoDiscovery should be true.
|
|
|
|
return fmt.Errorf("NoDiscovery is false, but ClusterConfig.BootNodes is empty")
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(c.ClusterConfig.RendezvousNodes) == 0 {
|
|
|
|
if c.Rendezvous {
|
|
|
|
return fmt.Errorf("Rendezvous is enabled, but ClusterConfig.RendezvousNodes is empty")
|
2017-08-10 15:31:29 +00:00
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
} else if !c.Rendezvous {
|
|
|
|
return fmt.Errorf("Rendezvous is disabled, but ClusterConfig.RendezvousNodes is not empty")
|
2017-08-10 15:31:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
2017-03-15 21:03:01 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
func (c *NodeConfig) validateChildStructs(validate *validator.Validate) error {
|
|
|
|
// Validate child structs
|
|
|
|
if err := c.UpstreamConfig.Validate(validate); err != nil {
|
2017-03-15 21:03:01 +00:00
|
|
|
return err
|
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := c.ClusterConfig.Validate(validate); err != nil {
|
2017-03-15 21:03:01 +00:00
|
|
|
return err
|
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := c.LightEthConfig.Validate(validate); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := c.WhisperConfig.Validate(validate); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := c.SwarmConfig.Validate(validate); err != nil {
|
2017-03-15 21:03:01 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// Validate validates the UpstreamRPCConfig struct and returns an error if inconsistent values are found
|
|
|
|
func (c *UpstreamRPCConfig) Validate(validate *validator.Validate) error {
|
|
|
|
if !c.Enabled {
|
|
|
|
return nil
|
2017-05-16 03:24:56 +00:00
|
|
|
}
|
2017-08-15 10:27:12 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := validate.Struct(c); err != nil {
|
2017-08-15 10:27:12 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if _, err := url.ParseRequestURI(c.URL); err != nil {
|
|
|
|
return fmt.Errorf("UpstreamRPCConfig.URL '%s' is invalid: %v", c.URL, err.Error())
|
2017-05-16 03:24:56 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
return nil
|
|
|
|
}
|
2017-05-16 03:24:56 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// Validate validates the ClusterConfig struct and returns an error if inconsistent values are found
|
|
|
|
func (c *ClusterConfig) Validate(validate *validator.Validate) error {
|
|
|
|
if !c.Enabled {
|
2017-05-16 03:24:56 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := validate.Struct(c); err != nil {
|
2017-05-16 03:24:56 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if c.Fleet == "" {
|
|
|
|
return fmt.Errorf("ClusterConfig.Fleet is empty")
|
2017-10-16 21:54:56 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
return nil
|
2017-10-16 21:54:56 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// Validate validates the LightEthConfig struct and returns an error if inconsistent values are found
|
|
|
|
func (c *LightEthConfig) Validate(validate *validator.Validate) error {
|
|
|
|
if !c.Enabled {
|
2017-08-15 10:27:12 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := validate.Struct(c); err != nil {
|
|
|
|
return err
|
2017-08-15 10:27:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// Validate validates the WhisperConfig struct and returns an error if inconsistent values are found
|
|
|
|
func (c *WhisperConfig) Validate(validate *validator.Validate) error {
|
|
|
|
if !c.Enabled {
|
2017-08-04 16:14:17 +00:00
|
|
|
return nil
|
2017-05-16 03:24:56 +00:00
|
|
|
}
|
2017-07-13 06:54:10 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := validate.Struct(c); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2018-07-25 14:03:35 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if c.EnableMailServer {
|
|
|
|
if c.DataDir == "" {
|
|
|
|
return fmt.Errorf("WhisperConfig.DataDir must be specified when WhisperConfig.EnableMailServer is true")
|
2018-03-19 16:22:09 +00:00
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
if c.MailServerPassword == "" && c.MailServerAsymKey == "" {
|
|
|
|
return fmt.Errorf("WhisperConfig.MailServerPassword or WhisperConfig.MailServerAsymKey must be specified when WhisperConfig.EnableMailServer is true")
|
2018-03-19 16:22:09 +00:00
|
|
|
}
|
2017-07-13 06:54:10 +00:00
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if c.MailServerAsymKey != "" {
|
|
|
|
if _, err := crypto.HexToECDSA(c.MailServerAsymKey); err != nil {
|
|
|
|
return fmt.Errorf("WhisperConfig.MailServerAsymKey is invalid: %s", c.MailServerAsymKey)
|
|
|
|
}
|
|
|
|
}
|
2017-05-16 03:24:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
// Validate validates the SwarmConfig struct and returns an error if inconsistent values are found
|
|
|
|
func (c *SwarmConfig) Validate(validate *validator.Validate) error {
|
|
|
|
if !c.Enabled {
|
|
|
|
return nil
|
2017-05-16 03:24:56 +00:00
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
if err := validate.Struct(c); err != nil {
|
|
|
|
return err
|
2017-05-16 03:24:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-09-13 16:31:29 +00:00
|
|
|
func getUpstreamURL(networkID uint64) string {
|
|
|
|
switch networkID {
|
|
|
|
case MainNetworkID:
|
|
|
|
return MainnetEthereumNetworkURL
|
|
|
|
case RopstenNetworkID:
|
|
|
|
return RopstenEthereumNetworkURL
|
|
|
|
case RinkebyNetworkID:
|
|
|
|
return RinkebyEthereumNetworkURL
|
|
|
|
}
|
|
|
|
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
// Save dumps configuration to the disk
|
|
|
|
func (c *NodeConfig) Save() error {
|
|
|
|
data, err := json.MarshalIndent(c, "", " ")
|
|
|
|
if err != nil {
|
|
|
|
return err
|
2018-04-20 12:23:18 +00:00
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
|
|
|
|
if err := os.MkdirAll(c.DataDir, os.ModePerm); err != nil {
|
|
|
|
return err
|
2018-04-20 12:23:18 +00:00
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
|
|
|
|
configFilePath := filepath.Join(c.DataDir, "config.json")
|
|
|
|
if err := ioutil.WriteFile(configFilePath, data, os.ModePerm); err != nil {
|
|
|
|
return err
|
2018-08-24 11:20:50 +00:00
|
|
|
}
|
2018-09-13 16:31:29 +00:00
|
|
|
|
|
|
|
c.log.Info("config file saved", "path", configFilePath)
|
|
|
|
return nil
|
2018-04-20 12:23:18 +00:00
|
|
|
}
|
|
|
|
|
2017-03-15 21:03:01 +00:00
|
|
|
// String dumps config object as nicely indented JSON
|
|
|
|
func (c *NodeConfig) String() string {
|
|
|
|
data, _ := json.MarshalIndent(c, "", " ")
|
|
|
|
return string(data)
|
|
|
|
}
|
2018-04-12 16:17:10 +00:00
|
|
|
|
|
|
|
// FormatAPIModules returns a slice of APIModules.
|
|
|
|
func (c *NodeConfig) FormatAPIModules() []string {
|
|
|
|
if len(c.APIModules) == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return strings.Split(c.APIModules, ",")
|
|
|
|
}
|
2018-05-08 21:57:29 +00:00
|
|
|
|
|
|
|
// AddAPIModule adds a mobule to APIModules
|
|
|
|
func (c *NodeConfig) AddAPIModule(m string) {
|
|
|
|
c.APIModules = fmt.Sprintf("%s,%s", c.APIModules, m)
|
|
|
|
}
|
2018-08-21 12:46:10 +00:00
|
|
|
|
|
|
|
// GetStatusHome gets home directory of status-go
|
|
|
|
func GetStatusHome() string {
|
|
|
|
gopath := os.Getenv("GOPATH")
|
|
|
|
if gopath == "" {
|
|
|
|
gopath = build.Default.GOPATH
|
|
|
|
}
|
|
|
|
return path.Join(gopath, "/src/github.com/status-im/status-go/")
|
|
|
|
}
|
2018-08-24 03:17:32 +00:00
|
|
|
|
|
|
|
// LesTopic returns discovery v5 topic derived from genesis of the provided network.
|
2018-08-27 09:32:14 +00:00
|
|
|
// 1 - mainnet, 3 - ropsten, 4 - rinkeby
|
2018-08-24 03:17:32 +00:00
|
|
|
func LesTopic(netid int) string {
|
|
|
|
switch netid {
|
|
|
|
case 1:
|
2018-08-27 09:32:14 +00:00
|
|
|
return LESDiscoveryIdentifier + common.Bytes2Hex(params.MainnetGenesisHash.Bytes()[:8])
|
2018-08-24 03:17:32 +00:00
|
|
|
case 3:
|
2018-08-27 09:32:14 +00:00
|
|
|
return LESDiscoveryIdentifier + common.Bytes2Hex(params.TestnetGenesisHash.Bytes()[:8])
|
|
|
|
case 4:
|
|
|
|
return LESDiscoveryIdentifier + common.Bytes2Hex(params.RinkebyGenesisHash.Bytes()[:8])
|
2018-08-24 03:17:32 +00:00
|
|
|
default:
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
}
|