512 lines
14 KiB
Go
512 lines
14 KiB
Go
package params
|
|
|
|
import (
|
|
"bytes"
|
|
"crypto/ecdsa"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/status-im/status-go/static"
|
|
)
|
|
|
|
// default node configuration options
|
|
var (
|
|
UseMainnetFlag = "false" // to be overridden via -ldflags '-X geth/params.UseMainnetFlag'
|
|
UseMainnet = false
|
|
)
|
|
|
|
func init() {
|
|
if UseMainnetFlag == "true" { // set at compile time, here we make sure to set corresponding boolean flag
|
|
UseMainnet = true
|
|
}
|
|
}
|
|
|
|
// errors
|
|
var (
|
|
ErrMissingDataDir = errors.New("missing required 'DataDir' parameter")
|
|
ErrMissingNetworkID = errors.New("missing required 'NetworkID' parameter")
|
|
ErrEmptyPasswordFile = errors.New("password file cannot be empty")
|
|
ErrEmptyIdentityFile = errors.New("identity file cannot be empty")
|
|
ErrEmptyAuthorizationKeyFile = errors.New("authorization key file cannot be empty")
|
|
)
|
|
|
|
// LightEthConfig holds LES-related configuration
|
|
// Status nodes are always lightweight clients (due to mobile platform constraints)
|
|
type LightEthConfig struct {
|
|
// Enabled flag specifies whether protocol is enabled
|
|
Enabled bool
|
|
|
|
// Genesis is JSON to seed the chain database with
|
|
Genesis string
|
|
|
|
// DatabaseCache is memory (in MBs) allocated to internal caching (min 16MB / database forced)
|
|
DatabaseCache int
|
|
}
|
|
|
|
// FirebaseConfig holds FCM-related configuration
|
|
type FirebaseConfig struct {
|
|
// AuthorizationKeyFile file path that contains FCM authorization key
|
|
AuthorizationKeyFile string
|
|
|
|
// NotificationTriggerURL URL used to send push notification requests to
|
|
NotificationTriggerURL string
|
|
}
|
|
|
|
// WhisperConfig holds SHH-related configuration
|
|
type WhisperConfig struct {
|
|
// Enabled flag specifies whether protocol is enabled
|
|
Enabled bool
|
|
|
|
// IdentityFile path to private key, that will be loaded as identity into Whisper
|
|
IdentityFile string
|
|
|
|
// PasswordFile path to password file, for non-interactive password entry
|
|
// (if no account file selected, then this password is used for symmetric encryption)
|
|
PasswordFile string
|
|
|
|
// EchoMode if mode is on, prints some arguments for diagnostics
|
|
EchoMode bool
|
|
|
|
// BootstrapNode whether node doesn't actively connect to peers, and waits for incoming connections
|
|
BootstrapNode bool
|
|
|
|
// ForwarderNode is mode when node only forwards messages, neither sends nor decrypts messages
|
|
ForwarderNode bool
|
|
|
|
// MailServerNode is mode when node is capable of delivering expired messages on demand
|
|
MailServerNode bool
|
|
|
|
// NotificationServerNode is mode when node is capable of sending Push (and probably other kinds) Notifications
|
|
NotificationServerNode bool
|
|
|
|
// DataDir is the file system folder Whisper should use for any data storage needs.
|
|
DataDir string
|
|
|
|
// Port Whisper node's listening port
|
|
Port int
|
|
|
|
// MinimumPoW minimum PoW for Whisper messages
|
|
MinimumPoW float64
|
|
|
|
// TTL time to live for messages, in seconds
|
|
TTL int
|
|
|
|
// FirebaseConfig extra configuration for Firebase Cloud Messaging
|
|
FirebaseConfig *FirebaseConfig `json:"FirebaseConfig,"`
|
|
}
|
|
|
|
// SwarmConfig holds Swarm-related configuration
|
|
type SwarmConfig struct {
|
|
// Enabled flag specifies whether protocol is enabled
|
|
Enabled bool
|
|
}
|
|
|
|
// BootCluster holds configuration for supporting boot cluster, which is a temporary
|
|
// 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).
|
|
type BootClusterConfig struct {
|
|
// Enabled flag specifies whether feature is enabled
|
|
Enabled bool
|
|
|
|
// ConfigFile is a path to JSON file containing array of boot nodes
|
|
// See `static/bootcluster/*.json` for cluster configurations provided
|
|
// out of box. You can pass absolute path, and if file at that path can be
|
|
// loaded, it will be used. Otherwise, file is supposed to be relative to
|
|
// `static/bootcluster` folder.
|
|
ConfigFile string
|
|
}
|
|
|
|
// NodeConfig stores configuration options for a node
|
|
type NodeConfig struct {
|
|
// DevMode is true when given configuration is to be used during development.
|
|
// For production, this flag should be turned off, so that more strict requirements
|
|
// are applied to node's configuration
|
|
DevMode bool
|
|
|
|
// NetworkID sets network to use for selecting peers to connect to
|
|
NetworkID uint64 `json:"NetworkId,"`
|
|
|
|
// DataDir is the file system folder the node should use for any data storage needs.
|
|
DataDir string
|
|
|
|
// KeyStoreDir is the file system folder that contains private keys.
|
|
// If KeyStoreDir is empty, the default location is the "keystore" subdirectory of DataDir.
|
|
KeyStoreDir string
|
|
|
|
// PrivateKeyFile is a filename with node ID (private key)
|
|
// This file should contain a valid secp256k1 private key that will be used for both
|
|
// remote peer identification as well as network traffic encryption.
|
|
NodeKeyFile string
|
|
|
|
// Name sets the instance name of the node. It must not contain the / character.
|
|
Name string
|
|
|
|
// 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
|
|
|
|
// HTTPPort is the TCP port number on which to start the Geth's HTTP RPC server.
|
|
HTTPPort int
|
|
|
|
// WSHost is a host interface for the WebSocket RPC server
|
|
WSHost string
|
|
|
|
// WSPort is the TCP port number on which to start the Geth's WebSocket RPC server.
|
|
WSPort int
|
|
|
|
// WSEnabled specifies whether WS-RPC Server is enabled or not
|
|
WSEnabled bool
|
|
|
|
// 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
|
|
|
|
// LogToFile specified whether logs should be saved into file
|
|
LogEnabled bool
|
|
|
|
// LogFile is filename where exposed logs get written to
|
|
LogFile string
|
|
|
|
// LogLevel defines minimum log level. Valid names are "ERROR", "WARNING", "INFO", "DEBUG", and "TRACE".
|
|
LogLevel string
|
|
|
|
// LogToStderr defines whether logged info should also be output to os.Stderr
|
|
LogToStderr bool
|
|
|
|
// BootClusterConfig extra configuration for supporting cluster
|
|
BootClusterConfig *BootClusterConfig `json:"BootClusterConfig,"`
|
|
|
|
// LightEthConfig extra configuration for LES
|
|
LightEthConfig *LightEthConfig `json:"LightEthConfig,"`
|
|
|
|
// WhisperConfig extra configuration for SHH
|
|
WhisperConfig *WhisperConfig `json:"WhisperConfig,"`
|
|
|
|
// SwarmConfig extra configuration for Swarm and ENS
|
|
SwarmConfig *SwarmConfig `json:"SwarmConfig,"`
|
|
}
|
|
|
|
// NewNodeConfig creates new node configuration object
|
|
func NewNodeConfig(dataDir string, networkID uint64, devMode bool) (*NodeConfig, error) {
|
|
nodeConfig := &NodeConfig{
|
|
DevMode: devMode,
|
|
NetworkID: networkID,
|
|
DataDir: dataDir,
|
|
Name: ClientIdentifier,
|
|
Version: Version,
|
|
HTTPHost: HTTPHost,
|
|
HTTPPort: HTTPPort,
|
|
WSHost: WSHost,
|
|
WSPort: WSPort,
|
|
MaxPeers: MaxPeers,
|
|
MaxPendingPeers: MaxPendingPeers,
|
|
IPCFile: IPCFile,
|
|
LogFile: LogFile,
|
|
LogLevel: LogLevel,
|
|
LogToStderr: LogToStderr,
|
|
LightEthConfig: &LightEthConfig{
|
|
Enabled: true,
|
|
DatabaseCache: DatabaseCache,
|
|
},
|
|
BootClusterConfig: &BootClusterConfig{
|
|
Enabled: true,
|
|
ConfigFile: BootClusterConfigFile,
|
|
},
|
|
WhisperConfig: &WhisperConfig{
|
|
Enabled: true,
|
|
Port: WhisperPort,
|
|
MinimumPoW: WhisperMinimumPoW,
|
|
TTL: WhisperTTL,
|
|
FirebaseConfig: &FirebaseConfig{
|
|
NotificationTriggerURL: FirebaseNotificationTriggerURL,
|
|
},
|
|
},
|
|
SwarmConfig: &SwarmConfig{},
|
|
}
|
|
|
|
// adjust dependent values
|
|
if err := nodeConfig.updateConfig(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return nodeConfig, nil
|
|
}
|
|
|
|
// LoadNodeConfig parses incoming JSON and returned it as Config
|
|
func LoadNodeConfig(configJSON string) (*NodeConfig, error) {
|
|
nodeConfig, err := NewNodeConfig("", 0, true)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
decoder := json.NewDecoder(strings.NewReader(configJSON))
|
|
//decoder.UseNumber()
|
|
|
|
// override default configuration with values by JSON input
|
|
if err := decoder.Decode(&nodeConfig); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// repopulate
|
|
if err := nodeConfig.updateConfig(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if len(nodeConfig.DataDir) == 0 {
|
|
return nil, ErrMissingDataDir
|
|
}
|
|
|
|
if nodeConfig.NetworkID <= 0 {
|
|
return nil, ErrMissingNetworkID
|
|
}
|
|
|
|
return nodeConfig, nil
|
|
}
|
|
|
|
// Save dumps configuration to the disk
|
|
func (c *NodeConfig) Save() error {
|
|
data, err := json.MarshalIndent(c, "", " ")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := os.MkdirAll(c.DataDir, os.ModePerm); err != nil {
|
|
return err
|
|
}
|
|
|
|
configFilePath := filepath.Join(c.DataDir, "config.json")
|
|
if err := ioutil.WriteFile(configFilePath, data, os.ModePerm); err != nil {
|
|
return err
|
|
}
|
|
|
|
log.Info(fmt.Sprintf("config file saved: %v", configFilePath))
|
|
return nil
|
|
}
|
|
|
|
// LoadBootClusterNodes loads boot nodes from a config file provided in BootClusterConfig
|
|
func (c *NodeConfig) LoadBootClusterNodes() ([]string, error) {
|
|
var bootnodes []string
|
|
var configData []byte
|
|
var err error
|
|
|
|
filename := c.BootClusterConfig.ConfigFile
|
|
log.Info("Loading boot nodes config file", "source", filename)
|
|
if _, err = os.Stat(filename); os.IsNotExist(err) { // load from static resources
|
|
configData, err = static.Asset("bootcluster/" + filename)
|
|
} else {
|
|
configData, err = ioutil.ReadFile(filename)
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// parse JSON
|
|
if err := json.Unmarshal([]byte(configData), &bootnodes); err != nil {
|
|
return nil, err
|
|
}
|
|
return bootnodes, nil
|
|
}
|
|
|
|
// updateConfig traverses configuration and adjusts dependent fields
|
|
// (we have a development/production and mobile/full node dependent configurations)
|
|
func (c *NodeConfig) updateConfig() error {
|
|
if err := c.updateGenesisConfig(); err != nil {
|
|
return err
|
|
}
|
|
if err := c.updateRPCConfig(); err != nil {
|
|
return err
|
|
}
|
|
if err := c.updateBootClusterConfig(); err != nil {
|
|
return err
|
|
}
|
|
if err := c.updateRelativeDirsConfig(); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// updateGenesisConfig does necessary adjustments to config object (depending on network node will be running on)
|
|
func (c *NodeConfig) updateGenesisConfig() error {
|
|
var genesis *core.Genesis
|
|
|
|
switch c.NetworkID {
|
|
case MainNetworkID:
|
|
genesis = core.DefaultGenesisBlock()
|
|
case RopstenNetworkID:
|
|
genesis = core.DefaultTestnetGenesisBlock()
|
|
case RinkebyNetworkID:
|
|
genesis = core.DefaultRinkebyGenesisBlock()
|
|
default:
|
|
return nil
|
|
}
|
|
|
|
// encode the genesis into JSON
|
|
enc, err := json.Marshal(genesis)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
c.LightEthConfig.Genesis = string(enc)
|
|
|
|
return nil
|
|
}
|
|
|
|
// updateBootClusterConfig populates cluster config file, depending on dev/prod and mobile/full settings
|
|
func (c *NodeConfig) updateBootClusterConfig() error {
|
|
var configFile string
|
|
switch c.NetworkID {
|
|
case MainNetworkID:
|
|
configFile = "homestead.prod.json"
|
|
case RopstenNetworkID:
|
|
configFile = "ropsten.prod.json"
|
|
case RinkebyNetworkID:
|
|
configFile = "rinkeby.prod.json"
|
|
}
|
|
if c.DevMode {
|
|
configFile = strings.Replace(configFile, "prod", "dev", 1)
|
|
}
|
|
if len(configFile) > 0 {
|
|
c.BootClusterConfig.ConfigFile = configFile
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// updateRPCConfig transforms RPC settings to meet requirements of a given configuration
|
|
func (c *NodeConfig) updateRPCConfig() error {
|
|
c.APIModules = ProdAPIModules
|
|
if c.DevMode {
|
|
c.APIModules = DevAPIModules
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// updateRelativeDirsConfig updates directories that should be wrt to DataDir
|
|
func (c *NodeConfig) updateRelativeDirsConfig() error {
|
|
makeSubDirPath := func(baseDir, subDir string) string {
|
|
if len(baseDir) == 0 {
|
|
return ""
|
|
}
|
|
|
|
return filepath.Join(baseDir, subDir)
|
|
}
|
|
if len(c.KeyStoreDir) == 0 {
|
|
c.KeyStoreDir = makeSubDirPath(c.DataDir, KeyStoreDir)
|
|
}
|
|
|
|
if len(c.WhisperConfig.DataDir) == 0 {
|
|
c.WhisperConfig.DataDir = makeSubDirPath(c.DataDir, WhisperDataDir)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// String dumps config object as nicely indented JSON
|
|
func (c *NodeConfig) String() string {
|
|
data, _ := json.MarshalIndent(c, "", " ")
|
|
return string(data)
|
|
}
|
|
|
|
// String dumps config object as nicely indented JSON
|
|
func (c *WhisperConfig) String() string {
|
|
data, _ := json.MarshalIndent(c, "", " ")
|
|
return string(data)
|
|
}
|
|
|
|
// String dumps config object as nicely indented JSON
|
|
func (c *SwarmConfig) String() string {
|
|
data, _ := json.MarshalIndent(c, "", " ")
|
|
return string(data)
|
|
}
|
|
|
|
// String dumps config object as nicely indented JSON
|
|
func (c *BootClusterConfig) String() string {
|
|
data, _ := json.MarshalIndent(c, "", " ")
|
|
return string(data)
|
|
}
|
|
|
|
// ReadPasswordFile reads and returns content of the password file
|
|
func (c *WhisperConfig) ReadPasswordFile() ([]byte, error) {
|
|
if len(c.PasswordFile) <= 0 {
|
|
return nil, ErrEmptyPasswordFile
|
|
}
|
|
|
|
password, err := ioutil.ReadFile(c.PasswordFile)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
password = bytes.TrimRight(password, "\n")
|
|
|
|
if len(password) == 0 {
|
|
return nil, ErrEmptyPasswordFile
|
|
}
|
|
|
|
return password, nil
|
|
}
|
|
|
|
// ReadIdentityFile reads and loads identity private key
|
|
func (c *WhisperConfig) ReadIdentityFile() (*ecdsa.PrivateKey, error) {
|
|
if len(c.IdentityFile) <= 0 {
|
|
return nil, ErrEmptyIdentityFile
|
|
}
|
|
|
|
identity, err := crypto.LoadECDSA(c.IdentityFile)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if identity == nil {
|
|
return nil, ErrEmptyIdentityFile
|
|
}
|
|
|
|
return identity, nil
|
|
}
|
|
|
|
// ReadAuthorizationKeyFile reads and loads FCM authorization key
|
|
func (c *FirebaseConfig) ReadAuthorizationKeyFile() ([]byte, error) {
|
|
if len(c.AuthorizationKeyFile) <= 0 {
|
|
return nil, ErrEmptyAuthorizationKeyFile
|
|
}
|
|
|
|
key, err := ioutil.ReadFile(c.AuthorizationKeyFile)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
key = bytes.TrimRight(key, "\n")
|
|
|
|
if key == nil {
|
|
return nil, ErrEmptyAuthorizationKeyFile
|
|
}
|
|
|
|
return key, nil
|
|
}
|