go-ethereum/statediff/helpers.go

// Copyright 2019 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// 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.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

// Contains a batch of utility type declarations used by the tests. As the node
// operates on unique types, a lot of them are needed to check various features.

package statediff

import (
	"fmt"
	"sort"
	"strings"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/statediff/indexer/postgres"
	"github.com/ethereum/go-ethereum/statediff/types"
)

func sortKeys(data AccountMap) []string {
	keys := make([]string, 0, len(data))
	for key := range data {
		keys = append(keys, key)
	}
	sort.Strings(keys)

	return keys
}

// findIntersection finds the set of strings from both arrays that are equivalent
// a and b must first be sorted
// this is used to find which keys have been both "deleted" and "created" i.e. they were updated
func findIntersection(a, b []string) []string {
	lenA := len(a)
	lenB := len(b)
	iOfA, iOfB := 0, 0
	updates := make([]string, 0)
	if iOfA >= lenA || iOfB >= lenB {
		return updates
	}
	for {
		switch strings.Compare(a[iOfA], b[iOfB]) {
		// -1 when a[iOfA] < b[iOfB]
		case -1:
			iOfA++
			if iOfA >= lenA {
				return updates
			}
			// 0 when a[iOfA] == b[iOfB]
		case 0:
			updates = append(updates, a[iOfA])
			iOfA++
			iOfB++
			if iOfA >= lenA || iOfB >= lenB {
				return updates
			}
			// 1 when a[iOfA] > b[iOfB]
		case 1:
			iOfB++
			if iOfB >= lenB {
				return updates
			}
		}
	}
}

// loadWatched is used to load watched addresses and storage slots to the in-memory write loop params from the db
func loadWatched(db *postgres.DB) error {
	type Watched struct {
		Address string `db:"address"`
		Kind    int    `db:"kind"`
	}
	var watched []Watched
	pgStr := "SELECT address, kind FROM eth.watched_addresses"
	err := db.Select(&watched, pgStr)
	if err != nil {
		return fmt.Errorf("error loading watched addresses: %v", err)
	}

	var watchedAddresses []common.Address
	var watchedStorageSlots []common.Hash
	for _, entry := range watched {
		switch entry.Kind {
		case types.WatchedAddress.Int():
			watchedAddresses = append(watchedAddresses, common.HexToAddress(entry.Address))
		case types.WatchedStorageSlot.Int():
			watchedStorageSlots = append(watchedStorageSlots, common.HexToHash(entry.Address))
		default:
			return fmt.Errorf("Unexpected kind %d", entry.Kind)
		}
	}

	writeLoopParams.Lock()
	defer writeLoopParams.Unlock()
	writeLoopParams.WatchedAddresses = watchedAddresses
	writeLoopParams.WatchedStorageSlots = watchedStorageSlots

	return nil
}

// removeAddresses is used to remove given addresses from a list of addresses
func removeAddresses(addresses []common.Address, addressesToRemove []common.Address) []common.Address {
	filteredAddresses := []common.Address{}

	for _, address := range addresses {
		if idx := containsAddress(addressesToRemove, address); idx == -1 {
			filteredAddresses = append(filteredAddresses, address)
		}
	}

	return filteredAddresses
}

// removeAddresses is used to remove given storage slots from a list of storage slots
func removeStorageSlots(storageSlots []common.Hash, storageSlotsToRemove []common.Hash) []common.Hash {
	filteredStorageSlots := []common.Hash{}

	for _, address := range storageSlots {
		if idx := containsStorageSlot(storageSlotsToRemove, address); idx == -1 {
			filteredStorageSlots = append(filteredStorageSlots, address)
		}
	}

	return filteredStorageSlots
}

// containsAddress is used to check if an address is present in the provided list of addresses
// return the index if found else -1
func containsAddress(addresses []common.Address, address common.Address) int {
	for idx, addr := range addresses {
		if addr == address {
			return idx
		}
	}
	return -1
}

// containsAddress is used to check if a storage slot is present in the provided list of storage slots
// return the index if found else -1
func containsStorageSlot(storageSlots []common.Hash, storageSlot common.Hash) int {
	for idx, slot := range storageSlots {
		if slot == storageSlot {
			return idx
		}
	}
	return -1
}

// getAddresses is used to get the list of addresses from a list of WatchAddressArgs
func getAddresses(args []types.WatchAddressArg) []common.Address {
	addresses := make([]common.Address, len(args))
	for idx, arg := range args {
		addresses[idx] = common.HexToAddress(arg.Address)
	}

	return addresses
}

// getStorageSlots is used to get the list of storage slots from a list of WatchAddressArgs
func getStorageSlots(args []types.WatchAddressArg) []common.Hash {
	storageSlots := make([]common.Hash, len(args))
	for idx, arg := range args {
		storageSlots[idx] = common.HexToHash(arg.Address)
	}

	return storageSlots
}

// filterAddressArgs filters out the args having an address from a given list of addresses
func filterAddressArgs(args []types.WatchAddressArg, addressesToRemove []common.Address) ([]types.WatchAddressArg, []common.Address) {
	filteredArgs := []types.WatchAddressArg{}
	filteredAddresses := []common.Address{}

	for _, arg := range args {
		address := common.HexToAddress(arg.Address)
		if idx := containsAddress(addressesToRemove, address); idx == -1 {
			filteredArgs = append(filteredArgs, arg)
			filteredAddresses = append(filteredAddresses, address)
		}
	}

	return filteredArgs, filteredAddresses
}

// filterStorageSlotArgs filters out the args having a storage slot from a given list of storage slots
func filterStorageSlotArgs(args []types.WatchAddressArg, storageSlotsToRemove []common.Hash) ([]types.WatchAddressArg, []common.Hash) {
	filteredArgs := []types.WatchAddressArg{}
	filteredStorageSlots := []common.Hash{}

	for _, arg := range args {
		storageSlot := common.HexToHash(arg.Address)
		if idx := containsStorageSlot(storageSlotsToRemove, storageSlot); idx == -1 {
			filteredArgs = append(filteredArgs, arg)
			filteredStorageSlots = append(filteredStorageSlots, storageSlot)
		}
	}

	return filteredArgs, filteredStorageSlots
}