cmd

Documentation

Index

• Constants
• Variables
• func ConfirmAction(actionText, deniedText string) (bool, error)
• func DefaultConfigDir() string
• func WrapFlags(flags []cli.Flag) []cli.Flag

Constants

const (
	DefaultHTTPHost             = "localhost" // Default host interface for the HTTP RPC server
	DefaultHTTPPort             = 8545        // Default TCP port for the HTTP RPC server
	DefaultWSHost               = "localhost" // Default host interface for the websocket RPC server
	DefaultWSPort               = 8546        // Default TCP port for the websocket RPC server
	DefaultIpcPath              = "orchestrator.ipc"
	DefaultVanguardGRPCEndpoint = "127.0.0.1:4000"
	DefaultPandoraRPCEndpoint   = "http://127.0.0.1:8545"
)

Variables

var (
	// DataDirFlag defines a path on disk.
	DataDirFlag = &cli.StringFlag{
		Name:  "datadir",
		Usage: "Data directory for storing consensus metadata and block headers",
		Value: DefaultConfigDir(),
	}

	// ForceClearDB removes any previously stored data at the data directory.
	ForceClearDB = &cli.BoolFlag{
		Name:  "force-clear-db",
		Usage: "Clear any previously stored data at the data directory",
	}
	// ClearDB prompts user to see if they want to remove any previously stored data at the data directory.
	ClearDB = &cli.BoolFlag{
		Name:  "clear-db",
		Usage: "Prompt for clearing any previously stored data at the data directory",
	}

	IPCPathFlag = &cli.StringFlag{
		Name:  "ipcpath",
		Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
	}

	HTTPEnabledFlag = &cli.BoolFlag{
		Name:  "http",
		Usage: "Enable the HTTP-RPC server",
	}

	HTTPListenAddrFlag = &cli.StringFlag{
		Name:  "http.addr",
		Usage: "HTTP-RPC server listening interface",
		Value: DefaultHTTPHost,
	}

	HTTPPortFlag = &cli.IntFlag{
		Name:  "http.port",
		Usage: "HTTP-RPC server listening port",
		Value: DefaultHTTPPort,
	}

	HTTPVirtualHosts = &cli.StringSliceFlag{
		Name:  "http.vhosts",
		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
		Value: cli.NewStringSlice("localhost"),
	}

	WSEnabledFlag = &cli.BoolFlag{
		Name:  "ws",
		Usage: "Enable the WS-RPC server",
	}

	WSListenAddrFlag = &cli.StringFlag{
		Name:  "ws.addr",
		Usage: "WS-RPC server listening interface",
		Value: DefaultWSHost,
	}

	WSPortFlag = &cli.IntFlag{
		Name:  "ws.port",
		Usage: "WS-RPC server listening port",
		Value: DefaultWSPort,
	}

	VanguardGRPCEndpoint = &cli.StringFlag{
		Name:  "vanguard-grpc-endpoint",
		Usage: "Vanguard node gRPC provider endpoint",
		Value: DefaultVanguardGRPCEndpoint,
	}

	// PandoraRPCEndpoint provides an WSS/IPC access endpoint to an Pandora RPC.
	PandoraRPCEndpoint = &cli.StringFlag{
		Name:  "pandora-rpc-endpoint",
		Usage: "Pandora node RPC provider endpoint",
		Value: DefaultPandoraRPCEndpoint,
	}

	// VerbosityFlag defines the logrus configuration.
	VerbosityFlag = &cli.StringFlag{
		Name:  "verbosity",
		Usage: "Logging verbosity (trace, debug, info=default, warn, error, fatal, panic)",
		Value: "info",
	}

	// BoltMMapInitialSizeFlag specifies the initial size in bytes of boltdb's mmap syscall.
	BoltMMapInitialSizeFlag = &cli.IntFlag{
		Name:  "bolt-mmap-initial-size",
		Usage: "Specifies the size in bytes of bolt db's mmap syscall allocation",
		Value: 536870912,
	}

	// LogFormat specifies the log output format.
	LogFormat = &cli.StringFlag{
		Name:  "log-format",
		Usage: "Specify log formatting. Supports: text, json, fluentd, journald.",
		Value: "text",
	}

	// LogFileName specifies the log output file name.
	LogFileName = &cli.StringFlag{
		Name:  "log-file",
		Usage: "Specify log file name, relative or absolute",
	}

	// VanguardGenesisTime specifies time when vanguard node has started
	VanguardGenesisTime = &cli.Uint64Flag{
		Name:  "genesis-time",
		Usage: "Genesis timestamp of vanguard node",
	}

	SecondsPerSlot = &cli.Uint64Flag{
		Name:  "seconds-per-slot",
		Usage: "Seconds per slot",
	}
)

TODO(Atif)- Need to have more options for http and ws for security purpose

Functions

func ConfirmAction

func ConfirmAction(actionText, deniedText string) (bool, error)

ConfirmAction uses the passed in actionText as the confirmation text displayed in the terminal. The user must enter Y or N to indicate whether they confirm the action detailed in the warning text. Returns a boolean representing the user's answer.

func DefaultConfigDir

func DefaultConfigDir() string

DefaultConfigDir is the default config directory to use for the vaults and other persistence requirements.

func WrapFlags

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

WrapFlags so that they can be loaded from alternative sources.