github.1485827954.workers.dev/ethereum/go-ethereum@v1.14.3/triedb/database/database.go (about)

     1  // Copyright 2024 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package database
    18  
    19  import (
    20  	"github.com/ethereum/go-ethereum/common"
    21  )
    22  
    23  // Reader wraps the Node method of a backing trie reader.
    24  type Reader interface {
    25  	// Node retrieves the trie node blob with the provided trie identifier,
    26  	// node path and the corresponding node hash. No error will be returned
    27  	// if the node is not found.
    28  	//
    29  	// Don't modify the returned byte slice since it's not deep-copied and
    30  	// still be referenced by database.
    31  	Node(owner common.Hash, path []byte, hash common.Hash) ([]byte, error)
    32  }
    33  
    34  // PreimageStore wraps the methods of a backing store for reading and writing
    35  // trie node preimages.
    36  type PreimageStore interface {
    37  	// Preimage retrieves the preimage of the specified hash.
    38  	Preimage(hash common.Hash) []byte
    39  
    40  	// InsertPreimage commits a set of preimages along with their hashes.
    41  	InsertPreimage(preimages map[common.Hash][]byte)
    42  }
    43  
    44  // Database wraps the methods of a backing trie store.
    45  type Database interface {
    46  	PreimageStore
    47  
    48  	// Reader returns a node reader associated with the specific state.
    49  	// An error will be returned if the specified state is not available.
    50  	Reader(stateRoot common.Hash) (Reader, error)
    51  }