blockdao

Documentation

Index

• Variables
• type BlockDAO
  • func NewBlockDAOWithIndexersAndCache(blkStore BlockDAO, indexers []BlockIndexer, cacheSize int) BlockDAO
• type BlockIndexer
• type BlockIndexerChecker
  • func NewBlockIndexerChecker(dao BlockDAO) *BlockIndexerChecker
  • func (bic *BlockIndexerChecker) CheckIndexer(ctx context.Context, indexer BlockIndexer, targetHeight uint64, ...) error
• type BlockIndexerWithStart
• type GrpcBlockDAO
  • func NewGrpcBlockDAO(url string, insecure bool, deserializer *block.Deserializer) *GrpcBlockDAO
  • func (gbd *GrpcBlockDAO) ContainsTransactionLog() bool
  • func (gbd *GrpcBlockDAO) FooterByHeight(height uint64) (*block.Footer, error)
  • func (gbd *GrpcBlockDAO) GetBlock(h hash.Hash256) (*block.Block, error)
  • func (gbd *GrpcBlockDAO) GetBlockByHeight(height uint64) (*block.Block, error)
  • func (gbd *GrpcBlockDAO) GetBlockHash(height uint64) (hash.Hash256, error)
  • func (gbd *GrpcBlockDAO) GetBlockHeight(h hash.Hash256) (uint64, error)
  • func (gbd *GrpcBlockDAO) GetReceipts(height uint64) ([]*action.Receipt, error)
  • func (gbd *GrpcBlockDAO) Header(h hash.Hash256) (*block.Header, error)
  • func (gbd *GrpcBlockDAO) HeaderByHeight(height uint64) (*block.Header, error)
  • func (gbd *GrpcBlockDAO) Height() (uint64, error)
  • func (gbd *GrpcBlockDAO) PutBlock(ctx context.Context, blk *block.Block) error
  • func (gbd *GrpcBlockDAO) Start(ctx context.Context) error
  • func (gbd *GrpcBlockDAO) Stop(ctx context.Context) error
  • func (gbd *GrpcBlockDAO) TransactionLogs(height uint64) (*iotextypes.TransactionLogs, error)

Variables

var (
	// ErrRemoteHeightTooLow is the error that remote height is too low
	ErrRemoteHeightTooLow = fmt.Errorf("remote height is too low")
	// ErrAlreadyExist is the error that block already exists
	ErrAlreadyExist = fmt.Errorf("block already exists")
)

Types

type BlockDAO

type BlockDAO interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	Height() (uint64, error)
	GetBlockHash(uint64) (hash.Hash256, error)
	GetBlockHeight(hash.Hash256) (uint64, error)
	GetBlock(hash.Hash256) (*block.Block, error)
	GetBlockByHeight(uint64) (*block.Block, error)
	GetReceipts(uint64) ([]*action.Receipt, error)
	ContainsTransactionLog() bool
	TransactionLogs(uint64) (*iotextypes.TransactionLogs, error)
	PutBlock(context.Context, *block.Block) error
	Header(hash.Hash256) (*block.Header, error)
	HeaderByHeight(uint64) (*block.Header, error)
	FooterByHeight(uint64) (*block.Footer, error)
}

BlockDAO represents the block data access object

func NewBlockDAOWithIndexersAndCache

func NewBlockDAOWithIndexersAndCache(blkStore BlockDAO, indexers []BlockIndexer, cacheSize int) BlockDAO

NewBlockDAOWithIndexersAndCache returns a BlockDAO with indexers which will consume blocks appended, and caches which will speed up reading

type BlockIndexer

type BlockIndexer interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	Height() (uint64, error)
	PutBlock(context.Context, *block.Block) error
	DeleteTipBlock(context.Context, *block.Block) error
}

BlockIndexer defines an interface to accept block to build index

type BlockIndexerChecker

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

BlockIndexerChecker defines a checker of block indexer

func NewBlockIndexerChecker

func NewBlockIndexerChecker(dao BlockDAO) *BlockIndexerChecker

NewBlockIndexerChecker creates a new block indexer checker

func (*BlockIndexerChecker) CheckIndexer

func (bic *BlockIndexerChecker) CheckIndexer(ctx context.Context, indexer BlockIndexer, targetHeight uint64, progressReporter func(uint64)) error

CheckIndexer checks a block indexer against block dao

type BlockIndexerWithStart

type BlockIndexerWithStart interface {
	BlockIndexer
	// StartHeight returns the start height of the indexer
	StartHeight() uint64
}

BlockIndexerWithStart defines an interface to accept block to build index from a start height

type GrpcBlockDAO

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

func NewGrpcBlockDAO

func NewGrpcBlockDAO(
	url string,
	insecure bool,
	deserializer *block.Deserializer,
) *GrpcBlockDAO

func (*GrpcBlockDAO) ContainsTransactionLog

func (gbd *GrpcBlockDAO) ContainsTransactionLog() bool

func (*GrpcBlockDAO) FooterByHeight

func (gbd *GrpcBlockDAO) FooterByHeight(height uint64) (*block.Footer, error)

func (*GrpcBlockDAO) GetBlock

func (gbd *GrpcBlockDAO) GetBlock(h hash.Hash256) (*block.Block, error)

func (*GrpcBlockDAO) GetBlockByHeight

func (gbd *GrpcBlockDAO) GetBlockByHeight(height uint64) (*block.Block, error)

func (*GrpcBlockDAO) GetBlockHash

func (gbd *GrpcBlockDAO) GetBlockHash(height uint64) (hash.Hash256, error)

func (*GrpcBlockDAO) GetBlockHeight

func (gbd *GrpcBlockDAO) GetBlockHeight(h hash.Hash256) (uint64, error)

func (*GrpcBlockDAO) GetReceipts

func (gbd *GrpcBlockDAO) GetReceipts(height uint64) ([]*action.Receipt, error)

func (*GrpcBlockDAO) Header

func (gbd *GrpcBlockDAO) Header(h hash.Hash256) (*block.Header, error)

func (*GrpcBlockDAO) HeaderByHeight

func (gbd *GrpcBlockDAO) HeaderByHeight(height uint64) (*block.Header, error)

func (*GrpcBlockDAO) Height

func (gbd *GrpcBlockDAO) Height() (uint64, error)

func (*GrpcBlockDAO) PutBlock

func (gbd *GrpcBlockDAO) PutBlock(ctx context.Context, blk *block.Block) error

func (*GrpcBlockDAO) Start

func (gbd *GrpcBlockDAO) Start(ctx context.Context) error

func (*GrpcBlockDAO) Stop

func (gbd *GrpcBlockDAO) Stop(ctx context.Context) error

func (*GrpcBlockDAO) TransactionLogs

func (gbd *GrpcBlockDAO) TransactionLogs(height uint64) (*iotextypes.TransactionLogs, error)