-
Notifications
You must be signed in to change notification settings - Fork 0
/
scanner.go
611 lines (469 loc) · 14.4 KB
/
scanner.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
package scanner
import (
"context"
"errors"
"fmt"
"math"
"math/big"
"sort"
"sync"
"sync/atomic"
"time"
"github.com/THaGKi9/block-scanner/util"
"github.com/ethereum/go-ethereum"
"github.com/ethereum/go-ethereum/core/types"
"github.com/google/uuid"
"github.com/sirupsen/logrus"
"gorm.io/gorm"
)
type Scanner struct {
startMutex sync.Mutex
started bool
runningTaskWg sync.WaitGroup
options *ScannerOptions
db *gorm.DB
ctx context.Context
cancelFunc context.CancelFunc
scanTasks []ScanTask
scheduledTasks []ScheduledTask
}
func NewScanner(ctx context.Context, opts *ScannerOptions, db *gorm.DB) *Scanner {
ctx, cancelFunc := context.WithCancel(ctx)
return &Scanner{
started: false,
db: db,
options: opts,
ctx: ctx,
cancelFunc: cancelFunc,
}
}
func (s *Scanner) InitializeTables() error {
return s.db.AutoMigrate(&ScannerTask{})
}
func (s *Scanner) Start() error {
s.startMutex.Lock()
defer s.startMutex.Unlock()
if len(s.scanTasks)+len(s.scheduledTasks) == 0 {
return errors.New("there are no tasks to run")
}
ctx, cancelFunc := context.WithTimeout(context.Background(), time.Minute*10)
defer cancelFunc()
s.runningTaskWg.Add(len(s.scanTasks) + len(s.scheduledTasks))
for _, task := range s.scanTasks {
s.startScanTask(ctx, task)
}
for _, task := range s.scheduledTasks {
s.startScheduledTask(ctx, task)
}
s.started = true
return nil
}
func (s *Scanner) Stop(ctx context.Context) {
s.startMutex.Lock()
defer s.startMutex.Unlock()
if !s.started {
return
}
s.cancelFunc()
c := make(chan struct{})
go func() {
defer close(c)
s.runningTaskWg.Wait()
}()
select {
case <-ctx.Done():
case <-c:
}
}
func (s *Scanner) Done() <-chan *struct{} {
ch := make(chan *struct{})
go func() {
s.runningTaskWg.Wait()
ch <- nil
}()
return ch
}
// AddScanTask adds a new scan task to the scanner
func (s *Scanner) AddScanTask(task ScanTask) error {
if s.started {
return errors.New("the scanner has started")
}
// Validating name
taskName := task.Name()
if taskName == "" {
return errors.New("task name must be defined")
}
for i, task := range s.scanTasks {
if taskName == task.Name() {
return fmt.Errorf("task name '%v' is duplicating with task #%v", taskName, i)
}
}
// Add to list
s.scanTasks = append(s.scanTasks, task)
return nil
}
// AddScheduledTask adds a new scheduled task to the scanner
func (s *Scanner) AddScheduledTask(task ScheduledTask) error {
if s.started {
return errors.New("the scanner has started")
}
// Validating name
taskName := task.Name()
if taskName == "" {
return errors.New("task name must be defined")
}
for i, task := range s.scheduledTasks {
if taskName == task.Name() {
return fmt.Errorf("task name '%v' is duplicating with task #%v", taskName, i)
}
}
// Add to list
s.scheduledTasks = append(s.scheduledTasks, task)
return nil
}
// startScanTask create task when necessary and starts a goroutine to execute the task. It's possible that the start stage could fail.
// In this case, the start of the scanner should be treated as failed and abort everything.
func (s *Scanner) startScanTask(ctx context.Context, task ScanTask) error {
logger := logrus.WithField("task", task.Name())
if !task.Enabled() {
s.runningTaskWg.Done()
logger.Info("Task is disabled")
return nil
}
taskModel, err := GetScannerTaskByName(s.db.WithContext(ctx), task.Name())
if err != nil {
s.runningTaskWg.Done()
return fmt.Errorf("fail get scanner task: %v", err)
} else if taskModel == nil {
taskModel, err = CreateScannerTaskByName(s.db.WithContext(ctx), task.Name(), task.StartBlock())
if err != nil {
s.runningTaskWg.Done()
return fmt.Errorf("fail to get scanner task: %v", err)
}
logger.Info("Create new task as this task doens't exist")
}
logger.Info("Starting task")
// Use scanner ctx as the based context so that we are also to propagate cancellation with context
taskCtx, cancelFunc := context.WithCancel(s.ctx)
go func() {
defer s.runningTaskWg.Done()
defer cancelFunc()
err := s.scanTaskDoWork(taskCtx, taskModel.NextBlock, task)
if err == nil || errors.Is(err, context.Canceled) {
logger.Info("Task finished")
} else {
logger.WithField("error", err).Error("Task aborted")
}
}()
return nil
}
type bulkBlockInfo struct {
fromBlock uint64
toBlock uint64
blockInfos map[uint64]*BlockInfo
}
func (s *Scanner) scanTaskDoWork(ctx context.Context, nextBlock uint64, task ScanTask) error {
logger := logrus.WithField("task", task.Name())
ethClientRpcUrl := s.options.RpcURL
if task, ok := task.(ScanTaskOverridesEthRpcURL); ok {
ethClientRpcUrl = task.EthRpcUrl()
}
ethClient, err := NewRetryableEthclient(
ctx,
ethClientRpcUrl,
logger.WithField("client", "normal"),
time.Millisecond*500,
3)
if err != nil {
return fmt.Errorf("fail to connect to ethereum node: %v", err)
}
defer ethClient.Close()
logger.Infof("Connected to the ethereum network: %v", ethClientRpcUrl)
task.SetEthClient(ethClient)
ticker := time.NewTicker(task.PullInterval())
defer ticker.Stop()
chData := make(chan *bulkBlockInfo, 5)
wg := sync.WaitGroup{}
wg.Add(1)
go s.processData(ctx, wg, chData, logger, task)
for {
select {
case <-ctx.Done():
goto exit
case <-ticker.C:
}
currentBlock, err := ethClient.BlockNumber(ctx)
if err != nil {
return err
}
confirmedBlock := currentBlock - s.options.MinimumConfirmationBlock
if nextBlock > confirmedBlock {
logger.WithField("next-block", nextBlock).Infof("Waiting for new block confirmation. Highest Block: %v. Last confirmed block: %v", currentBlock, confirmedBlock)
continue
}
fromBlock := nextBlock
toBlock := uint64(math.Min(float64(confirmedBlock), float64(fromBlock+task.BlockBatchSize().Uint64()-1)))
blocksLogger := logger.WithField("block-range", fmt.Sprintf("%v-%v", fromBlock, toBlock))
var getBlocksError, getLogsError error
logs := map[uint64][]*types.Log{}
blocks := map[uint64]*types.Block{}
getDataWaitGroup := sync.WaitGroup{}
getDataWaitGroup.Add(2)
go func() {
defer getDataWaitGroup.Done()
if task.NeedBlockInfo() {
blocks, getBlocksError = s.getBlocks(ctx, ethClient, blocksLogger, fromBlock, toBlock)
}
}()
go func() {
defer getDataWaitGroup.Done()
if task.LogFilter() != nil {
logs, getLogsError = s.getLogs(ctx, ethClient, blocksLogger, fromBlock, toBlock, task.LogFilter())
}
}()
getDataWaitGroup.Wait()
if getBlocksError != nil {
blocksLogger.WithError(getBlocksError).Errorf("Fail to get blocks")
return err
} else if getLogsError != nil {
blocksLogger.WithError(getLogsError).Errorf("Fail to get logs")
return err
}
blockInfos := map[uint64]*BlockInfo{}
for i := fromBlock; i <= toBlock; i++ {
blockInfos[i] = &BlockInfo{
NumberU64: i,
Number: big.NewInt(int64(i)),
Block: blocks[i],
Logs: logs[i],
}
}
chData <- &bulkBlockInfo{
fromBlock: fromBlock,
toBlock: toBlock,
blockInfos: blockInfos,
}
nextBlock = toBlock + 1
}
exit:
close(chData)
wg.Wait()
return nil
}
func (s *Scanner) processData(ctx context.Context, wg sync.WaitGroup, chData <-chan *bulkBlockInfo, logger *logrus.Entry, task ScanTask) {
stopAtBlock := uint64(math.MaxUint64)
if task, ok := task.(ScanTaskStopable); ok {
if b := task.StopAtBlock(); b > 0 {
stopAtBlock = b
}
}
taskModel, err := GetScannerTaskByName(s.db, task.Name())
if err != nil {
logger.WithError(err).Error("Fail to find the task in the database")
}
for bulkBlockInfo := range chData {
fromBlock := bulkBlockInfo.fromBlock
toBlock := bulkBlockInfo.toBlock
blocksLogger := logger.WithFields(logrus.Fields{
"start-block": bulkBlockInfo.fromBlock,
"end-block": bulkBlockInfo.toBlock,
})
dbTx := s.db.Begin().WithContext(ctx)
rollbackFunc := func() {
if result := dbTx.Rollback(); result.Error != nil {
blocksLogger.WithError(result.Error).Error("Fail to rollback database transaction")
} else {
blocksLogger.Info("Successfully rollback the database transaction")
}
}
for ; fromBlock <= toBlock; fromBlock++ {
blockLogger := logger.WithField("block", fromBlock)
blockInfo := bulkBlockInfo.blockInfos[fromBlock]
if fromBlock > stopAtBlock {
blockLogger.Info("The task is finished after reaching destination block")
goto exit
}
if task.NeedBlockInfo() && blockInfo == nil {
blockLogger.Errorf("Block is not downloaded")
}
if task.LogFilter() != nil && len(blockInfo.Logs) == 0 && task.SkipWhenNoLogs() {
blockLogger.Info("Skip block as there is no logs")
continue
}
err = util.ExecuteWithRecover(blockLogger, "ScanTask.OnNewBlock", func() error {
return task.OnNewBlock(ctx, blockInfo, dbTx)
})
if err != nil {
blockLogger.WithError(err).Error("Fail to process new block")
rollbackFunc()
goto exit
}
newToken := uuid.New().String()
if err := UpdateNextBlock(dbTx, taskModel, fromBlock+1, newToken); err != nil {
blockLogger.WithError(err).Errorf("Fail to set next block to %v", fromBlock+1)
rollbackFunc()
goto exit
}
taskModel.NextBlock = fromBlock + 1
taskModel.JobToken = newToken
// Post commitment
err = util.ExecuteWithRecover(blockLogger, "ScanTask.OnBlockComitted", func() error {
return task.OnBlockCommitted(ctx, blockInfo)
})
if err != nil {
blocksLogger.WithError(err).Error("Fail to execute OnBlockCommitted")
}
}
// Commit changes
if result := dbTx.Commit(); result.Error != nil {
blocksLogger.WithError(result.Error).Error("Fail to commit database transaction")
rollbackFunc()
goto exit
}
blocksLogger.Debug("Block changes committed")
}
exit:
return
}
func (s *Scanner) getLogs(ctx context.Context, ethClient *RetryableEthclient, logger *logrus.Entry, fromBlock, toBlock uint64, filters []*ethereum.FilterQuery) (map[uint64][]*types.Log, error) {
var wg sync.WaitGroup
wg.Add(len(filters))
var logsMutex sync.Mutex
var logsByBlock map[uint64][]*types.Log = make(map[uint64][]*types.Log)
var failed bool
for _, filter := range filters {
localFilter := ethereum.FilterQuery{
FromBlock: big.NewInt(int64(fromBlock)),
ToBlock: big.NewInt(int64(toBlock)),
Topics: filter.Topics[:],
Addresses: filter.Addresses[:],
}
go func() {
defer wg.Done()
blocksToGet := toBlock - fromBlock + 1
logger.Infof("Getting events for from %v blocks, from %v to %v...", blocksToGet, fromBlock, toBlock)
logs, err := ethClient.FilterLogs(ctx, localFilter)
if err != nil {
logger.WithError(err).Error("Fail to get logs events")
failed = true
}
logger.Infof("Get %v events for from %v blocks, %v to %v", len(logs), blocksToGet, fromBlock, toBlock)
logsMutex.Lock()
// Split events by block
for _, log := range logs {
if _, ok := logsByBlock[log.BlockNumber]; !ok {
logsByBlock[log.BlockNumber] = nil
}
copiedLog := log
logsByBlock[log.BlockNumber] = append(logsByBlock[log.BlockNumber], &copiedLog)
}
logsMutex.Unlock()
}()
}
wg.Wait()
if failed {
return nil, errors.New("fail to get logs")
}
for _, logs := range logsByBlock {
sort.Slice(logs, func(i, j int) bool {
return logs[i].Index <= logs[j].Index
})
}
return logsByBlock, nil
}
func (s *Scanner) getBlocks(ctx context.Context, ethClient *RetryableEthclient, logger *logrus.Entry, fromBlock, toBlock uint64) (map[uint64]*types.Block, error) {
var wg sync.WaitGroup
blocksToGet := toBlock - fromBlock + 1
blocks := make(map[uint64]*types.Block)
innerCtx, cancelFunc := context.WithCancel(ctx)
defer cancelFunc()
counter := 0
for blocksToGet > 0 {
batchSize := int(math.Min(float64(blocksToGet), float64(s.options.BlockBatchSize)))
blocksToGet -= uint64(batchSize)
jobResult := make(chan *types.Block, batchSize)
jobFails := int32(0)
counter++
logger.Infof("Getting %v blocks starting from block %v. Batch %v", batchSize, fromBlock, counter)
wg.Add(batchSize)
for i := 0; i < batchSize; i++ {
go func(blockNumber *big.Int) {
defer wg.Done()
block, err := ethClient.BlockByNumber(innerCtx, blockNumber)
if errors.Is(err, context.Canceled) {
logger.Errorf("Task to get block %v is cancelled", blockNumber)
} else if err != nil {
logger.WithError(err).Errorf("Task to get block %v is failed", blockNumber)
cancelFunc()
jobFails = 0
atomic.AddInt32(&jobFails, 1)
} else {
jobResult <- block
}
}(big.NewInt(int64(fromBlock)))
fromBlock++
}
wg.Wait()
close(jobResult)
logger.Infof("Finish getting %v blocks starting from block %v. Batch %v", batchSize, fromBlock, counter)
if jobFails > 0 {
return nil, errors.New("fail to get blocks")
}
for block := range jobResult {
blocks[block.NumberU64()] = block
}
}
return blocks, nil
}
// startScanTask create task when necessary and starts a goroutine to execute the task. It's possible that the start stage could fail.
// In this case, the start of the scanner should be treated as failed and abort everything.
func (s *Scanner) startScheduledTask(ctx context.Context, task ScheduledTask) error {
logger := logrus.WithField("task", task.Name())
if !task.Enabled() {
s.runningTaskWg.Done()
logger.Info("Task is disabled")
return nil
}
logger.Info("Starting task")
// Use scanner ctx as the based context so that we are also to propagate cancellation with context
taskCtx, cancelFunc := context.WithCancel(s.ctx)
go func() {
defer s.runningTaskWg.Done()
defer cancelFunc()
logger.Info("Initializing task")
err := util.ExecuteWithRecover(logger, "ScheduledTask.Init", func() error {
return task.Init(taskCtx)
})
if err != nil {
logger.WithError(err).Error("Fail to initialize the task")
return
}
logger.Info("Initialization finished")
if err != nil {
logger.WithField("error", err).Error("Task fails in initialization")
} else {
ticker := time.NewTicker(task.Interval())
for err == nil {
select {
case <-taskCtx.Done():
err = taskCtx.Err()
case <-ticker.C:
logger.Info("Executing task")
err := util.ExecuteWithRecover(logger, "ScheduledTask.Execute", func() error {
return task.Execute(taskCtx)
})
if err != nil {
logger.WithError(err).Error("Fail to execute the task")
return
}
}
}
}
if err == nil || errors.Is(err, context.Canceled) {
logger.Info("Task finished")
} else {
logger.WithField("error", err).Error("Task aborted")
}
}()
return nil
}