storage

Documentation

Index

• Constants
• func CreateDBFromConfig(cfg *hostconfig.HostConfig, logger gethlog.Logger) (hostdb.HostDB, error)
• type BatchResolver
• type BlockResolver
• type Storage
  • func NewHostStorageFromConfig(config *hostconfig.HostConfig, logger gethlog.Logger) Storage
  • func NewStorage(backingDB hostdb.HostDB, logger gethlog.Logger) Storage

Constants

const HOST = "HOST_"

Functions

func CreateDBFromConfig

func CreateDBFromConfig(cfg *hostconfig.HostConfig, logger gethlog.Logger) (hostdb.HostDB, error)

CreateDBFromConfig creates an appropriate ethdb.Database instance based on your config

Types

type BatchResolver

type BatchResolver interface {
	// AddBatch stores the batch
	AddBatch(batch *common.ExtBatch) error
	// FetchBatchBySeqNo returns the batch with the given seq number
	FetchBatchBySeqNo(seqNum uint64) (*common.ExtBatch, error)
	// FetchBatchHashByHeight returns the batch hash given the batch number
	FetchBatchHashByHeight(number *big.Int) (*gethcommon.Hash, error)
	// FetchBatchHeaderByHash returns the batch header given its hash
	FetchBatchHeaderByHash(hash gethcommon.Hash) (*common.BatchHeader, error)
	// FetchHeadBatchHeader returns the latest batch header
	FetchHeadBatchHeader() (*common.BatchHeader, error)
	// FetchPublicBatchByHash returns the public batch
	FetchPublicBatchByHash(batchHash common.L2BatchHash) (*common.PublicBatch, error)
	// FetchBatch returns the `ExtBatch` with the given hash
	FetchBatch(batchHash gethcommon.Hash) (*common.ExtBatch, error)
	// FetchBatchByTx returns the `ExtBatch` with the given tx hash
	FetchBatchByTx(txHash gethcommon.Hash) (*common.ExtBatch, error)
	// FetchLatestBatch returns the head `BatchHeader`
	FetchLatestBatch() (*common.BatchHeader, error)
	// FetchBatchListing returns a paginated list of the public batch data
	FetchBatchListing(pagination *common.QueryPagination) (*common.BatchListingResponse, error)
	// FetchBatchListingDeprecated backwards compatible API to return batch data
	FetchBatchListingDeprecated(pagination *common.QueryPagination) (*common.BatchListingResponseDeprecated, error)
	// FetchBatchHeaderByHeight returns the `BatchHeader` with the given height
	FetchBatchHeaderByHeight(height *big.Int) (*common.BatchHeader, error)
	// FetchBatchByHeight returns the `PublicBatch` with the given height
	FetchBatchByHeight(height *big.Int) (*common.PublicBatch, error)
	// FetchTotalTxCount returns the value of the transactions_count table. Fast but inaccurate for Tenscan
	FetchTotalTxCount() (*big.Int, error)
	// FetchTotalTxsQuery returns the number of transactions in the DB. Required for e2e tests
	FetchTotalTxsQuery() (*big.Int, error)
	// FetchTransaction returns the transaction given its hash
	FetchTransaction(hash gethcommon.Hash) (*common.PublicTransaction, error)
	// FetchBatchTransactions returns a list of public transaction data within a given batch hash
	FetchBatchTransactions(batchHash gethcommon.Hash) (*common.TransactionListingResponse, error)
	// FetchTransactionListing returns a paginated list of public transaction data
	FetchTransactionListing(pagination *common.QueryPagination) (*common.TransactionListingResponse, error)
}

type BlockResolver

type BlockResolver interface {
	// AddBlock stores block data containing rollups in the host DB
	AddBlock(b *types.Header) error
	// AddRollup stores a rollup in the host DB
	AddRollup(rollup *common.ExtRollup, metadata *common.PublicRollupMetadata, block *common.L1Block) error
	// FetchLatestRollupHeader returns the head `RollupHeader`
	FetchLatestRollupHeader() (*common.RollupHeader, error)
	// FetchRollupListing returns a paginated list of rollups
	FetchRollupListing(pagination *common.QueryPagination) (*common.RollupListingResponse, error)
	// FetchBlockListing returns a paginated list of blocks that include rollups
	FetchBlockListing(pagination *common.QueryPagination) (*common.BlockListingResponse, error)
	// FetchRollupByHash returns the public rollup data given its hash
	FetchRollupByHash(rollupHash gethcommon.Hash) (*common.PublicRollup, error)
	// FetchRollupBySeqNo returns the public rollup given a seq number
	FetchRollupBySeqNo(seqNo uint64) (*common.PublicRollup, error)
	// FetchRollupBatches returns a list of public batch data within a given rollup hash
	FetchRollupBatches(rollupHash gethcommon.Hash) (*common.BatchListingResponse, error)
}

type Storage

type Storage interface {
	BatchResolver
	BlockResolver
	io.Closer
}

func NewHostStorageFromConfig

func NewHostStorageFromConfig(config *hostconfig.HostConfig, logger gethlog.Logger) Storage

func NewStorage

func NewStorage(backingDB hostdb.HostDB, logger gethlog.Logger) Storage