From a095ddd9cef86dc24472205ad21091fa1ff1ba32 Mon Sep 17 00:00:00 2001
From: Silas Davis <silas@monax.io>
Date: Sat, 12 May 2018 16:39:52 +0100
Subject: [PATCH] Reorganise and tweak CLI, add deep merge to spec
Signed-off-by: Silas Davis <silas@monax.io>
---
cmd/burrow/commands/configure.go | 174 ++++++++++++++
cmd/burrow/commands/helpers.go | 52 +++++
cmd/burrow/commands/spec.go | 67 ++++++
cmd/burrow/commands/start.go | 113 +++++++++
cmd/burrow/main.go | 383 +------------------------------
genesis/spec/genesis_spec.go | 25 +-
genesis/spec/presets.go | 98 ++++++--
genesis/spec/presets_test.go | 65 +++++-
8 files changed, 569 insertions(+), 408 deletions(-)
create mode 100644 cmd/burrow/commands/configure.go
create mode 100644 cmd/burrow/commands/helpers.go
create mode 100644 cmd/burrow/commands/spec.go
create mode 100644 cmd/burrow/commands/start.go
diff --git a/cmd/burrow/commands/configure.go b/cmd/burrow/commands/configure.go
new file mode 100644
index 00000000..545467cd
--- /dev/null
+++ b/cmd/burrow/commands/configure.go
@@ -0,0 +1,174 @@
+package commands
+
+import (
+ "fmt"
+ "io/ioutil"
+ "os"
+ "strings"
+
+ "github.com/hyperledger/burrow/config"
+ "github.com/hyperledger/burrow/config/source"
+ "github.com/hyperledger/burrow/execution"
+ "github.com/hyperledger/burrow/genesis"
+ "github.com/hyperledger/burrow/genesis/spec"
+ "github.com/hyperledger/burrow/keys"
+ "github.com/hyperledger/burrow/keys/mock"
+ "github.com/hyperledger/burrow/logging"
+ logging_config "github.com/hyperledger/burrow/logging/config"
+ "github.com/hyperledger/burrow/logging/config/presets"
+ "github.com/jawher/mow.cli"
+)
+
+func Configure(cmd *cli.Cmd) {
+ genesisSpecOpt := cmd.StringOpt("s genesis-spec", "",
+ "A GenesisSpec to use as a template for a GenesisDoc that will be created along with keys")
+
+ jsonOutOpt := cmd.BoolOpt("j json", false, "Emit config in JSON rather than TOML "+
+ "suitable for further processing")
+
+ keysUrlOpt := cmd.StringOpt("k keys-url", "", fmt.Sprintf("Provide keys URL, default: %s",
+ keys.DefaultKeysConfig().URL))
+
+ configOpt := cmd.StringOpt("c base-config", "", "Use the a specified burrow config file as a base")
+
+ genesisDocOpt := cmd.StringOpt("g genesis-doc", "", "GenesisDoc in JSON or TOML to embed in config")
+
+ generateKeysOpt := cmd.StringOpt("x generate-keys", "",
+ "File to output containing secret keys as JSON or according to a custom template (see --keys-template). "+
+ "Note that using this options means the keys will not be generated in the default keys instance")
+
+ keysTemplateOpt := cmd.StringOpt("z keys-template", mock.DefaultDumpKeysFormat,
+ fmt.Sprintf("Go text/template template (left delim: %s right delim: %s) to generate secret keys "+
+ "file specified with --generate-keys. Default:\n%s", mock.LeftTemplateDelim, mock.RightTemplateDelim,
+ mock.DefaultDumpKeysFormat))
+
+ separateGenesisDoc := cmd.StringOpt("w separate-genesis-doc", "", "Emit a separate genesis doc as JSON or TOML")
+
+ loggingOpt := cmd.StringOpt("l logging", "",
+ "Comma separated list of logging instructions which form a 'program' which is a depth-first "+
+ "pre-order of instructions that will build the root logging sink. See 'burrow help' for more information.")
+
+ describeLoggingOpt := cmd.BoolOpt("describe-logging", false,
+ "Print an exhaustive list of logging instructions available with the --logging option")
+
+ debugOpt := cmd.BoolOpt("d debug", false, "Include maximal debug options in config "+
+ "including logging opcodes and dumping EVM tokens to disk these can be later pruned from the "+
+ "generated config.")
+
+ chainNameOpt := cmd.StringOpt("n chain-name", "", "Default chain name")
+
+ cmd.Spec = "[--keys-url=<keys URL> | (--generate-keys=<secret keys files> [--keys-template=<text template for each key>])] " +
+ "[--genesis-spec=<GenesisSpec file> | --genesis-doc=<GenesisDoc file>] " +
+ "[--separate-genesis-doc=<genesis JSON file>] [--chain-name] [--json] " +
+ "[--logging=<logging program>] [--describe-logging] [--debug]"
+
+ cmd.Action = func() {
+ conf := config.DefaultBurrowConfig()
+
+ if *configOpt != "" {
+ // If explicitly given a config file use it as a base:
+ err := source.FromFile(*configOpt, conf)
+ if err != nil {
+ fatalf("could not read base config file (as TOML): %v", err)
+ }
+ }
+
+ if *describeLoggingOpt {
+ fmt.Printf("Usage:\n burrow configure -l INSTRUCTION[,...]\n\nBuilds a logging " +
+ "configuration by constructing a tree of logging sinks assembled from preset instructions " +
+ "that generate the tree while traversing it.\n\nLogging Instructions:\n")
+ for _, instruction := range presets.Instructons() {
+ fmt.Printf(" %-15s\t%s\n", instruction.Name(), instruction.Description())
+ }
+ fmt.Printf("\nExample Usage:\n burrow configure -l include-any,info,stderr\n")
+ return
+ }
+
+ if *keysUrlOpt != "" {
+ conf.Keys.URL = *keysUrlOpt
+ }
+
+ // Genesis Spec
+ if *genesisSpecOpt != "" {
+ genesisSpec := new(spec.GenesisSpec)
+ err := source.FromFile(*genesisSpecOpt, genesisSpec)
+ if err != nil {
+ fatalf("Could not read GenesisSpec: %v", err)
+ }
+ if *generateKeysOpt != "" {
+ keyClient := mock.NewMockKeyClient()
+ conf.GenesisDoc, err = genesisSpec.GenesisDoc(keyClient)
+ if err != nil {
+ fatalf("Could not generate GenesisDoc from GenesisSpec using MockKeyClient: %v", err)
+ }
+
+ secretKeysString, err := keyClient.DumpKeys(*keysTemplateOpt)
+ if err != nil {
+ fatalf("Could not dump keys: %v", err)
+ }
+ err = ioutil.WriteFile(*generateKeysOpt, []byte(secretKeysString), 0700)
+ if err != nil {
+ fatalf("Could not write secret keys: %v", err)
+ }
+ } else {
+ conf.GenesisDoc, err = genesisSpec.GenesisDoc(keys.NewKeyClient(conf.Keys.URL, logging.NewNoopLogger()))
+ }
+ if err != nil {
+ fatalf("could not realise GenesisSpec: %v", err)
+ }
+ } else if *genesisDocOpt != "" {
+ genesisDoc := new(genesis.GenesisDoc)
+ err := source.FromFile(*genesisSpecOpt, genesisDoc)
+ if err != nil {
+ fatalf("could not read GenesisSpec: %v", err)
+ }
+ conf.GenesisDoc = genesisDoc
+ }
+
+ // Logging
+ if *loggingOpt != "" {
+ ops := strings.Split(*loggingOpt, ",")
+ sinkConfig, err := presets.BuildSinkConfig(ops...)
+ if err != nil {
+ fatalf("could not build logging configuration: %v\n\nTo see possible logging "+
+ "instructions run:\n burrow configure --describe-logging", err)
+ }
+ conf.Logging = &logging_config.LoggingConfig{
+ RootSink: sinkConfig,
+ }
+ }
+
+ if *debugOpt {
+ conf.Execution = &execution.ExecutionConfig{
+ VMOptions: []execution.VMOption{execution.DumpTokens, execution.DebugOpcodes},
+ }
+ }
+
+ if *chainNameOpt != "" {
+ if conf.GenesisDoc == nil {
+ fatalf("Unable to set ChainName since no GenesisDoc/GenesisSpec provided.")
+ }
+ conf.GenesisDoc.ChainName = *chainNameOpt
+ }
+
+ if *separateGenesisDoc != "" {
+ if conf.GenesisDoc == nil {
+ fatalf("Cannot write separate genesis doc since no GenesisDoc/GenesisSpec provided.")
+ }
+ genesisDocJSON, err := conf.GenesisDoc.JSONBytes()
+ if err != nil {
+ fatalf("Could not form GenesisDoc JSON: %v", err)
+ }
+ err = ioutil.WriteFile(*separateGenesisDoc, genesisDocJSON, 0700)
+ if err != nil {
+ fatalf("Could not write GenesisDoc JSON: %v", err)
+ }
+ conf.GenesisDoc = nil
+ }
+ if *jsonOutOpt {
+ os.Stdout.WriteString(conf.JSONString())
+ } else {
+ os.Stdout.WriteString(conf.TOMLString())
+ }
+ }
+}
diff --git a/cmd/burrow/commands/helpers.go b/cmd/burrow/commands/helpers.go
new file mode 100644
index 00000000..232c1f2e
--- /dev/null
+++ b/cmd/burrow/commands/helpers.go
@@ -0,0 +1,52 @@
+package commands
+
+import (
+ "fmt"
+ "os"
+
+ "github.com/hyperledger/burrow/config"
+ "github.com/hyperledger/burrow/config/source"
+ "github.com/hyperledger/burrow/genesis"
+)
+
+// Print informational output to Stderr
+func printf(format string, args ...interface{}) {
+ fmt.Fprintf(os.Stderr, format+"\n", args...)
+}
+
+func fatalf(format string, args ...interface{}) {
+ fmt.Fprintf(os.Stderr, format+"\n", args...)
+ os.Exit(1)
+}
+
+func burrowConfigProvider(configFile string) source.ConfigProvider {
+ return source.FirstOf(
+ // Will fail if file doesn't exist, but still skipped it configFile == ""
+ source.File(configFile, false),
+ source.Environment(config.DefaultBurrowConfigJSONEnvironmentVariable),
+ // Try working directory
+ source.File(config.DefaultBurrowConfigTOMLFileName, true),
+ source.Default(config.DefaultBurrowConfig()))
+}
+
+func genesisDocProvider(genesisFile string, skipNonExistent bool) source.ConfigProvider {
+ return source.NewConfigProvider(fmt.Sprintf("genesis file at %s", genesisFile),
+ source.ShouldSkipFile(genesisFile, skipNonExistent),
+ func(baseConfig interface{}) error {
+ conf, ok := baseConfig.(*config.BurrowConfig)
+ if !ok {
+ return fmt.Errorf("config passed was not BurrowConfig")
+ }
+ if conf.GenesisDoc != nil {
+ return fmt.Errorf("sourcing GenesisDoc from file %v, but GenesisDoc was defined in earlier "+
+ "config source, only specify GenesisDoc in one place", genesisFile)
+ }
+ genesisDoc := new(genesis.GenesisDoc)
+ err := source.FromFile(genesisFile, genesisDoc)
+ if err != nil {
+ return err
+ }
+ conf.GenesisDoc = genesisDoc
+ return nil
+ })
+}
diff --git a/cmd/burrow/commands/spec.go b/cmd/burrow/commands/spec.go
new file mode 100644
index 00000000..63400631
--- /dev/null
+++ b/cmd/burrow/commands/spec.go
@@ -0,0 +1,67 @@
+package commands
+
+import (
+ "fmt"
+ "os"
+
+ "github.com/hyperledger/burrow/config/source"
+ "github.com/hyperledger/burrow/genesis/spec"
+ "github.com/jawher/mow.cli"
+)
+
+func Spec(cmd *cli.Cmd) {
+ tomlOpt := cmd.BoolOpt("t toml", false, "Emit GenesisSpec as TOML rather than the "+
+ "default JSON")
+
+ baseSpecsArg := cmd.StringsArg("BASE", nil, "Provide a base GenesisSpecs on top of which any "+
+ "additional GenesisSpec presets specified by other flags will be merged. GenesisSpecs appearing "+
+ "later take precedent over those appearing early if multiple --base flags are provided")
+
+ accountNamePrefixOpt := cmd.StringOpt("name-prefix", "", "Prefix added to the names of accounts in GenesisSpec")
+ fullOpt := cmd.IntOpt("f full-accounts", 0, "Number of preset Full type accounts")
+ validatorOpt := cmd.IntOpt("v validator-accounts", 0, "Number of preset Validator type accounts")
+ rootOpt := cmd.IntOpt("r root-accounts", 0, "Number of preset Root type accounts")
+ developerOpt := cmd.IntOpt("d developer-accounts", 0, "Number of preset Developer type accounts")
+ participantsOpt := cmd.IntOpt("p participant-accounts", 0, "Number of preset Participant type accounts")
+ chainNameOpt := cmd.StringOpt("n chain-name", "", "Default chain name")
+
+ cmd.Spec = "[--full-accounts] [--validator-accounts] [--root-accounts] [--developer-accounts] " +
+ "[--participant-accounts] [--chain-name] [--toml] [BASE...]"
+
+ cmd.Action = func() {
+ specs := make([]spec.GenesisSpec, 0, *participantsOpt+*fullOpt)
+ for _, baseSpec := range *baseSpecsArg {
+ genesisSpec := new(spec.GenesisSpec)
+ err := source.FromFile(baseSpec, genesisSpec)
+ if err != nil {
+ fatalf("could not read GenesisSpec: %v", err)
+ }
+ specs = append(specs, *genesisSpec)
+ }
+ for i := 0; i < *fullOpt; i++ {
+ specs = append(specs, spec.FullAccount(fmt.Sprintf("%sFull_%v", *accountNamePrefixOpt, i)))
+ }
+ for i := 0; i < *validatorOpt; i++ {
+ specs = append(specs, spec.ValidatorAccount(fmt.Sprintf("%sValidator_%v", *accountNamePrefixOpt, i)))
+ }
+ for i := 0; i < *rootOpt; i++ {
+ specs = append(specs, spec.RootAccount(fmt.Sprintf("%sRoot_%v", *accountNamePrefixOpt, i)))
+ }
+ for i := 0; i < *developerOpt; i++ {
+ specs = append(specs, spec.DeveloperAccount(fmt.Sprintf("%sDeveloper_%v", *accountNamePrefixOpt, i)))
+ }
+ for i := 0; i < *participantsOpt; i++ {
+ specs = append(specs, spec.ParticipantAccount(fmt.Sprintf("%sParticipant_%v", *accountNamePrefixOpt, i)))
+ }
+ genesisSpec := spec.MergeGenesisSpecs(specs...)
+ if *chainNameOpt != "" {
+ genesisSpec.ChainName = *chainNameOpt
+ }
+ if *tomlOpt {
+ os.Stdout.WriteString(source.TOMLString(genesisSpec))
+ } else {
+ os.Stdout.WriteString(source.JSONString(genesisSpec))
+ }
+ os.Stdout.WriteString("\n")
+ }
+}
diff --git a/cmd/burrow/commands/start.go b/cmd/burrow/commands/start.go
new file mode 100644
index 00000000..5efb282a
--- /dev/null
+++ b/cmd/burrow/commands/start.go
@@ -0,0 +1,113 @@
+package commands
+
+import (
+ "context"
+
+ acm "github.com/hyperledger/burrow/account"
+ "github.com/hyperledger/burrow/config"
+ "github.com/hyperledger/burrow/config/source"
+ logging_config "github.com/hyperledger/burrow/logging/config"
+ "github.com/jawher/mow.cli"
+)
+
+func Start(cmd *cli.Cmd) {
+ genesisOpt := cmd.StringOpt("g genesis", "",
+ "Use the specified genesis JSON file rather than a key in the main config, use - to read from STDIN")
+
+ configOpt := cmd.StringOpt("c config", "", "Use the a specified burrow config file")
+
+ validatorIndexOpt := cmd.Int(cli.IntOpt{
+ Name: "v validator-index",
+ Desc: "Validator index (in validators list - GenesisSpec or GenesisDoc) from which to set ValidatorAddress",
+ Value: -1,
+ EnvVar: "BURROW_VALIDATOR_INDEX",
+ })
+
+ validatorAddressOpt := cmd.String(cli.StringOpt{
+ Name: "a validator-address",
+ Desc: "The address of the the signing key of this validator",
+ EnvVar: "BURROW_VALIDATOR_ADDRESS",
+ })
+
+ validatorPassphraseOpt := cmd.String(cli.StringOpt{
+ Name: "p validator-passphrase",
+ Desc: "The passphrase of the signing key of this validator (currently unimplemented but planned for future version of our KeyClient interface)",
+ EnvVar: "BURROW_VALIDATOR_PASSPHRASE",
+ })
+
+ validatorMonikerOpt := cmd.String(cli.StringOpt{
+ Name: "m validator-moniker",
+ Desc: "An optional human-readable moniker to identify this validator amongst Tendermint peers in logs and status queries",
+ EnvVar: "BURROW_VALIDATOR_MONIKER",
+ })
+
+ cmd.Spec = "[--config=<config file>] [--validator-moniker=<human readable moniker>] " +
+ "[--validator-index=<index of validator in GenesisDoc> | --validator-address=<address of validator signing key>] " +
+ "[--genesis=<genesis json file>]"
+
+ cmd.Action = func() {
+
+ // We need to reflect on whether this obscures where values are coming from
+ conf := config.DefaultBurrowConfig()
+ // We treat logging a little differently in that if anything is set for logging we will not
+ // set default outputs
+ conf.Logging = nil
+ err := source.EachOf(
+ burrowConfigProvider(*configOpt),
+ source.FirstOf(
+ genesisDocProvider(*genesisOpt, false),
+ // Try working directory
+ genesisDocProvider(config.DefaultGenesisDocJSONFileName, true)),
+ ).Apply(conf)
+
+ // If no logging config was provided use the default
+ if conf.Logging == nil {
+ conf.Logging = logging_config.DefaultNodeLoggingConfig()
+ }
+ if err != nil {
+ fatalf("could not obtain config: %v", err)
+ }
+
+ // Which validator am I?
+ if *validatorAddressOpt != "" {
+ address, err := acm.AddressFromHexString(*validatorAddressOpt)
+ if err != nil {
+ fatalf("could not read address for validator in '%s'", *validatorAddressOpt)
+ }
+ conf.ValidatorAddress = &address
+ } else if *validatorIndexOpt > -1 {
+ if conf.GenesisDoc == nil {
+ fatalf("Unable to set ValidatorAddress from provided validator-index since no " +
+ "GenesisDoc/GenesisSpec provided.")
+ }
+ if *validatorIndexOpt >= len(conf.GenesisDoc.Validators) {
+ fatalf("validator-index of %v given but only %v validators specified in GenesisDoc",
+ *validatorIndexOpt, len(conf.GenesisDoc.Validators))
+ }
+ conf.ValidatorAddress = &conf.GenesisDoc.Validators[*validatorIndexOpt].Address
+ printf("Using validator index %v (address: %s)", *validatorIndexOpt, *conf.ValidatorAddress)
+ }
+
+ if *validatorPassphraseOpt != "" {
+ conf.ValidatorPassphrase = validatorPassphraseOpt
+ }
+
+ if *validatorMonikerOpt != "" {
+ conf.Tendermint.Moniker = *validatorMonikerOpt
+ }
+
+ ctx, cancel := context.WithCancel(context.Background())
+ defer cancel()
+
+ kern, err := conf.Kernel(ctx)
+ if err != nil {
+ fatalf("could not create Burrow kernel: %v", err)
+ }
+
+ err = kern.Boot()
+ if err != nil {
+ fatalf("could not boot Burrow kernel: %v", err)
+ }
+ kern.WaitForShutdown()
+ }
+}
diff --git a/cmd/burrow/main.go b/cmd/burrow/main.go
index bec7b21c..6c577586 100644
--- a/cmd/burrow/main.go
+++ b/cmd/burrow/main.go
@@ -1,23 +1,10 @@
package main
import (
- "context"
"fmt"
- "io/ioutil"
"os"
- "strings"
- acm "github.com/hyperledger/burrow/account"
- "github.com/hyperledger/burrow/config"
- "github.com/hyperledger/burrow/config/source"
- "github.com/hyperledger/burrow/execution"
- "github.com/hyperledger/burrow/genesis"
- "github.com/hyperledger/burrow/genesis/spec"
- "github.com/hyperledger/burrow/keys"
- "github.com/hyperledger/burrow/keys/mock"
- "github.com/hyperledger/burrow/logging"
- logging_config "github.com/hyperledger/burrow/logging/config"
- "github.com/hyperledger/burrow/logging/config/presets"
+ "github.com/hyperledger/burrow/cmd/burrow/commands"
"github.com/hyperledger/burrow/project"
"github.com/jawher/mow.cli"
)
@@ -39,373 +26,15 @@ func burrow() *cli.Cli {
}
}
- app.Command("serve", "",
- func(cmd *cli.Cmd) {
- genesisOpt := cmd.StringOpt("g genesis", "",
- "Use the specified genesis JSON file rather than a key in the main config, use - to read from STDIN")
+ app.Command("start", "Start a Burrow node",
+ commands.Start)
- configOpt := cmd.StringOpt("c config", "", "Use the a specified burrow config file")
-
- validatorIndexOpt := cmd.Int(cli.IntOpt{
- Name: "v validator-index",
- Desc: "Validator index (in validators list - GenesisSpec or GenesisDoc) from which to set ValidatorAddress",
- Value: -1,
- EnvVar: "BURROW_VALIDATOR_INDEX",
- })
-
- validatorAddressOpt := cmd.String(cli.StringOpt{
- Name: "a validator-address",
- Desc: "The address of the the signing key of this validator",
- EnvVar: "BURROW_VALIDATOR_ADDRESS",
- })
-
- validatorPassphraseOpt := cmd.String(cli.StringOpt{
- Name: "p validator-passphrase",
- Desc: "The passphrase of the signing key of this validator (currently unimplemented but planned for future version of our KeyClient interface)",
- EnvVar: "BURROW_VALIDATOR_PASSPHRASE",
- })
-
- validatorMonikerOpt := cmd.String(cli.StringOpt{
- Name: "m validator-moniker",
- Desc: "An optional human-readable moniker to identify this validator amongst Tendermint peers in logs and status queries",
- EnvVar: "BURROW_VALIDATOR_MONIKER",
- })
-
- cmd.Spec = "[--config=<config file>] [--validator-moniker=<human readable moniker>] " +
- "[--validator-index=<index of validator in GenesisDoc> | --validator-address=<address of validator signing key>] " +
- "[--genesis=<genesis json file>]"
-
- cmd.Action = func() {
-
- // We need to reflect on whether this obscures where values are coming from
- conf := config.DefaultBurrowConfig()
- // We treat logging a little differently in that if anything is set for logging we will not
- // set default outputs
- conf.Logging = nil
- err := source.EachOf(
- burrowConfigProvider(*configOpt),
- source.FirstOf(
- genesisDocProvider(*genesisOpt, false),
- // Try working directory
- genesisDocProvider(config.DefaultGenesisDocJSONFileName, true)),
- ).Apply(conf)
-
- // If no logging config was provided use the default
- if conf.Logging == nil {
- conf.Logging = logging_config.DefaultNodeLoggingConfig()
- }
- if err != nil {
- fatalf("could not obtain config: %v", err)
- }
-
- // Which validator am I?
- if *validatorAddressOpt != "" {
- address, err := acm.AddressFromHexString(*validatorAddressOpt)
- if err != nil {
- fatalf("could not read address for validator in '%s'", *validatorAddressOpt)
- }
- conf.ValidatorAddress = &address
- } else if *validatorIndexOpt > -1 {
- if conf.GenesisDoc == nil {
- fatalf("Unable to set ValidatorAddress from provided validator-index since no " +
- "GenesisDoc/GenesisSpec provided.")
- }
- if *validatorIndexOpt >= len(conf.GenesisDoc.Validators) {
- fatalf("validator-index of %v given but only %v validators specified in GenesisDoc",
- *validatorIndexOpt, len(conf.GenesisDoc.Validators))
- }
- conf.ValidatorAddress = &conf.GenesisDoc.Validators[*validatorIndexOpt].Address
- printf("Using validator index %v (address: %s)", *validatorIndexOpt, *conf.ValidatorAddress)
- }
-
- if *validatorPassphraseOpt != "" {
- conf.ValidatorPassphrase = validatorPassphraseOpt
- }
-
- if *validatorMonikerOpt != "" {
- conf.Tendermint.Moniker = *validatorMonikerOpt
- }
-
- ctx, cancel := context.WithCancel(context.Background())
- defer cancel()
-
- kern, err := conf.Kernel(ctx)
- if err != nil {
- fatalf("could not create Burrow kernel: %v", err)
- }
-
- err = kern.Boot()
- if err != nil {
- fatalf("could not boot Burrow kernel: %v", err)
- }
- kern.WaitForShutdown()
- }
- })
-
- app.Command("spec",
- "Build a GenesisSpec that acts as a template for a GenesisDoc and the configure command",
- func(cmd *cli.Cmd) {
- tomlOpt := cmd.BoolOpt("t toml", false, "Emit GenesisSpec as TOML rather than the "+
- "default JSON")
-
- baseOpt := cmd.StringsOpt("b base", nil, "Provide a base GenesisSpecs on top of which any "+
- "additional GenesisSpec presets specified by other flags will be merged. GenesisSpecs appearing "+
- "later take precedent over those appearing early if multiple --base flags are provided")
-
- fullOpt := cmd.IntOpt("f full-accounts", 0, "Number of preset Full type accounts")
- validatorOpt := cmd.IntOpt("v validator-accounts", 0, "Number of preset Validator type accounts")
- rootOpt := cmd.IntOpt("r root-accounts", 0, "Number of preset Root type accounts")
- developerOpt := cmd.IntOpt("d developer-accounts", 0, "Number of preset Developer type accounts")
- participantsOpt := cmd.IntOpt("p participant-accounts", 0, "Number of preset Participant type accounts")
- chainNameOpt := cmd.StringOpt("n chain-name", "", "Default chain name")
-
- cmd.Spec = "[--base] [--full-accounts] [--validator-accounts] [--root-accounts] [--developer-accounts] " +
- "[--participant-accounts] [--chain-name] [--toml]"
-
- cmd.Action = func() {
- specs := make([]spec.GenesisSpec, 0, *participantsOpt+*fullOpt)
- for _, baseSpec := range *baseOpt {
- genesisSpec := new(spec.GenesisSpec)
- err := source.FromFile(baseSpec, genesisSpec)
- if err != nil {
- fatalf("could not read GenesisSpec: %v", err)
- }
- specs = append(specs, *genesisSpec)
- }
- for i := 0; i < *fullOpt; i++ {
- specs = append(specs, spec.FullAccount(i))
- }
- for i := 0; i < *validatorOpt; i++ {
- specs = append(specs, spec.ValidatorAccount(i))
- }
- for i := 0; i < *rootOpt; i++ {
- specs = append(specs, spec.RootAccount(i))
- }
- for i := 0; i < *developerOpt; i++ {
- specs = append(specs, spec.DeveloperAccount(i))
- }
- for i := 0; i < *participantsOpt; i++ {
- specs = append(specs, spec.ParticipantAccount(i))
- }
- genesisSpec := spec.MergeGenesisSpecs(specs...)
- if *chainNameOpt != "" {
- genesisSpec.ChainName = *chainNameOpt
- }
- if *tomlOpt {
- os.Stdout.WriteString(source.TOMLString(genesisSpec))
- } else {
- os.Stdout.WriteString(source.JSONString(genesisSpec))
- }
- }
- })
+ app.Command("spec", "Build a GenesisSpec that acts as a template for a GenesisDoc and the configure command",
+ commands.Spec)
app.Command("configure",
"Create Burrow configuration by consuming a GenesisDoc or GenesisSpec, creating keys, and emitting the config",
- func(cmd *cli.Cmd) {
- genesisSpecOpt := cmd.StringOpt("s genesis-spec", "",
- "A GenesisSpec to use as a template for a GenesisDoc that will be created along with keys")
-
- jsonOutOpt := cmd.BoolOpt("j json-out", false, "Emit config in JSON rather than TOML "+
- "suitable for further processing or forming a separate genesis.json GenesisDoc")
-
- keysUrlOpt := cmd.StringOpt("k keys-url", "", fmt.Sprintf("Provide keys URL, default: %s",
- keys.DefaultKeysConfig().URL))
-
- configOpt := cmd.StringOpt("c base-config", "", "Use the a specified burrow config file as a base")
-
- genesisDocOpt := cmd.StringOpt("g genesis-doc", "", "GenesisDoc in JSON or TOML to embed in config")
-
- generateKeysOpt := cmd.StringOpt("x generate-keys", "",
- "File to output containing secret keys as JSON or according to a custom template (see --keys-template). "+
- "Note that using this options means the keys will not be generated in the default keys instance")
-
- keysTemplateOpt := cmd.StringOpt("z keys-template", mock.DefaultDumpKeysFormat,
- fmt.Sprintf("Go text/template template (left delim: %s right delim: %s) to generate secret keys "+
- "file specified with --generate-keys. Default:\n%s", mock.LeftTemplateDelim, mock.RightTemplateDelim,
- mock.DefaultDumpKeysFormat))
-
- separateGenesisDoc := cmd.StringOpt("w separate-genesis-doc", "", "Emit a separate genesis doc as JSON or TOML")
-
- loggingOpt := cmd.StringOpt("l logging", "",
- "Comma separated list of logging instructions which form a 'program' which is a depth-first "+
- "pre-order of instructions that will build the root logging sink. See 'burrow help' for more information.")
-
- describeLoggingOpt := cmd.BoolOpt("describe-logging", false,
- "Print an exhaustive list of logging instructions available with the --logging option")
-
- debugOpt := cmd.BoolOpt("d debug", false, "Include maximal debug options in config "+
- "including logging opcodes and dumping EVM tokens to disk these can be later pruned from the "+
- "generated config.")
-
- chainNameOpt := cmd.StringOpt("n chain-name", "", "Default chain name")
-
- cmd.Spec = "[--keys-url=<keys URL> | (--generate-keys=<secret keys files> [--keys-template=<text template for each key>])] " +
- "[--genesis-spec=<GenesisSpec file> | --genesis-doc=<GenesisDoc file>] " +
- "[--separate-genesis-doc=<genesis JSON file>] [--chain-name] [--json-out] " +
- "[--logging=<logging program>] [--describe-logging] [--debug]"
-
- cmd.Action = func() {
- conf := config.DefaultBurrowConfig()
-
- if *configOpt != "" {
- // If explicitly given a config file use it as a base:
- err := source.FromFile(*configOpt, conf)
- if err != nil {
- fatalf("could not read base config file (as TOML): %v", err)
- }
- }
-
- if *describeLoggingOpt {
- fmt.Printf("Usage:\n burrow configure -l INSTRUCTION[,...]\n\nBuilds a logging " +
- "configuration by constructing a tree of logging sinks assembled from preset instructions " +
- "that generate the tree while traversing it.\n\nLogging Instructions:\n")
- for _, instruction := range presets.Instructons() {
- fmt.Printf(" %-15s\t%s\n", instruction.Name(), instruction.Description())
- }
- fmt.Printf("\nExample Usage:\n burrow configure -l include-any,info,stderr\n")
- return
- }
-
- if *keysUrlOpt != "" {
- conf.Keys.URL = *keysUrlOpt
- }
-
- // Genesis Spec
- if *genesisSpecOpt != "" {
- genesisSpec := new(spec.GenesisSpec)
- err := source.FromFile(*genesisSpecOpt, genesisSpec)
- if err != nil {
- fatalf("Could not read GenesisSpec: %v", err)
- }
- if *generateKeysOpt != "" {
- keyClient := mock.NewMockKeyClient()
- conf.GenesisDoc, err = genesisSpec.GenesisDoc(keyClient)
- if err != nil {
- fatalf("Could not generate GenesisDoc from GenesisSpec using MockKeyClient: %v", err)
- }
-
- secretKeysString, err := keyClient.DumpKeys(*keysTemplateOpt)
- if err != nil {
- fatalf("Could not dump keys: %v", err)
- }
- err = ioutil.WriteFile(*generateKeysOpt, []byte(secretKeysString), 0700)
- if err != nil {
- fatalf("Could not write secret keys: %v", err)
- }
- } else {
- conf.GenesisDoc, err = genesisSpec.GenesisDoc(keys.NewKeyClient(conf.Keys.URL, logging.NewNoopLogger()))
- }
- if err != nil {
- fatalf("could not realise GenesisSpec: %v", err)
- }
- } else if *genesisDocOpt != "" {
- genesisDoc := new(genesis.GenesisDoc)
- err := source.FromFile(*genesisSpecOpt, genesisDoc)
- if err != nil {
- fatalf("could not read GenesisSpec: %v", err)
- }
- conf.GenesisDoc = genesisDoc
- }
-
- // Logging
- if *loggingOpt != "" {
- ops := strings.Split(*loggingOpt, ",")
- sinkConfig, err := presets.BuildSinkConfig(ops...)
- if err != nil {
- fatalf("could not build logging configuration: %v\n\nTo see possible logging "+
- "instructions run:\n burrow configure --describe-logging", err)
- }
- conf.Logging = &logging_config.LoggingConfig{
- RootSink: sinkConfig,
- }
- }
-
- if *debugOpt {
- conf.Execution = &execution.ExecutionConfig{
- VMOptions: []execution.VMOption{execution.DumpTokens, execution.DebugOpcodes},
- }
- }
-
- if *chainNameOpt != "" {
- if conf.GenesisDoc == nil {
- fatalf("Unable to set ChainName since no GenesisDoc/GenesisSpec provided.")
- }
- conf.GenesisDoc.ChainName = *chainNameOpt
- }
-
- if *separateGenesisDoc != "" {
- if conf.GenesisDoc == nil {
- fatalf("Cannot write separate genesis doc since no GenesisDoc/GenesisSpec provided.")
- }
- genesisDocJSON, err := conf.GenesisDoc.JSONBytes()
- if err != nil {
- fatalf("Could not form GenesisDoc JSON: %v", err)
- }
- err = ioutil.WriteFile(*separateGenesisDoc, genesisDocJSON, 0700)
- if err != nil {
- fatalf("Could not write GenesisDoc JSON: %v", err)
- }
- conf.GenesisDoc = nil
- }
- if *jsonOutOpt {
- os.Stdout.WriteString(conf.JSONString())
- } else {
- os.Stdout.WriteString(conf.TOMLString())
- }
- }
- })
-
- app.Command("help",
- "Get more detailed or exhaustive options of selected commands or flags.",
- func(cmd *cli.Cmd) {
-
- cmd.Spec = "[--participant-accounts] [--full-accounts] [--toml]"
-
- cmd.Action = func() {
- }
- })
+ commands.Configure)
return app
}
-
-// Print informational output to Stderr
-func printf(format string, args ...interface{}) {
- fmt.Fprintf(os.Stderr, format+"\n", args...)
-}
-
-func fatalf(format string, args ...interface{}) {
- fmt.Fprintf(os.Stderr, format+"\n", args...)
- os.Exit(1)
-}
-
-func burrowConfigProvider(configFile string) source.ConfigProvider {
- return source.FirstOf(
- // Will fail if file doesn't exist, but still skipped it configFile == ""
- source.File(configFile, false),
- source.Environment(config.DefaultBurrowConfigJSONEnvironmentVariable),
- // Try working directory
- source.File(config.DefaultBurrowConfigTOMLFileName, true),
- source.Default(config.DefaultBurrowConfig()))
-}
-
-func genesisDocProvider(genesisFile string, skipNonExistent bool) source.ConfigProvider {
- return source.NewConfigProvider(fmt.Sprintf("genesis file at %s", genesisFile),
- source.ShouldSkipFile(genesisFile, skipNonExistent),
- func(baseConfig interface{}) error {
- conf, ok := baseConfig.(*config.BurrowConfig)
- if !ok {
- return fmt.Errorf("config passed was not BurrowConfig")
- }
- if conf.GenesisDoc != nil {
- return fmt.Errorf("sourcing GenesisDoc from file %v, but GenesisDoc was defined in earlier "+
- "config source, only specify GenesisDoc in one place", genesisFile)
- }
- genesisDoc := new(genesis.GenesisDoc)
- err := source.FromFile(genesisFile, genesisDoc)
- if err != nil {
- return err
- }
- conf.GenesisDoc = genesisDoc
- return nil
- })
-}
diff --git a/genesis/spec/genesis_spec.go b/genesis/spec/genesis_spec.go
index c037c5c4..11549a01 100644
--- a/genesis/spec/genesis_spec.go
+++ b/genesis/spec/genesis_spec.go
@@ -24,23 +24,24 @@ const DefaultAmountBonded uint64 = 10000
// by interacting with the KeysClient it is passed and other information not known at
// specification time
type GenesisSpec struct {
- GenesisTime *time.Time `json:",omitempty"`
- ChainName string `json:",omitempty"`
- Salt []byte `json:",omitempty"`
- GlobalPermissions []string `json:",omitempty"`
- Accounts []TemplateAccount `json:",omitempty"`
+ GenesisTime *time.Time `json:",omitempty" toml:",omitempty"`
+ ChainName string `json:",omitempty" toml:",omitempty"`
+ Salt []byte `json:",omitempty" toml:",omitempty"`
+ GlobalPermissions []string `json:",omitempty" toml:",omitempty"`
+ Accounts []TemplateAccount `json:",omitempty" toml:",omitempty"`
}
type TemplateAccount struct {
+ // Template accounts sharing a name will be merged when merging genesis specs
+ Name string `json:",omitempty" toml:",omitempty"`
// Address is convenient to have in file for reference, but otherwise ignored since derived from PublicKey
- Address *acm.Address `json:",omitempty"`
- PublicKey *acm.PublicKey `json:",omitempty"`
- Amount *uint64 `json:",omitempty"`
+ Address *acm.Address `json:",omitempty" toml:",omitempty"`
+ PublicKey *acm.PublicKey `json:",omitempty" toml:",omitempty"`
+ Amount *uint64 `json:",omitempty" toml:",omitempty"`
// If any bonded amount then this account is also a Validator
- AmountBonded *uint64 `json:",omitempty"`
- Name string `json:",omitempty"`
- Permissions []string `json:",omitempty"`
- Roles []string `json:",omitempty"`
+ AmountBonded *uint64 `json:",omitempty" toml:",omitempty"`
+ Permissions []string `json:",omitempty" toml:",omitempty"`
+ Roles []string `json:",omitempty" toml:",omitempty"`
}
func (ta TemplateAccount) Validator(keyClient keys.KeyClient, index int) (*genesis.Validator, error) {
diff --git a/genesis/spec/presets.go b/genesis/spec/presets.go
index 0298a447..312ec7a7 100644
--- a/genesis/spec/presets.go
+++ b/genesis/spec/presets.go
@@ -1,8 +1,6 @@
package spec
import (
- "fmt"
-
"sort"
"github.com/hyperledger/burrow/permission"
@@ -11,13 +9,13 @@ import (
// Files here can be used as starting points for building various 'chain types' but are otherwise
// a fairly unprincipled collection of GenesisSpecs that we find useful in testing and development
-func FullAccount(index int) GenesisSpec {
+func FullAccount(name string) GenesisSpec {
// Inheriting from the arbitrary figures used by monax tool for now
amount := uint64(99999999999999)
amountBonded := uint64(9999999999)
return GenesisSpec{
Accounts: []TemplateAccount{{
- Name: fmt.Sprintf("Full_%v", index),
+ Name: name,
Amount: &amount,
AmountBonded: &amountBonded,
Permissions: []string{permission.AllString},
@@ -26,12 +24,12 @@ func FullAccount(index int) GenesisSpec {
}
}
-func RootAccount(index int) GenesisSpec {
+func RootAccount(name string) GenesisSpec {
// Inheriting from the arbitrary figures used by monax tool for now
amount := uint64(99999999999999)
return GenesisSpec{
Accounts: []TemplateAccount{{
- Name: fmt.Sprintf("Root_%v", index),
+ Name: name,
Amount: &amount,
Permissions: []string{permission.AllString},
},
@@ -39,12 +37,12 @@ func RootAccount(index int) GenesisSpec {
}
}
-func ParticipantAccount(index int) GenesisSpec {
+func ParticipantAccount(name string) GenesisSpec {
// Inheriting from the arbitrary figures used by monax tool for now
amount := uint64(9999999999)
return GenesisSpec{
Accounts: []TemplateAccount{{
- Name: fmt.Sprintf("Participant_%v", index),
+ Name: name,
Amount: &amount,
Permissions: []string{permission.SendString, permission.CallString, permission.NameString,
permission.HasRoleString},
@@ -52,12 +50,12 @@ func ParticipantAccount(index int) GenesisSpec {
}
}
-func DeveloperAccount(index int) GenesisSpec {
+func DeveloperAccount(name string) GenesisSpec {
// Inheriting from the arbitrary figures used by monax tool for now
amount := uint64(9999999999)
return GenesisSpec{
Accounts: []TemplateAccount{{
- Name: fmt.Sprintf("Developer_%v", index),
+ Name: name,
Amount: &amount,
Permissions: []string{permission.SendString, permission.CallString, permission.CreateContractString,
permission.CreateAccountString, permission.NameString, permission.HasRoleString,
@@ -66,13 +64,13 @@ func DeveloperAccount(index int) GenesisSpec {
}
}
-func ValidatorAccount(index int) GenesisSpec {
+func ValidatorAccount(name string) GenesisSpec {
// Inheriting from the arbitrary figures used by monax tool for now
amount := uint64(9999999999)
amountBonded := amount - 1
return GenesisSpec{
Accounts: []TemplateAccount{{
- Name: fmt.Sprintf("Validator_%v", index),
+ Name: name,
Amount: &amount,
AmountBonded: &amountBonded,
Permissions: []string{permission.BondString},
@@ -83,7 +81,7 @@ func ValidatorAccount(index int) GenesisSpec {
func MergeGenesisSpecs(genesisSpecs ...GenesisSpec) GenesisSpec {
mergedGenesisSpec := GenesisSpec{}
// We will deduplicate and merge global permissions flags
- permSet := make(map[string]bool)
+ permSet := make(map[string]struct{})
for _, genesisSpec := range genesisSpecs {
// We'll overwrite chain name for later specs
@@ -97,11 +95,11 @@ func MergeGenesisSpecs(genesisSpecs ...GenesisSpec) GenesisSpec {
}
for _, permString := range genesisSpec.GlobalPermissions {
- permSet[permString] = true
+ permSet[permString] = struct{}{}
}
mergedGenesisSpec.Salt = append(mergedGenesisSpec.Salt, genesisSpec.Salt...)
- mergedGenesisSpec.Accounts = append(mergedGenesisSpec.Accounts, genesisSpec.Accounts...)
+ mergedGenesisSpec.Accounts = mergeAccounts(mergedGenesisSpec.Accounts, genesisSpec.Accounts)
}
mergedGenesisSpec.GlobalPermissions = make([]string, 0, len(permSet))
@@ -115,3 +113,73 @@ func MergeGenesisSpecs(genesisSpecs ...GenesisSpec) GenesisSpec {
return mergedGenesisSpec
}
+
+// Merge accounts by adding to base list or updating previously named account
+func mergeAccounts(bases, overrides []TemplateAccount) []TemplateAccount {
+ indexOfBase := make(map[string]int, len(bases))
+ for i, ta := range bases {
+ if ta.Name != "" {
+ indexOfBase[ta.Name] = i
+ }
+ }
+
+ for _, override := range overrides {
+ if override.Name != "" {
+ if i, ok := indexOfBase[override.Name]; ok {
+ bases[i] = mergeAccount(bases[i], override)
+ continue
+ }
+ }
+ bases = append(bases, override)
+ }
+ return bases
+}
+
+func mergeAccount(base, override TemplateAccount) TemplateAccount {
+ if override.Address != nil {
+ base.Address = override.Address
+ }
+ if override.PublicKey != nil {
+ base.PublicKey = override.PublicKey
+ }
+ if override.Name != "" {
+ base.Name = override.Name
+ }
+
+ base.Amount = addUint64Pointers(base.Amount, override.Amount)
+ base.AmountBonded = addUint64Pointers(base.AmountBonded, override.AmountBonded)
+
+ base.Permissions = mergeStrings(base.Permissions, override.Permissions)
+ base.Roles = mergeStrings(base.Roles, override.Roles)
+ return base
+}
+
+func mergeStrings(as, bs []string) []string {
+ var strs []string
+ strSet := make(map[string]struct{})
+ for _, a := range as {
+ strSet[a] = struct{}{}
+ }
+ for _, b := range bs {
+ strSet[b] = struct{}{}
+ }
+ for str := range strSet {
+ strs = append(strs, str)
+ }
+ sort.Strings(strs)
+ return strs
+}
+
+func addUint64Pointers(a, b *uint64) *uint64 {
+ if a == nil && b == nil {
+ return nil
+ }
+ amt := uint64(0)
+ if a != nil {
+ amt += *a
+ }
+ if b != nil {
+ amt += *b
+ }
+ return &amt
+}
diff --git a/genesis/spec/presets_test.go b/genesis/spec/presets_test.go
index dc65fd9e..b8a40cd0 100644
--- a/genesis/spec/presets_test.go
+++ b/genesis/spec/presets_test.go
@@ -11,14 +11,11 @@ import (
func TestMergeGenesisSpecAccounts(t *testing.T) {
keyClient := mock.NewMockKeyClient()
- gs := MergeGenesisSpecs(FullAccount(0), ParticipantAccount(1), ParticipantAccount(2))
+ gs := MergeGenesisSpecs(FullAccount("0"), ParticipantAccount("1"), ParticipantAccount("2"))
gd, err := gs.GenesisDoc(keyClient)
require.NoError(t, err)
assert.Len(t, gd.Validators, 1)
assert.Len(t, gd.Accounts, 3)
- //bs, err := gd.JSONBytes()
- //require.NoError(t, err)
- //fmt.Println(string(bs))
}
func TestMergeGenesisSpecGlobalPermissions(t *testing.T) {
@@ -33,3 +30,63 @@ func TestMergeGenesisSpecGlobalPermissions(t *testing.T) {
assert.Equal(t, []string{permission.CreateAccountString, permission.HasRoleString, permission.SendString},
gsMerged.GlobalPermissions)
}
+
+func TestMergeGenesisSpecsRepeatedAccounts(t *testing.T) {
+ name1 := "Party!"
+ name3 := "Counter!"
+
+ amt1 := uint64(5)
+ amt2 := uint64(2)
+ amt3 := uint64(9)
+
+ gs1 := GenesisSpec{
+ Accounts: []TemplateAccount{
+ {
+ Name: name1,
+ Amount: &amt1,
+ Permissions: []string{permission.SendString, permission.CreateAccountString, permission.HasRoleString},
+ Roles: []string{"fooer"},
+ },
+ },
+ }
+ gs2 := GenesisSpec{
+ Accounts: []TemplateAccount{
+ {
+ Name: name1,
+ Amount: &amt2,
+ Permissions: []string{permission.SendString, permission.CreateAccountString},
+ Roles: []string{"barer"},
+ },
+ },
+ }
+ gs3 := GenesisSpec{
+ Accounts: []TemplateAccount{
+ {
+ Name: name3,
+ Amount: &amt3,
+ },
+ },
+ }
+
+ gsMerged := MergeGenesisSpecs(gs1, gs2, gs3)
+ bsMerged, err := gsMerged.JSONBytes()
+ require.NoError(t, err)
+
+ amtExpected := amt1 + amt2
+ gsExpected := GenesisSpec{
+ Accounts: []TemplateAccount{
+ {
+ Name: name1,
+ Amount: &amtExpected,
+ Permissions: []string{permission.CreateAccountString, permission.HasRoleString, permission.SendString},
+ Roles: []string{"barer", "fooer"},
+ },
+ gs3.Accounts[0],
+ },
+ }
+ bsExpected, err := gsExpected.JSONBytes()
+ require.NoError(t, err)
+ if !assert.Equal(t, string(bsExpected), string(bsMerged)) {
+ t.Logf("Expected:\n%s\n\nActual:\n%s", string(bsExpected), string(bsMerged))
+ }
+}
--
GitLab