cmd/swarm: add config file (#15548)
This commit adds a TOML configuration option to swarm. It reuses the TOML configuration structure used in geth with swarm customized items. The commit: * Adds a "dumpconfig" command to the swarm executable which allows printing the (default) configuration to stdout, which then can be redirected to a file in order to customize it. * Adds a "--config <file>" option to the swarm executable which will allow to load a configuration file in TOML format from the specified location in order to initialize the Swarm node The override priorities are like follows: environment variables override command line arguments override config file override default config.
This commit is contained in:
holisticode
Felix Lange
@ -18,15 +18,15 @@ package api
|
||||
|
||||
import (
|
||||
"crypto/ecdsa"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/ethereum/go-ethereum/common"
|
||||
"github.com/ethereum/go-ethereum/contracts/ens"
|
||||
"github.com/ethereum/go-ethereum/crypto"
|
||||
"github.com/ethereum/go-ethereum/log"
|
||||
"github.com/ethereum/go-ethereum/node"
|
||||
"github.com/ethereum/go-ethereum/swarm/network"
|
||||
"github.com/ethereum/go-ethereum/swarm/services/swap"
|
||||
"github.com/ethereum/go-ethereum/swarm/storage"
|
||||
@ -46,101 +46,68 @@ type Config struct {
|
||||
*network.HiveParams
|
||||
Swap *swap.SwapParams
|
||||
*network.SyncParams
|
||||
Path string
|
||||
ListenAddr string
|
||||
Port string
|
||||
PublicKey string
|
||||
BzzKey string
|
||||
EnsRoot common.Address
|
||||
NetworkId uint64
|
||||
Contract common.Address
|
||||
EnsRoot common.Address
|
||||
EnsApi string
|
||||
Path string
|
||||
ListenAddr string
|
||||
Port string
|
||||
PublicKey string
|
||||
BzzKey string
|
||||
NetworkId uint64
|
||||
SwapEnabled bool
|
||||
SyncEnabled bool
|
||||
SwapApi string
|
||||
Cors string
|
||||
BzzAccount string
|
||||
BootNodes string
|
||||
}
|
||||
|
||||
// config is agnostic to where private key is coming from
|
||||
// so managing accounts is outside swarm and left to wrappers
|
||||
func NewConfig(path string, contract common.Address, prvKey *ecdsa.PrivateKey, networkId uint64) (self *Config, err error) {
|
||||
address := crypto.PubkeyToAddress(prvKey.PublicKey) // default beneficiary address
|
||||
dirpath := filepath.Join(path, "bzz-"+common.Bytes2Hex(address.Bytes()))
|
||||
err = os.MkdirAll(dirpath, os.ModePerm)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
confpath := filepath.Join(dirpath, "config.json")
|
||||
var data []byte
|
||||
pubkey := crypto.FromECDSAPub(&prvKey.PublicKey)
|
||||
pubkeyhex := common.ToHex(pubkey)
|
||||
keyhex := crypto.Keccak256Hash(pubkey).Hex()
|
||||
//create a default config with all parameters to set to defaults
|
||||
func NewDefaultConfig() (self *Config) {
|
||||
|
||||
self = &Config{
|
||||
SyncParams: network.NewSyncParams(dirpath),
|
||||
HiveParams: network.NewHiveParams(dirpath),
|
||||
StoreParams: storage.NewDefaultStoreParams(),
|
||||
ChunkerParams: storage.NewChunkerParams(),
|
||||
StoreParams: storage.NewStoreParams(dirpath),
|
||||
HiveParams: network.NewDefaultHiveParams(),
|
||||
SyncParams: network.NewDefaultSyncParams(),
|
||||
Swap: swap.NewDefaultSwapParams(),
|
||||
ListenAddr: DefaultHTTPListenAddr,
|
||||
Port: DefaultHTTPPort,
|
||||
Path: dirpath,
|
||||
Swap: swap.DefaultSwapParams(contract, prvKey),
|
||||
PublicKey: pubkeyhex,
|
||||
BzzKey: keyhex,
|
||||
Path: node.DefaultDataDir(),
|
||||
EnsApi: node.DefaultIPCEndpoint("geth"),
|
||||
EnsRoot: ens.TestNetAddress,
|
||||
NetworkId: networkId,
|
||||
}
|
||||
data, err = ioutil.ReadFile(confpath)
|
||||
|
||||
// if not set in function param, then set default for swarm network, will be overwritten by config file if present
|
||||
if networkId == 0 {
|
||||
self.NetworkId = network.NetworkId
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
if !os.IsNotExist(err) {
|
||||
return
|
||||
}
|
||||
|
||||
// file does not exist
|
||||
// write out config file
|
||||
err = self.Save()
|
||||
if err != nil {
|
||||
err = fmt.Errorf("error writing config: %v", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// file exists, deserialise
|
||||
err = json.Unmarshal(data, self)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to parse config: %v", err)
|
||||
}
|
||||
// check public key
|
||||
if pubkeyhex != self.PublicKey {
|
||||
return nil, fmt.Errorf("public key does not match the one in the config file %v != %v", pubkeyhex, self.PublicKey)
|
||||
}
|
||||
if keyhex != self.BzzKey {
|
||||
return nil, fmt.Errorf("bzz key does not match the one in the config file %v != %v", keyhex, self.BzzKey)
|
||||
}
|
||||
|
||||
// if set in function param, replace id set from config file
|
||||
if networkId != 0 {
|
||||
self.NetworkId = networkId
|
||||
}
|
||||
|
||||
self.Swap.SetKey(prvKey)
|
||||
|
||||
if (self.EnsRoot == common.Address{}) {
|
||||
self.EnsRoot = ens.TestNetAddress
|
||||
NetworkId: network.NetworkId,
|
||||
SwapEnabled: false,
|
||||
SyncEnabled: true,
|
||||
SwapApi: "",
|
||||
BootNodes: "",
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (self *Config) Save() error {
|
||||
data, err := json.MarshalIndent(self, "", " ")
|
||||
//some config params need to be initialized after the complete
|
||||
//config building phase is completed (e.g. due to overriding flags)
|
||||
func (self *Config) Init(prvKey *ecdsa.PrivateKey) {
|
||||
|
||||
address := crypto.PubkeyToAddress(prvKey.PublicKey)
|
||||
self.Path = filepath.Join(self.Path, "bzz-"+common.Bytes2Hex(address.Bytes()))
|
||||
err := os.MkdirAll(self.Path, os.ModePerm)
|
||||
if err != nil {
|
||||
return err
|
||||
log.Error(fmt.Sprintf("Error creating root swarm data directory: %v", err))
|
||||
return
|
||||
}
|
||||
err = os.MkdirAll(self.Path, os.ModePerm)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
confpath := filepath.Join(self.Path, "config.json")
|
||||
return ioutil.WriteFile(confpath, data, os.ModePerm)
|
||||
|
||||
pubkey := crypto.FromECDSAPub(&prvKey.PublicKey)
|
||||
pubkeyhex := common.ToHex(pubkey)
|
||||
keyhex := crypto.Keccak256Hash(pubkey).Hex()
|
||||
|
||||
self.PublicKey = pubkeyhex
|
||||
self.BzzKey = keyhex
|
||||
|
||||
self.Swap.Init(self.Contract, prvKey)
|
||||
self.SyncParams.Init(self.Path)
|
||||
self.HiveParams.Init(self.Path)
|
||||
self.StoreParams.Init(self.Path)
|
||||
}
|
||||
|
||||
@ -17,109 +17,53 @@
|
||||
package api
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/ethereum/go-ethereum/common"
|
||||
"github.com/ethereum/go-ethereum/crypto"
|
||||
)
|
||||
|
||||
var (
|
||||
hexprvkey = "65138b2aa745041b372153550584587da326ab440576b2a1191dd95cee30039c"
|
||||
defaultConfig = `{
|
||||
"ChunkDbPath": "` + filepath.Join("TMPDIR", "chunks") + `",
|
||||
"DbCapacity": 5000000,
|
||||
"CacheCapacity": 5000,
|
||||
"Radius": 0,
|
||||
"Branches": 128,
|
||||
"Hash": "SHA3",
|
||||
"CallInterval": 3000000000,
|
||||
"KadDbPath": "` + filepath.Join("TMPDIR", "bzz-peers.json") + `",
|
||||
"MaxProx": 8,
|
||||
"ProxBinSize": 2,
|
||||
"BucketSize": 4,
|
||||
"PurgeInterval": 151200000000000,
|
||||
"InitialRetryInterval": 42000000,
|
||||
"MaxIdleInterval": 42000000000,
|
||||
"ConnRetryExp": 2,
|
||||
"Swap": {
|
||||
"BuyAt": 20000000000,
|
||||
"SellAt": 20000000000,
|
||||
"PayAt": 100,
|
||||
"DropAt": 10000,
|
||||
"AutoCashInterval": 300000000000,
|
||||
"AutoCashThreshold": 50000000000000,
|
||||
"AutoDepositInterval": 300000000000,
|
||||
"AutoDepositThreshold": 50000000000000,
|
||||
"AutoDepositBuffer": 100000000000000,
|
||||
"PublicKey": "0x045f5cfd26692e48d0017d380349bcf50982488bc11b5145f3ddf88b24924299048450542d43527fbe29a5cb32f38d62755393ac002e6bfdd71b8d7ba725ecd7a3",
|
||||
"Contract": "0x0000000000000000000000000000000000000000",
|
||||
"Beneficiary": "0x0d2f62485607cf38d9d795d93682a517661e513e"
|
||||
},
|
||||
"RequestDbPath": "` + filepath.Join("TMPDIR", "requests") + `",
|
||||
"RequestDbBatchSize": 512,
|
||||
"KeyBufferSize": 1024,
|
||||
"SyncBatchSize": 128,
|
||||
"SyncBufferSize": 128,
|
||||
"SyncCacheSize": 1024,
|
||||
"SyncPriorities": [
|
||||
2,
|
||||
1,
|
||||
1,
|
||||
0,
|
||||
0
|
||||
],
|
||||
"SyncModes": [
|
||||
true,
|
||||
true,
|
||||
true,
|
||||
true,
|
||||
false
|
||||
],
|
||||
"Path": "TMPDIR",
|
||||
"ListenAddr": "127.0.0.1",
|
||||
"Port": "8500",
|
||||
"PublicKey": "0x045f5cfd26692e48d0017d380349bcf50982488bc11b5145f3ddf88b24924299048450542d43527fbe29a5cb32f38d62755393ac002e6bfdd71b8d7ba725ecd7a3",
|
||||
"BzzKey": "0xe861964402c0b78e2d44098329b8545726f215afa737d803714a4338552fcb81",
|
||||
"EnsRoot": "0x112234455c3a32fd11230c42e7bccd4a84e02010",
|
||||
"NetworkId": 323
|
||||
}`
|
||||
)
|
||||
func TestConfig(t *testing.T) {
|
||||
|
||||
func TestConfigWriteRead(t *testing.T) {
|
||||
tmp, err := ioutil.TempDir(os.TempDir(), "bzz-test")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tmp)
|
||||
var hexprvkey = "65138b2aa745041b372153550584587da326ab440576b2a1191dd95cee30039c"
|
||||
|
||||
prvkey, err := crypto.HexToECDSA(hexprvkey)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to load private key: %v", err)
|
||||
}
|
||||
orig, err := NewConfig(tmp, common.Address{}, prvkey, 323)
|
||||
if err != nil {
|
||||
t.Fatalf("expected no error, got %v", err)
|
||||
}
|
||||
data, err := ioutil.ReadFile(filepath.Join(orig.Path, "config.json"))
|
||||
if err != nil {
|
||||
t.Fatalf("default config file cannot be read: %v", err)
|
||||
}
|
||||
exp := strings.Replace(defaultConfig, "TMPDIR", orig.Path, -1)
|
||||
exp = strings.Replace(exp, "\\", "\\\\", -1)
|
||||
if string(data) != exp {
|
||||
t.Fatalf("default config mismatch:\nexpected: %v\ngot: %v", exp, string(data))
|
||||
|
||||
one := NewDefaultConfig()
|
||||
two := NewDefaultConfig()
|
||||
|
||||
if equal := reflect.DeepEqual(one, two); equal == false {
|
||||
t.Fatal("Two default configs are not equal")
|
||||
}
|
||||
|
||||
conf, err := NewConfig(tmp, common.Address{}, prvkey, 323)
|
||||
if err != nil {
|
||||
t.Fatalf("expected no error, got %v", err)
|
||||
one.Init(prvkey)
|
||||
|
||||
//the init function should set the following fields
|
||||
if one.BzzKey == "" {
|
||||
t.Fatal("Expected BzzKey to be set")
|
||||
}
|
||||
if conf.Swap.Beneficiary.Hex() != orig.Swap.Beneficiary.Hex() {
|
||||
t.Fatalf("expected beneficiary from loaded config %v to match original %v", conf.Swap.Beneficiary.Hex(), orig.Swap.Beneficiary.Hex())
|
||||
if one.PublicKey == "" {
|
||||
t.Fatal("Expected PublicKey to be set")
|
||||
}
|
||||
|
||||
//the Init function should append subdirs to the given path
|
||||
if one.Swap.PayProfile.Beneficiary == (common.Address{}) {
|
||||
t.Fatal("Failed to correctly initialize SwapParams")
|
||||
}
|
||||
|
||||
if one.SyncParams.RequestDbPath == one.Path {
|
||||
t.Fatal("Failed to correctly initialize SyncParams")
|
||||
}
|
||||
|
||||
if one.HiveParams.KadDbPath == one.Path {
|
||||
t.Fatal("Failed to correctly initialize HiveParams")
|
||||
}
|
||||
|
||||
if one.StoreParams.ChunkDbPath == one.Path {
|
||||
t.Fatal("Failed to correctly initialize StoreParams")
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user