core

Documentation

Index

• Variables
• func ConstructModule(tp node.Type, cfg *Config, options ...fx.Option) fx.Option
• func Flags() *flag.FlagSet
• func ParseFlags(cmd *cobra.Command, cfg *Config) error
• func WithClient(client core.Client) fx.Option
• func WithHeaderConstructFn(construct header.ConstructFn) fx.Option
• type Config
  • func DefaultConfig() Config
  • func (cfg *Config) IsEndpointConfigured() bool
  • func (cfg *Config) Validate() error

Variables

var MetricsEnabled bool

Functions

func ConstructModule

func ConstructModule(tp node.Type, cfg *Config, options ...fx.Option) fx.Option

ConstructModule collects all the components and services related to managing the relationship with the Core node.

func Flags

func Flags() *flag.FlagSet

Flags gives a set of hardcoded Core flags.

func ParseFlags

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

ParseFlags parses Core flags from the given cmd and saves them to the passed config.

func WithClient

func WithClient(client core.Client) fx.Option

WithClient sets custom client for core process

func WithHeaderConstructFn

func WithHeaderConstructFn(construct header.ConstructFn) fx.Option

WithHeaderConstructFn sets custom func that creates extended header

Types

type Config

type Config struct {
	IP       string
	RPCPort  string
	GRPCPort string
}

Config combines all configuration fields for managing the relationship with a Core node.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns default configuration for managing the node's connection to a Celestia-Core endpoint.

func (*Config) IsEndpointConfigured

func (cfg *Config) IsEndpointConfigured() bool

IsEndpointConfigured returns whether a core endpoint has been set on the config (true if set).

func (*Config) Validate

func (cfg *Config) Validate() error

Validate performs basic validation of the config.