flags

Documentation

Index

• Constants
• Variables
• func GetByName(name string) cli.Flag
• func Register(flags ...cli.Flag)
• func Validator(ctx *cli.Context) (string, string, string, error)
• func WrapperFlags(flags []cli.Flag) []cli.Flag

Constants

const (
	DataDirFlagName = "datadir"
	LogFileFlagName = "logfile"
	RunModeFlagName = "runmode"
	GenesisFlagName = "genesis"
)

const (
	PasswordFlagName = "password"
	LightKdfFlagName = "lightkdf"
	UnlockFlagName   = "unlock"
)

const (
	NetworkIDFlagName     = "networkid"
	NoCompactionFlagName  = "nocompaction"
	CacheFlagName         = "cache"
	CacheDatabaseFlagName = "cache.database"
	CacheGCFlagName       = "cache.gc"
	MaxTxMapSizeFlagName  = "txpoolsize"
	FifoTxPoolQueue       = "fifotxpool"
)

const (
	MineFlagName      = "mine"
	ValidatorFlagName = "validator"
)

const (
	IpcAddrFlagName = "ipcaddr"
	RpcAddrFlagName = "rpcaddr"
	// these two flags should be removed in the future
	RpcCorsDomainFlagName = "rpccorsdomain"
	RpcApiFlagName        = "rpcapi"
)

const (
	MaxPeersFlagName        = "maxpeers"
	MaxPendingPeersFlagName = "maxpendpeers"
	PortFlagName            = "port"
	BootnodesFlagName       = "bootnodes"
	ValidatorsFlagName      = "validators"
	NodeKeyFileFlagName     = "nodekey"
)

const (
	IdentityFlagName            = "identity"
	ProfileFlagName             = "profile"
	ProfileAddressFlagName      = "profileaddr"
	MetricGatewayFlagName       = "metricgateway"
	MetricExposeAddressFlagName = "metric_expose_addr"
)

const (
	LineNumberFlagName         = "linenumber"
	VerbosityFlagName          = "verbosity"
	IgnoreNetworkCheckFlagName = "ignoreNetworkCheck"
)

const (
	FastSyncFlagName = "fast"
)

Variables

var AccountFlags = []cli.Flag{

	cli.StringFlag{
		Name:  PasswordFlagName,
		Usage: "Password file to use for non-interactive password input",
		Value: "",
	},
	cli.BoolFlag{
		Name:  LightKdfFlagName,
		Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
	},
	cli.StringFlag{
		Name:  UnlockFlagName,
		Usage: "Comma separated list of accounts to unlock",
		Value: "",
	},
}

var ChainFlags = []cli.Flag{
	cli.Uint64Flag{
		Name:  NetworkIDFlagName,
		Usage: "Network identifier (integer, mainnet=0,dev=1,testnet=2)",
	},
	cli.StringFlag{
		Name:  "account",
		Usage: "Public address for block mining rewards. Use the first account if none is provided.",
	},
	cli.BoolFlag{
		Name:  NoCompactionFlagName,
		Usage: "Disables db compaction after import",
	},
	cli.IntFlag{
		Name:  CacheFlagName,
		Usage: "Megabytes of memory allocated to internal caching",
		Value: 1024,
	},
	cli.IntFlag{
		Name:  CacheDatabaseFlagName,
		Usage: "Percentage of cache memory allowance to use for database io",
		Value: 75,
	},
	cli.IntFlag{
		Name:  CacheGCFlagName,
		Usage: "Percentage of cache memory allowance to use for trie pruning",
		Value: 25,
	},
	cli.IntFlag{
		Name:  MaxTxMapSizeFlagName,
		Usage: "Maximum number of pending transactions",
		Value: 1024,
	},
	cli.BoolFlag{
		Name:  FifoTxPoolQueue,
		Usage: "Use FIFO tx pool queue",
	},
}

var ConfigFileFlag = cli.StringFlag{
	Name:  "config",
	Usage: fmt.Sprintf("Path to TOML configuration file (default \"<datadir>/config.toml\")"),
}

this should be a global option

var GasFlags = []cli.Flag{
	cli.Int64Flag{
		Name:  "gasprice",
		Usage: "Gas Price, unit is Wei, default is suggested gas price from server",
	},
	cli.Int64Flag{
		Name:  "gaslimit",
		Usage: "Gas Limit, default 2000000",
		Value: 2000000,
	},
}

var GeneralFlags = []cli.Flag{
	cli.StringFlag{
		Name:  DataDirFlagName,
		Usage: "Data directory for the database and keystore",
		Value: node.DefaultDataDir(),
	},
	cli.StringFlag{
		Name:  LogFileFlagName,
		Usage: "Log file for the logger output",
		Value: "cpchain.log",
	},
	cli.StringFlag{
		Name:  RunModeFlagName,
		Usage: "Run mode for switch node configuration, eg:dev|testnet|mainnet|mini",
	},
}

var LogFlags = []cli.Flag{
	cli.BoolFlag{
		Name:   LineNumberFlagName,
		Usage:  "Show filename and line number in log",
		EnvVar: "CPC_LINENUMBER",
	},
	cli.IntFlag{
		Name:   VerbosityFlagName,
		Value:  int(log.InfoLevel),
		Usage:  "Log Level Panic:0 Fatal:1 Error:2 Warn:3 Info:4 Debug:5",
		EnvVar: "CPC_VERBOSITY",
	},
}

var MinerFlags = []cli.Flag{
	cli.BoolFlag{
		Name:  MineFlagName,
		Usage: "Enable mining",
	},
	cli.BoolFlag{
		Name:  ValidatorFlagName,
		Usage: "Enable validator",
	},
}

var MiscFlags = []cli.Flag{}

var NodeFlags = []cli.Flag{
	cli.StringFlag{
		Name:  IdentityFlagName,
		Usage: "Customized node name",
	},
	cli.StringFlag{
		Name:  ProfileFlagName,
		Usage: "Profile the running cpchain instance, output to the specified dir path",
	},
	cli.StringFlag{
		Name:  ProfileAddressFlagName,
		Usage: "Profile http service address",
	},
	cli.StringFlag{
		Name:  MetricGatewayFlagName,
		Usage: "Metric Gateway Address",
		Value: "",
	},
	cli.StringFlag{
		Name:  MetricExposeAddressFlagName,
		Usage: "Metric Expose Address",
		Value: ":9100",
	},
}

var P2pFlags = []cli.Flag{
	cli.IntFlag{
		Name:  MaxPeersFlagName,
		Usage: "Maximum number of network peers (network disabled if set to 0)",
		Value: 100,
	},
	cli.IntFlag{
		Name:  MaxPendingPeersFlagName,
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
	},
	cli.IntFlag{
		Name:  PortFlagName,
		Usage: "Network listening port",
		Value: 30310,
	},
	cli.StringFlag{
		Name:  BootnodesFlagName,
		Usage: "Comma separated enode URLs for P2P discovery bootstrap (set v4+v5 instead for light servers)",
		Value: "",
	},
	cli.StringFlag{
		Name:  ValidatorsFlagName,
		Usage: "Comma separated enode URLs for validators",
		Value: "",
	},
	cli.StringFlag{
		Name:  NodeKeyFileFlagName,
		Usage: "P2P node key file",
	},
	cli.StringFlag{
		Name:  GenesisFlagName,
		Usage: "If your use your own genesis.toml, you should specify the path of it",
	},
}

TODO @chengxin adjust the following {ac} p2p flags

var RPCFlags = []cli.Flag{

	cli.StringFlag{
		Name:  "rpc",
		Usage: "Set the APIs offered over the HTTP-RPC interface",
		Value: "http://127.0.0.1:8501",
	},
}

RPCFlags set the APIs offered over the HTTP-RPC interface

var RpcFlags = []cli.Flag{

	cli.StringFlag{
		Name:  RpcApiFlagName,
		Usage: "Set the APIs offered over the HTTP-RPC interface",
		Value: "",
	},
	cli.StringFlag{
		Name:  IpcAddrFlagName,
		Usage: "Local ipc path",
	},
	cli.StringFlag{
		Name:  RpcAddrFlagName,
		Usage: "RPC address whose format is <host:port>",
	},
	cli.StringFlag{
		Name:  RpcCorsDomainFlagName,
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
	},
}

TODO @sangh adjust these

var RunModeFlags = []cli.Flag{
	cli.StringFlag{
		Name:  RunModeFlagName,
		Usage: "Run mode for switch node configuration, eg:dev|testnet|mainnet|testmainnet|mini",
		Value: configs.Mainnet.String(),
	},
}

var SyncFlags = []cli.Flag{
	cli.BoolFlag{
		Name:  FastSyncFlagName,
		Usage: "Enable fast sync",
	},
}

Functions

func GetByName

func GetByName(name string) cli.Flag

func Register

func Register(flags ...cli.Flag)

func Validator

func Validator(ctx *cli.Context) (string, string, string, error)

func WrapperFlags

func WrapperFlags(flags []cli.Flag) []cli.Flag