config

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 1, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BuilderEntry

type BuilderEntry struct {
	Noop *noopbuilder.Config `yaml:"noop,omitempty"`
}

func (*BuilderEntry) Start

type CommitterEntry

type CommitterEntry struct {
	Noop *noopcommitter.Config `yaml:"noop,omitempty"`
}

func (*CommitterEntry) Start

type Ensemble

type Ensemble struct {
	// Endpoints is a no-op list of endpoints
	// to prevent repetitive endpoints in a yaml.
	// This list can all be declared at the top, and items can be referenced with yaml refs.
	Endpoints []string `yaml:"endpoints"`

	Builders   map[seqtypes.BuilderID]*BuilderEntry     `yaml:"builders"`
	Signers    map[seqtypes.SignerID]*SignerEntry       `yaml:"signers"`
	Committers map[seqtypes.CommitterID]*CommitterEntry `yaml:"committers"`
	Publishers map[seqtypes.PublisherID]*PublisherEntry `yaml:"publishers"`
	Sequencers map[seqtypes.SequencerID]*SequencerEntry `yaml:"sequencers"`
}

func (*Ensemble) Load

func (c *Ensemble) Load(ctx context.Context) (work.Starter, error)

Load is a short-cut to skip the config-loading phase, and use an existing config instead. This can be used by tests to plug in a config directly, without having to store it on disk somewhere.

func (*Ensemble) Start

func (c *Ensemble) Start(ctx context.Context, opts *work.StartOpts) (ensemble *work.Ensemble, errResult error)

Start sets up the configured group of builders.

type PublisherEntry

type PublisherEntry struct {
	Noop *nooppublisher.Config `yaml:"noop,omitempty"`
}

func (*PublisherEntry) Start

type SequencerEntry

type SequencerEntry struct {
	Full *fullseq.Config `yaml:"full,omitempty"`
	Noop *noopseq.Config `yaml:"noop,omitempty"`
}

func (*SequencerEntry) Start

type SignerEntry

type SignerEntry struct {
	Noop *noopsigner.Config `yaml:"noop,omitempty"`
}

func (*SignerEntry) Start

type YamlLoader

type YamlLoader struct {
	Path string
}

YamlLoader is a Loader that loads a builders configuration from a YAML file path.

func (*YamlLoader) Load

func (l *YamlLoader) Load(ctx context.Context) (work.Starter, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL