core

Documentation

Index

• func Module(tp node.Type, cfg *Config, options ...fx.Option) fx.Option
• func Remote(cfg Config) (core.Client, error)
• func WithClient(client core.Client) fx.Option
• func WithHeaderConstructFn(construct header.ConstructFn) fx.Option
• type Config
  • func DefaultConfig() Config
  • func (cfg *Config) Validate() error

Functions

func Module

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

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

func Remote

func Remote(cfg Config) (core.Client, error)

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) Validate

func (cfg *Config) Validate() error

Validate performs basic validation of the config.