2016-04-14 11:18:24 -05:00
|
|
|
// Copyright 2014 The go-ethereum Authors
|
2015-07-22 11:48:40 -05:00
|
|
|
// This file is part of the go-ethereum library.
|
2015-07-06 19:54:22 -05:00
|
|
|
//
|
2015-07-23 11:35:11 -05:00
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
2015-07-06 19:54:22 -05:00
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
2015-07-22 11:48:40 -05:00
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
2015-07-06 19:54:22 -05:00
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-07-22 11:48:40 -05:00
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2015-07-06 19:54:22 -05:00
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
2015-07-22 11:48:40 -05:00
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
2015-07-06 19:54:22 -05:00
|
|
|
|
2015-08-30 03:04:59 -05:00
|
|
|
package filters
|
2014-08-11 09:23:17 -05:00
|
|
|
|
|
|
|
import (
|
2015-10-12 10:58:51 -05:00
|
|
|
"math"
|
2016-02-12 18:40:44 -06:00
|
|
|
"time"
|
2015-10-12 10:58:51 -05:00
|
|
|
|
2015-03-17 05:19:23 -05:00
|
|
|
"github.com/ethereum/go-ethereum/common"
|
2015-08-30 03:04:59 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core"
|
2015-03-26 06:06:14 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core/types"
|
2015-08-30 03:19:10 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
2015-08-31 10:09:50 -05:00
|
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
2014-08-11 09:23:17 -05:00
|
|
|
)
|
|
|
|
|
2014-10-18 06:20:06 -05:00
|
|
|
type AccountChange struct {
|
|
|
|
Address, StateAddress []byte
|
2014-08-15 09:19:10 -05:00
|
|
|
}
|
|
|
|
|
2014-08-11 09:23:17 -05:00
|
|
|
// Filtering interface
|
|
|
|
type Filter struct {
|
2016-02-12 18:40:44 -06:00
|
|
|
created time.Time
|
|
|
|
|
2015-10-12 10:58:51 -05:00
|
|
|
db ethdb.Database
|
|
|
|
begin, end int64
|
|
|
|
addresses []common.Address
|
|
|
|
topics [][]common.Hash
|
2014-08-15 09:19:10 -05:00
|
|
|
|
2015-08-30 03:19:10 -05:00
|
|
|
BlockCallback func(*types.Block, vm.Logs)
|
2015-05-06 10:51:32 -05:00
|
|
|
TransactionCallback func(*types.Transaction)
|
2016-01-05 07:55:28 -06:00
|
|
|
LogCallback func(*vm.Log, bool)
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Create a new filter which uses a bloom filter on blocks to figure out whether a particular block
|
|
|
|
// is interesting or not.
|
2015-08-31 10:09:50 -05:00
|
|
|
func New(db ethdb.Database) *Filter {
|
2015-08-30 03:04:59 -05:00
|
|
|
return &Filter{db: db}
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Set the earliest and latest block for filtering.
|
|
|
|
// -1 = latest block (i.e., the current block)
|
|
|
|
// hash = particular hash from-to
|
2015-10-12 10:58:51 -05:00
|
|
|
func (self *Filter) SetBeginBlock(begin int64) {
|
|
|
|
self.begin = begin
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2015-10-12 10:58:51 -05:00
|
|
|
func (self *Filter) SetEndBlock(end int64) {
|
|
|
|
self.end = end
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2015-10-12 10:58:51 -05:00
|
|
|
func (self *Filter) SetAddresses(addr []common.Address) {
|
|
|
|
self.addresses = addr
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2015-03-17 05:19:23 -05:00
|
|
|
func (self *Filter) SetTopics(topics [][]common.Hash) {
|
2015-01-28 03:23:18 -06:00
|
|
|
self.topics = topics
|
2014-08-14 10:02:39 -05:00
|
|
|
}
|
|
|
|
|
2015-01-28 03:23:18 -06:00
|
|
|
// Run filters logs with the current parameters set
|
2015-08-30 03:19:10 -05:00
|
|
|
func (self *Filter) Find() vm.Logs {
|
2016-07-26 09:37:04 -05:00
|
|
|
latestHash := core.GetHeadBlockHash(self.db)
|
|
|
|
latestBlock := core.GetBlock(self.db, latestHash)
|
|
|
|
if latestBlock == nil {
|
|
|
|
return vm.Logs{}
|
|
|
|
}
|
2015-10-12 10:58:51 -05:00
|
|
|
var beginBlockNo uint64 = uint64(self.begin)
|
|
|
|
if self.begin == -1 {
|
|
|
|
beginBlockNo = latestBlock.NumberU64()
|
2014-09-26 06:32:54 -05:00
|
|
|
}
|
2015-10-12 10:58:51 -05:00
|
|
|
var endBlockNo uint64 = uint64(self.end)
|
|
|
|
if self.end == -1 {
|
|
|
|
endBlockNo = latestBlock.NumberU64()
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2015-10-12 10:58:51 -05:00
|
|
|
// if no addresses are present we can't make use of fast search which
|
|
|
|
// uses the mipmap bloom filters to check for fast inclusion and uses
|
|
|
|
// higher range probability in order to ensure at least a false positive
|
|
|
|
if len(self.addresses) == 0 {
|
|
|
|
return self.getLogs(beginBlockNo, endBlockNo)
|
2015-08-31 10:09:50 -05:00
|
|
|
}
|
2015-10-12 10:58:51 -05:00
|
|
|
return self.mipFind(beginBlockNo, endBlockNo, 0)
|
|
|
|
}
|
2015-06-09 06:22:16 -05:00
|
|
|
|
2015-10-12 10:58:51 -05:00
|
|
|
func (self *Filter) mipFind(start, end uint64, depth int) (logs vm.Logs) {
|
|
|
|
level := core.MIPMapLevels[depth]
|
|
|
|
// normalise numerator so we can work in level specific batches and
|
|
|
|
// work with the proper range checks
|
|
|
|
for num := start / level * level; num <= end; num += level {
|
|
|
|
// find addresses in bloom filters
|
|
|
|
bloom := core.GetMipmapBloom(self.db, num, level)
|
|
|
|
for _, addr := range self.addresses {
|
|
|
|
if bloom.TestBytes(addr[:]) {
|
|
|
|
// range check normalised values and make sure that
|
|
|
|
// we're resolving the correct range instead of the
|
|
|
|
// normalised values.
|
|
|
|
start := uint64(math.Max(float64(num), float64(start)))
|
|
|
|
end := uint64(math.Min(float64(num+level-1), float64(end)))
|
|
|
|
if depth+1 == len(core.MIPMapLevels) {
|
|
|
|
logs = append(logs, self.getLogs(start, end)...)
|
|
|
|
} else {
|
|
|
|
logs = append(logs, self.mipFind(start, end, depth+1)...)
|
|
|
|
}
|
|
|
|
// break so we don't check the same range for each
|
|
|
|
// possible address. Checks on multiple addresses
|
|
|
|
// are handled further down the stack.
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return logs
|
|
|
|
}
|
|
|
|
|
|
|
|
func (self *Filter) getLogs(start, end uint64) (logs vm.Logs) {
|
|
|
|
for i := start; i <= end; i++ {
|
2016-07-26 09:37:04 -05:00
|
|
|
var block *types.Block
|
2015-10-12 10:58:51 -05:00
|
|
|
hash := core.GetCanonicalHash(self.db, i)
|
|
|
|
if hash != (common.Hash{}) {
|
|
|
|
block = core.GetBlock(self.db, hash)
|
2016-07-26 09:37:04 -05:00
|
|
|
}
|
|
|
|
if block == nil { // block not found/written
|
2015-10-12 10:58:51 -05:00
|
|
|
return logs
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Use bloom filtering to see if this block is interesting given the
|
|
|
|
// current parameters
|
|
|
|
if self.bloomFilter(block) {
|
2015-01-28 03:23:18 -06:00
|
|
|
// Get the logs of the block
|
2015-08-30 03:04:59 -05:00
|
|
|
var (
|
|
|
|
receipts = core.GetBlockReceipts(self.db, block.Hash())
|
2015-08-30 03:19:10 -05:00
|
|
|
unfiltered vm.Logs
|
2015-08-30 03:04:59 -05:00
|
|
|
)
|
|
|
|
for _, receipt := range receipts {
|
2015-09-29 11:36:16 -05:00
|
|
|
unfiltered = append(unfiltered, receipt.Logs...)
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
2015-02-22 06:12:01 -06:00
|
|
|
logs = append(logs, self.FilterLogs(unfiltered)...)
|
2014-08-14 17:24:37 -05:00
|
|
|
}
|
|
|
|
}
|
2014-08-11 09:23:17 -05:00
|
|
|
|
2015-10-12 10:54:59 -05:00
|
|
|
return logs
|
2014-08-14 17:24:37 -05:00
|
|
|
}
|
2014-08-11 09:23:17 -05:00
|
|
|
|
2015-03-17 05:19:23 -05:00
|
|
|
func includes(addresses []common.Address, a common.Address) bool {
|
2014-08-15 09:19:10 -05:00
|
|
|
for _, addr := range addresses {
|
2015-09-01 02:19:45 -05:00
|
|
|
if addr == a {
|
|
|
|
return true
|
2014-08-15 09:19:10 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-09-01 02:19:45 -05:00
|
|
|
return false
|
2014-08-15 09:19:10 -05:00
|
|
|
}
|
|
|
|
|
2015-08-30 03:19:10 -05:00
|
|
|
func (self *Filter) FilterLogs(logs vm.Logs) vm.Logs {
|
|
|
|
var ret vm.Logs
|
2014-08-11 09:23:17 -05:00
|
|
|
|
2015-01-28 03:23:18 -06:00
|
|
|
// Filter the logs for interesting stuff
|
2015-02-04 19:28:54 -06:00
|
|
|
Logs:
|
2015-01-28 03:23:18 -06:00
|
|
|
for _, log := range logs {
|
2015-10-12 10:58:51 -05:00
|
|
|
if len(self.addresses) > 0 && !includes(self.addresses, log.Address) {
|
2014-08-14 17:24:37 -05:00
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
2015-03-17 05:19:23 -05:00
|
|
|
logTopics := make([]common.Hash, len(self.topics))
|
2015-04-08 10:14:58 -05:00
|
|
|
copy(logTopics, log.Topics)
|
2015-03-01 12:08:26 -06:00
|
|
|
|
2015-04-24 06:36:34 -05:00
|
|
|
// If the to filtered topics is greater than the amount of topics in
|
|
|
|
// logs, skip.
|
|
|
|
if len(self.topics) > len(log.Topics) {
|
|
|
|
continue Logs
|
|
|
|
}
|
|
|
|
|
2015-03-01 12:08:26 -06:00
|
|
|
for i, topics := range self.topics {
|
2015-04-24 06:36:34 -05:00
|
|
|
var match bool
|
2015-03-01 12:08:26 -06:00
|
|
|
for _, topic := range topics {
|
2015-04-21 05:00:57 -05:00
|
|
|
// common.Hash{} is a match all (wildcard)
|
|
|
|
if (topic == common.Hash{}) || log.Topics[i] == topic {
|
2015-03-01 12:08:26 -06:00
|
|
|
match = true
|
2015-04-24 06:36:34 -05:00
|
|
|
break
|
2015-03-01 12:08:26 -06:00
|
|
|
}
|
2014-08-15 09:19:10 -05:00
|
|
|
}
|
2015-04-24 06:36:34 -05:00
|
|
|
|
|
|
|
if !match {
|
|
|
|
continue Logs
|
|
|
|
}
|
|
|
|
|
2014-08-15 09:19:10 -05:00
|
|
|
}
|
|
|
|
|
2015-01-28 03:23:18 -06:00
|
|
|
ret = append(ret, log)
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2015-01-28 03:23:18 -06:00
|
|
|
return ret
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2014-11-18 09:58:22 -06:00
|
|
|
func (self *Filter) bloomFilter(block *types.Block) bool {
|
2015-10-12 10:58:51 -05:00
|
|
|
if len(self.addresses) > 0 {
|
2015-02-17 09:12:55 -06:00
|
|
|
var included bool
|
2015-10-12 10:58:51 -05:00
|
|
|
for _, addr := range self.addresses {
|
2015-04-15 04:59:30 -05:00
|
|
|
if types.BloomLookup(block.Bloom(), addr) {
|
2015-02-17 09:12:55 -06:00
|
|
|
included = true
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if !included {
|
|
|
|
return false
|
|
|
|
}
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
|
2015-03-01 12:08:26 -06:00
|
|
|
for _, sub := range self.topics {
|
|
|
|
var included bool
|
|
|
|
for _, topic := range sub {
|
2015-04-24 06:36:34 -05:00
|
|
|
if (topic == common.Hash{}) || types.BloomLookup(block.Bloom(), topic) {
|
2015-03-01 12:08:26 -06:00
|
|
|
included = true
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if !included {
|
2015-01-28 03:23:18 -06:00
|
|
|
return false
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-28 03:23:18 -06:00
|
|
|
return true
|
2014-08-11 09:23:17 -05:00
|
|
|
}
|