Roy Crihfield
9f967abfb9
refactor packages, flags, subscriptions also DRY up builder tests use mockgen
56 lines
1.9 KiB
Go
56 lines
1.9 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 (
|
|
"io"
|
|
"math/big"
|
|
"time"
|
|
|
|
"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 interface required to index statediff data
|
|
type StateDiffIndexer interface {
|
|
PushBlock(block *types.Block, receipts types.Receipts, totalDifficulty *big.Int) (Batch, error)
|
|
PushStateNode(tx Batch, stateNode sdtypes.StateLeafNode, headerID string) error
|
|
PushIPLD(tx Batch, ipld sdtypes.IPLD) error
|
|
ReportDBMetrics(delay time.Duration, quit <-chan bool)
|
|
|
|
// 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
|
|
|
|
io.Closer
|
|
}
|
|
|
|
// Batch required for indexing data atomically
|
|
type Batch interface {
|
|
Submit(err error) error
|
|
}
|
|
|
|
// Config used to configure different underlying implementations
|
|
type Config interface {
|
|
Type() shared.DBType
|
|
}
|