das

Documentation

Index

• func ConstructModule(tp node.Type, cfg *Config) fx.Option
• func WithMetrics(d *das.DASer) error
• type API
  • func (api *API) SamplingStats(ctx context.Context) (das.SamplingStats, error)
  • func (api *API) WaitCatchUp(ctx context.Context) error
• type Config
  • func DefaultConfig(tp node.Type) Config
  • func (cfg *Config) Validate() error
• type Module

Functions

func ConstructModule

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

func WithMetrics

func WithMetrics(d *das.DASer) error

WithMetrics is a utility function that is expected to be "invoked" by the fx lifecycle.

Types

type API

type API struct {
	Internal struct {
		SamplingStats func(ctx context.Context) (das.SamplingStats, error) `perm:"read"`
		WaitCatchUp   func(ctx context.Context) error                      `perm:"read"`
	}
}

API is a wrapper around Module for the RPC. TODO(@distractedm1nd): These structs need to be autogenerated.

func (*API) SamplingStats

func (api *API) SamplingStats(ctx context.Context) (das.SamplingStats, error)

func (*API) WaitCatchUp

func (api *API) WaitCatchUp(ctx context.Context) error

type Config

type Config das.Parameters

Config contains configuration parameters for the DASer (or DASing process)

func DefaultConfig

func DefaultConfig(tp node.Type) Config

TODO(@derrandz): parameters needs performance testing on real network to define optimal values DefaultConfig provide the optimal default configuration per node type. For the moment, there is only one default configuration for all node types but this function will provide more once #1261 is addressed.

TODO(@derrandz): Address #1261

func (*Config) Validate

func (cfg *Config) Validate() error

Validate performs basic validation of the config. Upon encountering an invalid value, Validate returns an error of type: ErrMisConfig

type Module

type Module interface {
	// SamplingStats returns the current statistics over the DA sampling process.
	SamplingStats(ctx context.Context) (das.SamplingStats, error)
	// WaitCatchUp blocks until DASer finishes catching up to the network head.
	WaitCatchUp(ctx context.Context) error
}