worker

Documentation

Index

• type Context
  • func NewContext(encodingConfig *params.EncodingConfig, clientProxy *client.Proxy, ...) *Context
• type Worker
  • func NewWorker(index int, ctx *Context) Worker
  • func (w Worker) ExportBlock(b *tmctypes.ResultBlock, txs []*types.Tx, vals *tmctypes.ResultValidators) error
  • func (w Worker) ExportCommit(commit *tmtypes.Commit, vals *tmctypes.ResultValidators) error
  • func (w Worker) ExportTxs(txs []*types.Tx) error
  • func (w Worker) HandleGenesis(genesis *tmtypes.GenesisDoc) error
  • func (w Worker) SaveValidators(vals []*tmtypes.Validator) error
  • func (w Worker) Start()

Types

type Context

type Context struct {
	EncodingConfig *params.EncodingConfig
	ClientProxy    *client.Proxy
	Database       db.Database
	Logger         logging.Logger

	Queue   types.HeightQueue
	Modules []modules.Module
}

Context represents the context that is shared among different workers

func NewContext

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

NewContext allows to build a new Worker Context instance

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, ctx *Context) Worker

NewWorker allows to create a new Worker implementation.

func (Worker) ExportBlock

func (w Worker) ExportBlock(b *tmctypes.ResultBlock, txs []*types.Tx, vals *tmctypes.ResultValidators) 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) ExportCommit

func (w Worker) ExportCommit(commit *tmtypes.Commit, vals *tmctypes.ResultValidators) error

ExportCommit accepts a block commitment and a corresponding set of validators for the commitment and persists them to the database. An error is returned if any write fails or if there is any missing aggregated data.

func (Worker) ExportTxs

func (w Worker) ExportTxs(txs []*types.Tx) 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(genesis *tmtypes.GenesisDoc) error

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

func (Worker) SaveValidators

func (w Worker) SaveValidators(vals []*tmtypes.Validator) error

SaveValidators persists a list of Tendermint validators with an address and a consensus public key. An error is returned if the public key cannot be Bech32 encoded or if the DB write fails.

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.