github.com/xfond/eth-implementation@v1.8.9-0.20180514135602-f6bc65fc6811/core/rawdb/schema.go (about)

     1  // Copyright 2018 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 rawdb contains a collection of low level database accessors.
    18  package rawdb
    19  
    20  import (
    21  	"encoding/binary"
    22  
    23  	"github.com/ethereum/go-ethereum/common"
    24  	"github.com/ethereum/go-ethereum/metrics"
    25  )
    26  
    27  // The fields below define the low level database schema prefixing.
    28  var (
    29  	// databaseVerisionKey tracks the current database version.
    30  	databaseVerisionKey = []byte("DatabaseVersion")
    31  
    32  	// headHeaderKey tracks the latest know header's hash.
    33  	headHeaderKey = []byte("LastHeader")
    34  
    35  	// headBlockKey tracks the latest know full block's hash.
    36  	headBlockKey = []byte("LastBlock")
    37  
    38  	// headFastBlockKey tracks the latest known incomplete block's hash duirng fast sync.
    39  	headFastBlockKey = []byte("LastFast")
    40  
    41  	// fastTrieProgressKey tracks the number of trie entries imported during fast sync.
    42  	fastTrieProgressKey = []byte("TrieSync")
    43  
    44  	// Data item prefixes (use single byte to avoid mixing data types, avoid `i`, used for indexes).
    45  	headerPrefix       = []byte("h") // headerPrefix + num (uint64 big endian) + hash -> header
    46  	headerTDSuffix     = []byte("t") // headerPrefix + num (uint64 big endian) + hash + headerTDSuffix -> td
    47  	headerHashSuffix   = []byte("n") // headerPrefix + num (uint64 big endian) + headerHashSuffix -> hash
    48  	headerNumberPrefix = []byte("H") // headerNumberPrefix + hash -> num (uint64 big endian)
    49  
    50  	blockBodyPrefix     = []byte("b") // blockBodyPrefix + num (uint64 big endian) + hash -> block body
    51  	blockReceiptsPrefix = []byte("r") // blockReceiptsPrefix + num (uint64 big endian) + hash -> block receipts
    52  
    53  	txLookupPrefix  = []byte("l") // txLookupPrefix + hash -> transaction/receipt lookup metadata
    54  	bloomBitsPrefix = []byte("B") // bloomBitsPrefix + bit (uint16 big endian) + section (uint64 big endian) + hash -> bloom bits
    55  
    56  	preimagePrefix = []byte("secure-key-")      // preimagePrefix + hash -> preimage
    57  	configPrefix   = []byte("ethereum-config-") // config prefix for the db
    58  
    59  	// Chain index prefixes (use `i` + single byte to avoid mixing data types).
    60  	BloomBitsIndexPrefix = []byte("iB") // BloomBitsIndexPrefix is the data table of a chain indexer to track its progress
    61  
    62  	preimageCounter    = metrics.NewRegisteredCounter("db/preimage/total", nil)
    63  	preimageHitCounter = metrics.NewRegisteredCounter("db/preimage/hits", nil)
    64  )
    65  
    66  // TxLookupEntry is a positional metadata to help looking up the data content of
    67  // a transaction or receipt given only its hash.
    68  type TxLookupEntry struct {
    69  	BlockHash  common.Hash
    70  	BlockIndex uint64
    71  	Index      uint64
    72  }
    73  
    74  // encodeBlockNumber encodes a block number as big endian uint64
    75  func encodeBlockNumber(number uint64) []byte {
    76  	enc := make([]byte, 8)
    77  	binary.BigEndian.PutUint64(enc, number)
    78  	return enc
    79  }