forked from ChainSafe/gossamer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
service.go
363 lines (294 loc) · 9.13 KB
/
service.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
// Copyright 2021 ChainSafe Systems (ON)
// SPDX-License-Identifier: LGPL-3.0-only
package state
import (
"fmt"
"path/filepath"
"github.com/ChainSafe/gossamer/dot/state/pruner"
"github.com/ChainSafe/gossamer/dot/types"
"github.com/ChainSafe/gossamer/internal/database"
"github.com/ChainSafe/gossamer/internal/log"
"github.com/ChainSafe/gossamer/internal/metrics"
"github.com/ChainSafe/gossamer/lib/blocktree"
"github.com/ChainSafe/gossamer/pkg/trie"
inmemory_trie "github.com/ChainSafe/gossamer/pkg/trie/inmemory"
)
var logger = log.NewFromGlobal(
log.AddContext("pkg", "state"),
)
// Service is the struct that holds storage, block and network states
type Service struct {
dbPath string
logLvl log.Level
db database.Database
isMemDB bool // set to true if using an in-memory database; only used for testing.
Base *BaseState
Storage *InmemoryStorageState
Block *BlockState
Transaction *TransactionState
Epoch *EpochState
Grandpa *GrandpaState
Slot *SlotState
closeCh chan interface{}
genesisBABEConfig *types.BabeConfiguration
PrunerCfg pruner.Config
Telemetry Telemetry
// Below are for testing only.
BabeThresholdNumerator uint64
BabeThresholdDenominator uint64
}
// Pause Pauses the state service
func (s *Service) Pause() error {
return s.Block.Pause()
}
// Config is the default configuration used by state service.
type Config struct {
Path string
LogLevel log.Level
PrunerCfg pruner.Config
Telemetry Telemetry
Metrics metrics.IntervalConfig
GenesisBABEConfig *types.BabeConfiguration
}
// NewService create a new instance of Service
func NewService(config Config) *Service {
logger.Patch(log.SetLevel(config.LogLevel))
return &Service{
dbPath: config.Path,
logLvl: config.LogLevel,
db: nil,
isMemDB: false,
Storage: nil,
Block: nil,
closeCh: make(chan interface{}),
PrunerCfg: config.PrunerCfg,
Telemetry: config.Telemetry,
genesisBABEConfig: config.GenesisBABEConfig,
}
}
// UseMemDB tells the service to use an in-memory key-value store instead of a persistent database.
// This should be called after NewService, and before Initialise.
// This should only be used for testing.
func (s *Service) UseMemDB() {
s.isMemDB = true
}
// DB returns the Service's database
func (s *Service) DB() database.Database {
return s.db
}
// SetupBase intitializes state.Base property with
// the instance of a chain.NewBadger database
func (s *Service) SetupBase() error {
if s.isMemDB {
return nil
}
basepath, err := filepath.Abs(s.dbPath)
if err != nil {
return err
}
// initialise database
db, err := database.LoadDatabase(basepath, false)
if err != nil {
return err
}
s.db = db
s.Base = NewBaseState(db)
return nil
}
// Start initialises the Storage database and the Block database.
func (s *Service) Start() (err error) {
if !s.isMemDB && (s.Storage != nil || s.Block != nil || s.Epoch != nil || s.Grandpa != nil) {
return nil
}
tries := NewTries()
tries.SetEmptyTrie()
// create block state
s.Block, err = NewBlockState(s.db, tries, s.Telemetry)
if err != nil {
return fmt.Errorf("failed to create block state: %w", err)
}
// retrieve latest header
bestHeader, err := s.Block.GetHighestFinalisedHeader()
if err != nil {
return fmt.Errorf("failed to get best block hash: %w", err)
}
stateRoot := bestHeader.StateRoot
logger.Debugf("start with latest state root: %s", stateRoot)
// create storage state
s.Storage, err = NewStorageState(s.db, s.Block, tries)
if err != nil {
return fmt.Errorf("failed to create storage state: %w", err)
}
// load current storage state trie into memory
_, err = s.Storage.LoadFromDB(stateRoot)
if err != nil {
return fmt.Errorf("failed to load storage trie from database: %w", err)
}
// create transaction queue
s.Transaction = NewTransactionState(s.Telemetry)
// create epoch and slot state
s.Slot = NewSlotState(s.db)
s.Epoch, err = NewEpochState(s.db, s.Block, s.genesisBABEConfig)
if err != nil {
return fmt.Errorf("failed to create epoch state: %w", err)
}
s.Grandpa = NewGrandpaState(s.db, s.Block, s.Telemetry)
num, _ := s.Block.BestBlockNumber()
logger.Infof(
"created state service with head %s, highest number %d and genesis hash %s",
s.Block.BestBlockHash(), num, s.Block.genesisHash.String())
return nil
}
// Rewind rewinds the chain to the given block number.
// If the given number of blocks is greater than the chain height, it will rewind to genesis.
func (s *Service) Rewind(toBlock uint) error {
num, _ := s.Block.BestBlockNumber()
if toBlock > num {
return fmt.Errorf("cannot rewind, given height is higher than our current height")
}
logger.Infof(
"rewinding state from current height %s to desired height %d...",
num, toBlock)
root, err := s.Block.GetBlockByNumber(toBlock)
if err != nil {
return err
}
s.Block.bt = blocktree.NewBlockTreeFromRoot(&root.Header)
header, err := s.Block.BestBlockHeader()
if err != nil {
return err
}
s.Block.lastFinalised = header.Hash()
logger.Infof(
"rewinding state for new height %s and best block hash %s...",
header.Number, header.Hash())
epoch, err := s.Epoch.GetEpochForBlock(header)
if err != nil {
return err
}
err = s.Epoch.StoreCurrentEpoch(epoch)
if err != nil {
return err
}
s.Block.lastFinalised = header.Hash()
// TODO: this is broken, it needs to set the latest finalised header after
// rewinding to some block number, but there is no reverse lookup function
// for block -> (round, setID) where it was finalised (#1859)
err = s.Block.SetFinalisedHash(header.Hash(), 0, 0)
if err != nil {
return err
}
// update the current grandpa set ID
prevSetID, err := s.Grandpa.GetCurrentSetID()
if err != nil {
return err
}
newSetID, err := s.Grandpa.GetSetIDByBlockNumber(header.Number)
if err != nil {
return err
}
err = s.Grandpa.setCurrentSetID(newSetID)
if err != nil {
return err
}
// remove previously set grandpa changes, need to go up to prevSetID+1 in case of a scheduled change
for i := newSetID + 1; i <= prevSetID+1; i++ {
err = s.Grandpa.db.Del(setIDChangeKey(i))
if err != nil {
return err
}
}
return nil
}
// Stop closes each state database
func (s *Service) Stop() error {
close(s.closeCh)
hash, err := s.Block.GetHighestFinalisedHash()
if err != nil {
return err
}
logger.Debugf("stop with best finalised hash %s", hash)
if err = s.db.Flush(); err != nil {
return err
}
return s.db.Close()
}
// Import imports the given state corresponding to the given header and sets the head of the chain
// to it. Additionally, it uses the first slot to correctly set the epoch number of the block.
func (s *Service) Import(header *types.Header, t trie.Trie,
stateTrieVersion trie.TrieLayout, firstSlot uint64) error {
var err error
// initialise database using data directory
if !s.isMemDB {
s.db, err = database.LoadDatabase(s.dbPath, s.isMemDB)
if err != nil {
return fmt.Errorf("failed to create database: %w", err)
}
}
block := &BlockState{
bt: blocktree.NewEmptyBlockTree(),
db: database.NewTable(s.db, blockPrefix),
unfinalisedBlocks: newHashToBlockMap(),
}
storage := &InmemoryStorageState{
db: database.NewTable(s.db, storagePrefix),
}
epoch, err := NewEpochState(s.db, block, s.genesisBABEConfig)
if err != nil {
return err
}
s.Base = NewBaseState(s.db)
blockEpoch, err := getEpochForBlockHeader(header, epoch.epochLength, firstSlot)
if err != nil {
return err
}
skipTo := blockEpoch + 1
if err := s.Base.storeSkipToEpoch(skipTo); err != nil {
return err
}
logger.Debugf("skip BABE verification up to epoch %d", skipTo)
if err := epoch.StoreCurrentEpoch(blockEpoch); err != nil {
return err
}
root := stateTrieVersion.MustHash(t)
if root != header.StateRoot {
return fmt.Errorf("trie state root does not equal header state root")
}
logger.Info("importing storage trie from base path " +
s.dbPath + " with root " + root.String() + "...")
// TODO: all trie related db operations should be done in pkg/trie
if inmemoryTrie, ok := t.(*inmemory_trie.InMemoryTrie); ok {
if err := inmemoryTrie.WriteDirty(storage.db); err != nil {
return err
}
}
hash := header.Hash()
if err := block.SetHeader(header); err != nil {
return err
}
// TODO: this is broken, need to know round and setID for the header as well
if err := block.db.Put(finalisedHashKey(0, 0), hash[:]); err != nil {
return err
}
if err := block.setHighestRoundAndSetID(0, 0); err != nil {
return err
}
logger.Debugf(
"Import best block hash %s with latest state root %s",
hash, root)
if err := s.db.Flush(); err != nil {
return err
}
logger.Info("finished state import")
if s.isMemDB {
return nil
}
return s.db.Close()
}
func getEpochForBlockHeader(header *types.Header, epochLength, chainFirstSlotNumber uint64) (uint64, error) {
slotNumber, err := header.SlotNumber()
if err != nil {
return 0, fmt.Errorf("getting slot number: %w", err)
}
return (slotNumber - chainFirstSlotNumber) / epochLength, nil
}