-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
orm.go
984 lines (876 loc) · 34 KB
/
orm.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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
package logpoller
import (
"context"
"database/sql"
"fmt"
"math/big"
"strings"
"time"
"github.com/ethereum/go-ethereum/common"
pkgerrors "github.com/pkg/errors"
"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/sqlutil"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
ubig "github.com/smartcontractkit/chainlink/v2/core/chains/evm/utils/big"
)
// ORM represents the persistent data access layer used by the log poller. At this moment, it's a bit leaky abstraction, because
// it exposes some of the database implementation details (e.g. pg.Q). Ideally it should be agnostic and could be applied to any persistence layer.
// What is more, LogPoller should not be aware of the underlying database implementation and delegate all the queries to the ORM.
type ORM interface {
InsertLogs(ctx context.Context, logs []Log) error
InsertLogsWithBlock(ctx context.Context, logs []Log, block LogPollerBlock) error
InsertFilter(ctx context.Context, filter Filter) error
LoadFilters(ctx context.Context) (map[string]Filter, error)
DeleteFilter(ctx context.Context, name string) error
InsertBlock(ctx context.Context, blockHash common.Hash, blockNumber int64, blockTimestamp time.Time, finalizedBlock int64) error
DeleteBlocksBefore(ctx context.Context, end int64, limit int64) (int64, error)
DeleteLogsAndBlocksAfter(ctx context.Context, start int64) error
DeleteExpiredLogs(ctx context.Context, limit int64) (int64, error)
GetBlocksRange(ctx context.Context, start int64, end int64) ([]LogPollerBlock, error)
SelectBlockByNumber(ctx context.Context, blockNumber int64) (*LogPollerBlock, error)
SelectBlockByHash(ctx context.Context, hash common.Hash) (*LogPollerBlock, error)
SelectLatestBlock(ctx context.Context) (*LogPollerBlock, error)
SelectOldestBlock(ctx context.Context, minAllowedBlockNumber int64) (*LogPollerBlock, error)
SelectLogs(ctx context.Context, start, end int64, address common.Address, eventSig common.Hash) ([]Log, error)
SelectLogsWithSigs(ctx context.Context, start, end int64, address common.Address, eventSigs []common.Hash) ([]Log, error)
SelectLogsCreatedAfter(ctx context.Context, address common.Address, eventSig common.Hash, after time.Time, confs Confirmations) ([]Log, error)
SelectLatestLogByEventSigWithConfs(ctx context.Context, eventSig common.Hash, address common.Address, confs Confirmations) (*Log, error)
SelectLatestLogEventSigsAddrsWithConfs(ctx context.Context, fromBlock int64, addresses []common.Address, eventSigs []common.Hash, confs Confirmations) ([]Log, error)
SelectLatestBlockByEventSigsAddrsWithConfs(ctx context.Context, fromBlock int64, eventSigs []common.Hash, addresses []common.Address, confs Confirmations) (int64, error)
SelectLogsByBlockRange(ctx context.Context, start, end int64) ([]Log, error)
SelectIndexedLogs(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValues []common.Hash, confs Confirmations) ([]Log, error)
SelectIndexedLogsByBlockRange(ctx context.Context, start, end int64, address common.Address, eventSig common.Hash, topicIndex int, topicValues []common.Hash) ([]Log, error)
SelectIndexedLogsCreatedAfter(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValues []common.Hash, after time.Time, confs Confirmations) ([]Log, error)
SelectIndexedLogsTopicGreaterThan(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValueMin common.Hash, confs Confirmations) ([]Log, error)
SelectIndexedLogsTopicRange(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValueMin, topicValueMax common.Hash, confs Confirmations) ([]Log, error)
SelectIndexedLogsWithSigsExcluding(ctx context.Context, sigA, sigB common.Hash, topicIndex int, address common.Address, startBlock, endBlock int64, confs Confirmations) ([]Log, error)
SelectIndexedLogsByTxHash(ctx context.Context, address common.Address, eventSig common.Hash, txHash common.Hash) ([]Log, error)
SelectLogsDataWordRange(ctx context.Context, address common.Address, eventSig common.Hash, wordIndex int, wordValueMin, wordValueMax common.Hash, confs Confirmations) ([]Log, error)
SelectLogsDataWordGreaterThan(ctx context.Context, address common.Address, eventSig common.Hash, wordIndex int, wordValueMin common.Hash, confs Confirmations) ([]Log, error)
SelectLogsDataWordBetween(ctx context.Context, address common.Address, eventSig common.Hash, wordIndexMin int, wordIndexMax int, wordValue common.Hash, confs Confirmations) ([]Log, error)
}
type DSORM struct {
chainID *big.Int
ds sqlutil.DataSource
lggr logger.Logger
}
var _ ORM = &DSORM{}
// NewORM creates an DSORM scoped to chainID.
func NewORM(chainID *big.Int, ds sqlutil.DataSource, lggr logger.Logger) *DSORM {
return &DSORM{
chainID: chainID,
ds: ds,
lggr: lggr,
}
}
func (o *DSORM) Transact(ctx context.Context, fn func(*DSORM) error) (err error) {
return sqlutil.Transact(ctx, o.new, o.ds, nil, fn)
}
// new returns a NewORM like o, but backed by ds.
func (o *DSORM) new(ds sqlutil.DataSource) *DSORM { return NewORM(o.chainID, ds, o.lggr) }
// InsertBlock is idempotent to support replays.
func (o *DSORM) InsertBlock(ctx context.Context, blockHash common.Hash, blockNumber int64, blockTimestamp time.Time, finalizedBlock int64) error {
args, err := newQueryArgs(o.chainID).
withCustomHashArg("block_hash", blockHash).
withCustomArg("block_number", blockNumber).
withCustomArg("block_timestamp", blockTimestamp).
withCustomArg("finalized_block_number", finalizedBlock).
toArgs()
if err != nil {
return err
}
query := `INSERT INTO evm.log_poller_blocks
(evm_chain_id, block_hash, block_number, block_timestamp, finalized_block_number, created_at)
VALUES (:evm_chain_id, :block_hash, :block_number, :block_timestamp, :finalized_block_number, NOW())
ON CONFLICT DO NOTHING`
_, err = o.ds.NamedExecContext(ctx, query, args)
return err
}
// InsertFilter is idempotent.
//
// Each address/event pair must have a unique job id, so it may be removed when the job is deleted.
// If a second job tries to overwrite the same pair, this should fail.
func (o *DSORM) InsertFilter(ctx context.Context, filter Filter) (err error) {
topicArrays := []types.HashArray{filter.Topic2, filter.Topic3, filter.Topic4}
args, err := newQueryArgs(o.chainID).
withCustomArg("name", filter.Name).
withRetention(filter.Retention).
withMaxLogsKept(filter.MaxLogsKept).
withLogsPerBlock(filter.LogsPerBlock).
withAddressArray(filter.Addresses).
withEventSigArray(filter.EventSigs).
withTopicArrays(filter.Topic2, filter.Topic3, filter.Topic4).
toArgs()
if err != nil {
return err
}
var topicsColumns, topicsSql strings.Builder
for n, topicValues := range topicArrays {
if len(topicValues) != 0 {
topicCol := fmt.Sprintf("topic%d", n+2)
fmt.Fprintf(&topicsColumns, ", %s", topicCol)
fmt.Fprintf(&topicsSql, ",\n(SELECT unnest(:%s ::::BYTEA[]) %s) t%d", topicCol, topicCol, n+2)
}
}
// '::' has to be escaped in the query string
// https://github.com/jmoiron/sqlx/issues/91, https://github.com/jmoiron/sqlx/issues/428
query := fmt.Sprintf(`
INSERT INTO evm.log_poller_filters
(name, evm_chain_id, retention, max_logs_kept, logs_per_block, created_at, address, event %s)
SELECT * FROM
(SELECT :name, :evm_chain_id ::::NUMERIC, :retention ::::BIGINT, :max_logs_kept ::::NUMERIC, :logs_per_block ::::NUMERIC, NOW()) x,
(SELECT unnest(:address_array ::::BYTEA[]) addr) a,
(SELECT unnest(:event_sig_array ::::BYTEA[]) ev) e
%s
ON CONFLICT (evm.f_log_poller_filter_hash(name, evm_chain_id, address, event, topic2, topic3, topic4))
DO UPDATE SET retention=:retention ::::BIGINT, max_logs_kept=:max_logs_kept ::::NUMERIC, logs_per_block=:logs_per_block ::::NUMERIC`,
topicsColumns.String(),
topicsSql.String())
_, err = o.ds.NamedExecContext(ctx, query, args)
return err
}
// DeleteFilter removes all events,address pairs associated with the Filter
func (o *DSORM) DeleteFilter(ctx context.Context, name string) error {
_, err := o.ds.ExecContext(ctx,
`DELETE FROM evm.log_poller_filters WHERE name = $1 AND evm_chain_id = $2`,
name, ubig.New(o.chainID))
return err
}
// LoadFilters returns all filters for this chain
func (o *DSORM) LoadFilters(ctx context.Context) (map[string]Filter, error) {
query := `SELECT name,
ARRAY_AGG(DISTINCT address)::BYTEA[] AS addresses,
ARRAY_AGG(DISTINCT event)::BYTEA[] AS event_sigs,
ARRAY_AGG(DISTINCT topic2 ORDER BY topic2) FILTER(WHERE topic2 IS NOT NULL) AS topic2,
ARRAY_AGG(DISTINCT topic3 ORDER BY topic3) FILTER(WHERE topic3 IS NOT NULL) AS topic3,
ARRAY_AGG(DISTINCT topic4 ORDER BY topic4) FILTER(WHERE topic4 IS NOT NULL) AS topic4,
MAX(logs_per_block) AS logs_per_block,
MAX(retention) AS retention,
MAX(max_logs_kept) AS max_logs_kept
FROM evm.log_poller_filters WHERE evm_chain_id = $1
GROUP BY name`
var rows []Filter
err := o.ds.SelectContext(ctx, &rows, query, ubig.New(o.chainID))
filters := make(map[string]Filter)
for _, filter := range rows {
filters[filter.Name] = filter
}
return filters, err
}
func (o *DSORM) SelectBlockByHash(ctx context.Context, hash common.Hash) (*LogPollerBlock, error) {
var b LogPollerBlock
if err := o.ds.GetContext(ctx, &b, `SELECT * FROM evm.log_poller_blocks WHERE block_hash = $1 AND evm_chain_id = $2`, hash.Bytes(), ubig.New(o.chainID)); err != nil {
return nil, err
}
return &b, nil
}
func (o *DSORM) SelectBlockByNumber(ctx context.Context, n int64) (*LogPollerBlock, error) {
var b LogPollerBlock
if err := o.ds.GetContext(ctx, &b, `SELECT * FROM evm.log_poller_blocks WHERE block_number = $1 AND evm_chain_id = $2`, n, ubig.New(o.chainID)); err != nil {
return nil, err
}
return &b, nil
}
func (o *DSORM) SelectLatestBlock(ctx context.Context) (*LogPollerBlock, error) {
var b LogPollerBlock
if err := o.ds.GetContext(ctx, &b, `SELECT * FROM evm.log_poller_blocks WHERE evm_chain_id = $1 ORDER BY block_number DESC LIMIT 1`, ubig.New(o.chainID)); err != nil {
return nil, err
}
return &b, nil
}
func (o *DSORM) SelectOldestBlock(ctx context.Context, minAllowedBlockNumber int64) (*LogPollerBlock, error) {
var b LogPollerBlock
if err := o.ds.GetContext(ctx, &b, `SELECT * FROM evm.log_poller_blocks WHERE evm_chain_id = $1 AND block_number >= $2 ORDER BY block_number ASC LIMIT 1`, ubig.New(o.chainID), minAllowedBlockNumber); err != nil {
return nil, err
}
return &b, nil
}
func (o *DSORM) SelectLatestLogByEventSigWithConfs(ctx context.Context, eventSig common.Hash, address common.Address, confs Confirmations) (*Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND event_sig = :event_sig
AND address = :address
AND block_number <= %s
ORDER BY block_number desc, log_index DESC
LIMIT 1
`, nestedBlockNumberQuery(confs))
var l Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err = o.ds.GetContext(ctx, &l, query, sqlArgs...); err != nil {
return nil, err
}
return &l, nil
}
// DeleteBlocksBefore delete blocks before and including end. When limit is set, it will delete at most limit blocks.
// Otherwise, it will delete all blocks at once.
func (o *DSORM) DeleteBlocksBefore(ctx context.Context, end int64, limit int64) (int64, error) {
if limit > 0 {
result, err := o.ds.ExecContext(ctx,
`DELETE FROM evm.log_poller_blocks
WHERE block_number IN (
SELECT block_number FROM evm.log_poller_blocks
WHERE block_number <= $1
AND evm_chain_id = $2
LIMIT $3
)
AND evm_chain_id = $2`,
end, ubig.New(o.chainID), limit)
if err != nil {
return 0, err
}
return result.RowsAffected()
}
result, err := o.ds.ExecContext(ctx, `DELETE FROM evm.log_poller_blocks
WHERE block_number <= $1 AND evm_chain_id = $2`, end, ubig.New(o.chainID))
if err != nil {
return 0, err
}
return result.RowsAffected()
}
func (o *DSORM) DeleteLogsAndBlocksAfter(ctx context.Context, start int64) error {
// These deletes are bounded by reorg depth, so they are
// fast and should not slow down the log readers.
return o.Transact(ctx, func(orm *DSORM) error {
// Applying upper bound filter is critical for Postgres performance (especially for evm.logs table)
// because it allows the planner to properly estimate the number of rows to be scanned.
// If not applied, these queries can become very slow. After some critical number
// of logs, Postgres will try to scan all the logs in the index by block_number.
// Latency without upper bound filter can be orders of magnitude higher for large number of logs.
_, err := o.ds.ExecContext(ctx, `DELETE FROM evm.log_poller_blocks
WHERE evm_chain_id = $1
AND block_number >= $2
AND block_number <= (SELECT MAX(block_number)
FROM evm.log_poller_blocks
WHERE evm_chain_id = $1)`,
ubig.New(o.chainID), start)
if err != nil {
o.lggr.Warnw("Unable to clear reorged blocks, retrying", "err", err)
return err
}
_, err = o.ds.ExecContext(ctx, `DELETE FROM evm.logs
WHERE evm_chain_id = $1
AND block_number >= $2
AND block_number <= (SELECT MAX(block_number) FROM evm.logs WHERE evm_chain_id = $1)`,
ubig.New(o.chainID), start)
if err != nil {
o.lggr.Warnw("Unable to clear reorged logs, retrying", "err", err)
return err
}
return nil
})
}
type Exp struct {
Address common.Address
EventSig common.Hash
Expiration time.Time
TimeNow time.Time
ShouldDelete bool
}
func (o *DSORM) DeleteExpiredLogs(ctx context.Context, limit int64) (int64, error) {
var err error
var result sql.Result
if limit > 0 {
result, err = o.ds.ExecContext(ctx, `
DELETE FROM evm.logs
WHERE (evm_chain_id, address, event_sig, block_number) IN (
SELECT l.evm_chain_id, l.address, l.event_sig, l.block_number
FROM evm.logs l
INNER JOIN (
SELECT address, event, MAX(retention) AS retention
FROM evm.log_poller_filters
WHERE evm_chain_id = $1
GROUP BY evm_chain_id, address, event
HAVING NOT 0 = ANY(ARRAY_AGG(retention))
) r ON l.evm_chain_id = $1 AND l.address = r.address AND l.event_sig = r.event
AND l.block_timestamp <= STATEMENT_TIMESTAMP() - (r.retention / 10^9 * interval '1 second')
LIMIT $2
)`, ubig.New(o.chainID), limit)
} else {
result, err = o.ds.ExecContext(ctx, `WITH r AS
( SELECT address, event, MAX(retention) AS retention
FROM evm.log_poller_filters WHERE evm_chain_id=$1
GROUP BY evm_chain_id,address, event HAVING NOT 0 = ANY(ARRAY_AGG(retention))
) DELETE FROM evm.logs l USING r
WHERE l.evm_chain_id = $1 AND l.address=r.address AND l.event_sig=r.event
AND l.block_timestamp <= STATEMENT_TIMESTAMP() - (r.retention / 10^9 * interval '1 second')`, // retention is in nanoseconds (time.Duration aka BIGINT)
ubig.New(o.chainID))
}
if err != nil {
return 0, err
}
return result.RowsAffected()
}
// InsertLogs is idempotent to support replays.
func (o *DSORM) InsertLogs(ctx context.Context, logs []Log) error {
if err := o.validateLogs(logs); err != nil {
return err
}
return o.Transact(ctx, func(orm *DSORM) error {
return orm.insertLogsWithinTx(ctx, logs, orm.ds)
})
}
func (o *DSORM) InsertLogsWithBlock(ctx context.Context, logs []Log, block LogPollerBlock) error {
// Optimization, don't open TX when there is only a block to be persisted
if len(logs) == 0 {
return o.InsertBlock(ctx, block.BlockHash, block.BlockNumber, block.BlockTimestamp, block.FinalizedBlockNumber)
}
if err := o.validateLogs(logs); err != nil {
return err
}
// Block and logs goes with the same TX to ensure atomicity
return o.Transact(ctx, func(orm *DSORM) error {
err := orm.InsertBlock(ctx, block.BlockHash, block.BlockNumber, block.BlockTimestamp, block.FinalizedBlockNumber)
if err != nil {
return err
}
return orm.insertLogsWithinTx(ctx, logs, orm.ds)
})
}
func (o *DSORM) insertLogsWithinTx(ctx context.Context, logs []Log, tx sqlutil.DataSource) error {
batchInsertSize := 4000
for i := 0; i < len(logs); i += batchInsertSize {
start, end := i, i+batchInsertSize
if end > len(logs) {
end = len(logs)
}
query := `INSERT INTO evm.logs
(evm_chain_id, log_index, block_hash, block_number, block_timestamp, address, event_sig, topics, tx_hash, data, created_at)
VALUES
(:evm_chain_id, :log_index, :block_hash, :block_number, :block_timestamp, :address, :event_sig, :topics, :tx_hash, :data, NOW())
ON CONFLICT DO NOTHING`
_, err := o.ds.NamedExecContext(ctx, query, logs[start:end])
if err != nil {
return err
}
if err != nil {
if pkgerrors.Is(err, context.DeadlineExceeded) && batchInsertSize > 500 {
// In case of DB timeouts, try to insert again with a smaller batch upto a limit
batchInsertSize /= 2
i -= batchInsertSize // counteract +=batchInsertSize on next loop iteration
continue
}
return err
}
}
return nil
}
func (o *DSORM) validateLogs(logs []Log) error {
for _, log := range logs {
if o.chainID.Cmp(log.EvmChainId.ToInt()) != 0 {
return pkgerrors.Errorf("invalid chainID in log got %v want %v", log.EvmChainId.ToInt(), o.chainID)
}
}
return nil
}
func (o *DSORM) SelectLogsByBlockRange(ctx context.Context, start, end int64) ([]Log, error) {
args, err := newQueryArgs(o.chainID).
withStartBlock(start).
withEndBlock(end).
toArgs()
if err != nil {
return nil, err
}
query := `SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND block_number >= :start_block
AND block_number <= :end_block
ORDER BY block_number, log_index`
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...)
if err != nil {
return nil, err
}
return logs, nil
}
// SelectLogs finds the logs in a given block range.
func (o *DSORM) SelectLogs(ctx context.Context, start, end int64, address common.Address, eventSig common.Hash) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withStartBlock(start).
withEndBlock(end).
toArgs()
if err != nil {
return nil, err
}
query := `SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND block_number >= :start_block
AND block_number <= :end_block
ORDER BY block_number, log_index`
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...)
if err != nil {
return nil, err
}
return logs, nil
}
// SelectLogsCreatedAfter finds logs created after some timestamp.
func (o *DSORM) SelectLogsCreatedAfter(ctx context.Context, address common.Address, eventSig common.Hash, after time.Time, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withBlockTimestampAfter(after).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND block_timestamp > :block_timestamp_after
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
// SelectLogsWithSigs finds the logs in the given block range with the given event signatures
// emitted from the given address.
func (o *DSORM) SelectLogsWithSigs(ctx context.Context, start, end int64, address common.Address, eventSigs []common.Hash) (logs []Log, err error) {
args, err := newQueryArgs(o.chainID).
withAddress(address).
withEventSigArray(eventSigs).
withStartBlock(start).
withEndBlock(end).
toArgs()
if err != nil {
return nil, err
}
query := `SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = ANY(:event_sig_array)
AND block_number BETWEEN :start_block AND :end_block
ORDER BY block_number, log_index`
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...)
if pkgerrors.Is(err, sql.ErrNoRows) {
return nil, nil
}
return logs, err
}
func (o *DSORM) GetBlocksRange(ctx context.Context, start int64, end int64) ([]LogPollerBlock, error) {
args, err := newQueryArgs(o.chainID).
withStartBlock(start).
withEndBlock(end).
toArgs()
if err != nil {
return nil, err
}
query := `SELECT * FROM evm.log_poller_blocks
WHERE block_number >= :start_block
AND block_number <= :end_block
AND evm_chain_id = :evm_chain_id
ORDER BY block_number ASC`
var blocks []LogPollerBlock
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
err = o.ds.SelectContext(ctx, &blocks, query, sqlArgs...)
if err != nil {
return nil, err
}
return blocks, nil
}
// SelectLatestLogEventSigsAddrsWithConfs finds the latest log by (address, event) combination that matches a list of Addresses and list of events
func (o *DSORM) SelectLatestLogEventSigsAddrsWithConfs(ctx context.Context, fromBlock int64, addresses []common.Address, eventSigs []common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgs(o.chainID).
withAddressArray(addresses).
withEventSigArray(eventSigs).
withStartBlock(fromBlock).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs WHERE (block_number, address, event_sig) IN (
SELECT MAX(block_number), address, event_sig FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND event_sig = ANY(:event_sig_array)
AND address = ANY(:address_array)
AND block_number > :start_block
AND block_number <= %s
GROUP BY event_sig, address
)
ORDER BY block_number ASC`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, pkgerrors.Wrap(err, "failed to execute query")
}
return logs, nil
}
// SelectLatestBlockByEventSigsAddrsWithConfs finds the latest block number that matches a list of Addresses and list of events. It returns 0 if there is no matching block
func (o *DSORM) SelectLatestBlockByEventSigsAddrsWithConfs(ctx context.Context, fromBlock int64, eventSigs []common.Hash, addresses []common.Address, confs Confirmations) (int64, error) {
args, err := newQueryArgs(o.chainID).
withEventSigArray(eventSigs).
withAddressArray(addresses).
withStartBlock(fromBlock).
withConfs(confs).
toArgs()
if err != nil {
return 0, err
}
query := fmt.Sprintf(`
SELECT COALESCE(MAX(block_number), 0) FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND event_sig = ANY(:event_sig_array)
AND address = ANY(:address_array)
AND block_number > :start_block
AND block_number <= %s`, nestedBlockNumberQuery(confs))
var blockNumber int64
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return 0, err
}
if err = o.ds.GetContext(ctx, &blockNumber, query, sqlArgs...); err != nil {
return 0, err
}
return blockNumber, nil
}
func (o *DSORM) SelectLogsDataWordRange(ctx context.Context, address common.Address, eventSig common.Hash, wordIndex int, wordValueMin, wordValueMax common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withWordIndex(wordIndex).
withWordValueMin(wordValueMin).
withWordValueMax(wordValueMax).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND substring(data from 32*:word_index+1 for 32) >= :word_value_min
AND substring(data from 32*:word_index+1 for 32) <= :word_value_max
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectLogsDataWordGreaterThan(ctx context.Context, address common.Address, eventSig common.Hash, wordIndex int, wordValueMin common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withWordIndex(wordIndex).
withWordValueMin(wordValueMin).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND substring(data from 32*:word_index+1 for 32) >= :word_value_min
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectLogsDataWordBetween(ctx context.Context, address common.Address, eventSig common.Hash, wordIndexMin int, wordIndexMax int, wordValue common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withWordIndexMin(wordIndexMin).
withWordIndexMax(wordIndexMax).
withWordValue(wordValue).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND substring(data from 32*:word_index_min+1 for 32) <= :word_value
AND substring(data from 32*:word_index_max+1 for 32) >= :word_value
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectIndexedLogsTopicGreaterThan(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValueMin common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withTopicIndex(topicIndex).
withTopicValueMin(topicValueMin).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND topics[:topic_index] >= :topic_value_min
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectIndexedLogsTopicRange(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValueMin, topicValueMax common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withTopicIndex(topicIndex).
withTopicValueMin(topicValueMin).
withTopicValueMax(topicValueMax).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND topics[:topic_index] >= :topic_value_min
AND topics[:topic_index] <= :topic_value_max
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectIndexedLogs(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValues []common.Hash, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withTopicIndex(topicIndex).
withTopicValues(topicValues).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND topics[:topic_index] = ANY(:topic_values)
AND block_number <= %s
ORDER BY block_number, log_index`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
// SelectIndexedLogsByBlockRange finds the indexed logs in a given block range.
func (o *DSORM) SelectIndexedLogsByBlockRange(ctx context.Context, start, end int64, address common.Address, eventSig common.Hash, topicIndex int, topicValues []common.Hash) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withTopicIndex(topicIndex).
withTopicValues(topicValues).
withStartBlock(start).
withEndBlock(end).
toArgs()
if err != nil {
return nil, err
}
query := `SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND topics[:topic_index] = ANY(:topic_values)
AND block_number >= :start_block
AND block_number <= :end_block
ORDER BY block_number, log_index`
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...)
if err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectIndexedLogsCreatedAfter(ctx context.Context, address common.Address, eventSig common.Hash, topicIndex int, topicValues []common.Hash, after time.Time, confs Confirmations) ([]Log, error) {
args, err := newQueryArgsForEvent(o.chainID, address, eventSig).
withBlockTimestampAfter(after).
withConfs(confs).
withTopicIndex(topicIndex).
withTopicValues(topicValues).
toArgs()
if err != nil {
return nil, err
}
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND topics[:topic_index] = ANY(:topic_values)
AND block_timestamp > :block_timestamp_after
AND block_number <= %s
ORDER BY block_number, log_index
`, nestedBlockNumberQuery(confs))
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func (o *DSORM) SelectIndexedLogsByTxHash(ctx context.Context, address common.Address, eventSig common.Hash, txHash common.Hash) ([]Log, error) {
args, err := newQueryArgs(o.chainID).
withTxHash(txHash).
withAddress(address).
withEventSig(eventSig).
toArgs()
if err != nil {
return nil, err
}
query := `SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :event_sig
AND tx_hash = :tx_hash
ORDER BY block_number, log_index`
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
err = o.ds.SelectContext(ctx, &logs, query, sqlArgs...)
if err != nil {
return nil, err
}
return logs, nil
}
// SelectIndexedLogsWithSigsExcluding query's for logs that have signature A and exclude logs that have a corresponding signature B, matching is done based on the topic index both logs should be inside the block range and have the minimum number of confirmations
func (o *DSORM) SelectIndexedLogsWithSigsExcluding(ctx context.Context, sigA, sigB common.Hash, topicIndex int, address common.Address, startBlock, endBlock int64, confs Confirmations) ([]Log, error) {
args, err := newQueryArgs(o.chainID).
withAddress(address).
withTopicIndex(topicIndex).
withStartBlock(startBlock).
withEndBlock(endBlock).
withCustomHashArg("sigA", sigA).
withCustomHashArg("sigB", sigB).
withConfs(confs).
toArgs()
if err != nil {
return nil, err
}
nestedQuery := nestedBlockNumberQuery(confs)
query := fmt.Sprintf(`
SELECT * FROM evm.logs
WHERE evm_chain_id = :evm_chain_id
AND address = :address
AND event_sig = :sigA
AND block_number BETWEEN :start_block AND :end_block
AND block_number <= %s
EXCEPT
SELECT a.* FROM evm.logs AS a
INNER JOIN evm.logs B
ON a.evm_chain_id = b.evm_chain_id
AND a.address = b.address
AND a.topics[:topic_index] = b.topics[:topic_index]
AND a.event_sig = :sigA
AND b.event_sig = :sigB
AND b.block_number BETWEEN :start_block AND :end_block
AND b.block_number <= %s
ORDER BY block_number, log_index`, nestedQuery, nestedQuery)
var logs []Log
query, sqlArgs, err := o.ds.BindNamed(query, args)
if err != nil {
return nil, err
}
if err := o.ds.SelectContext(ctx, &logs, query, sqlArgs...); err != nil {
return nil, err
}
return logs, nil
}
func nestedBlockNumberQuery(confs Confirmations) string {
if confs == Finalized {
return `
(SELECT finalized_block_number
FROM evm.log_poller_blocks
WHERE evm_chain_id = :evm_chain_id
ORDER BY block_number DESC LIMIT 1) `
}
// Intentionally wrap with greatest() function and don't return negative block numbers when :confs > :block_number
// It doesn't impact logic of the outer query, because block numbers are never less or equal to 0 (guarded by log_poller_blocks_block_number_check)
return `
(SELECT greatest(block_number - :confs, 0)
FROM evm.log_poller_blocks
WHERE evm_chain_id = :evm_chain_id
ORDER BY block_number DESC LIMIT 1) `
}