Skip to content

Commit e116db0

Browse files
jsvisakielbarry
jsvisa
authored and
kielbarry
committed
core/rawdb: wrap db key creations (ethereum#16914)
* core/rawdb: use wrappered helper to assemble key * core/rawdb: wrappered helper to assemble key * core/rawdb: rewrite the wrapper, pass common.Hash
1 parent dddac0e commit e116db0

File tree

4 files changed

+85
-48
lines changed

4 files changed

+85
-48
lines changed

‎core/rawdb/accessors_chain.go

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929

3030
// ReadCanonicalHash retrieves the hash assigned to a canonical block number.
3131
func ReadCanonicalHash(db DatabaseReader, number uint64) common.Hash {
32-
data, _ := db.Get(append(append(headerPrefix, encodeBlockNumber(number)...), headerHashSuffix...))
32+
data, _ := db.Get(headerHashKey(number))
3333
if len(data) == 0 {
3434
return common.Hash{}
3535
}
@@ -38,22 +38,21 @@ func ReadCanonicalHash(db DatabaseReader, number uint64) common.Hash {
3838

3939
// WriteCanonicalHash stores the hash assigned to a canonical block number.
4040
func WriteCanonicalHash(db DatabaseWriter, hash common.Hash, number uint64) {
41-
key := append(append(headerPrefix, encodeBlockNumber(number)...), headerHashSuffix...)
42-
if err := db.Put(key, hash.Bytes()); err != nil {
41+
if err := db.Put(headerHashKey(number), hash.Bytes()); err != nil {
4342
log.Crit("Failed to store number to hash mapping", "err", err)
4443
}
4544
}
4645

4746
// DeleteCanonicalHash removes the number to hash canonical mapping.
4847
func DeleteCanonicalHash(db DatabaseDeleter, number uint64) {
49-
if err := db.Delete(append(append(headerPrefix, encodeBlockNumber(number)...), headerHashSuffix...)); err != nil {
48+
if err := db.Delete(headerHashKey(number)); err != nil {
5049
log.Crit("Failed to delete number to hash mapping", "err", err)
5150
}
5251
}
5352

5453
// ReadHeaderNumber returns the header number assigned to a hash.
5554
func ReadHeaderNumber(db DatabaseReader, hash common.Hash) *uint64 {
56-
data, _ := db.Get(append(headerNumberPrefix, hash.Bytes()...))
55+
data, _ := db.Get(headerNumberKey(hash))
5756
if len(data) != 8 {
5857
return nil
5958
}
@@ -129,14 +128,13 @@ func WriteFastTrieProgress(db DatabaseWriter, count uint64) {
129128

130129
// ReadHeaderRLP retrieves a block header in its raw RLP database encoding.
131130
func ReadHeaderRLP(db DatabaseReader, hash common.Hash, number uint64) rlp.RawValue {
132-
data, _ := db.Get(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
131+
data, _ := db.Get(headerKey(number, hash))
133132
return data
134133
}
135134

136135
// HasHeader verifies the existence of a block header corresponding to the hash.
137136
func HasHeader(db DatabaseReader, hash common.Hash, number uint64) bool {
138-
key := append(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
139-
if has, err := db.Has(key); !has || err != nil {
137+
if has, err := db.Has(headerKey(number, hash)); !has || err != nil {
140138
return false
141139
}
142140
return true
@@ -161,11 +159,11 @@ func ReadHeader(db DatabaseReader, hash common.Hash, number uint64) *types.Heade
161159
func WriteHeader(db DatabaseWriter, header *types.Header) {
162160
// Write the hash -> number mapping
163161
var (
164-
hash = header.Hash().Bytes()
162+
hash = header.Hash()
165163
number = header.Number.Uint64()
166164
encoded = encodeBlockNumber(number)
167165
)
168-
key := append(headerNumberPrefix, hash...)
166+
key := headerNumberKey(hash)
169167
if err := db.Put(key, encoded); err != nil {
170168
log.Crit("Failed to store hash to number mapping", "err", err)
171169
}
@@ -174,40 +172,38 @@ func WriteHeader(db DatabaseWriter, header *types.Header) {
174172
if err != nil {
175173
log.Crit("Failed to RLP encode header", "err", err)
176174
}
177-
key = append(append(headerPrefix, encoded...), hash...)
175+
key = headerKey(number, hash)
178176
if err := db.Put(key, data); err != nil {
179177
log.Crit("Failed to store header", "err", err)
180178
}
181179
}
182180

183181
// DeleteHeader removes all block header data associated with a hash.
184182
func DeleteHeader(db DatabaseDeleter, hash common.Hash, number uint64) {
185-
if err := db.Delete(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...)); err != nil {
183+
if err := db.Delete(headerKey(number, hash)); err != nil {
186184
log.Crit("Failed to delete header", "err", err)
187185
}
188-
if err := db.Delete(append(headerNumberPrefix, hash.Bytes()...)); err != nil {
186+
if err := db.Delete(headerNumberKey(hash)); err != nil {
189187
log.Crit("Failed to delete hash to number mapping", "err", err)
190188
}
191189
}
192190

193191
// ReadBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
194192
func ReadBodyRLP(db DatabaseReader, hash common.Hash, number uint64) rlp.RawValue {
195-
data, _ := db.Get(append(append(blockBodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
193+
data, _ := db.Get(blockBodyKey(number, hash))
196194
return data
197195
}
198196

199197
// WriteBodyRLP stores an RLP encoded block body into the database.
200198
func WriteBodyRLP(db DatabaseWriter, hash common.Hash, number uint64, rlp rlp.RawValue) {
201-
key := append(append(blockBodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
202-
if err := db.Put(key, rlp); err != nil {
199+
if err := db.Put(blockBodyKey(number, hash), rlp); err != nil {
203200
log.Crit("Failed to store block body", "err", err)
204201
}
205202
}
206203

207204
// HasBody verifies the existence of a block body corresponding to the hash.
208205
func HasBody(db DatabaseReader, hash common.Hash, number uint64) bool {
209-
key := append(append(blockBodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
210-
if has, err := db.Has(key); !has || err != nil {
206+
if has, err := db.Has(blockBodyKey(number, hash)); !has || err != nil {
211207
return false
212208
}
213209
return true
@@ -238,14 +234,14 @@ func WriteBody(db DatabaseWriter, hash common.Hash, number uint64, body *types.B
238234

239235
// DeleteBody removes all block body data associated with a hash.
240236
func DeleteBody(db DatabaseDeleter, hash common.Hash, number uint64) {
241-
if err := db.Delete(append(append(blockBodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...)); err != nil {
237+
if err := db.Delete(blockBodyKey(number, hash)); err != nil {
242238
log.Crit("Failed to delete block body", "err", err)
243239
}
244240
}
245241

246242
// ReadTd retrieves a block's total difficulty corresponding to the hash.
247243
func ReadTd(db DatabaseReader, hash common.Hash, number uint64) *big.Int {
248-
data, _ := db.Get(append(append(append(headerPrefix, encodeBlockNumber(number)...), hash[:]...), headerTDSuffix...))
244+
data, _ := db.Get(headerTDKey(number, hash))
249245
if len(data) == 0 {
250246
return nil
251247
}
@@ -263,23 +259,22 @@ func WriteTd(db DatabaseWriter, hash common.Hash, number uint64, td *big.Int) {
263259
if err != nil {
264260
log.Crit("Failed to RLP encode block total difficulty", "err", err)
265261
}
266-
key := append(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...), headerTDSuffix...)
267-
if err := db.Put(key, data); err != nil {
262+
if err := db.Put(headerTDKey(number, hash), data); err != nil {
268263
log.Crit("Failed to store block total difficulty", "err", err)
269264
}
270265
}
271266

272267
// DeleteTd removes all block total difficulty data associated with a hash.
273268
func DeleteTd(db DatabaseDeleter, hash common.Hash, number uint64) {
274-
if err := db.Delete(append(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...), headerTDSuffix...)); err != nil {
269+
if err := db.Delete(headerTDKey(number, hash)); err != nil {
275270
log.Crit("Failed to delete block total difficulty", "err", err)
276271
}
277272
}
278273

279274
// ReadReceipts retrieves all the transaction receipts belonging to a block.
280275
func ReadReceipts(db DatabaseReader, hash common.Hash, number uint64) types.Receipts {
281276
// Retrieve the flattened receipt slice
282-
data, _ := db.Get(append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash[:]...))
277+
data, _ := db.Get(blockReceiptsKey(number, hash))
283278
if len(data) == 0 {
284279
return nil
285280
}
@@ -308,15 +303,14 @@ func WriteReceipts(db DatabaseWriter, hash common.Hash, number uint64, receipts
308303
log.Crit("Failed to encode block receipts", "err", err)
309304
}
310305
// Store the flattened receipt slice
311-
key := append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
312-
if err := db.Put(key, bytes); err != nil {
306+
if err := db.Put(blockReceiptsKey(number, hash), bytes); err != nil {
313307
log.Crit("Failed to store block receipts", "err", err)
314308
}
315309
}
316310

317311
// DeleteReceipts removes all receipt data associated with a block hash.
318312
func DeleteReceipts(db DatabaseDeleter, hash common.Hash, number uint64) {
319-
if err := db.Delete(append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash.Bytes()...)); err != nil {
313+
if err := db.Delete(blockReceiptsKey(number, hash)); err != nil {
320314
log.Crit("Failed to delete block receipts", "err", err)
321315
}
322316
}

‎core/rawdb/accessors_indexes.go

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717
package rawdb
1818

1919
import (
20-
"encoding/binary"
21-
2220
"github.com/ethereum/go-ethereum/common"
2321
"github.com/ethereum/go-ethereum/core/types"
2422
"github.com/ethereum/go-ethereum/log"
@@ -28,7 +26,7 @@ import (
2826
// ReadTxLookupEntry retrieves the positional metadata associated with a transaction
2927
// hash to allow retrieving the transaction or receipt by hash.
3028
func ReadTxLookupEntry(db DatabaseReader, hash common.Hash) (common.Hash, uint64, uint64) {
31-
data, _ := db.Get(append(txLookupPrefix, hash.Bytes()...))
29+
data, _ := db.Get(txLookupKey(hash))
3230
if len(data) == 0 {
3331
return common.Hash{}, 0, 0
3432
}
@@ -53,15 +51,15 @@ func WriteTxLookupEntries(db DatabaseWriter, block *types.Block) {
5351
if err != nil {
5452
log.Crit("Failed to encode transaction lookup entry", "err", err)
5553
}
56-
if err := db.Put(append(txLookupPrefix, tx.Hash().Bytes()...), data); err != nil {
54+
if err := db.Put(txLookupKey(tx.Hash()), data); err != nil {
5755
log.Crit("Failed to store transaction lookup entry", "err", err)
5856
}
5957
}
6058
}
6159

6260
// DeleteTxLookupEntry removes all transaction data associated with a hash.
6361
func DeleteTxLookupEntry(db DatabaseDeleter, hash common.Hash) {
64-
db.Delete(append(txLookupPrefix, hash.Bytes()...))
62+
db.Delete(txLookupKey(hash))
6563
}
6664

6765
// ReadTransaction retrieves a specific transaction from the database, along with
@@ -97,23 +95,13 @@ func ReadReceipt(db DatabaseReader, hash common.Hash) (*types.Receipt, common.Ha
9795
// ReadBloomBits retrieves the compressed bloom bit vector belonging to the given
9896
// section and bit index from the.
9997
func ReadBloomBits(db DatabaseReader, bit uint, section uint64, head common.Hash) ([]byte, error) {
100-
key := append(append(bloomBitsPrefix, make([]byte, 10)...), head.Bytes()...)
101-
102-
binary.BigEndian.PutUint16(key[1:], uint16(bit))
103-
binary.BigEndian.PutUint64(key[3:], section)
104-
105-
return db.Get(key)
98+
return db.Get(bloomBitsKey(bit, section, head))
10699
}
107100

108101
// WriteBloomBits stores the compressed bloom bits vector belonging to the given
109102
// section and bit index.
110103
func WriteBloomBits(db DatabaseWriter, bit uint, section uint64, head common.Hash, bits []byte) {
111-
key := append(append(bloomBitsPrefix, make([]byte, 10)...), head.Bytes()...)
112-
113-
binary.BigEndian.PutUint16(key[1:], uint16(bit))
114-
binary.BigEndian.PutUint64(key[3:], section)
115-
116-
if err := db.Put(key, bits); err != nil {
104+
if err := db.Put(bloomBitsKey(bit, section, head), bits); err != nil {
117105
log.Crit("Failed to store bloom bits", "err", err)
118106
}
119107
}

‎core/rawdb/accessors_metadata.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func WriteDatabaseVersion(db DatabaseWriter, version int) {
4545

4646
// ReadChainConfig retrieves the consensus settings based on the given genesis hash.
4747
func ReadChainConfig(db DatabaseReader, hash common.Hash) *params.ChainConfig {
48-
data, _ := db.Get(append(configPrefix, hash[:]...))
48+
data, _ := db.Get(configKey(hash))
4949
if len(data) == 0 {
5050
return nil
5151
}
@@ -66,22 +66,22 @@ func WriteChainConfig(db DatabaseWriter, hash common.Hash, cfg *params.ChainConf
6666
if err != nil {
6767
log.Crit("Failed to JSON encode chain config", "err", err)
6868
}
69-
if err := db.Put(append(configPrefix, hash[:]...), data); err != nil {
69+
if err := db.Put(configKey(hash), data); err != nil {
7070
log.Crit("Failed to store chain config", "err", err)
7171
}
7272
}
7373

7474
// ReadPreimage retrieves a single preimage of the provided hash.
7575
func ReadPreimage(db DatabaseReader, hash common.Hash) []byte {
76-
data, _ := db.Get(append(preimagePrefix, hash.Bytes()...))
76+
data, _ := db.Get(preimageKey(hash))
7777
return data
7878
}
7979

8080
// WritePreimages writes the provided set of preimages to the database. `number` is the
8181
// current block number, and is used for debug messages only.
8282
func WritePreimages(db DatabaseWriter, number uint64, preimages map[common.Hash][]byte) {
8383
for hash, preimage := range preimages {
84-
if err := db.Put(append(preimagePrefix, hash.Bytes()...), preimage); err != nil {
84+
if err := db.Put(preimageKey(hash), preimage); err != nil {
8585
log.Crit("Failed to store trie preimage", "err", err)
8686
}
8787
}

‎core/rawdb/schema.go

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,58 @@ func encodeBlockNumber(number uint64) []byte {
7777
binary.BigEndian.PutUint64(enc, number)
7878
return enc
7979
}
80+
81+
// headerKey = headerPrefix + num (uint64 big endian) + hash
82+
func headerKey(number uint64, hash common.Hash) []byte {
83+
return append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
84+
}
85+
86+
// headerTDKey = headerPrefix + num (uint64 big endian) + hash + headerTDSuffix
87+
func headerTDKey(number uint64, hash common.Hash) []byte {
88+
return append(headerKey(number, hash), headerTDSuffix...)
89+
}
90+
91+
// headerHashKey = headerPrefix + num (uint64 big endian) + headerHashSuffix
92+
func headerHashKey(number uint64) []byte {
93+
return append(append(headerPrefix, encodeBlockNumber(number)...), headerHashSuffix...)
94+
}
95+
96+
// headerNumberKey = headerNumberPrefix + hash
97+
func headerNumberKey(hash common.Hash) []byte {
98+
return append(headerNumberPrefix, hash.Bytes()...)
99+
}
100+
101+
// blockBodyKey = blockBodyPrefix + num (uint64 big endian) + hash
102+
func blockBodyKey(number uint64, hash common.Hash) []byte {
103+
return append(append(blockBodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
104+
}
105+
106+
// blockReceiptsKey = blockReceiptsPrefix + num (uint64 big endian) + hash
107+
func blockReceiptsKey(number uint64, hash common.Hash) []byte {
108+
return append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
109+
}
110+
111+
// txLookupKey = txLookupPrefix + hash
112+
func txLookupKey(hash common.Hash) []byte {
113+
return append(txLookupPrefix, hash.Bytes()...)
114+
}
115+
116+
// bloomBitsKey = bloomBitsPrefix + bit (uint16 big endian) + section (uint64 big endian) + hash
117+
func bloomBitsKey(bit uint, section uint64, hash common.Hash) []byte {
118+
key := append(append(bloomBitsPrefix, make([]byte, 10)...), hash.Bytes()...)
119+
120+
binary.BigEndian.PutUint16(key[1:], uint16(bit))
121+
binary.BigEndian.PutUint64(key[3:], section)
122+
123+
return key
124+
}
125+
126+
// preimageKey = preimagePrefix + hash
127+
func preimageKey(hash common.Hash) []byte {
128+
return append(preimagePrefix, hash.Bytes()...)
129+
}
130+
131+
// configKey = configPrefix + hash
132+
func configKey(hash common.Hash) []byte {
133+
return append(configPrefix, hash.Bytes()...)
134+
}

0 commit comments

Comments
 (0)