mirror of
https://github.com/tendermint/tendermint.git
synced 2026-08-21 06:36:19 +00:00
Adrian BrinkandEthan Buchman
2c129447fd
This example shows how a user of the tendermint library can build their own node and supply it with its own commands. It includes two todos in order to make it easier for library users to use tendermint.
108 lines
3.6 KiB
Go
108 lines
3.6 KiB
Go
package commands
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
cfg "github.com/tendermint/tendermint/config"
|
|
"github.com/tendermint/tendermint/node"
|
|
"github.com/tendermint/tendermint/proxy"
|
|
"github.com/tendermint/tendermint/types"
|
|
|
|
cmn "github.com/tendermint/tmlibs/common"
|
|
"github.com/tendermint/tmlibs/log"
|
|
)
|
|
|
|
var (
|
|
config = cfg.DefaultConfig()
|
|
logger = log.NewTMLogger(log.NewSyncWriter(os.Stdout)).With("module", "main")
|
|
)
|
|
|
|
var RunNodeCmd = &cobra.Command{
|
|
Use: "node",
|
|
Short: "Run the tendermint node",
|
|
RunE: runNode,
|
|
}
|
|
|
|
func init() {
|
|
AddNodeFlags(RunNodeCmd)
|
|
}
|
|
|
|
// AddNodeFlags exposes some common configuration options on the command-line
|
|
// These are exposed for convenience of commands embedding a tendermint node
|
|
func AddNodeFlags(cmd *cobra.Command) {
|
|
// bind flags
|
|
cmd.Flags().String("moniker", config.Moniker, "Node Name")
|
|
|
|
// node flags
|
|
cmd.Flags().Bool("fast_sync", config.FastSync, "Fast blockchain syncing")
|
|
|
|
// abci flags
|
|
cmd.Flags().String("proxy_app", config.ProxyApp, "Proxy app address, or 'nilapp' or 'dummy' for local testing.")
|
|
cmd.Flags().String("abci", config.ABCI, "Specify abci transport (socket | grpc)")
|
|
|
|
// rpc flags
|
|
cmd.Flags().String("rpc.laddr", config.RPC.ListenAddress, "RPC listen address. Port required")
|
|
cmd.Flags().String("rpc.grpc_laddr", config.RPC.GRPCListenAddress, "GRPC listen address (BroadcastTx only). Port required")
|
|
cmd.Flags().Bool("rpc.unsafe", config.RPC.Unsafe, "Enabled unsafe rpc methods")
|
|
|
|
// p2p flags
|
|
cmd.Flags().String("p2p.laddr", config.P2P.ListenAddress, "Node listen address. (0.0.0.0:0 means any interface, any port)")
|
|
cmd.Flags().String("p2p.seeds", config.P2P.Seeds, "Comma delimited host:port seed nodes")
|
|
cmd.Flags().Bool("p2p.skip_upnp", config.P2P.SkipUPNP, "Skip UPNP configuration")
|
|
cmd.Flags().Bool("p2p.pex", config.P2P.PexReactor, "Enable Peer-Exchange (dev feature)")
|
|
|
|
// consensus flags
|
|
cmd.Flags().Bool("consensus.create_empty_blocks", config.Consensus.CreateEmptyBlocks, "Set this to false to only produce blocks when there are txs or when the AppHash changes")
|
|
}
|
|
|
|
// Users wishing to:
|
|
// * Use an external signer for their validators
|
|
// * Supply an in-proc abci app
|
|
// should import github.com/tendermint/tendermint/node and implement
|
|
// their own run_node to call node.NewNode (instead of node.NewNodeDefault)
|
|
// with their custom priv validator and/or custom proxy.ClientCreator
|
|
func runNode(cmd *cobra.Command, args []string) error {
|
|
|
|
// Wait until the genesis doc becomes available
|
|
// This is for Mintnet compatibility.
|
|
// TODO: If Mintnet gets deprecated or genesis_file is
|
|
// always available, remove.
|
|
genDocFile := config.GenesisFile()
|
|
for !cmn.FileExists(genDocFile) {
|
|
logger.Info(cmn.Fmt("Waiting for genesis file %v...", genDocFile))
|
|
time.Sleep(time.Second)
|
|
}
|
|
|
|
genDoc, err := types.GenesisDocFromFile(genDocFile)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
config.ChainID = genDoc.ChainID
|
|
|
|
// Create & start node
|
|
// n := node.NewNodeDefault(config, logger.With("module", "node"))
|
|
|
|
// TODO: Make types.PrivValidator an interface so that it can be provided
|
|
// by a hardware wallet or any other wallet provider.
|
|
|
|
// The next two lines show how a private validator is setup.
|
|
privValidator := types.LoadOrGenPrivValidator(config.PrivValidatorFile(), logger)
|
|
privValidator.SetSigner(types.NewDefaultSigner(privValidator.PrivKey))
|
|
|
|
n := node.NewNode(config, privValidator, proxy.DefaultClientCreator(config.ProxyApp, config.ABCI, config.DBDir()), logger)
|
|
if _, err := n.Start(); err != nil {
|
|
return fmt.Errorf("Failed to start node: %v", err)
|
|
} else {
|
|
logger.Info("Started node", "nodeInfo", n.Switch().NodeInfo())
|
|
}
|
|
|
|
// Trap signal, run forever.
|
|
n.RunForever()
|
|
|
|
return nil
|
|
}
|