mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-24 15:44:32 +00:00
256 lines
9 KiB
Go
256 lines
9 KiB
Go
// Copyright 2015 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/>.
|
|
|
|
package tradingstate
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/XinFinOrg/XDPoSChain/common"
|
|
"github.com/XinFinOrg/XDPoSChain/core/types"
|
|
"github.com/XinFinOrg/XDPoSChain/ethdb"
|
|
"github.com/XinFinOrg/XDPoSChain/log"
|
|
"github.com/XinFinOrg/XDPoSChain/trie"
|
|
"github.com/XinFinOrg/XDPoSChain/trie/trienode"
|
|
)
|
|
|
|
// XDCXTrie wraps a trie with key hashing. In a secure trie, all
|
|
// access operations hash the key using keccak256. This prevents
|
|
// calling code from creating long chains of nodes that
|
|
// increase the access time.
|
|
//
|
|
// Contrary to a regular trie, a XDCXTrie can only be created with
|
|
// New and must have an attached database. The database also stores
|
|
// the preimage of each key.
|
|
//
|
|
// XDCXTrie is not safe for concurrent use.
|
|
type XDCXTrie struct {
|
|
trie trie.Trie
|
|
secKeyCache map[string][]byte
|
|
secKeyCacheOwner *XDCXTrie // Pointer to self, replace the key cache on mismatch
|
|
}
|
|
|
|
// NewXDCXTrie creates a trie with an existing root node from a backing database
|
|
// and optional intermediate in-memory node pool.
|
|
//
|
|
// If root is the zero hash or the sha3 hash of an empty string, the
|
|
// trie is initially empty. Otherwise, New will panic if db is nil
|
|
// and returns MissingNodeError if the root node cannot be found.
|
|
//
|
|
// Accessing the trie loads nodes from the database or node pool on demand.
|
|
// Loaded nodes are kept around until their 'cache generation' expires.
|
|
// A new cache generation is created by each call to Commit.
|
|
// cachelimit sets the number of past cache generations to keep.
|
|
func NewXDCXTrie(root common.Hash, db *trie.Database) (*XDCXTrie, error) {
|
|
if db == nil {
|
|
panic("trie.NewXDCXTrie called without a database")
|
|
}
|
|
trie, err := trie.New(trie.TrieID(root), db)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &XDCXTrie{trie: *trie}, nil
|
|
}
|
|
|
|
// Get returns the value for key stored in the trie.
|
|
// The value bytes must not be modified by the caller.
|
|
func (t *XDCXTrie) Get(key []byte) []byte {
|
|
res, err := t.TryGet(key)
|
|
if err != nil {
|
|
log.Error(fmt.Sprintf("Unhandled trie error: %v", err))
|
|
}
|
|
return res
|
|
}
|
|
|
|
// TryGet returns the value for key stored in the trie.
|
|
// The value bytes must not be modified by the caller.
|
|
// If a node was not found in the database, a MissingNodeError is returned.
|
|
func (t *XDCXTrie) TryGet(key []byte) ([]byte, error) {
|
|
return t.trie.Get(key)
|
|
}
|
|
|
|
// TryGetBestLeftKey returns the value of max left leaf
|
|
// If a node was not found in the database, a MissingNodeError is returned.
|
|
func (t *XDCXTrie) TryGetBestLeftKeyAndValue() ([]byte, []byte, error) {
|
|
return t.trie.TryGetBestLeftKeyAndValue()
|
|
}
|
|
|
|
func (t *XDCXTrie) TryGetAllLeftKeyAndValue(limit []byte) ([][]byte, [][]byte, error) {
|
|
return t.trie.TryGetAllLeftKeyAndValue(limit)
|
|
}
|
|
|
|
// TryGetBestRightKey returns the value of max left leaf
|
|
// If a node was not found in the database, a MissingNodeError is returned.
|
|
func (t *XDCXTrie) TryGetBestRightKeyAndValue() ([]byte, []byte, error) {
|
|
return t.trie.TryGetBestRightKeyAndValue()
|
|
}
|
|
|
|
// Update associates key with value in the trie. Subsequent calls to
|
|
// Get will return value. If value has length zero, any existing value
|
|
// is deleted from the trie and calls to Get will return nil.
|
|
//
|
|
// The value bytes must not be modified by the caller while they are
|
|
// stored in the trie.
|
|
func (t *XDCXTrie) Update(key, value []byte) {
|
|
if err := t.TryUpdate(key, value); err != nil {
|
|
log.Error(fmt.Sprintf("Unhandled trie error: %v", err))
|
|
}
|
|
}
|
|
|
|
// TryUpdate associates key with value in the trie. Subsequent calls to
|
|
// Get will return value. If value has length zero, any existing value
|
|
// is deleted from the trie and calls to Get will return nil.
|
|
//
|
|
// The value bytes must not be modified by the caller while they are
|
|
// stored in the trie.
|
|
//
|
|
// If a node was not found in the database, a MissingNodeError is returned.
|
|
func (t *XDCXTrie) TryUpdate(key, value []byte) error {
|
|
err := t.trie.Update(key, value)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
t.getSecKeyCache()[string(key)] = common.CopyBytes(key)
|
|
return nil
|
|
}
|
|
|
|
// Delete removes any existing value for key from the trie.
|
|
func (t *XDCXTrie) Delete(key []byte) {
|
|
if err := t.TryDelete(key); err != nil {
|
|
log.Error(fmt.Sprintf("Unhandled trie error: %v", err))
|
|
}
|
|
}
|
|
|
|
// TryDelete removes any existing value for key from the trie.
|
|
// If a node was not found in the database, a MissingNodeError is returned.
|
|
func (t *XDCXTrie) TryDelete(key []byte) error {
|
|
delete(t.getSecKeyCache(), string(key))
|
|
return t.trie.Delete(key)
|
|
}
|
|
|
|
// GetKey returns the sha3 preimage of a hashed key that was
|
|
// previously used to store a value.
|
|
func (t *XDCXTrie) GetKey(shaKey []byte) []byte {
|
|
if key, ok := t.getSecKeyCache()[string(shaKey)]; ok {
|
|
return key
|
|
}
|
|
return t.trie.Preimage(common.BytesToHash(shaKey))
|
|
}
|
|
|
|
// Commit writes all nodes and the secure hash pre-images to the trie's database.
|
|
// Nodes are stored with their sha3 hash as the key.
|
|
//
|
|
// Committing flushes nodes from memory. Subsequent Get calls will load nodes
|
|
// from the database.
|
|
func (t *XDCXTrie) Commit(onleaf trie.LeafCallback) (common.Hash, error) {
|
|
// Write all the pre-images to the actual disk database
|
|
if len(t.getSecKeyCache()) > 0 {
|
|
t.trie.InsertPreimage(t.secKeyCache)
|
|
t.secKeyCache = make(map[string][]byte)
|
|
}
|
|
// Commit the trie to its intermediate node database
|
|
// PR #1103 causes TestRevertStates and TestDumpState to fail,
|
|
// but we will not fix them since XDCx has been abandoned.
|
|
// TODO(daniel): The following code may be incorrect, ref PR #25320:
|
|
root, nodes, err := t.trie.Commit(false)
|
|
if err != nil {
|
|
return common.Hash{}, err
|
|
}
|
|
if nodes != nil {
|
|
if err := t.trie.UpdateDb(root, types.EmptyRootHash, 0, trienode.NewWithNodeSet(nodes), nil); err != nil {
|
|
return common.Hash{}, err
|
|
}
|
|
}
|
|
return root, nil
|
|
}
|
|
|
|
func (t *XDCXTrie) Hash() common.Hash {
|
|
return t.trie.Hash()
|
|
}
|
|
|
|
func (t *XDCXTrie) Copy() *XDCXTrie {
|
|
cpy := *t
|
|
return &cpy
|
|
}
|
|
|
|
// NodeIterator returns an iterator that returns nodes of the underlying trie. Iteration
|
|
// starts at the key after the given start key.
|
|
func (t *XDCXTrie) NodeIterator(start []byte) trie.NodeIterator {
|
|
trieIt, err := t.trie.NodeIterator(start)
|
|
if err != nil {
|
|
log.Error(fmt.Sprintf("Unhandled trie error: %v", err))
|
|
return errNodeIterator{err: err}
|
|
}
|
|
return trieIt
|
|
}
|
|
|
|
// errNodeIterator is a safe, non-nil iterator that reports an error and yields no nodes.
|
|
// It prevents nil dereferences when callers don't check for a nil iterator.
|
|
type errNodeIterator struct {
|
|
err error
|
|
}
|
|
|
|
func (it errNodeIterator) Next(bool) bool { return false }
|
|
func (it errNodeIterator) Error() error { return it.err }
|
|
func (it errNodeIterator) Hash() common.Hash {
|
|
return common.Hash{}
|
|
}
|
|
func (it errNodeIterator) Parent() common.Hash {
|
|
return common.Hash{}
|
|
}
|
|
func (it errNodeIterator) Path() []byte { return nil }
|
|
func (it errNodeIterator) NodeBlob() []byte { return nil }
|
|
func (it errNodeIterator) Leaf() bool { return false }
|
|
func (it errNodeIterator) LeafKey() []byte { return nil }
|
|
func (it errNodeIterator) LeafBlob() []byte { return nil }
|
|
func (it errNodeIterator) LeafProof() [][]byte {
|
|
return nil
|
|
}
|
|
func (it errNodeIterator) AddResolver(trie.NodeResolver) {}
|
|
|
|
// hashKey returns the hash of key as an ephemeral buffer.
|
|
// The caller must not hold onto the return value because it will become
|
|
// invalid on the next call to hashKey or secKey.
|
|
//func (t *XDCXTrie) hashKey(key []byte) []byte {
|
|
// h := newHasher(0, 0, nil)
|
|
// h.sha.Reset()
|
|
// h.sha.Write(key)
|
|
// buf := h.sha.Sum(t.hashKeyBuf[:0])
|
|
// returnHasherToPool(h)
|
|
// return buf
|
|
//}
|
|
|
|
// getSecKeyCache returns the current secure key cache, creating a new one if
|
|
// ownership changed (i.e. the current secure trie is a copy of another owning
|
|
// the actual cache).
|
|
func (t *XDCXTrie) getSecKeyCache() map[string][]byte {
|
|
if t != t.secKeyCacheOwner {
|
|
t.secKeyCacheOwner = t
|
|
t.secKeyCache = make(map[string][]byte)
|
|
}
|
|
return t.secKeyCache
|
|
}
|
|
|
|
// Prove constructs a merkle proof for key. The result contains all encoded nodes
|
|
// on the path to the value at key. The value itself is also included in the last
|
|
// node and can be retrieved by verifying the proof.
|
|
//
|
|
// If the trie does not contain a value for key, the returned proof contains all
|
|
// nodes of the longest existing prefix of the key (at least the root node), ending
|
|
// with the node that proves the absence of the key.
|
|
func (t *XDCXTrie) Prove(key []byte, fromLevel uint, proofDb ethdb.KeyValueWriter) error {
|
|
return t.trie.Prove(key, proofDb)
|
|
}
|