cmd

Documentation

Index

• func CoreFlags() *flag.FlagSet
• func HeadersFlags() *flag.FlagSet
• func Init(fsets ...*flag.FlagSet) *cobra.Command
• func MiscFlags() *flag.FlagSet
• func NodeFlags(tp node.Type) *flag.FlagSet
• func P2PFlags() *flag.FlagSet
• func ParseCoreFlags(cmd *cobra.Command, env *Env) error
• func ParseHeadersFlags(cmd *cobra.Command, env *Env) error
• func ParseMiscFlags(cmd *cobra.Command) error
• func ParseNodeFlags(cmd *cobra.Command, env *Env) error
• func ParseP2PFlags(cmd *cobra.Command, env *Env) error
• func ParseTrustedHashFlags(cmd *cobra.Command, env *Env) error
• func ParseTrustedPeerFlags(cmd *cobra.Command, env *Env) error
• func Start(fsets ...*flag.FlagSet) *cobra.Command
• func TrustedHashFlags() *flag.FlagSet
• func TrustedPeerFlags() *flag.FlagSet
• func WithEnv(ctx context.Context) context.Context
• type Env
  • func GetEnv(ctx context.Context) (*Env, error)
  • func (env *Env) AddOptions(opts ...node.Option)
  • func (env *Env) Options() []node.Option
  • func (env *Env) SetNodeType(tp node.Type)

Functions

func CoreFlags

func CoreFlags() *flag.FlagSet

CoreFlags gives a set of hardcoded Core flags.

func HeadersFlags

func HeadersFlags() *flag.FlagSet

HeadersFlags gives a set of hardcoded Header package flags.

func Init

func Init(fsets ...*flag.FlagSet) *cobra.Command

Init constructs a CLI command to initialize Celestia Node of any type with the given flags.

func MiscFlags

func MiscFlags() *flag.FlagSet

MiscFlags gives a set of hardcoded miscellaneous flags.

func NodeFlags

func NodeFlags(tp node.Type) *flag.FlagSet

NodeFlags gives a set of hardcoded Node package flags.

func P2PFlags

func P2PFlags() *flag.FlagSet

P2PFlags gives a set of p2p flags.

func ParseCoreFlags

func ParseCoreFlags(cmd *cobra.Command, env *Env) error

ParseCoreFlags parses Core flags from the given cmd and applies values to Env.

func ParseHeadersFlags

func ParseHeadersFlags(cmd *cobra.Command, env *Env) error

ParseHeadersFlags parses Header package flags from the given cmd and applies values to Env.

func ParseMiscFlags

func ParseMiscFlags(cmd *cobra.Command) error

ParseMiscFlags parses miscellaneous flags from the given cmd and applies values to Env.

func ParseNodeFlags

func ParseNodeFlags(cmd *cobra.Command, env *Env) error

ParseNodeFlags parses Node flags from the given cmd and applies values to Env.

func ParseP2PFlags

func ParseP2PFlags(cmd *cobra.Command, env *Env) error

ParseP2PFlags parses P2P flags from the given cmd and applies values to Env.

func ParseTrustedHashFlags

func ParseTrustedHashFlags(cmd *cobra.Command, env *Env) error

ParseHeadersFlags parses Header package flags from the given cmd and applies values to Env.

func ParseTrustedPeerFlags

func ParseTrustedPeerFlags(cmd *cobra.Command, env *Env) error

ParseTrustedPeerFlags parses Header package flags from the given cmd and applies values to Env.

func Start

func Start(fsets ...*flag.FlagSet) *cobra.Command

Start constructs a CLI command to start Celestia Node daemon of any type with the given flags.

func TrustedHashFlags

func TrustedHashFlags() *flag.FlagSet

TrustedHashFlags returns a set of flags related to configuring a `TrustedHash`.

func TrustedPeerFlags

func TrustedPeerFlags() *flag.FlagSet

TrustedPeerFlags returns a set of flags related to configuring a `TrustedPeer`.

func WithEnv

func WithEnv(ctx context.Context) context.Context

WithEnv wraps given ctx with Env.

Types

type Env

type Env struct {
	NodeType  node.Type
	StorePath string
	// contains filtered or unexported fields
}

Env is an environment for CLI commands. It can be used to: 1. Propagate values from parent to child commands. 2. To group common logic that multiple commands rely on. Usage can be extended.

func GetEnv

func GetEnv(ctx context.Context) (*Env, error)

GetEnv takes Env from the given ctx, if any.

func (*Env) AddOptions

func (env *Env) AddOptions(opts ...node.Option)

AddOptions add new options to Env.

func (*Env) Options

func (env *Env) Options() []node.Option

Options returns Node Options parsed from Environment(Flags, ENV vars, etc)

func (*Env) SetNodeType

func (env *Env) SetNodeType(tp node.Type)

SetNodeType sets Node Type to the Env.