forked from iotexproject/iotex-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
statedb.go
265 lines (238 loc) · 8.02 KB
/
statedb.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
// Copyright (c) 2019 IoTeX
// This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no
// warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent
// permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache
// License 2.0 that can be found in the LICENSE file.
package factory
import (
"context"
"fmt"
"math/big"
"strconv"
"sync"
"github.com/pkg/errors"
"go.uber.org/zap"
"github.com/iotexproject/iotex-address/address"
"github.com/iotexproject/iotex-core/action/protocol"
"github.com/iotexproject/iotex-core/action/protocol/vote/candidatesutil"
"github.com/iotexproject/iotex-core/config"
"github.com/iotexproject/iotex-core/db"
"github.com/iotexproject/iotex-core/pkg/hash"
"github.com/iotexproject/iotex-core/pkg/log"
"github.com/iotexproject/iotex-core/pkg/prometheustimer"
"github.com/iotexproject/iotex-core/pkg/util/byteutil"
"github.com/iotexproject/iotex-core/state"
)
// stateDB implements StateFactory interface, tracks changes to account/contract and batch-commits to DB
type stateDB struct {
mutex sync.RWMutex
currentChainHeight uint64
dao db.KVStore // the underlying DB for account/contract storage
actionHandlers []protocol.ActionHandler // the handlers to handle actions
timerFactory *prometheustimer.TimerFactory
}
// StateDBOption sets stateDB construction parameter
type StateDBOption func(*stateDB, config.Config) error
// DefaultStateDBOption creates trie from config for state db
func DefaultStateDBOption() StateDBOption {
return func(sdb *stateDB, cfg config.Config) (err error) {
dbPath := cfg.Chain.TrieDBPath
if len(dbPath) == 0 {
return errors.New("Invalid empty trie db path")
}
cfg.DB.DbPath = dbPath // TODO: remove this after moving TrieDBPath from cfg.Chain to cfg.DB
sdb.dao = db.NewOnDiskDB(cfg.DB)
return nil
}
}
// InMemStateDBOption creates in memory trie for state db
func InMemStateDBOption() StateDBOption {
return func(sdb *stateDB, cfg config.Config) (err error) {
sdb.dao = db.NewMemKVStore()
return nil
}
}
// NewStateDB creates a new state db
func NewStateDB(cfg config.Config, opts ...StateDBOption) (Factory, error) {
sdb := stateDB{
currentChainHeight: 0,
}
for _, opt := range opts {
if err := opt(&sdb, cfg); err != nil {
log.S().Errorf("Failed to execute state factory creation option %p: %v", opt, err)
return nil, err
}
}
timerFactory, err := prometheustimer.New(
"iotex_statefactory_perf",
"Performance of state factory module",
[]string{"topic", "chainID"},
[]string{"default", strconv.FormatUint(uint64(cfg.Chain.ID), 10)},
)
if err != nil {
log.L().Error("Failed to generate prometheus timer factory.", zap.Error(err))
}
sdb.timerFactory = timerFactory
return &sdb, nil
}
func (sdb *stateDB) Start(ctx context.Context) error {
sdb.mutex.Lock()
defer sdb.mutex.Unlock()
return sdb.dao.Start(ctx)
}
func (sdb *stateDB) Stop(ctx context.Context) error {
sdb.mutex.Lock()
defer sdb.mutex.Unlock()
return sdb.dao.Stop(ctx)
}
// AddActionHandlers adds action handlers to the state factory
func (sdb *stateDB) AddActionHandlers(actionHandlers ...protocol.ActionHandler) {
sdb.mutex.Lock()
defer sdb.mutex.Unlock()
sdb.actionHandlers = append(sdb.actionHandlers, actionHandlers...)
}
//======================================
// account functions
//======================================
// Balance returns balance
func (sdb *stateDB) Balance(addr string) (*big.Int, error) {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
account, err := sdb.accountState(addr)
if err != nil {
return nil, err
}
return account.Balance, nil
}
// Nonce returns the Nonce if the account exists
func (sdb *stateDB) Nonce(addr string) (uint64, error) {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
account, err := sdb.accountState(addr)
if err != nil {
return 0, err
}
return account.Nonce, nil
}
// AccountState returns the confirmed account state on the chain
func (sdb *stateDB) AccountState(addr string) (*state.Account, error) {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
return sdb.accountState(addr)
}
// RootHash returns the hash of the root node of the state trie
func (sdb *stateDB) RootHash() hash.Hash256 { return hash.ZeroHash256 }
// RootHashByHeight returns the hash of the root node of the state trie at a given height
func (sdb *stateDB) RootHashByHeight(blockHeight uint64) (hash.Hash256, error) {
return hash.ZeroHash256, nil
}
// Height returns factory's height
func (sdb *stateDB) Height() (uint64, error) {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
height, err := sdb.dao.Get(AccountKVNameSpace, []byte(CurrentHeightKey))
if err != nil {
return 0, errors.Wrap(err, "failed to get factory's height from underlying DB")
}
return byteutil.BytesToUint64(height), nil
}
func (sdb *stateDB) NewWorkingSet() (WorkingSet, error) {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
return newStateTX(sdb.currentChainHeight, sdb.dao, sdb.actionHandlers), nil
}
// Commit persists all changes in RunActions() into the DB
func (sdb *stateDB) Commit(ws WorkingSet) error {
if ws == nil {
return errors.New("working set doesn't exist")
}
sdb.mutex.Lock()
defer sdb.mutex.Unlock()
timer := sdb.timerFactory.NewTimer("Commit")
defer timer.End()
if sdb.currentChainHeight != ws.Version() {
// another working set with correct version already committed, do nothing
return fmt.Errorf(
"current state height %d doesn't match working set version %d",
sdb.currentChainHeight,
ws.Version(),
)
}
if err := ws.Commit(); err != nil {
return errors.Wrap(err, "failed to commit working set")
}
// Update chain height
sdb.currentChainHeight = ws.Height()
return nil
}
//======================================
// Candidate functions
//======================================
// CandidatesByHeight returns array of Candidates in candidate pool of a given height
func (sdb *stateDB) CandidatesByHeight(height uint64) ([]*state.Candidate, error) {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
var candidates state.CandidateList
// Load Candidates on the given height from underlying db
candidatesKey := candidatesutil.ConstructKey(height)
err := sdb.state(candidatesKey, &candidates)
log.L().Debug(
"CandidatesByHeight",
zap.Uint64("height", height),
zap.Any("candidates", candidates),
zap.Error(err),
)
if errors.Cause(err) == nil {
if len(candidates) > 0 {
return candidates, nil
}
err = state.ErrStateNotExist
}
return nil, errors.Wrapf(
err,
"failed to get state of candidateList for height %d",
height,
)
}
// State returns a confirmed state in the state factory
func (sdb *stateDB) State(addr hash.Hash160, state interface{}) error {
sdb.mutex.RLock()
defer sdb.mutex.RUnlock()
return sdb.state(addr, state)
}
//======================================
// private trie constructor functions
//======================================
func (sdb *stateDB) state(addr hash.Hash160, s interface{}) error {
data, err := sdb.dao.Get(AccountKVNameSpace, addr[:])
if err != nil {
if errors.Cause(err) == db.ErrNotExist {
return errors.Wrapf(state.ErrStateNotExist, "state of %x doesn't exist", addr)
}
return errors.Wrapf(err, "error when getting the state of %x", addr)
}
if err := state.Deserialize(s, data); err != nil {
return errors.Wrapf(err, "error when deserializing state data into %T", s)
}
return nil
}
func (sdb *stateDB) accountState(encodedAddr string) (*state.Account, error) {
// TODO: state db shouldn't serve this function
addr, err := address.FromString(encodedAddr)
if err != nil {
return nil, err
}
pkHash := hash.BytesToHash160(addr.Bytes())
if err != nil {
return nil, errors.Wrap(err, "error when getting the pubkey hash")
}
var account state.Account
if err := sdb.state(pkHash, &account); err != nil {
if errors.Cause(err) == state.ErrStateNotExist {
account = state.EmptyAccount()
return &account, nil
}
return nil, errors.Wrapf(err, "error when loading state of %x", pkHash)
}
return &account, nil
}