Merge pull request #1078 from hyperledger/develop

Merge for v0.24.6 release

Author: Sean Young

CHANGELOG.md

@@ -2,6 +2,17 @@
 ## [Unreleased]
 
 
+## [0.24.6] - 2019-03-19
+### Changed
+- [RPC] 'blocks' on info RPC now lists blocks in ascending rather than descending height order
+
+### Added
+- [CLI] Introduced burrow configure --pool for generation of multiple validator configs suitable for running on a single (or many) machines
+
+### Fixed
+- [Metrics] Fix histogram statistics by making counts cumulative 
+
+
 ## [0.24.5] - 2019-03-14
 ### Changed
 - [Consensus] Tendermint timeouts configurable by a float factor from defaults and default change to 0.33 of Tendermint's default for smaller networks'
@@ -245,7 +256,7 @@ In addition to breaking changes associated with Tendermint (see their changelog)
 - Add BlockExplorer CLI for forensics
 - Expose reason for REVERT
 - Add last_block_info healthcheck endpoint to rpc/TM
-- 
+-
 #### Improvements
 - Implement checkpointing when saving application and blockchain state in commit - interrupted commit rolls burrow back to last block whereon it can catch up using Tendermint
 - Maintain separate read-only tree in state so that long-running RPC request cannot block writes
@@ -411,7 +422,7 @@ This release marks the start of Eris-DB as the full permissioned blockchain node
   - Allow multiple event subscriptions from same host under rpc/tendermint
 
 
-- Tool changes  
+- Tool changes
   - Use glide instead of godeps for dependencies
 
 
@@ -428,7 +439,8 @@ This release marks the start of Eris-DB as the full permissioned blockchain node
   - [Blockchain] Fix getBlocks to respect block height cap.
 
 
-[Unreleased]: https://github.com/hyperledger/burrow/compare/v0.24.5...HEAD
+[Unreleased]: https://github.com/hyperledger/burrow/compare/v0.24.6...HEAD
+[0.24.6]: https://github.com/hyperledger/burrow/compare/v0.24.5...v0.24.6
 [0.24.5]: https://github.com/hyperledger/burrow/compare/v0.24.4...v0.24.5
 [0.24.4]: https://github.com/hyperledger/burrow/compare/v0.24.3...v0.24.4
 [0.24.3]: https://github.com/hyperledger/burrow/compare/v0.24.2...v0.24.3

Gopkg.lock

@@ -1,12 +1,9 @@
 ### Changed
-- [Consensus] Tendermint timeouts configurable by a float factor from defaults and default change to 0.33 of Tendermint's default for smaller networks'
-- [Transactor] Hard-coded timeout removed from transactor and added to TxEnvelopeParam for client specified server-side timeout (in case of longer confirmation times such as when some validators are unavailable
-- [Logging] ExcludeTrace config inverted to Trace and now defaults to false (i.e. no trace/debug logging). Default log output now excludes Tendermint logging (and is therefore much less talkative)
+- [RPC] 'blocks' on info RPC now lists blocks in ascending rather than descending height order
 
 ### Added
-- [Logging] Add height to all logging messages
-- [RPC] Add LastBlockCommitDuration to SyncInfo
+- [CLI] Introduced burrow configure --pool for generation of multiple validator configs suitable for running on a single (or many) machines
 
 ### Fixed
-- [Metrics] Replace use of Summary metrics when Histogram was intended
+- [Metrics] Fix histogram statistics by making counts cumulative 
 

NOTES.md

@@ -70,12 +70,14 @@ func Configure(output Output) func(cmd *cli.Cmd) {
 
 		restoreDumpOpt := cmd.StringOpt("restore-dump", "", "Including AppHash for restored file")
 
+		pool := cmd.BoolOpt("pool", false, "Write config files for all the validators called burrowNNN.toml")
+
 		cmd.Spec = "[--keys-url=<keys URL> | --keysdir=<keys directory>] " +
 			"[--config-template-in=<text template> --config-out=<output file>]... " +
 			"[--genesis-spec=<GenesisSpec file> | --genesis-doc=<GenesisDoc file>] " +
 			"[--separate-genesis-doc=<genesis JSON file>] [--chain-name=<chain name>] [--json] " +
 			"[--generate-node-keys] [--restore-dump=<dump file>] " +
-			"[--logging=<logging program>] [--describe-logging] [--debug]"
+			"[--logging=<logging program>] [--describe-logging] [--debug] [--pool]"
 
 		configOpts := addConfigOptions(cmd)
 
@@ -129,7 +131,7 @@ func Configure(output Output) func(cmd *cli.Cmd) {
 					keyStore := keys.NewKeyStore(dir, conf.Keys.AllowBadFilePermissions)
 
 					keyClient := keys.NewLocalKeyClient(keyStore, logging.NewNoopLogger())
-					conf.GenesisDoc, err = genesisSpec.GenesisDoc(keyClient, *generateNodeKeys)
+					conf.GenesisDoc, err = genesisSpec.GenesisDoc(keyClient, *generateNodeKeys || *pool)
 					if err != nil {
 						output.Fatalf("Could not generate GenesisDoc from GenesisSpec using MockKeyClient: %v", err)
 					}
@@ -188,7 +190,7 @@ func Configure(output Output) func(cmd *cli.Cmd) {
 					if err != nil {
 						output.Fatalf("Could not create remote key client: %v", err)
 					}
-					conf.GenesisDoc, err = genesisSpec.GenesisDoc(keyClient, *generateNodeKeys)
+					conf.GenesisDoc, err = genesisSpec.GenesisDoc(keyClient, *generateNodeKeys || *pool)
 				}
 
 				if err != nil {
@@ -285,6 +287,11 @@ func Configure(output Output) func(cmd *cli.Cmd) {
 				}
 			}
 
+			var validators []genesis.Validator
+			if conf.GenesisDoc != nil {
+				validators = conf.GenesisDoc.Validators
+			}
+
 			if *separateGenesisDoc != "" {
 				if conf.GenesisDoc == nil {
 					output.Fatalf("Cannot write separate genesis doc since no GenesisDoc/GenesisSpec provided.")
@@ -305,11 +312,40 @@ func Configure(output Output) func(cmd *cli.Cmd) {
 				output.Fatalf("could not update burrow config: %v", err)
 			}
 
-			if *jsonOutOpt {
+			if *pool && len(validators) > 0 {
+				for i, v := range validators {
+					if v.NodeAddress == nil {
+						continue
+					}
+					seeds := ""
+					for n, v := range validators {
+						if i == n || v.NodeAddress == nil {
+							continue
+						}
+						if seeds != "" {
+							seeds += ","
+						}
+						seeds += fmt.Sprintf("tcp://%[email protected]:%d", strings.ToLower(v.NodeAddress.String()), 26656+n)
+					}
+					// set stuff
+					conf.ValidatorAddress = &v.Address
+					conf.Tendermint.PersistentPeers = seeds
+					conf.Tendermint.ListenAddress = fmt.Sprintf("tcp://127.0.0.1:%d", 26656+i)
+					conf.Tendermint.TendermintRoot = fmt.Sprintf("burrow%03d", i)
+					conf.RPC.Info.ListenAddress = fmt.Sprintf("tcp://127.0.0.1:%d", 26758+i)
+					conf.RPC.GRPC.ListenAddress = fmt.Sprintf("127.0.0.1:%d", 10997+i)
+					conf.RPC.Metrics.ListenAddress = fmt.Sprintf("tcp://127.0.0.1:%d", 9102+i)
+					conf.Logging.RootSink.Output.OutputType = "file"
+					conf.Logging.RootSink.Output.FileConfig = &logconfig.FileConfig{Path: fmt.Sprintf("burrow%03d.log", i)}
+
+					ioutil.WriteFile(fmt.Sprintf("burrow%03d.toml", i), []byte(conf.TOMLString()), 0644)
+				}
+			} else if *jsonOutOpt {
 				output.Printf(conf.JSONString())
 			} else {
 				output.Printf(conf.TOMLString())
 			}
+
 		}
 	}
 }

cmd/burrow/commands/configure.go

@@ -84,8 +84,20 @@ func (conf *BurrowConfig) Kernel(ctx context.Context, restoreDump string) (*core
 		}
 	}
 
+	// find node key
+	var nodeKey *crypto.PrivateKey
+	for _, v := range conf.GenesisDoc.Validators {
+		if v.Address == *conf.ValidatorAddress && v.NodeAddress != nil {
+			k, err := keyStore.GetKey("", v.NodeAddress.Bytes())
+			if err == nil {
+				nodeKey = &k.PrivateKey
+			}
+			break
+		}
+	}
+
 	return core.NewKernel(ctx, keyClient, privValidator, conf.GenesisDoc, conf.Tendermint.TendermintConfig(), conf.RPC,
-		conf.Keys, keyStore, exeOptions, conf.Tendermint.DefaultAuthorizedPeersProvider(), restoreDump, logger)
+		conf.Keys, keyStore, exeOptions, conf.Tendermint.DefaultAuthorizedPeersProvider(), restoreDump, nodeKey, logger)
 }
 
 func (conf *BurrowConfig) JSONString() string {

config/config.go

@@ -71,6 +71,9 @@ func (btc *BurrowTendermintConfig) TendermintConfig() *tm_config.Config {
 		conf.Consensus.TimeoutPrecommit = scaleTimeout(btc.TimeoutFactor, conf.Consensus.TimeoutPrecommit)
 		conf.Consensus.TimeoutPrecommitDelta = scaleTimeout(btc.TimeoutFactor, conf.Consensus.TimeoutPrecommitDelta)
 		conf.Consensus.TimeoutCommit = scaleTimeout(btc.TimeoutFactor, conf.Consensus.TimeoutCommit)
+		// This is the smallest increment we can use to get a strictly increasing sequence of block time - we set it low to avoid skew
+		// if the BlockTimeIota is longer than the average block time
+		conf.Consensus.BlockTimeIota = time.Nanosecond
 
 		// P2P
 		conf.Moniker = btc.Moniker

consensus/tendermint/config.go

@@ -11,6 +11,7 @@ import (
 	"github.com/hyperledger/burrow/logging"
 	"github.com/hyperledger/burrow/logging/structure"
 	"github.com/tendermint/tendermint/config"
+	"github.com/tendermint/tendermint/crypto/ed25519"
 	dbm "github.com/tendermint/tendermint/libs/db"
 	"github.com/tendermint/tendermint/node"
 	"github.com/tendermint/tendermint/p2p"
@@ -44,20 +45,27 @@ func (n *Node) Close() {
 }
 
 func NewNode(conf *config.Config, privValidator tmTypes.PrivValidator, genesisDoc *tmTypes.GenesisDoc,
-	app *abci.App, metricsProvider node.MetricsProvider, logger *logging.Logger) (*Node, error) {
+	app *abci.App, metricsProvider node.MetricsProvider, marmotNodeKey *crypto.PrivateKey, logger *logging.Logger) (*Node, error) {
 
 	var err error
 	// disable Tendermint's RPC
 	conf.RPC.ListenAddress = ""
 
-	err = os.MkdirAll(path.Dir(conf.NodeKeyFile()), 0777)
-	if err != nil {
-		return nil, err
-	}
+	var nodeKey *p2p.NodeKey
+	if marmotNodeKey != nil && marmotNodeKey.CurveType == crypto.CurveTypeEd25519 {
+		var pkey ed25519.PrivKeyEd25519
+		copy(pkey[:], marmotNodeKey.PrivateKey)
+		nodeKey = &p2p.NodeKey{PrivKey: pkey}
+	} else {
+		err = os.MkdirAll(path.Dir(conf.NodeKeyFile()), 0777)
+		if err != nil {
+			return nil, err
+		}
 
-	nodeKey, err := p2p.LoadOrGenNodeKey(conf.NodeKeyFile())
-	if err != nil {
-		return nil, err
+		nodeKey, err = p2p.LoadOrGenNodeKey(conf.NodeKeyFile())
+		if err != nil {
+			return nil, err
+		}
 	}
 
 	nde := &Node{}

consensus/tendermint/tendermint.go

@@ -39,6 +39,7 @@ import (
 	"github.com/hyperledger/burrow/bcm"
 	"github.com/hyperledger/burrow/consensus/tendermint"
 	"github.com/hyperledger/burrow/consensus/tendermint/abci"
+	"github.com/hyperledger/burrow/crypto"
 	"github.com/hyperledger/burrow/event"
 	"github.com/hyperledger/burrow/execution"
 	"github.com/hyperledger/burrow/genesis"
@@ -94,7 +95,7 @@ func NewBurrowDB(dbDir string) dbm.DB {
 
 func NewKernel(ctx context.Context, keyClient keys.KeyClient, privValidator tmTypes.PrivValidator,
 	genesisDoc *genesis.GenesisDoc, tmConf *tmConfig.Config, rpcConfig *rpc.RPCConfig, keyConfig *keys.KeysConfig,
-	keyStore *keys.KeyStore, exeOptions []execution.ExecutionOption, authorizedPeersProvider abci.PeersFilterProvider, restore string, logger *logging.Logger) (*Kernel, error) {
+	keyStore *keys.KeyStore, exeOptions []execution.ExecutionOption, authorizedPeersProvider abci.PeersFilterProvider, restore string, nodeKey *crypto.PrivateKey, logger *logging.Logger) (*Kernel, error) {
 
 	var err error
 	kern := &Kernel{
@@ -189,7 +190,7 @@ func NewKernel(ctx context.Context, keyClient keys.KeyClient, privValidator tmTy
 		Prometheus:           false,
 		PrometheusListenAddr: "",
 	})
-	kern.Node, err = tendermint.NewNode(tmConf, privValidator, tmGenesisDoc, app, metricsProvider, tendermintLogger)
+	kern.Node, err = tendermint.NewNode(tmConf, privValidator, tmGenesisDoc, app, metricsProvider, nodeKey, tendermintLogger)
 	if err != nil {
 		return nil, err
 	}

core/kernel.go

@@ -3,125 +3,29 @@
 ### Configure a chain with 2 full accounts and validators
 ```bash
  rm -rf .burrow* .keys*
- burrow spec -f2 | burrow configure -s- > .burrow_init.toml
-```
-
-### Configure 2 validator nodes config files
-From the generated `.burrow_init.toml `file, create new files for each node, and change the content, example:
-
-#### Validator 1 node `.burrow_val0.toml` modified line from `.burrow_init.toml`
-
-```toml
-[Tendermint]
-  Seeds = ""
-  SeedMode = false
-  PersistentPeers = ""
-  ListenAddress = "tcp://0.0.0.0:20000"
-  Moniker = "val_node_0"
-  TendermintRoot = ".burrow_node0"
-
-[Execution]
-
-[Keys]
-  GRPCServiceEnabled = false
-  AllowBadFilePermissions = true
-  RemoteAddress = ""
-  KeysDirectory = ".keys"
-
-[RPC]
-  [RPC.Info]
-    Enabled = true
-    ListenAddress = "tcp://127.0.0.1:20001"
-  [RPC.Profiler]
-    Enabled = false
-  [RPC.GRPC]
-    Enabled = true
-    ListenAddress = "127.0.0.1:20002"
-  [RPC.Metrics]
-    Enabled = false
-```
-
-#### Validator 2 node `.burrow_val1.toml` modified line from `.burrow_init.toml`
-
-```toml
-[Tendermint]
-  Seeds = ""
-  SeedMode = false
-  PersistentPeers = "PUT_HERE_NODE_0_ID@LISTEN_EXTERNAL_ADDRESS"
-  ListenAddress = "tcp://0.0.0.0:30000"
-  Moniker = "val_node_1"
-  TendermintRoot = ".burrow_node1"
-
-[Execution]
-
-[Keys]
-  GRPCServiceEnabled = false
-  AllowBadFilePermissions = true
-  RemoteAddress = ""
-  KeysDirectory = ".keys"
-
-[RPC]
-  [RPC.Info]
-    Enabled = true
-    ListenAddress = "tcp://127.0.0.1:30001"
-  [RPC.Profiler]
-    Enabled = false
-  [RPC.GRPC]
-    Enabled = true
-    ListenAddress = "127.0.0.1:30002"
-  [RPC.Metrics]
-    Enabled = false
-```
-
-Node 0 will be defined as persistent peer of node 1.
-Persistent peers are people you want to be constantly connected with.
-
+ burrow spec -f2 | burrow configure -s- --pool
+ ```
 ### Start the network
 
 #### Start the first node
 ```bash
-burrow start --validator-index=0 --config=.burrow_val0.toml
+burrow start --config=burrow000.toml
 ```
 
-You will see `Blockpool has no peers` in console logs.
+You will see `Blockpool has no peers` in burrow000.log.
 The node has not enough validator power in order to have quorum (2/3) on the network, so it is blocked waiting for the second validator to join.
 
-#### Find the first node identifier and address
-
-Configure second node to persistently connect to the first node.
-
-```bash
-NODE_0_URL=`curl -s 127.0.0.1:20001/network | jq -r '.result.ThisNode | [.ID, .ListenAddress] | join("@") | ascii_downcase'`
-sed -i s%PUT_HERE_NODE_0_ID@LISTEN_EXTERNAL_ADDRESS%${NODE_0_URL}% .burrow_val1.toml
-```
-
 #### Start the second node
 
 ```bash
-burrow start --validator-index=1 --config=.burrow_val1.toml
+burrow start --config=burrow001.toml
 ```
 
 If the connection successed, you will see empty blocks automatically created `Sending vote message` and `Finalizing commit of block with 0 txs`, you can see consensus state:
 ```bash
-curl -s 127.0.0.1:20001/consensus
+curl -s 127.0.0.1:26758/consensus
 ```
 
-#### Disable Tendermint strict address if required
-If you face `Cannot add non-routable address` message in logs, it means your listen address is not routable for tendermint.
-
-You can disable this check by modified default tendermint/config.go:46 and rebuild burrow:
-```go
-conf.P2P.AddrBookStrict = false
-```
-
-Or explicitly set an external routable address, for example on node 0, if you have a net interface on `172.217.19.227`:
-```toml
-[Tendermint]
-  ExternalAddress = "172.217.19.227:20000"
-```
-
-Update `PersistentPeers` property of node 1 with this new address.
-
 ## Send transactions to the blockchain
 
-You can start to [send transactions](send-transactions.md).
+You can start to [send transactions](send-transactions.md).