-
Notifications
You must be signed in to change notification settings - Fork 197
/
accountsDB.go
703 lines (572 loc) · 16 KB
/
accountsDB.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
package state
import (
"bytes"
"encoding/hex"
"fmt"
"sync"
logger "github.com/ElrondNetwork/elrond-go-logger"
"github.com/ElrondNetwork/elrond-go/core/check"
"github.com/ElrondNetwork/elrond-go/data"
"github.com/ElrondNetwork/elrond-go/hashing"
"github.com/ElrondNetwork/elrond-go/marshal"
)
// AccountsDB is the struct used for accessing accounts. This struct is concurrent safe.
type AccountsDB struct {
mainTrie data.Trie
hasher hashing.Hasher
marshalizer marshal.Marshalizer
accountFactory AccountFactory
lastRootHash []byte
dataTries TriesHolder
entries []JournalEntry
mutOp sync.RWMutex
}
var log = logger.GetOrCreate("state")
// NewAccountsDB creates a new account manager
func NewAccountsDB(
trie data.Trie,
hasher hashing.Hasher,
marshalizer marshal.Marshalizer,
accountFactory AccountFactory,
) (*AccountsDB, error) {
if check.IfNil(trie) {
return nil, ErrNilTrie
}
if check.IfNil(hasher) {
return nil, ErrNilHasher
}
if check.IfNil(marshalizer) {
return nil, ErrNilMarshalizer
}
if check.IfNil(accountFactory) {
return nil, ErrNilAccountFactory
}
return &AccountsDB{
mainTrie: trie,
hasher: hasher,
marshalizer: marshalizer,
accountFactory: accountFactory,
entries: make([]JournalEntry, 0),
mutOp: sync.RWMutex{},
dataTries: NewDataTriesHolder(),
}, nil
}
// SaveAccount saves in the trie all changes made to the account.
func (adb *AccountsDB) SaveAccount(account AccountHandler) error {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
if check.IfNil(account) {
return fmt.Errorf("%w in accountsDB SaveAccount", ErrNilAccountHandler)
}
oldAccount, err := adb.getAccount(account.AddressBytes())
if err != nil {
return err
}
var entry JournalEntry
if check.IfNil(oldAccount) {
entry, err = NewJournalEntryAccountCreation(account.AddressBytes(), adb.mainTrie)
if err != nil {
return err
}
adb.journalize(entry)
} else {
entry, err = NewJournalEntryAccount(oldAccount)
if err != nil {
return err
}
adb.journalize(entry)
}
baseAcc, ok := account.(baseAccountHandler)
if ok {
err = adb.saveCode(baseAcc)
if err != nil {
return err
}
err = adb.saveDataTrie(baseAcc)
if err != nil {
return err
}
}
return adb.saveAccountToTrie(account)
}
func (adb *AccountsDB) saveCode(accountHandler baseAccountHandler) error {
// TODO: enable code pruning
code := accountHandler.GetCode()
if len(code) == 0 {
return nil
}
codeHash := adb.hasher.Compute(string(code))
currentCodeHash := accountHandler.GetCodeHash()
noUpdateNeeded := bytes.Equal(codeHash, currentCodeHash)
if noUpdateNeeded {
return nil
}
codeFromTrie, err := adb.mainTrie.Get(codeHash)
if err != nil {
return err
}
isCodeInTrie := len(codeFromTrie) > 0
if isCodeInTrie {
accountHandler.SetCodeHash(codeHash)
return nil
}
entry, err := NewJournalEntryCode(codeHash, adb.mainTrie)
if err != nil {
return err
}
adb.journalize(entry)
log.Trace("accountsDB.saveCode(): mainTrie.Update()", "codeHash", codeHash, "codeLength", len(code))
err = adb.mainTrie.Update(codeHash, code)
if err != nil {
return err
}
accountHandler.SetCodeHash(codeHash)
return nil
}
// LoadDataTrie retrieves and saves the SC data inside accountHandler object.
// Errors if something went wrong
func (adb *AccountsDB) loadDataTrie(accountHandler baseAccountHandler) error {
if len(accountHandler.GetRootHash()) == 0 {
return nil
}
dataTrie := adb.dataTries.Get(accountHandler.AddressBytes())
if dataTrie != nil {
accountHandler.SetDataTrie(dataTrie)
return nil
}
dataTrie, err := adb.mainTrie.Recreate(accountHandler.GetRootHash())
if err != nil {
return NewErrMissingTrie(accountHandler.GetRootHash())
}
accountHandler.SetDataTrie(dataTrie)
adb.dataTries.Put(accountHandler.AddressBytes(), dataTrie)
return nil
}
// SaveDataTrie is used to save the data trie (not committing it) and to recompute the new Root value
// If data is not dirtied, method will not create its JournalEntries to keep track of data modification
func (adb *AccountsDB) saveDataTrie(accountHandler baseAccountHandler) error {
if check.IfNil(accountHandler.DataTrieTracker()) {
return ErrNilTrackableDataTrie
}
if len(accountHandler.DataTrieTracker().DirtyData()) == 0 {
return nil
}
log.Trace("accountsDB.SaveDataTrie",
"address", hex.EncodeToString(accountHandler.AddressBytes()),
"nonce", accountHandler.GetNonce(),
)
if check.IfNil(accountHandler.DataTrie()) {
newDataTrie, err := adb.mainTrie.Recreate(make([]byte, 0))
if err != nil {
return err
}
accountHandler.SetDataTrie(newDataTrie)
adb.dataTries.Put(accountHandler.AddressBytes(), newDataTrie)
}
trackableDataTrie := accountHandler.DataTrieTracker()
dataTrie := trackableDataTrie.DataTrie()
oldValues := make(map[string][]byte)
for k, v := range trackableDataTrie.DirtyData() {
//TODO use trackableDataTrie.originalData() instead of getting from the trie
val, err := dataTrie.Get([]byte(k))
if err != nil {
return err
}
oldValues[k] = val
err = dataTrie.Update([]byte(k), v)
if err != nil {
return err
}
}
entry, err := NewJournalEntryDataTrieUpdates(oldValues, accountHandler)
if err != nil {
return err
}
adb.journalize(entry)
rootHash, err := trackableDataTrie.DataTrie().Root()
if err != nil {
return err
}
accountHandler.SetRootHash(rootHash)
trackableDataTrie.ClearDataCaches()
log.Trace("accountsDB.SaveDataTrie",
"address", hex.EncodeToString(accountHandler.AddressBytes()),
"new root hash", accountHandler.GetRootHash(),
)
return nil
}
func (adb *AccountsDB) saveAccountToTrie(accountHandler AccountHandler) error {
log.Trace("accountsDB.saveAccountToTrie",
"address", hex.EncodeToString(accountHandler.AddressBytes()),
)
//pass the reference to marshalizer, otherwise it will fail marshalizing balance
buff, err := adb.marshalizer.Marshal(accountHandler)
if err != nil {
return err
}
return adb.mainTrie.Update(accountHandler.AddressBytes(), buff)
}
// RemoveAccount removes the account data from underlying trie.
// It basically calls Update with empty slice
func (adb *AccountsDB) RemoveAccount(address []byte) error {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
if len(address) == 0 {
return fmt.Errorf("%w in RemoveAccount", ErrNilAddress)
}
acnt, err := adb.getAccount(address)
if err != nil {
return err
}
if acnt == nil {
return fmt.Errorf("%w in RemoveAccount for address %s", ErrAccNotFound, address)
}
entry, err := NewJournalEntryAccount(acnt)
if err != nil {
return err
}
adb.journalize(entry)
log.Trace("accountsDB.RemoveAccount",
"address", hex.EncodeToString(address),
)
return adb.mainTrie.Update(address, make([]byte, 0))
}
// LoadAccount fetches the account based on the address. Creates an empty account if the account is missing.
func (adb *AccountsDB) LoadAccount(address []byte) (AccountHandler, error) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
if len(address) == 0 {
return nil, fmt.Errorf("%w in LoadAccount", ErrNilAddress)
}
log.Trace("accountsDB.LoadAccount",
"address", hex.EncodeToString(address),
)
acnt, err := adb.getAccount(address)
if err != nil {
return nil, err
}
if acnt == nil {
return adb.accountFactory.CreateAccount(address)
}
baseAcc, ok := acnt.(baseAccountHandler)
if ok {
err = adb.loadCode(baseAcc)
if err != nil {
return nil, err
}
err = adb.loadDataTrie(baseAcc)
if err != nil {
return nil, err
}
}
return acnt, nil
}
func (adb *AccountsDB) getAccount(address []byte) (AccountHandler, error) {
val, err := adb.mainTrie.Get(address)
if err != nil {
return nil, err
}
if val == nil {
return nil, nil
}
acnt, err := adb.accountFactory.CreateAccount(address)
if err != nil {
return nil, err
}
err = adb.marshalizer.Unmarshal(acnt, val)
if err != nil {
return nil, err
}
return acnt, nil
}
// GetExistingAccount returns an existing account if exists or nil if missing
func (adb *AccountsDB) GetExistingAccount(address []byte) (AccountHandler, error) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
if len(address) == 0 {
return nil, fmt.Errorf("%w in GetExistingAccount", ErrNilAddress)
}
log.Trace("accountsDB.GetExistingAccount",
"address", hex.EncodeToString(address),
)
acnt, err := adb.getAccount(address)
if err != nil {
return nil, err
}
if acnt == nil {
return nil, ErrAccNotFound
}
baseAcc, ok := acnt.(baseAccountHandler)
if ok {
err = adb.loadCode(baseAcc)
if err != nil {
return nil, err
}
err = adb.loadDataTrie(baseAcc)
if err != nil {
return nil, err
}
}
return acnt, nil
}
// loadCode retrieves and saves the SC code inside AccountState object. Errors if something went wrong
func (adb *AccountsDB) loadCode(accountHandler baseAccountHandler) error {
if len(accountHandler.GetCodeHash()) == 0 {
return nil
}
val, err := adb.mainTrie.Get(accountHandler.GetCodeHash())
if err != nil {
return err
}
accountHandler.SetCode(val)
return nil
}
// RevertToSnapshot apply Revert method over accounts object and removes entries from the list
// Calling with 0 will revert everything. If the snapshot value is out of bounds, an err will be returned
func (adb *AccountsDB) RevertToSnapshot(snapshot int) error {
log.Trace("accountsDB.RevertToSnapshot started",
"snapshot", snapshot,
)
adb.mutOp.Lock()
defer func() {
log.Trace("accountsDB.RevertToSnapshot ended")
adb.mutOp.Unlock()
}()
if snapshot > len(adb.entries) || snapshot < 0 {
return ErrSnapshotValueOutOfBounds
}
if snapshot == 0 {
log.Trace("revert snapshot to adb.lastRootHash", "hash", adb.lastRootHash)
return adb.recreateTrie(adb.lastRootHash)
}
for i := len(adb.entries) - 1; i >= snapshot; i-- {
account, err := adb.entries[i].Revert()
if err != nil {
return err
}
if !check.IfNil(account) {
err = adb.saveAccountToTrie(account)
if err != nil {
return err
}
}
}
adb.entries = adb.entries[:snapshot]
return nil
}
// JournalLen will return the number of entries
func (adb *AccountsDB) JournalLen() int {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
length := len(adb.entries)
log.Trace("accountsDB.JournalLen",
"length", length,
)
return length
}
// Commit will persist all data inside the trie
func (adb *AccountsDB) Commit() ([]byte, error) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
log.Trace("accountsDB.Commit started")
adb.entries = make([]JournalEntry, 0)
oldHashes := make([][]byte, 0)
newHashes := make(data.ModifiedHashes)
//Step 1. commit all data tries
dataTries := adb.dataTries.GetAll()
for i := 0; i < len(dataTries); i++ {
oldTrieHashes := dataTries[i].ResetOldHashes()
newTrieHashes, err := dataTries[i].GetDirtyHashes()
if err != nil {
return nil, err
}
err = dataTries[i].Commit()
if err != nil {
return nil, err
}
oldHashes = append(oldHashes, oldTrieHashes...)
for hash := range newTrieHashes {
newHashes[hash] = struct{}{}
}
}
adb.dataTries.Reset()
newTrieHashes, err := adb.mainTrie.GetDirtyHashes()
if err != nil {
return nil, err
}
for hash := range newTrieHashes {
newHashes[hash] = struct{}{}
}
//Step 2. commit main trie
adb.mainTrie.SetNewHashes(newHashes)
adb.mainTrie.AppendToOldHashes(oldHashes)
err = adb.mainTrie.Commit()
if err != nil {
return nil, err
}
root, err := adb.mainTrie.Root()
if err != nil {
log.Trace("accountsDB.Commit ended", "error", err.Error())
return nil, err
}
adb.lastRootHash = root
log.Trace("accountsDB.Commit ended", "root hash", root)
return root, nil
}
// RootHash returns the main trie's root hash
func (adb *AccountsDB) RootHash() ([]byte, error) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
rootHash, err := adb.mainTrie.Root()
log.Trace("accountsDB.RootHash",
"root hash", rootHash,
"err", err,
)
return rootHash, err
}
// RecreateTrie is used to reload the trie based on an existing rootHash
func (adb *AccountsDB) RecreateTrie(rootHash []byte) error {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
err := adb.recreateTrie(rootHash)
if err != nil {
return err
}
adb.lastRootHash = rootHash
return nil
}
func (adb *AccountsDB) recreateTrie(rootHash []byte) error {
log.Trace("accountsDB.RecreateTrie", "root hash", rootHash)
defer func() {
log.Trace("accountsDB.RecreateTrie ended")
}()
adb.dataTries.Reset()
adb.entries = make([]JournalEntry, 0)
newTrie, err := adb.mainTrie.Recreate(rootHash)
if err != nil {
return err
}
if check.IfNil(newTrie) {
return ErrNilTrie
}
adb.mainTrie = newTrie
return nil
}
// RecreateAllTries recreates all the tries from the accounts DB
func (adb *AccountsDB) RecreateAllTries(rootHash []byte) (map[string]data.Trie, error) {
recreatedTrie, err := adb.mainTrie.Recreate(rootHash)
if err != nil {
return nil, err
}
leafs, err := recreatedTrie.GetAllLeaves()
if err != nil {
return nil, err
}
allTries := make(map[string]data.Trie)
allTries[string(rootHash)] = recreatedTrie
for _, leaf := range leafs {
account := &userAccount{}
err = adb.marshalizer.Unmarshal(account, leaf)
if err != nil {
log.Trace("this must be a leaf with code", "err", err)
continue
}
if len(account.RootHash) > 0 {
dataTrie, err := adb.mainTrie.Recreate(account.RootHash)
if err != nil {
return nil, err
}
allTries[string(account.RootHash)] = dataTrie
}
}
return allTries, nil
}
// Journalize adds a new object to entries list.
func (adb *AccountsDB) journalize(entry JournalEntry) {
if check.IfNil(entry) {
return
}
adb.entries = append(adb.entries, entry)
log.Trace("accountsDB.Journalize", "new length", len(adb.entries))
}
// PruneTrie removes old values from the trie database
func (adb *AccountsDB) PruneTrie(rootHash []byte, identifier data.TriePruningIdentifier) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
log.Trace("accountsDB.PruneTrie", "root hash", rootHash)
adb.mainTrie.Prune(rootHash, identifier)
}
// CancelPrune clears the trie's evictionWaitingList
func (adb *AccountsDB) CancelPrune(rootHash []byte, identifier data.TriePruningIdentifier) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
log.Trace("accountsDB.CancelPrune", "root hash", rootHash)
adb.mainTrie.CancelPrune(rootHash, identifier)
}
// SnapshotState triggers the snapshotting process of the state trie
func (adb *AccountsDB) SnapshotState(rootHash []byte) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
log.Trace("accountsDB.SnapshotState", "root hash", rootHash)
adb.mainTrie.EnterSnapshotMode()
go func() {
adb.mainTrie.TakeSnapshot(rootHash)
adb.snapshotUserAccountDataTrie(rootHash)
adb.mainTrie.ExitSnapshotMode()
}()
}
func (adb *AccountsDB) snapshotUserAccountDataTrie(rootHash []byte) {
leafs, err := adb.GetAllLeaves(rootHash)
if err != nil {
log.Error("incomplete snapshot as getAllLeaves error", "error", err)
return
}
for _, leaf := range leafs {
account := &userAccount{}
err = adb.marshalizer.Unmarshal(account, leaf)
if err != nil {
log.Trace("this must be a leaf with code", "err", err)
continue
}
if len(account.RootHash) > 0 {
adb.mainTrie.SetCheckpoint(account.RootHash)
}
}
}
// SetStateCheckpoint sets a checkpoint for the state trie
func (adb *AccountsDB) SetStateCheckpoint(rootHash []byte) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
log.Trace("accountsDB.SetStateCheckpoint", "root hash", rootHash)
adb.mainTrie.EnterSnapshotMode()
go func() {
adb.mainTrie.SetCheckpoint(rootHash)
adb.snapshotUserAccountDataTrie(rootHash)
adb.mainTrie.ExitSnapshotMode()
}()
}
// IsPruningEnabled returns true if state pruning is enabled
func (adb *AccountsDB) IsPruningEnabled() bool {
return adb.mainTrie.IsPruningEnabled()
}
// GetAllLeaves returns all the leaves from a given rootHash
func (adb *AccountsDB) GetAllLeaves(rootHash []byte) (map[string][]byte, error) {
adb.mutOp.Lock()
defer adb.mutOp.Unlock()
newTrie, err := adb.mainTrie.Recreate(rootHash)
if err != nil {
return nil, err
}
if newTrie == nil {
return nil, ErrNilTrie
}
allAccounts, err := newTrie.GetAllLeaves()
if err != nil {
return nil, err
}
return allAccounts, nil
}
// IsInterfaceNil returns true if there is no value under the interface
func (adb *AccountsDB) IsInterfaceNil() bool {
return adb == nil
}