indexer

Documentation

Index

• Constants
• Variables
• type Block
• type BlockTracker
  • func NewBlockTracker(ctx context.Context, contractAddress string, queries *queries.Queries) (*BlockTracker, error)
  • func (bt *BlockTracker) GetLatestBlock() (uint64, []byte)
  • func (bt *BlockTracker) UpdateLatestBlock(ctx context.Context, block uint64, hashBytes []byte) error
• type ChainReorgHandler
• type IBlockTracker
• type Indexer
  • func NewIndexer(ctx context.Context, log *zap.Logger) *Indexer
  • func (i *Indexer) Close()
  • func (i *Indexer) StartIndexer(db *sql.DB, cfg config.ContractsOptions, ...) error
• type ReorgHandler
  • func NewChainReorgHandler(ctx context.Context, client blockchain.ChainClient, queries *queries.Queries) *ReorgHandler
  • func (r *ReorgHandler) FindReorgPoint(detectedAt uint64) (uint64, []byte, error)

Constants

const BLOCK_RANGE_SIZE uint64 = 600

The indexer performs a reorg check every 60 blocks. Setting BLOCK_RANGE_SIZE to 600 (10 cycles of 60 blocks) allows us to retrieve a single page of blocks from the database, which will likely contain the reorg point.

Variables

var (
	ErrNoBlocksFound = errors.New("no blocks found")
	ErrGetBlock      = errors.New("failed to get block")
)

var (
	ErrEmptyBlockHash = errors.New("block hash is empty")
)

Types

type Block

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

type BlockTracker

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

* BlockTracker keeps a database record of the latest block that has been indexed for a contract address and allows the user to increase the value. *

func NewBlockTracker

func NewBlockTracker(
	ctx context.Context,
	contractAddress string,
	queries *queries.Queries,
) (*BlockTracker, error)

Return a new BlockTracker initialized to the latest block from the DB

func (*BlockTracker) GetLatestBlock

func (bt *BlockTracker) GetLatestBlock() (uint64, []byte)

func (*BlockTracker) UpdateLatestBlock

func (bt *BlockTracker) UpdateLatestBlock(
	ctx context.Context,
	block uint64,
	hashBytes []byte,
) error

type ChainReorgHandler

type ChainReorgHandler interface {
	FindReorgPoint(detectedAt uint64) (uint64, []byte, error)
}

type IBlockTracker

type IBlockTracker interface {
	GetLatestBlock() (uint64, []byte)
	UpdateLatestBlock(ctx context.Context, block uint64, hash []byte) error
}

type Indexer

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

func NewIndexer

func NewIndexer(
	ctx context.Context,
	log *zap.Logger,
) *Indexer

func (*Indexer) Close

func (i *Indexer) Close()

func (*Indexer) StartIndexer

func (i *Indexer) StartIndexer(
	db *sql.DB,
	cfg config.ContractsOptions,
	validationService mlsvalidate.MLSValidationService,
) error

type ReorgHandler

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

func NewChainReorgHandler

func NewChainReorgHandler(
	ctx context.Context,
	client blockchain.ChainClient,
	queries *queries.Queries,
) *ReorgHandler

func (*ReorgHandler) FindReorgPoint

func (r *ReorgHandler) FindReorgPoint(detectedAt uint64) (uint64, []byte, error)

TODO(borja): When reorg range has been calculated, alert clients. Tracked in https://github.com/xmtp/xmtpd/issues/437