db

Documentation

Overview

Package db implements the data store

Index

• Variables
• type EthTxFilter
  • func BuildEthTxFilter(txHash *string, blockNumber *int, blockHash *string, confirmed *bool) EthTxFilter
• type EventDB
• type EventDBReader
• type EventDBWriter
• type LogFilter
  • func BuildLogFilter(contractAddress *string, blockNumber *int, txHash *string, txIndex *int, ...) LogFilter
• type ReceiptFilter
  • func BuildReceiptFilter(txHash *string, contractAddress *string, blockHash *string, blockNumber *int, ...) ReceiptFilter
• type TxWithBlockNumber

Variables

var ErrNoNonceForChain = errors.New("no nonce exists for this chain")

ErrNoNonceForChain indicates that no nonces have been saved for the chain yet.

var ErrNoNonceForDomain = errors.New("no nonce exists for this domain")

ErrNoNonceForDomain indicates there is no nonce for a domain.

var ErrNoStoredBlockForChain = errors.New("no block exists for this chain")

ErrNoStoredBlockForChain indicates there are no blocks stored for this domain.

var ErrNotFound = errors.New("record not found")

ErrNotFound is a not found record standardized across db drivers.

Types

type EthTxFilter

type EthTxFilter struct {
	TxHash      string
	ChainID     uint32
	BlockHash   string
	BlockNumber uint64
	Confirmed   bool
}

EthTxFilter is a filter to use when querying the database for eth transactions.

func BuildEthTxFilter

func BuildEthTxFilter(txHash *string, blockNumber *int, blockHash *string, confirmed *bool) EthTxFilter

BuildEthTxFilter cannot build eth tx filter.

type EventDB

type EventDB interface {
	EventDBWriter
	EventDBReader
}

EventDB stores events.

type EventDBReader

type EventDBReader interface {
	// RetrieveLogsWithFilter retrieves all logs that match a filter given a page.
	RetrieveLogsWithFilter(ctx context.Context, logFilter LogFilter, page int) (logs []*types.Log, err error)
	// RetrieveLogsInRange retrieves all logs that match an inputted filter and are within a range given a page.
	RetrieveLogsInRange(ctx context.Context, logFilter LogFilter, startBlock, endBlock uint64, page int) (logs []*types.Log, err error)
	// RetrieveLogsInRangeAsc retrieves all logs that match an inputted filter and are within a range given a page - in ascending order.
	RetrieveLogsInRangeAsc(ctx context.Context, logFilter LogFilter, startBlock, endBlock uint64, page int) (logs []*types.Log, err error)

	// RetrieveReceiptsWithFilter retrieves receipts with a filter given a page.
	RetrieveReceiptsWithFilter(ctx context.Context, receiptFilter ReceiptFilter, page int) (receipts []types.Receipt, err error)
	// RetrieveReceiptsInRange retrieves receipts that match an inputted filter and are within a range given a page.
	RetrieveReceiptsInRange(ctx context.Context, receiptFilter ReceiptFilter, startBlock, endBlock uint64, page int) (receipts []types.Receipt, err error)

	// RetrieveEthTxsWithFilter retrieves eth transactions with a filter given a page.
	RetrieveEthTxsWithFilter(ctx context.Context, ethTxFilter EthTxFilter, page int) ([]TxWithBlockNumber, error)
	// RetrieveEthTxsInRange retrieves eth transactions that match an inputted filter and are within a range given a page.
	RetrieveEthTxsInRange(ctx context.Context, ethTxFilter EthTxFilter, startBlock, endBlock uint64, page int) ([]TxWithBlockNumber, error)

	// RetrieveLastIndexed retrieves the last indexed for a contract address
	RetrieveLastIndexed(ctx context.Context, contractAddress common.Address, chainID uint32) (uint64, error)

	// RetrieveLastConfirmedBlock retrieves the last block number that has been confirmed.
	RetrieveLastConfirmedBlock(ctx context.Context, chainID uint32) (uint64, error)

	// RetrieveBlockTime retrieves a block time for a chain and block number.
	RetrieveBlockTime(ctx context.Context, chainID uint32, blockNumber uint64) (uint64, error)
	// RetrieveLastBlockStored retrieves the last block number that has a stored block time.
	RetrieveLastBlockStored(ctx context.Context, chainID uint32) (uint64, error)
	// RetrieveFirstBlockStored retrieves the first block number that has a stored block time.
	RetrieveFirstBlockStored(ctx context.Context, chainID uint32) (uint64, error)
	// RetrieveLogCountForContract retrieves the number of logs for a contract.
	RetrieveLogCountForContract(ctx context.Context, contractAddress common.Address, chainID uint32) (int64, error)
	// RetrieveReceiptCountForChain retrieves the number of receipts for a chain.
	RetrieveReceiptCountForChain(ctx context.Context, chainID uint32) (int64, error)
	// RetrieveBlockTimesCountForChain retrieves the number of block times stored for a chain.
	RetrieveBlockTimesCountForChain(ctx context.Context, chainID uint32) (int64, error)
}

EventDBReader is an interface for reading events from a database.

type EventDBWriter

type EventDBWriter interface {
	// StoreLogs stores a log
	StoreLogs(ctx context.Context, chainID uint32, log ...types.Log) error
	// ConfirmLogsForBlockHash confirms logs for a given block hash.
	ConfirmLogsForBlockHash(ctx context.Context, chainID uint32, blockHash common.Hash) error
	// ConfirmLogsInRange confirms logs in a range.
	ConfirmLogsInRange(ctx context.Context, startBlock, endBlock uint64, chainID uint32) error
	// DeleteLogsForBlockHash deletes logs with a given block hash.
	DeleteLogsForBlockHash(ctx context.Context, blockHash common.Hash, chainID uint32) error

	// StoreReceipt stores a receipt
	StoreReceipt(ctx context.Context, chainID uint32, receipt types.Receipt) error
	// ConfirmReceiptsForBlockHash confirms receipts for a given block hash.
	ConfirmReceiptsForBlockHash(ctx context.Context, chainID uint32, blockHash common.Hash) error
	// ConfirmReceiptsInRange confirms receipts in a range.
	ConfirmReceiptsInRange(ctx context.Context, startBlock, endBlock uint64, chainID uint32) error
	// DeleteReceiptsForBlockHash deletes receipts with a given block hash.
	DeleteReceiptsForBlockHash(ctx context.Context, chainID uint32, blockHash common.Hash) error

	// StoreEthTx stores a processed transaction
	StoreEthTx(ctx context.Context, tx *types.Transaction, chainID uint32, blockHash common.Hash, blockNumber uint64, transactionIndex uint64) error
	// ConfirmEthTxsForBlockHash confirms eth txs for a given block hash.
	ConfirmEthTxsForBlockHash(ctx context.Context, blockHash common.Hash, chainID uint32) error
	// ConfirmEthTxsInRange confirms eth txs in a range.
	ConfirmEthTxsInRange(ctx context.Context, startBlock, endBlock uint64, chainID uint32) error
	// DeleteEthTxsForBlockHash deletes eth txs with a given block hash.
	DeleteEthTxsForBlockHash(ctx context.Context, blockHash common.Hash, chainID uint32) error

	// StoreLastIndexed stores the last indexed for a contract address
	StoreLastIndexed(ctx context.Context, contractAddress common.Address, chainID uint32, blockNumber uint64) error

	// StoreLastConfirmedBlock stores the last block number that has been confirmed.
	// It updates the value if there is a previous last block confirmed value, and creates a new
	// entry if there is no previous value.
	StoreLastConfirmedBlock(ctx context.Context, chainID uint32, blockNumber uint64) error

	// StoreBlockTime stores a block time for a chain.
	StoreBlockTime(ctx context.Context, chainID uint32, blockNumber, timestamp uint64) error
}

EventDBWriter is an interface for writing events to a database.

type LogFilter

type LogFilter struct {
	ContractAddress string
	ChainID         uint32
	BlockNumber     uint64
	TxHash          string
	TxIndex         uint64
	BlockHash       string
	Index           uint64
	Confirmed       bool
}

LogFilter is a filter to use when querying the database for logs.

func BuildLogFilter

func BuildLogFilter(contractAddress *string, blockNumber *int, txHash *string, txIndex *int, blockHash *string, index *int, confirmed *bool) LogFilter

BuildLogFilter builds a log filter from nullable parameters.

type ReceiptFilter

type ReceiptFilter struct {
	ChainID          uint32
	TxHash           string
	ContractAddress  string
	BlockHash        string
	BlockNumber      uint64
	TransactionIndex uint64
	Confirmed        bool
}

ReceiptFilter is a filter to use when querying the database for receipts.

func BuildReceiptFilter

func BuildReceiptFilter(txHash *string, contractAddress *string, blockHash *string, blockNumber *int, transactionIndex *int, confirmed *bool) ReceiptFilter

BuildReceiptFilter builds a receipt filter.

type TxWithBlockNumber

type TxWithBlockNumber struct {
	Tx          types.Transaction
	BlockNumber uint64
}

TxWithBlockNumber is a transaction with a block number and is used for specifically for batching data in explorer.