eventprocessor

Documentation

Index

• type Config
  • func DefaultConfig() *Config
• type EventProcessor
• type Option
  • func WithBlockFailedExecutionBackoff(backoff time.Duration) Option
  • func WithDedupExecutedTxns(dedupExecutedTxns bool) Option
  • func WithHashCalcStep(step int64) Option
  • func WithWebhook(url string) Option
• type Receipt

Types

type Config

type Config struct {
	BlockFailedExecutionBackoff time.Duration
	DedupExecutedTxns           bool
	HashCalcStep                int64
	WebhookURL                  string
}

Config contains configuration attributes for an event processor.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns the default configuration.

type EventProcessor

type EventProcessor interface {
	GetLastExecutedBlockNumber() int64
	Start() error
	Stop()
}

EventProcessor processes events from a smart-contract.

type Option

type Option func(*Config) error

Option modifies a configuration attribute.

func WithBlockFailedExecutionBackoff

func WithBlockFailedExecutionBackoff(backoff time.Duration) Option

WithBlockFailedExecutionBackoff provides a sleep duration between retryiable executions. e.g: if execution block events fails due to the underlying database being unavailable, we'll wait this time before retrying.

func WithDedupExecutedTxns

func WithDedupExecutedTxns(dedupExecutedTxns bool) Option

WithDedupExecutedTxns makes the event processor skip executing txn hashes that have already been executed before. **IMPORTANT NOTE**: This is an unsafe flag that should only be enabled in test environments. A txn hash should never appear again after it was executed since that indicates there was a reorg in the chain.

func WithHashCalcStep

func WithHashCalcStep(step int64) Option

WithHashCalcStep determines the pace of state hash calculations. The hash will be calculated for every block equal or greater to the next multiple of the step.

func WithWebhook

func WithWebhook(url string) Option

WithWebhook is set when we want send table update notifications to an external webhook.

type Receipt

type Receipt struct {
	ChainID      tableland.ChainID
	BlockNumber  int64
	IndexInBlock int64
	TxnHash      string

	TableIDs      tables.TableIDs
	Error         *string
	ErrorEventIdx *int

	// Deprecated
	TableID *tables.TableID
}

Receipt is an event receipt.