87 lines
3.2 KiB
Go
87 lines
3.2 KiB
Go
// VulcanizeDB
|
|
// Copyright © 2021 Vulcanize
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package interfaces
|
|
|
|
import (
|
|
"context"
|
|
"math/big"
|
|
"time"
|
|
|
|
"github.com/cerc-io/plugeth-statediff/indexer/models"
|
|
"github.com/cerc-io/plugeth-statediff/indexer/shared"
|
|
sdtypes "github.com/cerc-io/plugeth-statediff/types"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
)
|
|
|
|
// StateDiffIndexer describes the interface for indexing state data.
|
|
type StateDiffIndexer interface {
|
|
// PushBlock indexes block data except for state & storage nodes: header, uncles, transactions &
|
|
// receipts. Returns an initiated DB transaction which must be committed or rolled back.
|
|
PushBlock(block *types.Block, receipts types.Receipts, totalDifficulty *big.Int) (Batch, error)
|
|
// PushHeader indexes a block header.
|
|
PushHeader(batch Batch, header *types.Header, reward, td *big.Int) (string, error)
|
|
// PushStateNode indexes a state node and its storage trie.
|
|
PushStateNode(tx Batch, stateNode sdtypes.StateLeafNode, headerID string) error
|
|
// PushIPLD indexes an IPLD node.
|
|
PushIPLD(tx Batch, ipld sdtypes.IPLD) error
|
|
// BeginTx starts a new DB transaction.
|
|
BeginTx(number *big.Int, ctx context.Context) Batch
|
|
|
|
// DetectGaps returns a list of gaps in the block range, if any.
|
|
DetectGaps(beginBlock uint64, endBlock uint64) ([]*BlockGap, error)
|
|
// CurrentBlock returns the latest indexed block.
|
|
CurrentBlock() (*models.HeaderModel, error)
|
|
// HasBlock returns true if the block is indexed.
|
|
HasBlock(hash common.Hash, number uint64) (bool, error)
|
|
|
|
// Close closes the associated output DB connection or files.
|
|
Close() error
|
|
|
|
// Methods used by WatchAddress API/functionality
|
|
|
|
LoadWatchedAddresses() ([]common.Address, error)
|
|
InsertWatchedAddresses(addresses []sdtypes.WatchAddressArg, currentBlock *big.Int) error
|
|
RemoveWatchedAddresses(addresses []sdtypes.WatchAddressArg) error
|
|
SetWatchedAddresses(args []sdtypes.WatchAddressArg, currentBlockNumber *big.Int) error
|
|
ClearWatchedAddresses() error
|
|
|
|
ReportDBMetrics(delay time.Duration, quit <-chan bool)
|
|
}
|
|
|
|
// Batch required for indexing data atomically
|
|
type Batch interface {
|
|
// Submit commits the batch transaction
|
|
Submit() error
|
|
// BlockNumber is the block number of the header this batch contains
|
|
BlockNumber() string
|
|
// RollbackOnFailure rolls back the batch transaction if the error is not nil
|
|
RollbackOnFailure(error)
|
|
}
|
|
|
|
// Config used to configure different underlying implementations
|
|
type Config interface {
|
|
Type() shared.DBType
|
|
}
|
|
|
|
// Used to represent a gap in statediffed blocks
|
|
type BlockGap struct {
|
|
FirstMissing uint64 `json:"firstMissing"`
|
|
LastMissing uint64 `json:"lastMissing"`
|
|
}
|