server

Documentation

Index

• Constants
• func AddCommands(ctx *Context, cdc *codec.CodecProxy, registry jsonpb.AnyResolver, ...)
• func ExportCmd(ctx *Context, cdc *codec.Codec, appExporter AppExporter) *cobra.Command
• func ExternalIP() (string, error)
• func FreeTCPAddr() (addr, port string, err error)
• func GenerateCoinKey() (sdk.AccAddress, string, error)
• func GenerateSaveCoinKey(keybase keys.Keybase, keyName, keyPass string, overwrite bool, ...) (sdk.AccAddress, string, error)
• func GetPruningOptionsFromFlags() (types.PruningOptions, error)
• func InsertKeyJSON(cdc *codec.Codec, baseJSON []byte, key string, value json.RawMessage) ([]byte, error)
• func InstallHookEx(flag string, hooker fnHookstartInProcess)
• func PersistentPreRunEFn(context *Context) func(*cobra.Command, []string) error
• func RegisterServerFlags(cmd *cobra.Command) *cobra.Command
• func SetExternalPackageValue(cmd *cobra.Command)
• func SetupViper(t *testing.T) func()
• func ShowAddressCmd(ctx *Context) *cobra.Command
• func ShowNodeIDCmd(ctx *Context) *cobra.Command
• func ShowValidatorCmd(ctx *Context) *cobra.Command
• func StartCmd(ctx *Context, cdc *codec.CodecProxy, registry jsonpb.AnyResolver, ...) *cobra.Command
• func Stop()
• func StopCmd(ctx *Context) *cobra.Command
• func TrapSignal(cleanupFunc func())
• func UnsafeResetAllCmd(ctx *Context) *cobra.Command
• func VersionCmd(ctx *Context) *cobra.Command
• type AppCreator
• type AppExporter
• type AppStop
• type Context
  • func NewContext(config *cfg.Config, logger log.Logger) *Context
  • func NewDefaultContext() *Context

Constants

const (
	FlagEvmExportMode = "evm-export-mode"
	FlagEvmExportPath = "evm-export-path"
)

const (
	FlagMinGasPrices       = "minimum-gas-prices"
	FlagHaltHeight         = "halt-height"
	FlagHaltTime           = "halt-time"
	FlagInterBlockCache    = "inter-block-cache"
	FlagUnsafeSkipUpgrades = "unsafe-skip-upgrades"
	FlagTrace              = "trace"

	FlagPruning           = "pruning"
	FlagPruningKeepRecent = "pruning-keep-recent"
	FlagPruningKeepEvery  = "pruning-keep-every"
	FlagPruningInterval   = "pruning-interval"
	FlagLocalRpcPort      = "local-rpc-port"
	FlagPortMonitor       = "netstat"
	FlagEvmImportPath     = "evm-import-path"
	FlagEvmImportMode     = "evm-import-mode"
	FlagGoroutineNum      = "goroutine-num"

	FlagPruningMaxWsNum = "pruning-max-worldstate-num"
	FlagExportKeystore  = "export-keystore"
	FlagLogServerUrl    = "log-server"

	FlagActiveViewChange = "active-view-change"
	FlagCommitGapHeight  = "commit-gap-height"

	FlagBlockPartSizeBytes = "block-part-size"
)

Tendermint full-node start flags

const (
	FlagListenAddr         = "rest.laddr"
	FlagUlockKey           = "rest.unlock_key"
	FlagUlockKeyHome       = "rest.unlock_key_home"
	FlagRestPathPrefix     = "rest.path_prefix"
	FlagCORS               = "cors"
	FlagMaxOpenConnections = "max-open"
	FlagHookstartInProcess = "startInProcess"
	FlagWsMaxConnections   = "ws.max_connections"
	FlagWsSubChannelLength = "ws.sub_channel_length"
)

exchain full-node start flags

const FlagGops = "gops"

Functions

func AddCommands

func AddCommands(
	ctx *Context, cdc *codec.CodecProxy,
	registry jsonpb.AnyResolver,
	rootCmd *cobra.Command,
	appCreator AppCreator, appStop AppStop, appExport AppExporter,
	registerRouters func(rs *lcd.RestServer),
	registerAppFlagFn func(cmd *cobra.Command),
	appPreRun func(ctx *Context, cmd *cobra.Command) error,
	subFunc func(logger log.Logger) log.Subscriber)

add server commands

func ExportCmd

func ExportCmd(ctx *Context, cdc *codec.Codec, appExporter AppExporter) *cobra.Command

ExportCmd dumps app state to JSON.

func ExternalIP

func ExternalIP() (string, error)

https://stackoverflow.com/questions/23558425/how-do-i-get-the-local-ip-address-in-go TODO there must be a better way to get external IP

func FreeTCPAddr

func FreeTCPAddr() (addr, port string, err error)

Get a free address for a test tendermint server protocol is either tcp, http, etc

func GenerateCoinKey

func GenerateCoinKey() (sdk.AccAddress, string, error)

GenerateCoinKey returns the address of a public key, along with the secret phrase to recover the private key.

func GenerateSaveCoinKey

func GenerateSaveCoinKey(keybase keys.Keybase, keyName, keyPass string, overwrite bool, mnemonicInput string) (sdk.AccAddress, string, error)

GenerateSaveCoinKey returns the address of a public key, along with the secret phrase to recover the private key.

func GetPruningOptionsFromFlags

func GetPruningOptionsFromFlags() (types.PruningOptions, error)

GetPruningOptionsFromFlags parses command flags and returns the correct PruningOptions. If a pruning strategy is provided, that will be parsed and returned, otherwise, it is assumed custom pruning options are provided.

func InsertKeyJSON

func InsertKeyJSON(cdc *codec.Codec, baseJSON []byte, key string, value json.RawMessage) ([]byte, error)

InsertKeyJSON inserts a new JSON field/key with a given value to an existing JSON message. An error is returned if any serialization operation fails.

NOTE: The ordering of the keys returned as the resulting JSON message is non-deterministic, so the client should not rely on key ordering.

func InstallHookEx

func InstallHookEx(flag string, hooker fnHookstartInProcess)

func PersistentPreRunEFn

func PersistentPreRunEFn(context *Context) func(*cobra.Command, []string) error

PersistentPreRunEFn returns a PersistentPreRunE function for cobra that initailizes the passed in context with a properly configured logger and config object.

func RegisterServerFlags

func RegisterServerFlags(cmd *cobra.Command) *cobra.Command

RegisterServerFlags registers the flags required for rest server

func SetExternalPackageValue

func SetExternalPackageValue(cmd *cobra.Command)

Use SetExternalPackageValue to set external package config value.

func SetupViper

func SetupViper(t *testing.T) func()

SetupViper creates a homedir to run inside, and returns a cleanup function to defer

func ShowAddressCmd

func ShowAddressCmd(ctx *Context) *cobra.Command

ShowAddressCmd - show this node's validator address

func ShowNodeIDCmd

func ShowNodeIDCmd(ctx *Context) *cobra.Command

ShowNodeIDCmd - ported from Tendermint, dump node ID to stdout

func ShowValidatorCmd

func ShowValidatorCmd(ctx *Context) *cobra.Command

ShowValidator - ported from Tendermint, show this node's validator info

func StartCmd

func StartCmd(ctx *Context,
	cdc *codec.CodecProxy,
	registry jsonpb.AnyResolver,
	appCreator AppCreator,
	appStop AppStop,
	registerRoutesFn func(restServer *lcd.RestServer),
	registerAppFlagFn func(cmd *cobra.Command),
	appPreRun func(ctx *Context, cmd *cobra.Command) error,
	subFunc func(logger log.Logger) log.Subscriber,
) *cobra.Command

StartCmd runs the service passed in, either stand-alone or in-process with Tendermint.

func Stop

func Stop()

func StopCmd

func StopCmd(ctx *Context) *cobra.Command

StopCmd stop the node gracefully Tendermint.

func TrapSignal

func TrapSignal(cleanupFunc func())

TrapSignal traps SIGINT and SIGTERM and terminates the server correctly.

func UnsafeResetAllCmd

func UnsafeResetAllCmd(ctx *Context) *cobra.Command

UnsafeResetAllCmd - extension of the tendermint command, resets initialization

func VersionCmd

func VersionCmd(ctx *Context) *cobra.Command

VersionCmd prints tendermint and ABCI version numbers.

Types

type AppCreator

type AppCreator func(log.Logger, dbm.DB, io.Writer) abci.Application

AppCreator is a function that allows us to lazily initialize an application using various configurations.

type AppExporter

type AppExporter func(log.Logger, dbm.DB, io.Writer, int64, bool, []string) (json.RawMessage, []tmtypes.GenesisValidator, error)

AppExporter is a function that dumps all app state to JSON-serializable structure and returns the current validator set.

type AppStop

type AppStop func(app abci.Application)

type Context

type Context struct {
	Config *cfg.Config
	Logger log.Logger
}

server context

func NewContext

func NewContext(config *cfg.Config, logger log.Logger) *Context

func NewDefaultContext

func NewDefaultContext() *Context