utils

Documentation

Index

• Variables
• func DefaultDataDir() string
• func DefaultNodeConfig() node.Config
• func EthermintLogger() tmlog.Logger
• func GenesisBlockNoAlloc() *core.Genesis
• func HomeDir() string
• func MakeDataDir(ctx *cli.Context) string
• func MakeFullNode(ctx *cli.Context) *ethereum.Node
• func MigrateFlags(action func(ctx *cli.Context) error) func(*cli.Context) error
• func ParseGenesisOrDefault(genesisPath string) (*core.Genesis, error)
• func ResetAll(ctx *cli.Context) error
• func SetEthermintEthConfig(cfg *eth.Config)
• func SetEthermintNodeConfig(cfg *node.Config)
• func Setup(ctx *cli.Context) error
• func StartNode(stack *ethereum.Node)

Variables

var (
	LKRotateLogFileFlag = cli.StringFlag{
		Name:  "log_file",
		Value: "ethermint.log",
		Usage: "rotate logfile",
	}

	LKRoleFlag = cli.StringFlag{
		Name:  "role",
		Value: "validator",
		Usage: "role: validator or peer, default is validator",
	}

	LKNoBlockWarnIntervalFlag = cli.IntFlag{
		Name:  "no_block_warn_interval",
		Value: 300,
		Usage: "no block warn interval seconds, default is 300",
	}

	LKNoBlockCreateIntervalFlag = cli.IntFlag{
		Name:  "no_block_create_interval",
		Value: 5,
		Usage: "no block create interval seconds, default is 5",
	}

	LKRPCAddrFlag = cli.StringFlag{
		Name:  "lkrpc_addr",
		Value: "localhost:15001",
		Usage: "rpc subscribe service",
	}

	LKOnlineFlag = cli.BoolFlag{
		Name:  "lkonline",
		Usage: "online mode",
	}

	LKRollbackBlockByNumberFlag = cli.Int64Flag{
		Name:  "lkrollbackbyblocknumber",
		Usage: "roll back by block number",
		Value: 0,
	}

	LKRateTooManyTxsFlag = cli.Float64Flag{
		Name:  "ratetoomanytxs",
		Usage: "rate of too many txs in txpool or mempool",
		Value: 0.1,
	}

	LKStateFlag = cli.StringFlag{
		Name:  "lkstate",
		Value: "",
		Usage: "init state leveldb dir",
	}

	// TendermintAddrFlag is the address that ethermint will use to connect to the tendermint core node
	// #stable - 0.4.0
	TendermintAddrFlag = cli.StringFlag{
		Name:  "tendermint_addr",
		Value: "tcp://localhost:46657",
		Usage: "This is the address that ethermint will use to connect to the tendermint core node. Please provide a port.",
	}

	// ABCIAddrFlag is the address that ethermint will use to listen to incoming ABCI connections
	// #stable - 0.4.0
	ABCIAddrFlag = cli.StringFlag{
		Name:  "abci_laddr",
		Value: "tcp://0.0.0.0:46658",
		Usage: "This is the address that the ABCI server will use to listen to incoming connection from tendermint core.",
	}

	// ABCIProtocolFlag defines whether GRPC or SOCKET should be used for the ABCI connections
	// #stable - 0.4.0
	ABCIProtocolFlag = cli.StringFlag{
		Name:  "abci_protocol",
		Value: "socket",
		Usage: "socket | grpc",
	}

	// VerbosityFlag defines the verbosity of the logging
	// #unstable
	VerbosityFlag = cli.IntFlag{
		Name:  "verbosity",
		Value: 3,
		Usage: "Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=core, 5=debug, 6=detail",
	}

	// ConfigFileFlag defines the path to a TOML config for go-ethereum
	// #unstable
	ConfigFileFlag = cli.StringFlag{
		Name:  "config",
		Usage: "TOML configuration file",
	}

	// TargetGasLimitFlag defines gas limit of the Genesis block
	// #unstable
	TargetGasLimitFlag = cli.Uint64Flag{
		Name:  "targetgaslimit",
		Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine",
		Value: GenesisTargetGasLimit.Uint64(),
	}

	// WithTendermintFlag asks to start Tendermint
	// `tendermint init` and `tendermint node` when `ethermint init`
	// and `ethermint` are invoked respectively.
	WithTendermintFlag = cli.BoolFlag{
		Name: "with-tendermint",
		Usage: "If set, it will invoke `tendermint init` and `tendermint node` " +
			"when `ethermint init` and `ethermint` are invoked respectively",
	}

	// PocketAPIFlag defines the pocket api url
	// #unstable
	PocketAPIFlag = cli.StringFlag{
		Name:  "pocketapi",
		Value: "https://pocketapi.lianxiangcloud.com",
		Usage: "pocket api url",
	}
)

var (
	// GenesisTargetGasLimit is the target gas limit of the Genesis block.
	GenesisTargetGasLimit = big.NewInt(5e9)
)

Functions

func DefaultDataDir

func DefaultDataDir() string

DefaultDataDir tries to guess the default directory for ethermint data

func DefaultNodeConfig

func DefaultNodeConfig() node.Config

DefaultNodeConfig returns the default configuration for a go-ethereum node

func EthermintLogger

func EthermintLogger() tmlog.Logger

EthermintLogger returns a new instance of an ethermint logger. With() should be called upon the returned instance to set default keys

func GenesisBlockNoAlloc

func GenesisBlockNoAlloc() *core.Genesis

func HomeDir

func HomeDir() string

HomeDir returns the user's home most likely home directory

func MakeDataDir

func MakeDataDir(ctx *cli.Context) string

MakeDataDir retrieves the currently requested data directory

func MakeFullNode

func MakeFullNode(ctx *cli.Context) *ethereum.Node

MakeFullNode creates a full go-ethereum node #unstable

func MigrateFlags

func MigrateFlags(action func(ctx *cli.Context) error) func(*cli.Context) error

MigrateFlags sets the global flag from a local flag when it's set. This is a temporary function used for migrating old command/flags to the new format.

This allows the use of the existing configuration functionality. When all flags are migrated this function can be removed and the existing configuration functionality must be changed that is uses local flags

func ParseGenesisOrDefault

func ParseGenesisOrDefault(genesisPath string) (*core.Genesis, error)

ParseGenesisOrDefault tries to read the content from provided genesisPath. If the path is empty or doesn't exist, it will use defaultGenesisBytes as the fallback genesis source. Otherwise, it will open that path and if it encounters an error that doesn't satisfy os.IsNotExist, it returns that error.

func ResetAll

func ResetAll(ctx *cli.Context) error

ResetAll will remove the data directory.

func SetEthermintEthConfig

func SetEthermintEthConfig(cfg *eth.Config)

SetEthermintEthConfig takes a ethereum configuration and applies ethermint specific configuration

func SetEthermintNodeConfig

func SetEthermintNodeConfig(cfg *node.Config)

SetEthermintNodeConfig takes a node configuration and applies ethermint specific configuration

func Setup

func Setup(ctx *cli.Context) error

Setup sets up the logging infrastructure

func StartNode

func StartNode(stack *ethereum.Node)

StartNode will start up the node.