worker

Documentation

Index

• type Config
  • func NewConfig(queue types.HeightQueue, encodingConfig *params.EncodingConfig, ...) *Config
• type Worker
  • func NewWorker(index int, config *Config) Worker
  • func (w Worker) ExportBlock(b *flow.Block) error
  • func (w Worker) ExportCollection(block *flow.Block) ([]types.Collection, error)
  • func (w Worker) ExportTransactionResult(txids []flow.Identifier, height int64) error
  • func (w Worker) ExportTx(txs *types.Txs) error
  • func (w Worker) HandleGenesis(block *flow.Block) error
  • func (w Worker) Start()

Types

type Config

type Config struct {
	EncodingConfig *params.EncodingConfig
	Queue          types.HeightQueue
	ClientProxy    *client.Proxy
	Database       db.Database
	Modules        []modules.Module
	Logger         logging.Logger
}

func NewConfig

func NewConfig(
	queue types.HeightQueue,
	encodingConfig *params.EncodingConfig,
	clientProxy *client.Proxy,
	db db.Database,
	modules []modules.Module,
	logger logging.Logger,
) *Config

type Worker

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

Worker defines a job consumer that is responsible for getting and aggregating block and associated data and exporting it to a database.

func NewWorker

func NewWorker(index int, config *Config) Worker

NewWorker allows to create a new Worker implementation.

func (Worker) ExportBlock

func (w Worker) ExportBlock(b *flow.Block) error

ExportBlock accepts a finalized block and a corresponding set of transactions and persists them to the database along with attributable metadata. An error is returned if the write fails.

func (Worker) ExportCollection

func (w Worker) ExportCollection(block *flow.Block) ([]types.Collection, error)

func (Worker) ExportTransactionResult

func (w Worker) ExportTransactionResult(txids []flow.Identifier, height int64) error

func (Worker) ExportTx

func (w Worker) ExportTx(txs *types.Txs) error

ExportTxs accepts a slice of transactions and persists then inside the database. An error is returned if the write fails.

func (Worker) HandleGenesis

func (w Worker) HandleGenesis(block *flow.Block) error

HandleGenesis accepts a GenesisDoc and calls all the registered genesis handlers in the order in which they have been registered.

func (Worker) Start

func (w Worker) Start()

Start starts a worker by listening for new jobs (block heights) from the given worker queue. Any failed job is logged and re-enqueued.