cmd

Documentation

Index

• func CoreFlags() *flag.FlagSet
• func HeadersFlags() *flag.FlagSet
• func Init(fsets ...*flag.FlagSet) *cobra.Command
• func KeyFlags() *flag.FlagSet
• func MiscFlags() *flag.FlagSet
• func NodeConfig(ctx context.Context) nodebuilder.Config
• func NodeFlags() *flag.FlagSet
• func NodeOptions(ctx context.Context) []fx.Option
• func NodeType(ctx context.Context) node.Type
• func P2PFlags() *flag.FlagSet
• func ParseCoreFlags(cmd *cobra.Command, cfg *nodebuilder.Config) error
• func ParseHeadersFlags(ctx context.Context, cmd *cobra.Command, cfg *nodebuilder.Config) (context.Context, error)
• func ParseKeyFlags(cmd *cobra.Command, cfg *nodebuilder.Config)
• func ParseMiscFlags(ctx context.Context, cmd *cobra.Command) (context.Context, error)
• func ParseNodeFlags(ctx context.Context, cmd *cobra.Command) (context.Context, error)
• func ParseP2PFlags(cmd *cobra.Command, cfg *nodebuilder.Config) error
• func ParseRPCFlags(cmd *cobra.Command, cfg *nodebuilder.Config)
• func ParseTrustedHashFlags(ctx context.Context, cmd *cobra.Command, cfg *nodebuilder.Config) (setCtx context.Context, err error)
• func ParseTrustedPeerFlags(ctx context.Context, cmd *cobra.Command, cfg *nodebuilder.Config) (setCtx context.Context, err error)
• func RPCFlags() *flag.FlagSet
• func Start(fsets ...*flag.FlagSet) *cobra.Command
• func StorePath(ctx context.Context) string
• func TrustedHashFlags() *flag.FlagSet
• func TrustedPeersFlags() *flag.FlagSet
• func WithNodeConfig(ctx context.Context, config *nodebuilder.Config) context.Context
• func WithNodeOptions(ctx context.Context, opts ...fx.Option) context.Context
• func WithNodeType(ctx context.Context, tp node.Type) context.Context
• func WithStorePath(ctx context.Context, storePath string) context.Context

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 KeyFlags

func KeyFlags() *flag.FlagSet

func MiscFlags

func MiscFlags() *flag.FlagSet

MiscFlags gives a set of hardcoded miscellaneous flags.

func NodeConfig

func NodeConfig(ctx context.Context) nodebuilder.Config

NodeConfig reads the node config from the context.

func NodeFlags

func NodeFlags() *flag.FlagSet

NodeFlags gives a set of hardcoded Node package flags.

func NodeOptions

func NodeOptions(ctx context.Context) []fx.Option

NodeOptions returns config options parsed from Environment(Flags, ENV vars, etc)

func NodeType

func NodeType(ctx context.Context) node.Type

NodeType reads the node type from the context.

func P2PFlags

func P2PFlags() *flag.FlagSet

P2PFlags gives a set of p2p flags.

func ParseCoreFlags

func ParseCoreFlags(
	cmd *cobra.Command,
	cfg *nodebuilder.Config,
) error

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

func ParseHeadersFlags

func ParseHeadersFlags(ctx context.Context, cmd *cobra.Command, cfg *nodebuilder.Config) (context.Context, error)

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

func ParseKeyFlags

func ParseKeyFlags(cmd *cobra.Command, cfg *nodebuilder.Config)

func ParseMiscFlags

func ParseMiscFlags(ctx context.Context, cmd *cobra.Command) (context.Context, error)

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

func ParseNodeFlags

func ParseNodeFlags(ctx context.Context, cmd *cobra.Command) (context.Context, error)

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

func ParseP2PFlags

func ParseP2PFlags(
	cmd *cobra.Command,
	cfg *nodebuilder.Config,
) error

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

func ParseRPCFlags

func ParseRPCFlags(cmd *cobra.Command, cfg *nodebuilder.Config)

ParseRPCFlags parses RPC flags from the given cmd and applies values to Env.

func ParseTrustedHashFlags

func ParseTrustedHashFlags(
	ctx context.Context,
	cmd *cobra.Command,
	cfg *nodebuilder.Config,
) (setCtx context.Context, err error)

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

func ParseTrustedPeerFlags

func ParseTrustedPeerFlags(
	ctx context.Context,
	cmd *cobra.Command,
	cfg *nodebuilder.Config,
) (setCtx context.Context, err error)

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

func RPCFlags

func RPCFlags() *flag.FlagSet

RPCFlags gives a set of hardcoded node/rpc package flags.

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 StorePath

func StorePath(ctx context.Context) string

StorePath reads the store path from the context.

func TrustedHashFlags

func TrustedHashFlags() *flag.FlagSet

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

func TrustedPeersFlags

func TrustedPeersFlags() *flag.FlagSet

TrustedPeersFlags returns a set of flags.

func WithNodeConfig

func WithNodeConfig(ctx context.Context, config *nodebuilder.Config) context.Context

WithNodeConfig sets the node config in the Env.

func WithNodeOptions

func WithNodeOptions(ctx context.Context, opts ...fx.Option) context.Context

WithNodeOptions add new options to Env.

func WithNodeType

func WithNodeType(ctx context.Context, tp node.Type) context.Context

WithNodeType sets the node type in the given context.

func WithStorePath

func WithStorePath(ctx context.Context, storePath string) context.Context

WithStorePath sets Store Path in the given context.