cmd

Documentation

Index

• Variables
• func AuthCmd(fsets ...*flag.FlagSet) *cobra.Command
• func DecodeToBytes(param string) ([]byte, error)
• func Init(fsets ...*flag.FlagSet) *cobra.Command
• func InitClient(cmd *cobra.Command, _ []string) error
• func MiscFlags() *flag.FlagSet
• func Network(ctx context.Context) p2p.Network
• func NewBridge(options ...func(*cobra.Command, []*pflag.FlagSet)) *cobra.Command
• func NewFull(options ...func(*cobra.Command, []*pflag.FlagSet)) *cobra.Command
• func NewLight(options ...func(*cobra.Command, []*pflag.FlagSet)) *cobra.Command
• 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 ParseClientFromCtx(ctx context.Context) (*rpc.Client, error)
• func ParseMiscFlags(ctx context.Context, cmd *cobra.Command) (context.Context, error)
• func ParseNodeFlags(ctx context.Context, cmd *cobra.Command, network p2p.Network) (context.Context, error)
• func ParseV0Namespace(param string) (share.Namespace, error)
• func PersistentPreRunEnv(cmd *cobra.Command, nodeType node.Type, _ []string) error
• func PrintOutput(data interface{}, err error, formatData func(interface{}) interface{}) error
• func RPCFlags() *flag.FlagSet
• func RemoveConfigCmd(fsets ...*flag.FlagSet) *cobra.Command
• func ResetStore(fsets ...*flag.FlagSet) *cobra.Command
• func Start(options ...func(*cobra.Command)) *cobra.Command
• func StorePath(ctx context.Context) string
• func UpdateConfigCmd(fsets ...*flag.FlagSet) *cobra.Command
• func WithFlagSet(fset []*flag.FlagSet) func(*cobra.Command)
• func WithNetwork(ctx context.Context, network p2p.Network) context.Context
• 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

Variables

var (
	LogLevelFlag       = "log.level"
	LogLevelModuleFlag = "log.level.module"
)

Functions

func AuthCmd

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

func DecodeToBytes

func DecodeToBytes(param string) ([]byte, error)

DecodeToBytes decodes a Base64 or hex input string into a byte slice.

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 InitClient

func InitClient(cmd *cobra.Command, _ []string) error

func MiscFlags

func MiscFlags() *flag.FlagSet

MiscFlags gives a set of hardcoded miscellaneous flags.

func Network

func Network(ctx context.Context) p2p.Network

Network reads the node type from the context.

func NewBridge

func NewBridge(options ...func(*cobra.Command, []*pflag.FlagSet)) *cobra.Command

func NewFull

func NewFull(options ...func(*cobra.Command, []*pflag.FlagSet)) *cobra.Command

func NewLight

func NewLight(options ...func(*cobra.Command, []*pflag.FlagSet)) *cobra.Command

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 ParseClientFromCtx

func ParseClientFromCtx(ctx context.Context) (*rpc.Client, error)

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, network p2p.Network) (context.Context, error)

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

func ParseV0Namespace

func ParseV0Namespace(param string) (share.Namespace, error)

ParseV0Namespace parses a namespace from a base64 or hex string. The param is expected to be the user-specified portion of a v0 namespace ID (i.e. the last 10 bytes).

func PersistentPreRunEnv

func PersistentPreRunEnv(cmd *cobra.Command, nodeType node.Type, _ []string) error

func PrintOutput

func PrintOutput(data interface{}, err error, formatData func(interface{}) interface{}) error

func RPCFlags

func RPCFlags() *flag.FlagSet

func RemoveConfigCmd

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

func ResetStore

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

ResetStore constructs a CLI command to reset the store of Celestia Node.

func Start

func Start(options ...func(*cobra.Command)) *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 UpdateConfigCmd

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

func WithFlagSet

func WithFlagSet(fset []*flag.FlagSet) func(*cobra.Command)

WithFlagSet adds the given flagset to the command.

func WithNetwork

func WithNetwork(ctx context.Context, network p2p.Network) context.Context

WithNetwork sets the network in the given context.

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.