hermez-node/synchronizer/synchronizer.go
synchronizer/synchronizer.goRaw
1package synchronizer
2
3import (
4 "context"
5 "database/sql"
6 "fmt"
7 "math/big"
8 "sync"
9 "time"
10
11 "github.com/ethereum/go-ethereum"
12 "github.com/hermeznetwork/hermez-node/common"
13 "github.com/hermeznetwork/hermez-node/db/historydb"
14 "github.com/hermeznetwork/hermez-node/db/statedb"
15 "github.com/hermeznetwork/hermez-node/eth"
16 "github.com/hermeznetwork/hermez-node/log"
17 "github.com/hermeznetwork/tracerr"
18)
19
20// Stats of the syncrhonizer
21type Stats struct {
22 Eth struct {
23 RefreshPeriod time.Duration
24 Updated time.Time
25 FirstBlockNum int64
26 LastBlock common.Block
27 LastBatch int64
28 }
29 Sync struct {
30 Updated time.Time
31 LastBlock common.Block
32 LastBatch int64
33 // LastL1BatchBlock is the last ethereum block in which an
34 // l1Batch was forged
35 LastL1BatchBlock int64
36 LastForgeL1TxsNum int64
37 Auction struct {
38 CurrentSlot common.Slot
39 }
40 }
41}
42
43// Synced returns true if the Synchronizer is up to date with the last ethereum block
44func (s *Stats) Synced() bool {
45 return s.Eth.LastBlock.Num == s.Sync.LastBlock.Num
46}
47
48// TODO(Edu): Consider removing all the mutexes from StatsHolder, make
49// Synchronizer.Stats not thread-safe, don't pass the synchronizer to the
50// debugAPI, and have a copy of the Stats in the DebugAPI that the node passes
51// when the Sync updates.
52
53// StatsHolder stores stats and that allows reading and writing them
54// concurrently
55type StatsHolder struct {
56 Stats
57 rw sync.RWMutex
58}
59
60// NewStatsHolder creates a new StatsHolder
61func NewStatsHolder(firstBlockNum int64, refreshPeriod time.Duration) *StatsHolder {
62 stats := Stats{}
63 stats.Eth.RefreshPeriod = refreshPeriod
64 stats.Eth.FirstBlockNum = firstBlockNum
65 return &StatsHolder{Stats: stats}
66}
67
68// UpdateCurrentSlot updates the auction stats
69func (s *StatsHolder) UpdateCurrentSlot(slot common.Slot) {
70 s.rw.Lock()
71 s.Sync.Auction.CurrentSlot = slot
72 s.rw.Unlock()
73}
74
75// UpdateSync updates the synchronizer stats
76func (s *StatsHolder) UpdateSync(lastBlock *common.Block, lastBatch *common.BatchNum,
77 lastL1BatchBlock *int64, lastForgeL1TxsNum *int64) {
78 now := time.Now()
79 s.rw.Lock()
80 s.Sync.LastBlock = *lastBlock
81 if lastBatch != nil {
82 s.Sync.LastBatch = int64(*lastBatch)
83 }
84 if lastL1BatchBlock != nil {
85 s.Sync.LastL1BatchBlock = *lastL1BatchBlock
86 s.Sync.LastForgeL1TxsNum = *lastForgeL1TxsNum
87 }
88 s.Sync.Updated = now
89 s.rw.Unlock()
90}
91
92// UpdateEth updates the ethereum stats, only if the previous stats expired
93func (s *StatsHolder) UpdateEth(ethClient eth.ClientInterface) error {
94 now := time.Now()
95 s.rw.RLock()
96 elapsed := now.Sub(s.Eth.Updated)
97 s.rw.RUnlock()
98 if elapsed < s.Eth.RefreshPeriod {
99 return nil
100 }
101
102 lastBlock, err := ethClient.EthBlockByNumber(context.TODO(), -1)
103 if err != nil {
104 return tracerr.Wrap(err)
105 }
106 lastBatch, err := ethClient.RollupLastForgedBatch()
107 if err != nil {
108 return tracerr.Wrap(err)
109 }
110 s.rw.Lock()
111 s.Eth.Updated = now
112 s.Eth.LastBlock = *lastBlock
113 s.Eth.LastBatch = lastBatch
114 s.rw.Unlock()
115 return nil
116}
117
118// CopyStats returns a copy of the inner Stats
119func (s *StatsHolder) CopyStats() *Stats {
120 s.rw.RLock()
121 sCopy := s.Stats
122 if s.Sync.Auction.CurrentSlot.BidValue != nil {
123 sCopy.Sync.Auction.CurrentSlot.BidValue =
124 common.CopyBigInt(s.Sync.Auction.CurrentSlot.BidValue)
125 }
126 if s.Sync.Auction.CurrentSlot.DefaultSlotBid != nil {
127 sCopy.Sync.Auction.CurrentSlot.DefaultSlotBid =
128 common.CopyBigInt(s.Sync.Auction.CurrentSlot.DefaultSlotBid)
129 }
130 s.rw.RUnlock()
131 return &sCopy
132}
133
134func (s *StatsHolder) blocksPerc() float64 {
135 syncLastBlockNum := s.Sync.LastBlock.Num
136 if s.Sync.LastBlock.Num == 0 {
137 syncLastBlockNum = s.Eth.FirstBlockNum - 1
138 }
139 return float64(syncLastBlockNum-(s.Eth.FirstBlockNum-1)) * 100.0 /
140 float64(s.Eth.LastBlock.Num-(s.Eth.FirstBlockNum-1))
141}
142
143func (s *StatsHolder) batchesPerc(batchNum int64) float64 {
144 return float64(batchNum) * 100.0 /
145 float64(s.Eth.LastBatch)
146}
147
148// StartBlockNums sets the first block used to start tracking the smart
149// contracts
150type StartBlockNums struct {
151 Rollup int64
152 Auction int64
153 WDelayer int64
154}
155
156// SCVariables joins all the smart contract variables in a single struct
157type SCVariables struct {
158 Rollup common.RollupVariables `validate:"required"`
159 Auction common.AuctionVariables `validate:"required"`
160 WDelayer common.WDelayerVariables `validate:"required"`
161}
162
163// SCVariablesPtr joins all the smart contract variables as pointers in a single
164// struct
165type SCVariablesPtr struct {
166 Rollup *common.RollupVariables `validate:"required"`
167 Auction *common.AuctionVariables `validate:"required"`
168 WDelayer *common.WDelayerVariables `validate:"required"`
169}
170
171// SCConsts joins all the smart contract constants in a single struct
172type SCConsts struct {
173 Rollup common.RollupConstants
174 Auction common.AuctionConstants
175 WDelayer common.WDelayerConstants
176}
177
178// Config is the Synchronizer configuration
179type Config struct {
180 // StartBlockNum StartBlockNum
181 // InitialVariables SCVariables
182 StatsRefreshPeriod time.Duration
183}
184
185// Synchronizer implements the Synchronizer type
186type Synchronizer struct {
187 ethClient eth.ClientInterface
188 // auctionConstants common.AuctionConstants
189 // rollupConstants common.RollupConstants
190 // wDelayerConstants common.WDelayerConstants
191 consts SCConsts
192 historyDB *historydb.HistoryDB
193 stateDB *statedb.StateDB
194 cfg Config
195 initVars SCVariables
196 startBlockNum int64
197 vars SCVariables
198 stats *StatsHolder
199 // firstSavedBlock *common.Block
200 // mux sync.Mutex
201}
202
203// NewSynchronizer creates a new Synchronizer
204func NewSynchronizer(ethClient eth.ClientInterface, historyDB *historydb.HistoryDB,
205 stateDB *statedb.StateDB, cfg Config) (*Synchronizer, error) {
206 auctionConstants, err := ethClient.AuctionConstants()
207 if err != nil {
208 return nil, tracerr.Wrap(fmt.Errorf("NewSynchronizer ethClient.AuctionConstants(): %w",
209 err))
210 }
211 rollupConstants, err := ethClient.RollupConstants()
212 if err != nil {
213 return nil, tracerr.Wrap(fmt.Errorf("NewSynchronizer ethClient.RollupConstants(): %w",
214 err))
215 }
216 wDelayerConstants, err := ethClient.WDelayerConstants()
217 if err != nil {
218 return nil, tracerr.Wrap(fmt.Errorf("NewSynchronizer ethClient.WDelayerConstants(): %w",
219 err))
220 }
221 consts := SCConsts{
222 Rollup: *rollupConstants,
223 Auction: *auctionConstants,
224 WDelayer: *wDelayerConstants,
225 }
226
227 initVars, startBlockNums, err := getInitialVariables(ethClient, &consts)
228 if err != nil {
229 return nil, tracerr.Wrap(err)
230 }
231 log.Infow("Synchronizer syncing from smart contract blocks",
232 "rollup", startBlockNums.Rollup,
233 "auction", startBlockNums.Auction,
234 "wdelayer", startBlockNums.WDelayer,
235 )
236 // Set startBlockNum to the minimum between Auction, Rollup and
237 // WDelayer StartBlockNum
238 startBlockNum := startBlockNums.Auction
239 if startBlockNums.Rollup < startBlockNum {
240 startBlockNum = startBlockNums.Rollup
241 }
242 if startBlockNums.WDelayer < startBlockNum {
243 startBlockNum = startBlockNums.WDelayer
244 }
245 stats := NewStatsHolder(startBlockNum, cfg.StatsRefreshPeriod)
246 s := &Synchronizer{
247 ethClient: ethClient,
248 consts: consts,
249 historyDB: historyDB,
250 stateDB: stateDB,
251 cfg: cfg,
252 initVars: *initVars,
253 startBlockNum: startBlockNum,
254 stats: stats,
255 }
256 return s, s.init()
257}
258
259// Stats returns a copy of the Synchronizer Stats. It is safe to call Stats()
260// during a Sync call
261func (s *Synchronizer) Stats() *Stats {
262 return s.stats.CopyStats()
263}
264
265// AuctionConstants returns the AuctionConstants read from the smart contract
266func (s *Synchronizer) AuctionConstants() *common.AuctionConstants {
267 return &s.consts.Auction
268}
269
270// RollupConstants returns the RollupConstants read from the smart contract
271func (s *Synchronizer) RollupConstants() *common.RollupConstants {
272 return &s.consts.Rollup
273}
274
275// WDelayerConstants returns the WDelayerConstants read from the smart contract
276func (s *Synchronizer) WDelayerConstants() *common.WDelayerConstants {
277 return &s.consts.WDelayer
278}
279
280// SCVars returns a copy of the Smart Contract Variables
281func (s *Synchronizer) SCVars() SCVariablesPtr {
282 return SCVariablesPtr{
283 Rollup: s.vars.Rollup.Copy(),
284 Auction: s.vars.Auction.Copy(),
285 WDelayer: s.vars.WDelayer.Copy(),
286 }
287}
288
289func (s *Synchronizer) updateCurrentSlotIfSync(batchesLen int) error {
290 slot := common.Slot{
291 SlotNum: s.stats.Sync.Auction.CurrentSlot.SlotNum,
292 BatchesLen: int(s.stats.Sync.Auction.CurrentSlot.BatchesLen),
293 }
294 // We want the next block because the current one is already mined
295 blockNum := s.stats.Sync.LastBlock.Num + 1
296 slotNum := s.consts.Auction.SlotNum(blockNum)
297 if batchesLen == -1 {
298 dbBatchesLen, err := s.historyDB.GetBatchesLen(slotNum)
299 if err != nil {
300 return tracerr.Wrap(fmt.Errorf("historyDB.GetBatchesLen: %w", err))
301 }
302 slot.BatchesLen = dbBatchesLen
303 } else if slotNum > slot.SlotNum {
304 slot.BatchesLen = batchesLen
305 } else {
306 slot.BatchesLen += batchesLen
307 }
308 slot.SlotNum = slotNum
309 slot.StartBlock, slot.EndBlock = s.consts.Auction.SlotBlocks(slot.SlotNum)
310 // If Synced, update the current coordinator
311 if s.stats.Synced() && blockNum >= s.consts.Auction.GenesisBlockNum {
312 bidCoord, err := s.historyDB.GetBestBidCoordinator(slot.SlotNum)
313 if err != nil && tracerr.Unwrap(err) != sql.ErrNoRows {
314 return tracerr.Wrap(err)
315 }
316 if tracerr.Unwrap(err) == sql.ErrNoRows {
317 slot.BootCoord = true
318 slot.Forger = s.vars.Auction.BootCoordinator
319 slot.URL = s.vars.Auction.BootCoordinatorURL
320 } else if err == nil {
321 slot.BidValue = bidCoord.BidValue
322 slot.DefaultSlotBid = bidCoord.DefaultSlotSetBid[slot.SlotNum%6]
323 // Only if the highest bid value is higher than the
324 // default slot bid, the bidder is the winner of the
325 // slot. Otherwise the boot coordinator is the winner.
326 if slot.BidValue.Cmp(slot.DefaultSlotBid) >= 0 {
327 slot.Bidder = bidCoord.Bidder
328 slot.Forger = bidCoord.Forger
329 slot.URL = bidCoord.URL
330 } else {
331 slot.BootCoord = true
332 slot.Forger = s.vars.Auction.BootCoordinator
333 slot.URL = s.vars.Auction.BootCoordinatorURL
334 }
335 }
336
337 // TODO: Remove this SANITY CHECK once this code is tested enough
338 // BEGIN SANITY CHECK
339 canForge, err := s.ethClient.AuctionCanForge(slot.Forger, blockNum)
340 if err != nil {
341 return tracerr.Wrap(err)
342 }
343 if !canForge {
344 return tracerr.Wrap(fmt.Errorf("Synchronized value of forger address for closed slot "+
345 "differs from smart contract: %+v", slot))
346 }
347 // END SANITY CHECK
348 }
349 s.stats.UpdateCurrentSlot(slot)
350 return nil
351}
352
353func (s *Synchronizer) init() error {
354 // Update stats parameters so that they have valid values before the
355 // first Sync call
356 if err := s.stats.UpdateEth(s.ethClient); err != nil {
357 return tracerr.Wrap(err)
358 }
359 lastBlock := &common.Block{}
360 lastSavedBlock, err := s.historyDB.GetLastBlock()
361 if err != nil && tracerr.Unwrap(err) != sql.ErrNoRows {
362 return tracerr.Wrap(err)
363 }
364 // If there's no block in the DB (or we only have the default block 0),
365 // make sure that the stateDB is clean
366 if tracerr.Unwrap(err) == sql.ErrNoRows || lastSavedBlock.Num == 0 {
367 if err := s.stateDB.Reset(0); err != nil {
368 return tracerr.Wrap(err)
369 }
370 } else {
371 lastBlock = lastSavedBlock
372 }
373 if err := s.resetState(lastBlock); err != nil {
374 return tracerr.Wrap(err)
375 }
376
377 log.Infow("Sync init block",
378 "syncLastBlock", s.stats.Sync.LastBlock,
379 "syncBlocksPerc", s.stats.blocksPerc(),
380 "ethFirstBlockNum", s.stats.Eth.FirstBlockNum,
381 "ethLastBlock", s.stats.Eth.LastBlock,
382 )
383 log.Infow("Sync init batch",
384 "syncLastBatch", s.stats.Sync.LastBatch,
385 "syncBatchesPerc", s.stats.batchesPerc(s.stats.Sync.LastBatch),
386 "ethLastBatch", s.stats.Eth.LastBatch,
387 )
388 return nil
389}
390
391// Sync2 attems to synchronize an ethereum block starting from lastSavedBlock.
392// If lastSavedBlock is nil, the lastSavedBlock value is obtained from de DB.
393// If a block is synched, it will be returned and also stored in the DB. If a
394// reorg is detected, the number of discarded blocks will be returned and no
395// synchronization will be made.
396// TODO: Be smart about locking: only lock during the read/write operations
397func (s *Synchronizer) Sync2(ctx context.Context, lastSavedBlock *common.Block) (*common.BlockData, *int64, error) {
398 var nextBlockNum int64 // next block number to sync
399 if lastSavedBlock == nil {
400 var err error
401 // Get lastSavedBlock from History DB
402 lastSavedBlock, err = s.historyDB.GetLastBlock()
403 if err != nil && tracerr.Unwrap(err) != sql.ErrNoRows {
404 return nil, nil, tracerr.Wrap(err)
405 }
406 // If we don't have any stored block, we must do a full sync
407 // starting from the startBlockNum
408 if tracerr.Unwrap(err) == sql.ErrNoRows || lastSavedBlock.Num == 0 {
409 nextBlockNum = s.startBlockNum
410 lastSavedBlock = nil
411 }
412 }
413 if lastSavedBlock != nil {
414 nextBlockNum = lastSavedBlock.Num + 1
415 if lastSavedBlock.Num < s.startBlockNum {
416 return nil, nil, tracerr.Wrap(
417 fmt.Errorf("lastSavedBlock (%v) < startBlockNum (%v)",
418 lastSavedBlock.Num, s.startBlockNum))
419 }
420 }
421
422 ethBlock, err := s.ethClient.EthBlockByNumber(ctx, nextBlockNum)
423 if tracerr.Unwrap(err) == ethereum.NotFound {
424 return nil, nil, nil
425 } else if err != nil {
426 return nil, nil, tracerr.Wrap(err)
427 }
428 log.Debugf("ethBlock: num: %v, parent: %v, hash: %v",
429 ethBlock.Num, ethBlock.ParentHash.String(), ethBlock.Hash.String())
430
431 if err := s.stats.UpdateEth(s.ethClient); err != nil {
432 return nil, nil, tracerr.Wrap(err)
433 }
434
435 log.Debugw("Syncing...",
436 "block", nextBlockNum,
437 "ethLastBlock", s.stats.Eth.LastBlock,
438 )
439
440 // Check that the obtianed ethBlock.ParentHash == prevEthBlock.Hash; if not, reorg!
441 if lastSavedBlock != nil {
442 if lastSavedBlock.Hash != ethBlock.ParentHash {
443 // Reorg detected
444 log.Debugw("Reorg Detected",
445 "blockNum", ethBlock.Num,
446 "block.parent(got)", ethBlock.ParentHash, "parent.hash(exp)", lastSavedBlock.Hash)
447 lastDBBlockNum, err := s.reorg(lastSavedBlock)
448 if err != nil {
449 return nil, nil, tracerr.Wrap(err)
450 }
451 discarded := lastSavedBlock.Num - lastDBBlockNum
452 return nil, &discarded, nil
453 }
454 }
455
456 // Get data from the rollup contract
457 rollupData, err := s.rollupSync(ethBlock)
458 if err != nil {
459 return nil, nil, tracerr.Wrap(err)
460 }
461
462 // Get data from the auction contract
463 auctionData, err := s.auctionSync(ethBlock)
464 if err != nil {
465 return nil, nil, tracerr.Wrap(err)
466 }
467
468 // Get data from the WithdrawalDelayer contract
469 wDelayerData, err := s.wdelayerSync(ethBlock)
470 if err != nil {
471 return nil, nil, tracerr.Wrap(err)
472 }
473
474 for i := range rollupData.Withdrawals {
475 withdrawal := &rollupData.Withdrawals[i]
476 if !withdrawal.InstantWithdraw {
477 wDelayerTransfers := wDelayerData.DepositsByTxHash[withdrawal.TxHash]
478 if len(wDelayerTransfers) == 0 {
479 return nil, nil, tracerr.Wrap(fmt.Errorf("WDelayer deposit corresponding to " +
480 "non-instant rollup withdrawal not found"))
481 }
482 // Pop the first wDelayerTransfer to consume them in chronological order
483 wDelayerTransfer := wDelayerTransfers[0]
484 wDelayerData.DepositsByTxHash[withdrawal.TxHash] =
485 wDelayerData.DepositsByTxHash[withdrawal.TxHash][1:]
486
487 withdrawal.Owner = wDelayerTransfer.Owner
488 withdrawal.Token = wDelayerTransfer.Token
489 }
490 }
491
492 // Group all the block data into the structs to save into HistoryDB
493 blockData := common.BlockData{
494 Block: *ethBlock,
495 Rollup: *rollupData,
496 Auction: *auctionData,
497 WDelayer: *wDelayerData,
498 }
499
500 // log.Debugw("Sync()", "block", blockData)
501 // err = s.historyDB.AddBlock(blockData.Block)
502 // if err != nil {
503 // return err
504 // }
505 err = s.historyDB.AddBlockSCData(&blockData)
506 if err != nil {
507 return nil, nil, tracerr.Wrap(err)
508 }
509
510 batchesLen := len(rollupData.Batches)
511 if batchesLen == 0 {
512 s.stats.UpdateSync(ethBlock, nil, nil, nil)
513 } else {
514 var lastL1BatchBlock *int64
515 var lastForgeL1TxsNum *int64
516 for _, batchData := range rollupData.Batches {
517 if batchData.L1Batch {
518 lastL1BatchBlock = &batchData.Batch.EthBlockNum
519 lastForgeL1TxsNum = batchData.Batch.ForgeL1TxsNum
520 }
521 }
522 s.stats.UpdateSync(ethBlock,
523 &rollupData.Batches[batchesLen-1].Batch.BatchNum, lastL1BatchBlock, lastForgeL1TxsNum)
524 }
525 if err := s.updateCurrentSlotIfSync(len(rollupData.Batches)); err != nil {
526 return nil, nil, tracerr.Wrap(err)
527 }
528
529 log.Debugw("Synced block",
530 "syncLastBlockNum", s.stats.Sync.LastBlock.Num,
531 "syncBlocksPerc", s.stats.blocksPerc(),
532 "ethLastBlockNum", s.stats.Eth.LastBlock.Num,
533 )
534 for _, batchData := range rollupData.Batches {
535 log.Debugw("Synced batch",
536 "syncLastBatch", batchData.Batch.BatchNum,
537 "syncBatchesPerc", s.stats.batchesPerc(int64(batchData.Batch.BatchNum)),
538 "ethLastBatch", s.stats.Eth.LastBatch,
539 )
540 }
541
542 return &blockData, nil, nil
543}
544
545// reorg manages a reorg, updating History and State DB as needed. Keeps
546// checking previous blocks from the HistoryDB against the blockchain until a
547// block hash match is found. All future blocks in the HistoryDB and
548// corresponding batches in StateBD are discarded. Returns the last valid
549// blockNum from the HistoryDB.
550func (s *Synchronizer) reorg(uncleBlock *common.Block) (int64, error) {
551 blockNum := uncleBlock.Num
552
553 var block *common.Block
554 for blockNum >= s.startBlockNum {
555 ethBlock, err := s.ethClient.EthBlockByNumber(context.Background(), blockNum)
556 if err != nil {
557 return 0, tracerr.Wrap(fmt.Errorf("ethClient.EthBlockByNumber: %w", err))
558 }
559
560 block, err = s.historyDB.GetBlock(blockNum)
561 if err != nil {
562 return 0, tracerr.Wrap(fmt.Errorf("historyDB.GetBlock: %w", err))
563 }
564 if block.Hash == ethBlock.Hash {
565 log.Debugf("Found valid block: %v", blockNum)
566 break
567 }
568 blockNum--
569 }
570 total := uncleBlock.Num - block.Num
571 log.Debugw("Discarding blocks", "total", total, "from", uncleBlock.Num, "to", block.Num+1)
572
573 // Set History DB and State DB to the correct state
574 err := s.historyDB.Reorg(block.Num)
575 if err != nil {
576 return 0, tracerr.Wrap(err)
577 }
578
579 if err := s.resetState(block); err != nil {
580 return 0, tracerr.Wrap(err)
581 }
582
583 return block.Num, nil
584}
585
586func getInitialVariables(ethClient eth.ClientInterface,
587 consts *SCConsts) (*SCVariables, *StartBlockNums, error) {
588 rollupInit, rollupInitBlock, err := ethClient.RollupEventInit()
589 if err != nil {
590 return nil, nil, tracerr.Wrap(err)
591 }
592 auctionInit, auctionInitBlock, err := ethClient.AuctionEventInit()
593 if err != nil {
594 return nil, nil, tracerr.Wrap(err)
595 }
596 wDelayerInit, wDelayerInitBlock, err := ethClient.WDelayerEventInit()
597 if err != nil {
598 return nil, nil, tracerr.Wrap(err)
599 }
600 rollupVars := rollupInit.RollupVariables()
601 auctionVars := auctionInit.AuctionVariables(consts.Auction.InitialMinimalBidding)
602 wDelayerVars := wDelayerInit.WDelayerVariables()
603 return &SCVariables{
604 Rollup: *rollupVars,
605 Auction: *auctionVars,
606 WDelayer: *wDelayerVars,
607 }, &StartBlockNums{
608 Rollup: rollupInitBlock,
609 Auction: auctionInitBlock,
610 WDelayer: wDelayerInitBlock,
611 }, nil
612}
613
614func (s *Synchronizer) resetState(block *common.Block) error {
615 rollup, auction, wDelayer, err := s.historyDB.GetSCVars()
616 // If SCVars are not in the HistoryDB, this is probably the first run
617 // of the Synchronizer: store the initial vars taken from config
618 if tracerr.Unwrap(err) == sql.ErrNoRows {
619 vars := s.initVars
620 log.Info("Setting initial SCVars in HistoryDB")
621 if err = s.historyDB.SetInitialSCVars(&vars.Rollup, &vars.Auction, &vars.WDelayer); err != nil {
622 return tracerr.Wrap(fmt.Errorf("historyDB.SetInitialSCVars: %w", err))
623 }
624 s.vars.Rollup = *vars.Rollup.Copy()
625 s.vars.Auction = *vars.Auction.Copy()
626 s.vars.WDelayer = *vars.WDelayer.Copy()
627 } else if err != nil {
628 return tracerr.Wrap(err)
629 } else {
630 s.vars.Rollup = *rollup
631 s.vars.Auction = *auction
632 s.vars.WDelayer = *wDelayer
633 }
634
635 batchNum, err := s.historyDB.GetLastBatchNum()
636 if err != nil && tracerr.Unwrap(err) != sql.ErrNoRows {
637 return tracerr.Wrap(fmt.Errorf("historyDB.GetLastBatchNum: %w", err))
638 }
639 if tracerr.Unwrap(err) == sql.ErrNoRows {
640 batchNum = 0
641 }
642
643 lastL1BatchBlockNum, err := s.historyDB.GetLastL1BatchBlockNum()
644 if err != nil && tracerr.Unwrap(err) != sql.ErrNoRows {
645 return tracerr.Wrap(fmt.Errorf("historyDB.GetLastL1BatchBlockNum: %w", err))
646 }
647 if tracerr.Unwrap(err) == sql.ErrNoRows {
648 lastL1BatchBlockNum = 0
649 }
650
651 lastForgeL1TxsNum, err := s.historyDB.GetLastL1TxsNum()
652 if err != nil && tracerr.Unwrap(err) != sql.ErrNoRows {
653 return tracerr.Wrap(fmt.Errorf("historyDB.GetLastL1BatchBlockNum: %w", err))
654 }
655 if tracerr.Unwrap(err) == sql.ErrNoRows || lastForgeL1TxsNum == nil {
656 n := int64(-1)
657 lastForgeL1TxsNum = &n
658 }
659
660 err = s.stateDB.Reset(batchNum)
661 if err != nil {
662 return tracerr.Wrap(fmt.Errorf("stateDB.Reset: %w", err))
663 }
664
665 s.stats.UpdateSync(block, &batchNum, &lastL1BatchBlockNum, lastForgeL1TxsNum)
666
667 if err := s.updateCurrentSlotIfSync(-1); err != nil {
668 return tracerr.Wrap(err)
669 }
670 return nil
671}
672
673// rollupSync retreives all the Rollup Smart Contract Data that happened at
674// ethBlock.blockNum with ethBlock.Hash.
675func (s *Synchronizer) rollupSync(ethBlock *common.Block) (*common.RollupData, error) {
676 blockNum := ethBlock.Num
677 var rollupData = common.NewRollupData()
678 // var forgeL1TxsNum int64
679
680 // Get rollup events in the block, and make sure the block hash matches
681 // the expected one.
682 rollupEvents, blockHash, err := s.ethClient.RollupEventsByBlock(blockNum)
683 if err != nil {
684 return nil, tracerr.Wrap(err)
685 }
686 // No events in this block
687 if blockHash == nil {
688 return &rollupData, nil
689 }
690 if *blockHash != ethBlock.Hash {
691 log.Errorw("Block hash mismatch in Rollup events", "expected", ethBlock.Hash.String(),
692 "got", blockHash.String())
693 return nil, tracerr.Wrap(eth.ErrBlockHashMismatchEvent)
694 }
695
696 var nextForgeL1TxsNum int64 // forgeL1TxsNum for the next L1Batch
697 nextForgeL1TxsNumPtr, err := s.historyDB.GetLastL1TxsNum()
698 if err != nil {
699 return nil, tracerr.Wrap(err)
700 }
701 if nextForgeL1TxsNumPtr != nil {
702 nextForgeL1TxsNum = *nextForgeL1TxsNumPtr + 1
703 } else {
704 nextForgeL1TxsNum = 0
705 }
706
707 // Get L1UserTX
708 rollupData.L1UserTxs, err = getL1UserTx(rollupEvents.L1UserTx, blockNum)
709 if err != nil {
710 return nil, tracerr.Wrap(err)
711 }
712
713 // Get ForgeBatch events to get the L1CoordinatorTxs
714 for _, evtForgeBatch := range rollupEvents.ForgeBatch {
715 batchData := common.NewBatchData()
716 position := 0
717
718 // Get the input for each Tx
719 forgeBatchArgs, sender, err := s.ethClient.RollupForgeBatchArgs(evtForgeBatch.EthTxHash,
720 evtForgeBatch.L1UserTxsLen)
721 if err != nil {
722 return nil, tracerr.Wrap(err)
723 }
724
725 batchNum := common.BatchNum(evtForgeBatch.BatchNum)
726 var l1UserTxs []common.L1Tx
727 // Check if this is a L1Batch to get L1 Tx from it
728 if forgeBatchArgs.L1Batch {
729 // Get L1UserTxs with toForgeL1TxsNum, which correspond
730 // to the L1UserTxs that are forged in this batch, so
731 // that stateDB can process them.
732
733 // First try to find them in HistoryDB.
734 l1UserTxs, err = s.historyDB.GetUnforgedL1UserTxs(nextForgeL1TxsNum)
735 if err != nil {
736 return nil, tracerr.Wrap(err)
737 }
738 // Apart from the DB, try to find them in this block.
739 // This could happen because in a block there could be
740 // multiple batches with L1Batch = true (although it's
741 // a very rare case). If not found in the DB and the
742 // block doesn't contain the l1UserTxs, it means that
743 // the L1UserTxs queue with toForgeL1TxsNum was closed
744 // empty, so we leave `l1UserTxs` as an empty slice.
745 for _, l1UserTx := range rollupData.L1UserTxs {
746 if *l1UserTx.ToForgeL1TxsNum == nextForgeL1TxsNum {
747 l1UserTxs = append(l1UserTxs, l1UserTx)
748 }
749 }
750
751 position = len(l1UserTxs)
752 }
753 // Get L1 Coordinator Txs
754 for i := range forgeBatchArgs.L1CoordinatorTxs {
755 l1CoordinatorTx := forgeBatchArgs.L1CoordinatorTxs[i]
756 l1CoordinatorTx.Position = position
757 // l1CoordinatorTx.ToForgeL1TxsNum = &forgeL1TxsNum
758 l1CoordinatorTx.UserOrigin = false
759 l1CoordinatorTx.EthBlockNum = blockNum
760 l1CoordinatorTx.BatchNum = &batchNum
761 l1Tx, err := common.NewL1Tx(&l1CoordinatorTx)
762 if err != nil {
763 return nil, tracerr.Wrap(err)
764 }
765
766 batchData.L1CoordinatorTxs = append(batchData.L1CoordinatorTxs, *l1Tx)
767 position++
768 // fmt.Println("DGB l1coordtx")
769 }
770
771 // Insert all the txs forged in this batch (l1UserTxs,
772 // L1CoordinatorTxs, PoolL2Txs) into stateDB so that they are
773 // processed.
774
775 // Set TxType to the forged L2Txs
776 for i := range forgeBatchArgs.L2TxsData {
777 if err := forgeBatchArgs.L2TxsData[i].SetType(); err != nil {
778 return nil, tracerr.Wrap(err)
779 }
780 }
781
782 // Transform L2 txs to PoolL2Txs
783 poolL2Txs := common.L2TxsToPoolL2Txs(forgeBatchArgs.L2TxsData) // NOTE: This is a big ugly, find a better way
784
785 // ProcessTxs updates poolL2Txs adding: Nonce (and also TokenID, but we don't use it).
786 //nolint:gomnd
787 ptc := statedb.ProcessTxsConfig{ // TODO TMP
788 NLevels: 32,
789 MaxFeeTx: 64,
790 MaxTx: 512,
791 MaxL1Tx: 64,
792 }
793 processTxsOut, err := s.stateDB.ProcessTxs(ptc, forgeBatchArgs.FeeIdxCoordinator,
794 l1UserTxs, batchData.L1CoordinatorTxs, poolL2Txs)
795 if err != nil {
796 return nil, tracerr.Wrap(err)
797 }
798
799 // Transform processed PoolL2 txs to L2 and store in BatchData
800 l2Txs, err := common.PoolL2TxsToL2Txs(poolL2Txs) // NOTE: This is a big uggly, find a better way
801 if err != nil {
802 return nil, tracerr.Wrap(err)
803 }
804
805 // Set TxID, BlockNum, BatchNum and Position to the forged L2Txs
806 for i := range l2Txs {
807 if err := l2Txs[i].SetID(); err != nil {
808 return nil, tracerr.Wrap(err)
809 }
810 l2Txs[i].EthBlockNum = blockNum
811 l2Txs[i].BatchNum = batchNum
812 l2Txs[i].Position = position
813 position++
814 }
815 batchData.L2Txs = l2Txs
816
817 // Set the BatchNum in the forged L1UserTxs
818 for i := range l1UserTxs {
819 l1UserTxs[i].BatchNum = &batchNum
820 }
821 batchData.L1UserTxs = l1UserTxs
822
823 // Set batchNum in exits
824 for i := range processTxsOut.ExitInfos {
825 exit := &processTxsOut.ExitInfos[i]
826 exit.BatchNum = batchNum
827 }
828 batchData.ExitTree = processTxsOut.ExitInfos
829
830 for i := range processTxsOut.CreatedAccounts {
831 createdAccount := &processTxsOut.CreatedAccounts[i]
832 createdAccount.Nonce = 0
833 createdAccount.Balance = big.NewInt(0)
834 createdAccount.BatchNum = batchNum
835 }
836 batchData.CreatedAccounts = processTxsOut.CreatedAccounts
837
838 slotNum := int64(0)
839 if ethBlock.Num >= s.consts.Auction.GenesisBlockNum {
840 slotNum = (ethBlock.Num - s.consts.Auction.GenesisBlockNum) /
841 int64(s.consts.Auction.BlocksPerSlot)
842 }
843
844 // Get Batch information
845 batch := common.Batch{
846 BatchNum: batchNum,
847 EthBlockNum: blockNum,
848 ForgerAddr: *sender,
849 CollectedFees: processTxsOut.CollectedFees,
850 FeeIdxsCoordinator: forgeBatchArgs.FeeIdxCoordinator,
851 StateRoot: forgeBatchArgs.NewStRoot,
852 NumAccounts: len(batchData.CreatedAccounts),
853 LastIdx: forgeBatchArgs.NewLastIdx,
854 ExitRoot: forgeBatchArgs.NewExitRoot,
855 SlotNum: slotNum,
856 }
857 nextForgeL1TxsNumCpy := nextForgeL1TxsNum
858 if forgeBatchArgs.L1Batch {
859 batch.ForgeL1TxsNum = &nextForgeL1TxsNumCpy
860 batchData.L1Batch = true
861 nextForgeL1TxsNum++
862 }
863 batchData.Batch = batch
864 rollupData.Batches = append(rollupData.Batches, *batchData)
865 }
866
867 // Get Registered Tokens
868 for _, evtAddToken := range rollupEvents.AddToken {
869 var token common.Token
870
871 token.TokenID = common.TokenID(evtAddToken.TokenID)
872 token.EthAddr = evtAddToken.TokenAddress
873 token.EthBlockNum = blockNum
874
875 if consts, err := s.ethClient.EthERC20Consts(evtAddToken.TokenAddress); err != nil {
876 log.Warnw("Error retreiving ERC20 token constants", "addr", evtAddToken.TokenAddress)
877 token.Name = "ERC20_ETH_ERROR"
878 token.Symbol = "ERROR"
879 token.Decimals = 1
880 } else {
881 token.Name = cutStringMax(consts.Name, 20)
882 token.Symbol = cutStringMax(consts.Symbol, 10)
883 token.Decimals = consts.Decimals
884 }
885
886 rollupData.AddedTokens = append(rollupData.AddedTokens, token)
887 }
888
889 for _, evt := range rollupEvents.UpdateBucketWithdraw {
890 rollupData.UpdateBucketWithdraw = append(rollupData.UpdateBucketWithdraw,
891 common.BucketUpdate{
892 EthBlockNum: blockNum,
893 NumBucket: evt.NumBucket,
894 BlockStamp: evt.BlockStamp,
895 Withdrawals: evt.Withdrawals,
896 })
897 }
898
899 for _, evt := range rollupEvents.Withdraw {
900 rollupData.Withdrawals = append(rollupData.Withdrawals, common.WithdrawInfo{
901 Idx: common.Idx(evt.Idx),
902 NumExitRoot: common.BatchNum(evt.NumExitRoot),
903 InstantWithdraw: evt.InstantWithdraw,
904 TxHash: evt.TxHash,
905 })
906 }
907
908 for _, evt := range rollupEvents.UpdateTokenExchange {
909 if len(evt.AddressArray) != len(evt.ValueArray) {
910 return nil, tracerr.Wrap(fmt.Errorf("in RollupEventUpdateTokenExchange "+
911 "len(AddressArray) != len(ValueArray) (%v != %v)",
912 len(evt.AddressArray), len(evt.ValueArray)))
913 }
914 for i := range evt.AddressArray {
915 rollupData.TokenExchanges = append(rollupData.TokenExchanges,
916 common.TokenExchange{
917 EthBlockNum: blockNum,
918 Address: evt.AddressArray[i],
919 ValueUSD: int64(evt.ValueArray[i]),
920 })
921 }
922 }
923
924 varsUpdate := false
925
926 for _, evt := range rollupEvents.UpdateForgeL1L2BatchTimeout {
927 s.vars.Rollup.ForgeL1L2BatchTimeout = evt.NewForgeL1L2BatchTimeout
928 varsUpdate = true
929 }
930
931 for _, evt := range rollupEvents.UpdateFeeAddToken {
932 s.vars.Rollup.FeeAddToken = evt.NewFeeAddToken
933 varsUpdate = true
934 }
935
936 for _, evt := range rollupEvents.UpdateWithdrawalDelay {
937 s.vars.Rollup.WithdrawalDelay = evt.NewWithdrawalDelay
938 varsUpdate = true
939 }
940
941 // NOTE: We skip the event rollupEvents.SafeMode because the
942 // implementation RollupEventsByBlock already inserts a non-existing
943 // RollupEventUpdateBucketsParameters into UpdateBucketsParameters with
944 // all the bucket values at 0 and SafeMode = true
945
946 for _, evt := range rollupEvents.UpdateBucketsParameters {
947 for i, bucket := range evt.ArrayBuckets {
948 s.vars.Rollup.Buckets[i] = common.BucketParams{
949 CeilUSD: bucket.CeilUSD,
950 Withdrawals: bucket.Withdrawals,
951 BlockWithdrawalRate: bucket.BlockWithdrawalRate,
952 MaxWithdrawals: bucket.MaxWithdrawals,
953 }
954 }
955 s.vars.Rollup.SafeMode = evt.SafeMode
956 varsUpdate = true
957 }
958
959 if varsUpdate {
960 s.vars.Rollup.EthBlockNum = blockNum
961 rollupData.Vars = s.vars.Rollup.Copy()
962 }
963
964 return &rollupData, nil
965}
966
967func cutStringMax(s string, max int) string {
968 if len(s) > max {
969 return s[:max]
970 }
971 return s
972}
973
974// auctionSync gets information from the Auction Contract
975func (s *Synchronizer) auctionSync(ethBlock *common.Block) (*common.AuctionData, error) {
976 blockNum := ethBlock.Num
977 var auctionData = common.NewAuctionData()
978
979 // Get auction events in the block
980 auctionEvents, blockHash, err := s.ethClient.AuctionEventsByBlock(blockNum)
981 if err != nil {
982 return nil, tracerr.Wrap(err)
983 }
984 // No events in this block
985 if blockHash == nil {
986 return &auctionData, nil
987 }
988 if *blockHash != ethBlock.Hash {
989 log.Errorw("Block hash mismatch in Auction events", "expected", ethBlock.Hash.String(),
990 "got", blockHash.String())
991 return nil, tracerr.Wrap(eth.ErrBlockHashMismatchEvent)
992 }
993
994 // Get bids
995 for _, evt := range auctionEvents.NewBid {
996 bid := common.Bid{
997 SlotNum: evt.Slot,
998 BidValue: evt.BidAmount,
999 Bidder: evt.Bidder,
1000 EthBlockNum: blockNum,
1001 }
1002 auctionData.Bids = append(auctionData.Bids, bid)
1003 }
1004
1005 // Get Coordinators
1006 for _, evt := range auctionEvents.SetCoordinator {
1007 coordinator := common.Coordinator{
1008 Bidder: evt.BidderAddress,
1009 Forger: evt.ForgerAddress,
1010 URL: evt.CoordinatorURL,
1011 EthBlockNum: blockNum,
1012 }
1013 auctionData.Coordinators = append(auctionData.Coordinators, coordinator)
1014 }
1015
1016 varsUpdate := false
1017
1018 for _, evt := range auctionEvents.NewSlotDeadline {
1019 s.vars.Auction.SlotDeadline = evt.NewSlotDeadline
1020 varsUpdate = true
1021 }
1022 for _, evt := range auctionEvents.NewClosedAuctionSlots {
1023 s.vars.Auction.ClosedAuctionSlots = evt.NewClosedAuctionSlots
1024 varsUpdate = true
1025 }
1026 for _, evt := range auctionEvents.NewOutbidding {
1027 s.vars.Auction.Outbidding = evt.NewOutbidding
1028 varsUpdate = true
1029 }
1030 for _, evt := range auctionEvents.NewDonationAddress {
1031 s.vars.Auction.DonationAddress = evt.NewDonationAddress
1032 varsUpdate = true
1033 }
1034 for _, evt := range auctionEvents.NewBootCoordinator {
1035 s.vars.Auction.BootCoordinator = evt.NewBootCoordinator
1036 s.vars.Auction.BootCoordinatorURL = evt.NewBootCoordinatorURL
1037 varsUpdate = true
1038 }
1039 for _, evt := range auctionEvents.NewOpenAuctionSlots {
1040 s.vars.Auction.OpenAuctionSlots = evt.NewOpenAuctionSlots
1041 varsUpdate = true
1042 }
1043 for _, evt := range auctionEvents.NewAllocationRatio {
1044 s.vars.Auction.AllocationRatio = evt.NewAllocationRatio
1045 varsUpdate = true
1046 }
1047 for _, evt := range auctionEvents.NewDefaultSlotSetBid {
1048 if evt.SlotSet > 6 { //nolint:gomnd
1049 return nil, tracerr.Wrap(fmt.Errorf("unexpected SlotSet in "+
1050 "auctionEvents.NewDefaultSlotSetBid: %v", evt.SlotSet))
1051 }
1052 s.vars.Auction.DefaultSlotSetBid[evt.SlotSet] = evt.NewInitialMinBid
1053 s.vars.Auction.DefaultSlotSetBidSlotNum = s.consts.Auction.SlotNum(blockNum) +
1054 int64(s.vars.Auction.ClosedAuctionSlots) + 1
1055 varsUpdate = true
1056 }
1057
1058 // NOTE: We ignore NewForgeAllocated
1059 // NOTE: We ignore NewForge because we're already tracking ForgeBatch event from Rollup
1060 // NOTE: We ignore HEZClaimed
1061
1062 if varsUpdate {
1063 s.vars.Auction.EthBlockNum = blockNum
1064 auctionData.Vars = s.vars.Auction.Copy()
1065 }
1066
1067 return &auctionData, nil
1068}
1069
1070// wdelayerSync gets information from the Withdrawal Delayer Contract
1071func (s *Synchronizer) wdelayerSync(ethBlock *common.Block) (*common.WDelayerData, error) {
1072 blockNum := ethBlock.Num
1073 wDelayerData := common.NewWDelayerData()
1074
1075 // Get wDelayer events in the block
1076 wDelayerEvents, blockHash, err := s.ethClient.WDelayerEventsByBlock(blockNum)
1077 if err != nil {
1078 return nil, tracerr.Wrap(err)
1079 }
1080 // No events in this block
1081 if blockHash == nil {
1082 return &wDelayerData, nil
1083 }
1084 if *blockHash != ethBlock.Hash {
1085 log.Errorw("Block hash mismatch in WDelayer events", "expected", ethBlock.Hash.String(),
1086 "got", blockHash.String())
1087 return nil, tracerr.Wrap(eth.ErrBlockHashMismatchEvent)
1088 }
1089
1090 for _, evt := range wDelayerEvents.Deposit {
1091 wDelayerData.Deposits = append(wDelayerData.Deposits, common.WDelayerTransfer{
1092 Owner: evt.Owner,
1093 Token: evt.Token,
1094 Amount: evt.Amount,
1095 })
1096 wDelayerData.DepositsByTxHash[evt.TxHash] =
1097 append(wDelayerData.DepositsByTxHash[evt.TxHash],
1098 &wDelayerData.Deposits[len(wDelayerData.Deposits)-1])
1099 }
1100 for _, evt := range wDelayerEvents.Withdraw {
1101 wDelayerData.Withdrawals = append(wDelayerData.Withdrawals, common.WDelayerTransfer{
1102 Owner: evt.Owner,
1103 Token: evt.Token,
1104 Amount: evt.Amount,
1105 })
1106 }
1107 for _, evt := range wDelayerEvents.EscapeHatchWithdrawal {
1108 wDelayerData.EscapeHatchWithdrawals = append(wDelayerData.EscapeHatchWithdrawals,
1109 common.WDelayerEscapeHatchWithdrawal{
1110 EthBlockNum: blockNum,
1111 Who: evt.Who,
1112 To: evt.To,
1113 TokenAddr: evt.Token,
1114 Amount: evt.Amount,
1115 })
1116 }
1117
1118 varsUpdate := false
1119
1120 for range wDelayerEvents.EmergencyModeEnabled {
1121 s.vars.WDelayer.EmergencyMode = true
1122 s.vars.WDelayer.EmergencyModeStartingBlock = blockNum
1123 varsUpdate = true
1124 }
1125 for _, evt := range wDelayerEvents.NewWithdrawalDelay {
1126 s.vars.WDelayer.WithdrawalDelay = evt.WithdrawalDelay
1127 varsUpdate = true
1128 }
1129 for _, evt := range wDelayerEvents.NewEmergencyCouncil {
1130 s.vars.WDelayer.EmergencyCouncilAddress = evt.NewEmergencyCouncil
1131 varsUpdate = true
1132 }
1133 for _, evt := range wDelayerEvents.NewHermezGovernanceAddress {
1134 s.vars.WDelayer.HermezGovernanceAddress = evt.NewHermezGovernanceAddress
1135 varsUpdate = true
1136 }
1137
1138 if varsUpdate {
1139 s.vars.WDelayer.EthBlockNum = blockNum
1140 wDelayerData.Vars = s.vars.WDelayer.Copy()
1141 }
1142
1143 return &wDelayerData, nil
1144}
1145
1146func getL1UserTx(eventsL1UserTx []eth.RollupEventL1UserTx, blockNum int64) ([]common.L1Tx, error) {
1147 l1Txs := make([]common.L1Tx, len(eventsL1UserTx))
1148 for i := range eventsL1UserTx {
1149 eventsL1UserTx[i].L1UserTx.EthBlockNum = blockNum
1150 // Check validity of L1UserTx
1151 l1Tx, err := common.NewL1Tx(&eventsL1UserTx[i].L1UserTx)
1152 if err != nil {
1153 return nil, tracerr.Wrap(err)
1154 }
1155 l1Txs[i] = *l1Tx
1156 }
1157 return l1Txs, nil
1158}