-
Notifications
You must be signed in to change notification settings - Fork 668
/
dbmanager.go
576 lines (499 loc) · 17.8 KB
/
dbmanager.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
package sequencer
import (
"context"
"errors"
"fmt"
"math/big"
"time"
"github.com/0xPolygonHermez/zkevm-node/log"
"github.com/0xPolygonHermez/zkevm-node/pool"
"github.com/0xPolygonHermez/zkevm-node/pool/pgpoolstorage"
"github.com/0xPolygonHermez/zkevm-node/state"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/jackc/pgx/v4"
)
const (
wait time.Duration = 5
)
// Pool Loader and DB Updater
type dbManager struct {
txPool txPool
state dbManagerStateInterface
worker workerInterface
txsStore TxsStore
l2ReorgCh chan L2ReorgEvent
ctx context.Context
batchConstraints batchConstraints
numberOfReorgs uint64
}
func (d *dbManager) GetBatchByNumber(ctx context.Context, batchNumber uint64, dbTx pgx.Tx) (*state.Batch, error) {
return d.state.GetBatchByNumber(ctx, batchNumber, dbTx)
}
// ClosingBatchParameters contains the necessary parameters to close a batch
type ClosingBatchParameters struct {
BatchNumber uint64
StateRoot common.Hash
LocalExitRoot common.Hash
AccInputHash common.Hash
Txs []types.Transaction
}
func newDBManager(ctx context.Context, txPool txPool, state dbManagerStateInterface, worker *Worker, closingSignalCh ClosingSignalCh, txsStore TxsStore, batchConstraints batchConstraints) *dbManager {
numberOfReorgs, err := state.CountReorgs(ctx, nil)
if err != nil {
log.Error("failed to get number of reorgs: %v", err)
}
return &dbManager{ctx: ctx, txPool: txPool, state: state, worker: worker, txsStore: txsStore, l2ReorgCh: closingSignalCh.L2ReorgCh, batchConstraints: batchConstraints, numberOfReorgs: numberOfReorgs}
}
// Start stars the dbManager routines
func (d *dbManager) Start() {
go d.loadFromPool()
go d.storeProcessedTxAndDeleteFromPool()
}
// GetLastBatchNumber get the latest batch number from state
func (d *dbManager) GetLastBatchNumber(ctx context.Context) (uint64, error) {
return d.state.GetLastBatchNumber(ctx, nil)
}
// OpenBatch opens a new batch to star processing transactions
func (d *dbManager) OpenBatch(ctx context.Context, processingContext state.ProcessingContext, dbTx pgx.Tx) error {
return d.state.OpenBatch(ctx, processingContext, dbTx)
}
// CreateFirstBatch is using during genesis
func (d *dbManager) CreateFirstBatch(ctx context.Context, sequencerAddress common.Address) state.ProcessingContext {
processingCtx := state.ProcessingContext{
BatchNumber: 1,
Coinbase: sequencerAddress,
Timestamp: time.Now(),
GlobalExitRoot: state.ZeroHash,
}
dbTx, err := d.state.BeginStateTransaction(ctx)
if err != nil {
log.Errorf("failed to begin state transaction for opening a batch, err: %v", err)
return processingCtx
}
err = d.state.OpenBatch(ctx, processingCtx, dbTx)
if err != nil {
if rollbackErr := dbTx.Rollback(ctx); rollbackErr != nil {
log.Errorf(
"failed to rollback dbTx when opening batch that gave err: %v. Rollback err: %v",
rollbackErr, err,
)
}
log.Errorf("failed to open a batch, err: %v", err)
return processingCtx
}
if err := dbTx.Commit(ctx); err != nil {
log.Errorf("failed to commit dbTx when opening batch, err: %v", err)
return processingCtx
}
return processingCtx
}
// loadFromPool keeps loading transactions from the pool
func (d *dbManager) loadFromPool() {
for {
// TODO: Move this to a config parameter
time.Sleep(wait * time.Second)
poolTransactions, err := d.txPool.GetNonWIPPendingTxs(d.ctx, false, 0)
if err != nil && err != pgpoolstorage.ErrNotFound {
log.Errorf("load tx from pool: %v", err)
}
for _, tx := range poolTransactions {
err := d.addTxToWorker(tx, false)
if err != nil {
log.Errorf("error adding transaction to worker: %v", err)
}
}
poolClaims, err := d.txPool.GetNonWIPPendingTxs(d.ctx, true, 0)
if err != nil && err != pgpoolstorage.ErrNotFound {
log.Errorf("load claims from pool: %v", err)
}
for _, tx := range poolClaims {
err := d.addTxToWorker(tx, true)
if err != nil {
log.Errorf("error adding claim to worker: %v", err)
}
}
}
}
func (d *dbManager) addTxToWorker(tx pool.Transaction, isClaim bool) error {
txTracker, err := d.worker.NewTxTracker(tx.Transaction, isClaim, tx.ZKCounters)
if err != nil {
return err
}
d.worker.AddTx(d.ctx, txTracker)
return d.txPool.UpdateTxWIPStatus(d.ctx, tx.Hash(), true)
}
// BeginStateTransaction starts a db transaction in the state
func (d *dbManager) BeginStateTransaction(ctx context.Context) (pgx.Tx, error) {
return d.state.BeginStateTransaction(ctx)
}
// StoreProcessedTransaction stores a transaction in the state
func (d *dbManager) StoreProcessedTransaction(ctx context.Context, batchNumber uint64, processedTx *state.ProcessTransactionResponse, coinbase common.Address, timestamp uint64, dbTx pgx.Tx) error {
return d.state.StoreTransaction(ctx, batchNumber, processedTx, coinbase, timestamp, dbTx)
}
// DeleteTransactionFromPool deletes a transaction from the pool
func (d *dbManager) DeleteTransactionFromPool(ctx context.Context, txHash common.Hash) error {
return d.txPool.DeleteTransactionByHash(ctx, txHash)
}
// storeProcessedTxAndDeleteFromPool stores a tx into the state and changes it status in the pool
func (d *dbManager) storeProcessedTxAndDeleteFromPool() {
// TODO: Finish the retry mechanism and error handling
for {
numberOfReorgs, err := d.state.CountReorgs(d.ctx, nil)
if err != nil {
log.Error("failed to get number of reorgs: %v", err)
}
if numberOfReorgs != d.numberOfReorgs {
log.Warnf("New L2 reorg detected")
d.l2ReorgCh <- L2ReorgEvent{}
d.txsStore.Wg.Done()
continue
}
txToStore := <-d.txsStore.Ch
log.Debugf("Storing tx %v", txToStore.txResponse.TxHash)
dbTx, err := d.BeginStateTransaction(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool: %v", err)
}
err = d.StoreProcessedTransaction(d.ctx, txToStore.batchNumber, txToStore.txResponse, txToStore.coinbase, txToStore.timestamp, dbTx)
if err != nil {
err = dbTx.Rollback(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool: %v", err)
}
d.txsStore.Wg.Done()
continue
}
// Update batch l2 data
batch, err := d.state.GetBatchByNumber(d.ctx, txToStore.batchNumber, dbTx)
if err != nil {
err = dbTx.Rollback(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool: %v", err)
}
d.txsStore.Wg.Done()
continue
}
txData, err := state.EncodeTransaction(txToStore.txResponse.Tx)
if err != nil {
err = dbTx.Rollback(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool: %v", err)
}
d.txsStore.Wg.Done()
continue
}
batch.BatchL2Data = append(batch.BatchL2Data, txData...)
err = d.state.UpdateBatchL2Data(d.ctx, txToStore.batchNumber, batch.BatchL2Data, dbTx)
if err != nil {
err = dbTx.Rollback(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool: %v", err)
}
d.txsStore.Wg.Done()
continue
}
// Change Tx status to selected
err = d.txPool.UpdateTxStatus(d.ctx, txToStore.txResponse.TxHash, pool.TxStatusSelected, false)
if err != nil {
err = dbTx.Rollback(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool: %v", err)
}
d.txsStore.Wg.Done()
continue
}
err = dbTx.Commit(d.ctx)
if err != nil {
log.Errorf("StoreProcessedTxAndDeleteFromPool error committing : %v", err)
}
d.txsStore.Wg.Done()
}
}
// GetWIPBatch returns ready WIP batch
func (d *dbManager) GetWIPBatch(ctx context.Context) (*WipBatch, error) {
const two = 2
var lastBatch, previousLastBatch *state.Batch
dbTx, err := d.BeginStateTransaction(ctx)
if err != nil {
return nil, err
}
defer func() {
err := dbTx.Commit(ctx)
if err != nil {
log.Errorf("failed to commit GetWIPBatch: %v", err)
}
}()
lastBatches, err := d.state.GetLastNBatches(ctx, two, dbTx)
if err != nil {
return nil, err
}
lastBatch = lastBatches[0]
if len(lastBatches) > 1 {
previousLastBatch = lastBatches[1]
}
lastBatchTxs, _, err := state.DecodeTxs(lastBatch.BatchL2Data)
if err != nil {
return nil, err
}
lastBatch.Transactions = lastBatchTxs
lastStateRoot, err := d.state.GetLastStateRoot(ctx, dbTx)
if err != nil {
return nil, err
}
wipBatch := &WipBatch{
batchNumber: lastBatch.BatchNumber,
coinbase: lastBatch.Coinbase,
localExitRoot: lastBatch.LocalExitRoot,
timestamp: uint64(lastBatch.Timestamp.Unix()),
globalExitRoot: lastBatch.GlobalExitRoot,
countOfTxs: len(lastBatch.Transactions),
}
// Init counters to MAX values
var totalBytes uint64 = d.batchConstraints.MaxBatchBytesSize
var batchZkCounters state.ZKCounters = state.ZKCounters{
CumulativeGasUsed: d.batchConstraints.MaxCumulativeGasUsed,
UsedKeccakHashes: d.batchConstraints.MaxKeccakHashes,
UsedPoseidonHashes: d.batchConstraints.MaxPoseidonHashes,
UsedPoseidonPaddings: d.batchConstraints.MaxPoseidonPaddings,
UsedMemAligns: d.batchConstraints.MaxMemAligns,
UsedArithmetics: d.batchConstraints.MaxArithmetics,
UsedBinaries: d.batchConstraints.MaxBinaries,
UsedSteps: d.batchConstraints.MaxSteps,
}
isClosed, err := d.IsBatchClosed(ctx, lastBatch.BatchNumber)
if err != nil {
return nil, err
}
if isClosed {
wipBatch.batchNumber = lastBatch.BatchNumber + 1
wipBatch.stateRoot = lastBatch.StateRoot
wipBatch.initialStateRoot = lastBatch.StateRoot
processingContext := &state.ProcessingContext{
BatchNumber: wipBatch.batchNumber,
Coinbase: wipBatch.coinbase,
Timestamp: time.Unix(int64(wipBatch.timestamp), 0),
GlobalExitRoot: wipBatch.globalExitRoot,
}
err = d.state.OpenBatch(ctx, *processingContext, dbTx)
if err != nil {
if rollbackErr := dbTx.Rollback(ctx); rollbackErr != nil {
log.Errorf(
"failed to rollback dbTx when opening batch that gave err: %v. Rollback err: %v",
rollbackErr, err,
)
}
log.Errorf("failed to open a batch, err: %v", err)
return nil, err
}
if err := dbTx.Commit(ctx); err != nil {
log.Errorf("failed to commit dbTx when opening batch, err: %v", err)
return nil, err
}
} else {
wipBatch.stateRoot = lastStateRoot
wipBatch.initialStateRoot = previousLastBatch.StateRoot
batchL2DataLen := len(lastBatch.BatchL2Data)
if batchL2DataLen > 0 {
wipBatch.countOfTxs = len(lastBatch.Transactions)
batchToExecute := *lastBatch
batchToExecute.BatchNumber = wipBatch.batchNumber
batchResponse, err := d.state.ExecuteBatch(ctx, batchToExecute, false, dbTx)
if err != nil {
return nil, err
}
zkCounters := &state.ZKCounters{
CumulativeGasUsed: batchResponse.GetCumulativeGasUsed(),
UsedKeccakHashes: batchResponse.CntKeccakHashes,
UsedPoseidonHashes: batchResponse.CntPoseidonHashes,
UsedPoseidonPaddings: batchResponse.CntPoseidonPaddings,
UsedMemAligns: batchResponse.CntMemAligns,
UsedArithmetics: batchResponse.CntArithmetics,
UsedBinaries: batchResponse.CntBinaries,
UsedSteps: batchResponse.CntSteps,
}
err = batchZkCounters.Sub(*zkCounters)
if err != nil {
return nil, err
}
totalBytes -= uint64(batchL2DataLen)
} else {
wipBatch.countOfTxs = 0
}
}
wipBatch.remainingResources = batchResources{zKCounters: batchZkCounters, bytes: totalBytes}
return wipBatch, nil
}
// GetLastClosedBatch gets the latest closed batch from state
func (d *dbManager) GetLastClosedBatch(ctx context.Context) (*state.Batch, error) {
return d.state.GetLastClosedBatch(ctx, nil)
}
// GetLastBatch gets the latest batch from state
func (d *dbManager) GetLastBatch(ctx context.Context) (*state.Batch, error) {
batch, err := d.state.GetLastBatch(d.ctx, nil)
if err != nil {
return nil, err
}
return batch, nil
}
// IsBatchClosed checks if a batch is closed
func (d *dbManager) IsBatchClosed(ctx context.Context, batchNum uint64) (bool, error) {
return d.state.IsBatchClosed(ctx, batchNum, nil)
}
// GetLastNBatches gets the latest N batches from state
func (d *dbManager) GetLastNBatches(ctx context.Context, numBatches uint) ([]*state.Batch, error) {
return d.state.GetLastNBatches(ctx, numBatches, nil)
}
// GetLatestGer gets the latest global exit root
func (d *dbManager) GetLatestGer(ctx context.Context, gerFinalityNumberOfBlocks uint64) (state.GlobalExitRoot, time.Time, error) {
lastBlock, err := d.state.GetLastBlock(ctx, nil)
if err != nil {
return state.GlobalExitRoot{}, time.Time{}, fmt.Errorf("failed to get latest eth block number, err: %w", err)
}
blockNumber := lastBlock.BlockNumber
maxBlockNumber := uint64(0)
if gerFinalityNumberOfBlocks <= blockNumber {
maxBlockNumber = blockNumber - gerFinalityNumberOfBlocks
}
ger, receivedAt, err := d.state.GetLatestGlobalExitRoot(ctx, maxBlockNumber, nil)
if err != nil && errors.Is(err, state.ErrNotFound) {
return state.GlobalExitRoot{}, time.Time{}, nil
} else if err != nil {
return state.GlobalExitRoot{}, time.Time{}, fmt.Errorf("failed to get latest global exit root, err: %w", err)
} else {
return ger, receivedAt, nil
}
}
// CloseBatch closes a batch in the state
func (d *dbManager) CloseBatch(ctx context.Context, params ClosingBatchParameters) error {
processingReceipt := state.ProcessingReceipt{
BatchNumber: params.BatchNumber,
StateRoot: params.StateRoot,
LocalExitRoot: params.LocalExitRoot,
AccInputHash: params.AccInputHash,
}
batchL2Data, err := state.EncodeTransactions(params.Txs)
if err != nil {
return err
}
processingReceipt.BatchL2Data = batchL2Data
dbTx, err := d.BeginStateTransaction(ctx)
if err != nil {
return err
}
err = d.state.CloseBatch(ctx, processingReceipt, dbTx)
if err != nil {
err2 := dbTx.Rollback(ctx)
if err2 != nil {
log.Errorf("CloseBatch error rolling back: %v", err2)
}
return err
} else {
err := dbTx.Commit(ctx)
if err != nil {
log.Errorf("CloseBatch error committing: %v", err)
return err
}
}
return nil
}
// ProcessForcedBatch process a forced batch
func (d *dbManager) ProcessForcedBatch(forcedBatchNum uint64, request state.ProcessRequest) (*state.ProcessBatchResponse, error) {
// Open Batch
processingCtx := state.ProcessingContext{
BatchNumber: request.BatchNumber,
Coinbase: request.Coinbase,
Timestamp: time.Unix(int64(request.Timestamp), 0),
GlobalExitRoot: request.GlobalExitRoot,
ForcedBatchNum: &forcedBatchNum,
}
dbTx, err := d.state.BeginStateTransaction(d.ctx)
if err != nil {
log.Errorf("failed to begin state transaction for opening a forced batch, err: %v", err)
return nil, err
}
err = d.state.OpenBatch(d.ctx, processingCtx, dbTx)
if err != nil {
if rollbackErr := dbTx.Rollback(d.ctx); rollbackErr != nil {
log.Errorf(
"failed to rollback dbTx when opening a forced batch that gave err: %v. Rollback err: %v",
rollbackErr, err,
)
}
log.Errorf("failed to open a batch, err: %v", err)
return nil, err
}
// Fetch Forced Batch
forcedBatch, err := d.state.GetForcedBatch(d.ctx, forcedBatchNum, dbTx)
if err != nil {
if rollbackErr := dbTx.Rollback(d.ctx); rollbackErr != nil {
log.Errorf(
"failed to rollback dbTx when getting forced batch err: %v. Rollback err: %v",
rollbackErr, err,
)
}
log.Errorf("failed to get a forced batch, err: %v", err)
return nil, err
}
// Process Batch
processBatchResponse, err := d.state.ProcessSequencerBatch(d.ctx, request.BatchNumber, forcedBatch.RawTxsData, request.Caller, dbTx)
if err != nil {
log.Errorf("failed to process a forced batch, err: %v", err)
}
// Close Batch
processingReceipt := state.ProcessingReceipt{
BatchNumber: request.BatchNumber,
StateRoot: processBatchResponse.NewStateRoot,
LocalExitRoot: processBatchResponse.NewLocalExitRoot,
AccInputHash: processBatchResponse.NewAccInputHash,
BatchL2Data: forcedBatch.RawTxsData,
}
isClosed := false
tryToCloseAndCommit := true
for tryToCloseAndCommit {
if !isClosed {
closingErr := d.state.CloseBatch(d.ctx, processingReceipt, dbTx)
tryToCloseAndCommit = closingErr != nil
if tryToCloseAndCommit {
continue
}
isClosed = true
}
if err := dbTx.Commit(d.ctx); err != nil {
log.Errorf("failed to commit dbTx when processing a forced batch, err: %v", err)
}
tryToCloseAndCommit = err != nil
}
return processBatchResponse, nil
}
// GetForcedBatchesSince gets L1 forced batches since timestamp
func (d *dbManager) GetForcedBatchesSince(ctx context.Context, forcedBatchNumber, maxBlockNumber uint64, dbTx pgx.Tx) ([]*state.ForcedBatch, error) {
return d.state.GetForcedBatchesSince(ctx, forcedBatchNumber, maxBlockNumber, dbTx)
}
// GetLastL2BlockHeader gets the last l2 block number
func (d *dbManager) GetLastL2BlockHeader(ctx context.Context, dbTx pgx.Tx) (*types.Header, error) {
return d.state.GetLastL2BlockHeader(ctx, dbTx)
}
func (d *dbManager) GetLastBlock(ctx context.Context, dbTx pgx.Tx) (*state.Block, error) {
return d.state.GetLastBlock(ctx, dbTx)
}
func (d *dbManager) GetLastTrustedForcedBatchNumber(ctx context.Context, dbTx pgx.Tx) (uint64, error) {
return d.state.GetLastTrustedForcedBatchNumber(ctx, dbTx)
}
func (d *dbManager) GetBalanceByStateRoot(ctx context.Context, address common.Address, root common.Hash) (*big.Int, error) {
return d.state.GetBalanceByStateRoot(ctx, address, root)
}
func (d *dbManager) GetTransactionsByBatchNumber(ctx context.Context, batchNumber uint64) (txs []types.Transaction, err error) {
return d.state.GetTransactionsByBatchNumber(ctx, batchNumber, nil)
}
func (d *dbManager) UpdateTxStatus(ctx context.Context, hash common.Hash, newStatus pool.TxStatus, isWIP bool) error {
return d.txPool.UpdateTxStatus(ctx, hash, newStatus, isWIP)
}
// GetLatestVirtualBatchTimestamp gets last virtual batch timestamp
func (d *dbManager) GetLatestVirtualBatchTimestamp(ctx context.Context, dbTx pgx.Tx) (time.Time, error) {
return d.state.GetLatestVirtualBatchTimestamp(ctx, dbTx)
}
// CountReorgs returns the number of reorgs
func (d *dbManager) CountReorgs(ctx context.Context, dbTx pgx.Tx) (uint64, error) {
return d.state.CountReorgs(ctx, dbTx)
}