140 lines
4.3 KiB
Go
140 lines
4.3 KiB
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 (
|
|
"encoding/json"
|
|
"math/big"
|
|
"sync"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
ctypes "github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
"github.com/ethereum/go-ethereum/statediff/types"
|
|
)
|
|
|
|
// Subscription struct holds our subscription channels
|
|
type Subscription struct {
|
|
PayloadChan chan<- Payload
|
|
QuitChan chan<- bool
|
|
}
|
|
|
|
// DBParams holds params for Postgres db connection
|
|
type DBParams struct {
|
|
ConnectionURL string
|
|
ID string
|
|
ClientName string
|
|
}
|
|
|
|
// Params is used to carry in parameters from subscribing/requesting clients configuration
|
|
type Params struct {
|
|
IntermediateStateNodes bool
|
|
IntermediateStorageNodes bool
|
|
IncludeBlock bool
|
|
IncludeReceipts bool
|
|
IncludeTD bool
|
|
IncludeCode bool
|
|
WatchedAddresses []common.Address
|
|
watchedAddressesLeafKeys map[common.Hash]struct{}
|
|
}
|
|
|
|
// ComputeWatchedAddressesLeafKeys populates a map with keys (Keccak256Hash) of each of the WatchedAddresses
|
|
func (p *Params) ComputeWatchedAddressesLeafKeys() {
|
|
p.watchedAddressesLeafKeys = make(map[common.Hash]struct{}, len(p.WatchedAddresses))
|
|
for _, address := range p.WatchedAddresses {
|
|
p.watchedAddressesLeafKeys[crypto.Keccak256Hash(address.Bytes())] = struct{}{}
|
|
}
|
|
}
|
|
|
|
// ParamsWithMutex allows to lock the parameters while they are being updated | read from
|
|
type ParamsWithMutex struct {
|
|
Params
|
|
sync.RWMutex
|
|
}
|
|
|
|
// Args bundles the arguments for the state diff builder
|
|
type Args struct {
|
|
OldStateRoot, NewStateRoot, BlockHash common.Hash
|
|
BlockNumber *big.Int
|
|
}
|
|
|
|
type StateRoots struct {
|
|
OldStateRoot, NewStateRoot common.Hash
|
|
}
|
|
|
|
// Payload packages the data to send to statediff subscriptions
|
|
type Payload struct {
|
|
BlockRlp []byte `json:"blockRlp"`
|
|
TotalDifficulty *big.Int `json:"totalDifficulty"`
|
|
ReceiptsRlp []byte `json:"receiptsRlp"`
|
|
StateObjectRlp []byte `json:"stateObjectRlp" gencodec:"required"`
|
|
|
|
encoded []byte
|
|
err error
|
|
}
|
|
|
|
func (sd *Payload) ensureEncoded() {
|
|
if sd.encoded == nil && sd.err == nil {
|
|
sd.encoded, sd.err = json.Marshal(sd)
|
|
}
|
|
}
|
|
|
|
// Length to implement Encoder interface for Payload
|
|
func (sd *Payload) Length() int {
|
|
sd.ensureEncoded()
|
|
return len(sd.encoded)
|
|
}
|
|
|
|
// Encode to implement Encoder interface for Payload
|
|
func (sd *Payload) Encode() ([]byte, error) {
|
|
sd.ensureEncoded()
|
|
return sd.encoded, sd.err
|
|
}
|
|
|
|
// StateObject is the final output structure from the builder
|
|
type StateObject struct {
|
|
BlockNumber *big.Int `json:"blockNumber" gencodec:"required"`
|
|
BlockHash common.Hash `json:"blockHash" gencodec:"required"`
|
|
Nodes []types.StateNode `json:"nodes" gencodec:"required"`
|
|
CodeAndCodeHashes []types.CodeAndCodeHash `json:"codeMapping"`
|
|
}
|
|
|
|
// AccountMap is a mapping of hex encoded path => account wrapper
|
|
type AccountMap map[string]accountWrapper
|
|
|
|
// accountWrapper is used to temporary associate the unpacked node with its raw values
|
|
type accountWrapper struct {
|
|
Account *ctypes.StateAccount
|
|
NodeType types.NodeType
|
|
Path []byte
|
|
NodeValue []byte
|
|
LeafKey []byte
|
|
}
|
|
|
|
// OperationType for type of WatchAddress operation
|
|
type OperationType string
|
|
|
|
const (
|
|
Add OperationType = "add"
|
|
Remove OperationType = "remove"
|
|
Set OperationType = "set"
|
|
Clear OperationType = "clear"
|
|
)
|