conduit

Documentation

Index

• Variables
• type Args
• type Completed
• type CriticalError
  • func (e *CriticalError) Error() string
• type Metadata
• type OnCompleteFunc
• type PipelineInitProvider
  • func MakePipelineInitProvider(currentRound *sdk.Round, genesis *sdk.Genesis) *PipelineInitProvider
  • func (a *PipelineInitProvider) GetGenesis() *sdk.Genesis
  • func (a *PipelineInitProvider) NextDBRound() sdk.Round
• type PluginMetadata
• type PluginMetrics
• type ProvideMetricsFunc

Variables

var DefaultConfigBaseName = "conduit"

DefaultConfigBaseName is the default conduit configuration filename without the extension.

var DefaultConfigName = fmt.Sprintf("%s.yml", DefaultConfigBaseName)

DefaultConfigName is the default conduit configuration filename.

var DefaultLogLevel = log.InfoLevel

DefaultLogLevel is the default conduit log level if none is provided.

var DefaultMetricsPrefix = "conduit"

DefaultMetricsPrefix is the default prometheus subsystem if no Prefix option is provided.

Types

type Args

type Args struct {
	ConduitDataDir    string `yaml:"data-dir"`
	NextRoundOverride uint64 `yaml:"next-round-override"`
}

Args configuration for conduit running.

type Completed

type Completed interface {
	// OnComplete will be called by the Conduit framework when the pipeline
	// finishes processing a round.
	OnComplete(input data.BlockData) error
}

Completed is called by the conduit pipeline after every exporter has finished. It can be used for things like finalizing state.

type CriticalError

type CriticalError struct{}

CriticalError an error that causes the entire conduit pipeline to stop

func (*CriticalError) Error

func (e *CriticalError) Error() string

type Metadata

type Metadata struct {
	Name         string
	Description  string
	Deprecated   bool
	SampleConfig string
}

Metadata returns fields relevant to identification and description of plugins.

type OnCompleteFunc

type OnCompleteFunc func(input data.BlockData) error

OnCompleteFunc is the signature for the Completed functional interface.

type PipelineInitProvider

type PipelineInitProvider struct {
	// contains filtered or unexported fields
}

PipelineInitProvider algod based init provider

func MakePipelineInitProvider

func MakePipelineInitProvider(currentRound *sdk.Round, genesis *sdk.Genesis) *PipelineInitProvider

MakePipelineInitProvider constructs an init provider.

func (*PipelineInitProvider) GetGenesis

func (a *PipelineInitProvider) GetGenesis() *sdk.Genesis

GetGenesis produces genesis pointer

func (*PipelineInitProvider) NextDBRound

func (a *PipelineInitProvider) NextDBRound() sdk.Round

NextDBRound provides next database round

type PluginMetadata

type PluginMetadata interface {
	// Metadata associated with the plugin.
	Metadata() Metadata
}

PluginMetadata is the common interface for providing plugin metadata.

type PluginMetrics

type PluginMetrics interface {
	ProvideMetrics(subsystem string) []prometheus.Collector
}

PluginMetrics is for defining plugin specific metrics.

type ProvideMetricsFunc

type ProvideMetricsFunc func() []prometheus.Collector

ProvideMetricsFunc is the signature for the PluginMetrics interface.