store

type Block struct {
	CfxBlock *types.Block
	Extra    *BlockExtra
}

type BlockExtra struct {
	// extended fields for ETH block
	BaseFeePerGas   *hexutil.Big `json:"baseFeePerGas,omitempty"`
	MixHash         *common.Hash `json:"mixHash,omitempty"`
	TotalDifficulty *hexutil.Big `json:"totalDifficulty,omitempty"`
	Sha3Uncles      *common.Hash `json:"sha3Uncles,omitempty"`

	TxnExts []*TransactionExtra `json:"-"`
}

type BlockSummary struct {
	CfxBlockSummary *types.BlockSummary
	Extra           *BlockExtra
}

type CacheStore interface {
	Store

	// Flush deletes all kv pairs in cache
	Flush() error
}

type Configurable interface {
	// LoadConfig load configurations with specified names
	LoadConfig(confNames ...string) (map[string]interface{}, error)
	// StoreConfig stores configuration name to value pair
	StoreConfig(confName string, confVal interface{}) error
}

type EpochData struct {
	Number   uint64         // epoch number
	Blocks   []*types.Block // blocks in order and the last one is pivot block
	Receipts map[types.Hash]*types.TransactionReceipt

	// custom extra extentions
	BlockExts   []*BlockExtra
	ReceiptExts map[types.Hash]*ReceiptExtra
}

type EpochDataOpAffects struct {
	OpType            EpochOpType          // op type
	PushUpFromEpoch   uint64               // for push op
	PushUpToEpoch     uint64               // for push op
	PopUntilEpoch     uint64               // for pop op
	DequeueUntilEpoch uint64               // for dequeue op
	NumAlters         EpochDataOpNumAlters // num of adds/deletes for epoch op
}

type EpochDataOpNumAlters map[EpochDataType]int64

type EpochDataType uint

type EpochOpType uint8

type EpochRemoveOption uint8

type EthData struct {
	Number   uint64                         // block number
	Block    *types.Block                   // block body
	Receipts map[common.Hash]*types.Receipt // receipts
}

type Log struct {
	ID          uint64
	ContractID  uint64
	BlockNumber uint64
	Epoch       uint64
	Topic0      string
	Topic1      string
	Topic2      string
	Topic3      string
	LogIndex    uint64
	Extra       []byte
}

type LogExtra struct {
	// extended fields for ETH log
	LogType *string `json:"logType,omitempty"`
	Removed *bool   `json:"removed,,omitempty"`
}

type LogFilter struct {
	BlockFrom uint64
	BlockTo   uint64
	Contracts VariadicValue
	Topics    []VariadicValue // event hash and indexed data 1, 2, 3
	// contains filtered or unexported fields
}

type LogSlice []*Log

type Prunable interface {
	GetBlockEpochRange() (uint64, uint64, error)
	GetTransactionEpochRange() (uint64, uint64, error)
	GetLogEpochRange() (uint64, uint64, error)

	GetNumBlocks() (uint64, error)
	GetNumTransactions() (uint64, error)
	GetNumLogs() (uint64, error)

	// DequeueBlocks removes epoch blocks from the store like dequeuing a queue,
	// which is deleting data from the oldest epoch to some new epoch
	DequeueBlocks(epochUntil uint64) error
	// DequeueTransactions removes epoch transactions from the store like dequeuing a queue,
	// which is deleting data from the oldest epoch to some new epoch
	DequeueTransactions(epochUntil uint64) error
	// DequeueLogs removes epoch logs from the store like dequeuing a queue,
	// which is deleting data from the oldest epoch to some new epoch
	DequeueLogs(epochUntil uint64) error
}

type Readable interface {
	GetLogs(ctx context.Context, filter LogFilter) ([]*Log, error)

	GetTransaction(ctx context.Context, txHash types.Hash) (*Transaction, error)
	GetReceipt(ctx context.Context, txHash types.Hash) (*TransactionReceipt, error)

	GetBlocksByEpoch(ctx context.Context, epochNumber uint64) ([]types.Hash, error)
	GetBlockByEpoch(ctx context.Context, epochNumber uint64) (*Block, error)
	GetBlockSummaryByEpoch(ctx context.Context, epochNumber uint64) (*BlockSummary, error)
	GetBlockByHash(ctx context.Context, blockHash types.Hash) (*Block, error)
	GetBlockSummaryByHash(ctx context.Context, blockHash types.Hash) (*BlockSummary, error)
	GetBlockByBlockNumber(ctx context.Context, blockNumber uint64) (*Block, error)
	GetBlockSummaryByBlockNumber(ctx context.Context, blockNumber uint64) (*BlockSummary, error)
}

type ReceiptExtra struct {
	// extended fields for ETH receipt
	CumulativeGasUsed *uint64 `json:"cumulativeGasUsed,omitempty"`
	EffectiveGasPrice *uint64 `json:"effectiveGasPrice,omitempty"`
	Type              *uint   `json:"type,omitempty"`

	LogExts []*LogExtra `json:"-"`
}

type StackOperable interface {
	// Push appends epoch data to the store
	Push(data *EpochData) error
	Pushn(dataSlice []*EpochData) error
	// Pop removes epoch data from the store like popping a stack, which is deleting
	// data from the most recently appended epoch to some old epoch
	Popn(epochUntil uint64) error
}

type Store interface {
	Readable
	Prunable
	Configurable
	StackOperable
	io.Closer

	IsRecordNotFound(err error) bool

	GetGlobalEpochRange() (uint64, uint64, error)
}

type StoreDisabler interface {
	IsChainBlockDisabled() bool
	IsChainTxnDisabled() bool
	IsChainReceiptDisabled() bool
	IsChainLogDisabled() bool
	IsDisabledForType(edt EpochDataType) bool
}

type Transaction struct {
	CfxTransaction *types.Transaction
	Extra          *TransactionExtra
}

type TransactionExtra struct {
	// extended fields for ETH transaction
	Accesses             gethTypes.AccessList `json:"accessList,omitempty"`
	BlockNumber          *hexutil.Big         `json:"blockNumber,omitempty"`
	MaxFeePerGas         *hexutil.Big         `json:"maxFeePerGas,omitempty"`
	MaxPriorityFeePerGas *hexutil.Big         `json:"maxPriorityFeePerGas,omitempty"`
	Type                 *uint64              `json:"type,omitempty"`
	StandardV            *hexutil.Big         `json:"standardV,omitempty"`
}

type TransactionReceipt struct {
	CfxReceipt *types.TransactionReceipt
	Extra      *ReceiptExtra
}

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