config/config.go

   1 package config
   2
   3 import (
   4         "io"
   5         "io/ioutil"
   6         "os"
   7         "os/user"
   8         "path/filepath"
   9         "runtime"
  10
  11         log "github.com/sirupsen/logrus"
  12
  13         "github.com/vapor/crypto/ed25519"
  14 )
  15
  16 var (
  17         // CommonConfig means config object
  18         CommonConfig *Config
  19 )
  20
  21 type Config struct {
  22         // Top level options use an anonymous struct
  23         BaseConfig `mapstructure:",squash"`
  24         // Options for services
  25         P2P       *P2PConfig       `mapstructure:"p2p"`
  26         Wallet    *WalletConfig    `mapstructure:"wallet"`
  27         Auth      *RPCAuthConfig   `mapstructure:"auth"`
  28         Web       *WebConfig       `mapstructure:"web"`
  29         Simd      *SimdConfig      `mapstructure:"simd"`
  30         Websocket *WebsocketConfig `mapstructure:"ws"`
  31 }
  32
  33 // Default configurable parameters.
  34 func DefaultConfig() *Config {
  35         return &Config{
  36                 BaseConfig: DefaultBaseConfig(),
  37                 P2P:        DefaultP2PConfig(),
  38                 Wallet:     DefaultWalletConfig(),
  39                 Auth:       DefaultRPCAuthConfig(),
  40                 Web:        DefaultWebConfig(),
  41                 Simd:       DefaultSimdConfig(),
  42                 Websocket:  DefaultWebsocketConfig(),
  43         }
  44 }
  45
  46 // Set the RootDir for all Config structs
  47 func (cfg *Config) SetRoot(root string) *Config {
  48         cfg.BaseConfig.RootDir = root
  49         return cfg
  50 }
  51
  52 // NodeKey retrieves the currently configured private key of the node, checking
  53 // first any manually set key, falling back to the one found in the configured
  54 // data folder. If no key can be found, a new one is generated.
  55 func (cfg *Config) NodeKey() (string, error) {
  56         // Use any specifically configured key.
  57         if cfg.P2P.PrivateKey != "" {
  58                 return cfg.P2P.PrivateKey, nil
  59         }
  60
  61         keyFile := rootify(cfg.P2P.NodeKeyFile, cfg.BaseConfig.RootDir)
  62         buf := make([]byte, ed25519.PrivateKeySize*2)
  63         fd, err := os.Open(keyFile)
  64         defer fd.Close()
  65         if err == nil {
  66                 if _, err = io.ReadFull(fd, buf); err == nil {
  67                         return string(buf), nil
  68                 }
  69         }
  70
  71         log.WithField("err", err).Warning("key file access failed")
  72         _, privKey, err := ed25519.GenerateKey(nil)
  73         if err != nil {
  74                 return "", err
  75         }
  76
  77         if err = ioutil.WriteFile(keyFile, []byte(privKey.String()), 0600); err != nil {
  78                 return "", err
  79         }
  80         return privKey.String(), nil
  81 }
  82
  83 //-----------------------------------------------------------------------------
  84 // BaseConfig
  85 type BaseConfig struct {
  86         // The root directory for all data.
  87         // This should be set in viper so it can unmarshal into this struct
  88         RootDir string `mapstructure:"home"`
  89
  90         //The alias of the node
  91         NodeAlias string `mapstructure:"node_alias"`
  92
  93         //The ID of the network to json
  94         ChainID string `mapstructure:"chain_id"`
  95
  96         //log level to set
  97         LogLevel string `mapstructure:"log_level"`
  98
  99         // A custom human readable name for this node
 100         Moniker string `mapstructure:"moniker"`
 101
 102         // TCP or UNIX socket address for the profiling server to listen on
 103         ProfListenAddress string `mapstructure:"prof_laddr"`
 104
 105         Mining bool `mapstructure:"mining"`
 106
 107         // Database backend: leveldb | memdb
 108         DBBackend string `mapstructure:"db_backend"`
 109
 110         // Database directory
 111         DBPath string `mapstructure:"db_dir"`
 112
 113         // Keystore directory
 114         KeysPath string `mapstructure:"keys_dir"`
 115
 116         ApiAddress string `mapstructure:"api_addr"`
 117
 118         VaultMode bool `mapstructure:"vault_mode"`
 119
 120         // log file name
 121         LogFile string `mapstructure:"log_file"`
 122 }
 123
 124 // Default configurable base parameters.
 125 func DefaultBaseConfig() BaseConfig {
 126         return BaseConfig{
 127                 Moniker:           "anonymous",
 128                 ProfListenAddress: "",
 129                 Mining:            false,
 130                 DBBackend:         "leveldb",
 131                 DBPath:            "data",
 132                 KeysPath:          "keystore",
 133                 NodeAlias:         "",
 134         }
 135 }
 136
 137 func (b BaseConfig) DBDir() string {
 138         return rootify(b.DBPath, b.RootDir)
 139 }
 140
 141 func (b BaseConfig) KeysDir() string {
 142         return rootify(b.KeysPath, b.RootDir)
 143 }
 144
 145 // P2PConfig
 146 type P2PConfig struct {
 147         ListenAddress    string `mapstructure:"laddr"`
 148         Seeds            string `mapstructure:"seeds"`
 149         PrivateKey       string `mapstructure:"node_key"`
 150         NodeKeyFile      string `mapstructure:"node_key_file"`
 151         SkipUPNP         bool   `mapstructure:"skip_upnp"`
 152         LANDiscover      bool   `mapstructure:"lan_discoverable"`
 153         MaxNumPeers      int    `mapstructure:"max_num_peers"`
 154         HandshakeTimeout int    `mapstructure:"handshake_timeout"`
 155         DialTimeout      int    `mapstructure:"dial_timeout"`
 156         ProxyAddress     string `mapstructure:"proxy_address"`
 157         ProxyUsername    string `mapstructure:"proxy_username"`
 158         ProxyPassword    string `mapstructure:"proxy_password"`
 159         KeepDial         string `mapstructure:"keep_dial"`
 160 }
 161
 162 // Default configurable p2p parameters.
 163 func DefaultP2PConfig() *P2PConfig {
 164         return &P2PConfig{
 165                 ListenAddress:    "tcp://0.0.0.0:46656",
 166                 NodeKeyFile:      "nodekey",
 167                 SkipUPNP:         false,
 168                 LANDiscover:      true,
 169                 MaxNumPeers:      50,
 170                 HandshakeTimeout: 30,
 171                 DialTimeout:      3,
 172                 ProxyAddress:     "",
 173                 ProxyUsername:    "",
 174                 ProxyPassword:    "",
 175         }
 176 }
 177
 178 //-----------------------------------------------------------------------------
 179 type WalletConfig struct {
 180         Disable  bool   `mapstructure:"disable"`
 181         Rescan   bool   `mapstructure:"rescan"`
 182         TxIndex  bool   `mapstructure:"txindex"`
 183         MaxTxFee uint64 `mapstructure:"max_tx_fee"`
 184 }
 185
 186 type RPCAuthConfig struct {
 187         Disable bool `mapstructure:"disable"`
 188 }
 189
 190 type WebConfig struct {
 191         Closed bool `mapstructure:"closed"`
 192 }
 193
 194 type SimdConfig struct {
 195         Enable bool `mapstructure:"enable"`
 196 }
 197
 198 type WebsocketConfig struct {
 199         MaxNumWebsockets     int `mapstructure:"max_num_websockets"`
 200         MaxNumConcurrentReqs int `mapstructure:"max_num_concurrent_reqs"`
 201 }
 202
 203 // Default configurable rpc's auth parameters.
 204 func DefaultRPCAuthConfig() *RPCAuthConfig {
 205         return &RPCAuthConfig{
 206                 Disable: false,
 207         }
 208 }
 209
 210 // Default configurable web parameters.
 211 func DefaultWebConfig() *WebConfig {
 212         return &WebConfig{
 213                 Closed: false,
 214         }
 215 }
 216
 217 // Default configurable wallet parameters.
 218 func DefaultWalletConfig() *WalletConfig {
 219         return &WalletConfig{
 220                 Disable:  false,
 221                 Rescan:   false,
 222                 TxIndex:  false,
 223                 MaxTxFee: uint64(1000000000),
 224         }
 225 }
 226
 227 // Default configurable web parameters.
 228 func DefaultSimdConfig() *SimdConfig {
 229         return &SimdConfig{
 230                 Enable: false,
 231         }
 232 }
 233
 234 func DefaultWebsocketConfig() *WebsocketConfig {
 235         return &WebsocketConfig{
 236                 MaxNumWebsockets:     25,
 237                 MaxNumConcurrentReqs: 20,
 238         }
 239 }
 240
 241 //-----------------------------------------------------------------------------
 242 // Utils
 243
 244 // helper function to make config creation independent of root dir
 245 func rootify(path, root string) string {
 246         if filepath.IsAbs(path) {
 247                 return path
 248         }
 249         return filepath.Join(root, path)
 250 }
 251
 252 // DefaultDataDir is the default data directory to use for the databases and other
 253 // persistence requirements.
 254 func DefaultDataDir() string {
 255         // Try to place the data folder in the user's home dir
 256         home := homeDir()
 257         if home == "" {
 258                 return "./.bytom"
 259         }
 260         switch runtime.GOOS {
 261         case "darwin":
 262                 // In order to be compatible with old data path,
 263                 // copy the data from the old path to the new path
 264                 oldPath := filepath.Join(home, "Library", "Bytom")
 265                 newPath := filepath.Join(home, "Library", "Application Support", "Bytom")
 266                 if !isFolderNotExists(oldPath) && isFolderNotExists(newPath) {
 267                         if err := os.Rename(oldPath, newPath); err != nil {
 268                                 log.Errorf("DefaultDataDir: %v", err)
 269                                 return oldPath
 270                         }
 271                 }
 272                 return newPath
 273         case "windows":
 274                 return filepath.Join(home, "AppData", "Roaming", "Bytom")
 275         default:
 276                 return filepath.Join(home, ".bytom")
 277         }
 278 }
 279
 280 func isFolderNotExists(path string) bool {
 281         _, err := os.Stat(path)
 282         return os.IsNotExist(err)
 283 }
 284
 285 func homeDir() string {
 286         if home := os.Getenv("HOME"); home != "" {
 287                 return home
 288         }
 289         if usr, err := user.Current(); err == nil {
 290                 return usr.HomeDir
 291         }
 292         return ""
 293 }