/
order_watcher.go
1340 lines (1238 loc) · 46.4 KB
/
order_watcher.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
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package orderwatch
import (
"context"
"errors"
"fmt"
"math/big"
"sync"
"time"
"github.com/0xProject/0x-mesh/constants"
"github.com/0xProject/0x-mesh/db"
"github.com/0xProject/0x-mesh/ethereum"
"github.com/0xProject/0x-mesh/ethereum/blockwatch"
"github.com/0xProject/0x-mesh/expirationwatch"
"github.com/0xProject/0x-mesh/meshdb"
"github.com/0xProject/0x-mesh/zeroex"
"github.com/0xProject/0x-mesh/zeroex/ordervalidator"
"github.com/0xProject/0x-mesh/zeroex/orderwatch/decoder"
"github.com/0xProject/0x-mesh/zeroex/orderwatch/slowcounter"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/event"
"github.com/ethereum/go-ethereum/rpc"
logger "github.com/sirupsen/logrus"
)
const (
// minCleanupInterval specified the minimum amount of time between orderbook
// cleanups. These cleanups are meant to catch any stale orders that somehow
// were not caught by the event watcher process.
minCleanupInterval = 1 * time.Hour
// minRemovedCheckInterval specifies the minimum amount of time between checks
// on whether to remove orders flaggged for removal from the DB
minRemovedCheckInterval = 5 * time.Minute
// defaultLastUpdatedBuffer specifies how long it must have been since an order was
// last updated in order to be re-validated by the cleanup worker
defaultLastUpdatedBuffer = 30 * time.Minute
// permanentlyDeleteAfter specifies how long after an order is marked as IsRemoved and not updated that
// it should be considered for permanent deletion. Blocks get mined on avg. every 12 sec, so 5 minutes
// corresponds to a block depth of ~25.
permanentlyDeleteAfter = 5 * time.Minute
// expirationPollingInterval specifies the interval in which the order watcher should check for expired
// orders
expirationPollingInterval = 50 * time.Millisecond
// maxOrdersTrimRatio affects how many orders are trimmed whenever we reach the
// maximum number of orders. When order storage is full, Watcher will remove
// orders until the total number of remaining orders is equal to
// maxOrdersTrimRatio * maxOrders.
maxOrdersTrimRatio = 0.9
// defaultMaxOrders is the default max number of orders in storage.
defaultMaxOrders = 100000
// maxExpirationTimeCheckInterval is how often to check whether we can
// increase the max expiration time.
maxExpirationTimeCheckInterval = 30 * time.Second
// configuration options for the SlowCounter used for increasing max
// expiration time. Effectively, we will increase every 5 minutes as long as
// there is enough space in the database for orders. The first increase will
// be 5 seconds and the amount doubles from there (second increase will be 10
// seconds, then 20 seconds, then 40, etc.)
slowCounterOffset = 5 // seconds
slowCounterRate = 2.0
slowCounterInterval = 5 * time.Minute
)
// Watcher watches all order-relevant state and handles the state transitions
type Watcher struct {
meshDB *meshdb.MeshDB
blockWatcher *blockwatch.Watcher
eventDecoder *decoder.Decoder
assetDataDecoder *zeroex.AssetDataDecoder
blockSubscription event.Subscription
contractAddresses ethereum.ContractAddresses
expirationWatcher *expirationwatch.Watcher
orderFeed event.Feed
orderScope event.SubscriptionScope // Subscription scope tracking current live listeners
contractAddressToSeenCount map[common.Address]uint
orderValidator *ordervalidator.OrderValidator
wasStartedOnce bool
mu sync.Mutex
maxExpirationTime *big.Int
maxExpirationCounter *slowcounter.SlowCounter
maxOrders int
latestBlockTimestamp time.Time
}
type Config struct {
MeshDB *meshdb.MeshDB
BlockWatcher *blockwatch.Watcher
OrderValidator *ordervalidator.OrderValidator
ChainID int
MaxOrders int
MaxExpirationTime *big.Int
}
// New instantiates a new order watcher
func New(config Config) (*Watcher, error) {
decoder, err := decoder.New()
if err != nil {
return nil, err
}
assetDataDecoder := zeroex.NewAssetDataDecoder()
contractAddresses, err := ethereum.GetContractAddressesForChainID(config.ChainID)
if err != nil {
return nil, err
}
// Validate config.
if config.MaxOrders == 0 {
return nil, errors.New("config.MaxOrders is required and cannot be zero")
}
if config.MaxExpirationTime == nil {
return nil, errors.New("config.MaxExpirationTime is required and cannot be nil")
} else if big.NewInt(time.Now().Unix()).Cmp(config.MaxExpirationTime) == 1 {
// MaxExpirationTime should never be in the past.
config.MaxExpirationTime = big.NewInt(time.Now().Unix())
}
// Configure a SlowCounter to be used for increasing max expiration time.
slowCounterConfig := slowcounter.Config{
Offset: big.NewInt(slowCounterOffset),
Rate: slowCounterRate,
Interval: slowCounterInterval,
MaxCount: constants.UnlimitedExpirationTime,
}
maxExpirationCounter, err := slowcounter.New(slowCounterConfig, config.MaxExpirationTime)
if err != nil {
return nil, err
}
w := &Watcher{
meshDB: config.MeshDB,
blockWatcher: config.BlockWatcher,
expirationWatcher: expirationwatch.New(),
contractAddressToSeenCount: map[common.Address]uint{},
orderValidator: config.OrderValidator,
eventDecoder: decoder,
assetDataDecoder: assetDataDecoder,
contractAddresses: contractAddresses,
maxExpirationTime: big.NewInt(0).Set(config.MaxExpirationTime),
maxExpirationCounter: maxExpirationCounter,
maxOrders: config.MaxOrders,
}
// Check if any orders need to be removed right away due to high expiration
// times.
if err := w.decreaseMaxExpirationTimeIfNeeded(); err != nil {
return nil, err
}
// Pre-populate the OrderWatcher with all orders already stored in the DB
orders := []*meshdb.Order{}
err = w.meshDB.Orders.FindAll(&orders)
if err != nil {
return nil, err
}
for _, order := range orders {
err := w.setupInMemoryOrderState(order.SignedOrder)
if err != nil {
return nil, err
}
}
return w, nil
}
// Watch sets up the event & expiration watchers as well as the cleanup worker.
// Event watching will require the blockwatch.Watcher to be started first. Watch
// will block until there is a critical error or the given context is canceled.
func (w *Watcher) Watch(ctx context.Context) error {
w.mu.Lock()
if w.wasStartedOnce {
w.mu.Unlock()
return errors.New("Can only start Watcher once per instance")
}
w.wasStartedOnce = true
w.mu.Unlock()
// Create a child context so that we can preemptively cancel if there is an
// error.
innerCtx, cancel := context.WithCancel(ctx)
defer cancel()
// A waitgroup lets us wait for all goroutines to exit.
wg := &sync.WaitGroup{}
// Start four independent goroutines. The main loop, cleanup loop, removed orders
// checker and max expirationTime checker. Use four separate channels to communicate errors.
mainLoopErrChan := make(chan error, 1)
wg.Add(1)
go func() {
defer wg.Done()
mainLoopErrChan <- w.mainLoop(innerCtx)
}()
cleanupLoopErrChan := make(chan error, 1)
wg.Add(1)
go func() {
defer wg.Done()
cleanupLoopErrChan <- w.cleanupLoop(innerCtx)
}()
maxExpirationTimeLoopErrChan := make(chan error, 1)
wg.Add(1)
go func() {
defer wg.Done()
maxExpirationTimeLoopErrChan <- w.maxExpirationTimeLoop(innerCtx)
}()
removedCheckerLoopErrChan := make(chan error, 1)
wg.Add(1)
go func() {
defer wg.Done()
removedCheckerLoopErrChan <- w.removedCheckerLoop(innerCtx)
}()
// If any error channel returns a non-nil error, we cancel the inner context
// and return the error. Note that this means we only return the first error
// that occurs.
select {
case err := <-mainLoopErrChan:
if err != nil {
cancel()
return err
}
case err := <-cleanupLoopErrChan:
if err != nil {
cancel()
return err
}
case err := <-maxExpirationTimeLoopErrChan:
if err != nil {
cancel()
return err
}
case err := <-removedCheckerLoopErrChan:
if err != nil {
cancel()
return err
}
}
// Wait for all goroutines to exit. If we reached here it means we are done
// and there are no errors.
wg.Wait()
return nil
}
func (w *Watcher) mainLoop(ctx context.Context) error {
// Set up the channel used for subscribing to block events.
blockEvents := make(chan []*blockwatch.Event, 10)
w.blockSubscription = w.blockWatcher.Subscribe(blockEvents)
for {
select {
case <-ctx.Done():
w.blockSubscription.Unsubscribe()
close(blockEvents)
return nil
case err := <-w.blockSubscription.Err():
logger.WithFields(logger.Fields{
"error": err.Error(),
}).Error("block subscription error encountered")
case events := <-blockEvents:
if err := w.handleBlockEvents(events); err != nil {
return err
}
}
}
}
func (w *Watcher) cleanupLoop(ctx context.Context) error {
start := time.Now()
for {
select {
case <-ctx.Done():
return nil
default:
}
// Wait minCleanupInterval before calling cleanup again. Since
// we only start sleeping _after_ cleanup completes, we will never
// have multiple calls to cleanup running in parallel
time.Sleep(minCleanupInterval - time.Since(start))
start = time.Now()
if err := w.Cleanup(ctx, defaultLastUpdatedBuffer); err != nil {
return err
}
}
}
func (w *Watcher) maxExpirationTimeLoop(ctx context.Context) error {
ticker := time.NewTicker(maxExpirationTimeCheckInterval)
for {
select {
case <-ctx.Done():
ticker.Stop()
return nil
case <-ticker.C:
if err := w.increaseMaxExpirationTimeIfPossible(); err != nil {
return err
}
}
}
}
func (w *Watcher) removedCheckerLoop(ctx context.Context) error {
for {
start := time.Now()
if err := w.permanentlyDeleteStaleRemovedOrders(ctx); err != nil {
return err
}
select {
case <-ctx.Done():
return nil
// Wait minRemovedCheckInterval before calling permanentlyDeleteStaleRemovedOrders again. Since
// we only start waiting _after_ permanentlyDeleteStaleRemovedOrders completes, we will never
// have multiple calls to permanentlyDeleteStaleRemovedOrders running in parallel
case <-time.After(minRemovedCheckInterval - time.Since(start)):
continue
}
}
}
func (w *Watcher) generateExpirationOrderEventsIfAny(ordersColTxn *db.Transaction, latestBlockTimestamp time.Time) ([]*zeroex.OrderEvent, error) {
orderEvents := []*zeroex.OrderEvent{}
var defaultTime time.Time
if w.latestBlockTimestamp == defaultTime || w.latestBlockTimestamp.Before(latestBlockTimestamp) {
expiredOrders := w.expirationWatcher.Prune(latestBlockTimestamp)
for _, expiredOrder := range expiredOrders {
order := &meshdb.Order{}
err := w.meshDB.Orders.FindByID(common.HexToHash(expiredOrder.ID).Bytes(), order)
if err != nil {
logger.WithFields(logger.Fields{
"error": err.Error(),
"orderHash": expiredOrder.ID,
}).Trace("Order expired that was no longer in DB")
continue
}
w.unwatchOrder(ordersColTxn, order, order.FillableTakerAssetAmount)
orderEvent := &zeroex.OrderEvent{
OrderHash: common.HexToHash(expiredOrder.ID),
SignedOrder: order.SignedOrder,
FillableTakerAssetAmount: big.NewInt(0),
EndState: zeroex.ESOrderExpired,
}
orderEvents = append(orderEvents, orderEvent)
}
} else {
// A block re-org happened resulting in the latest block timestamp being
// lower than on the previous latest block. We need to "unexpire" any orders
// that have now become valid again as a result.
removedOrders, err := w.meshDB.FindRemovedOrders()
if err != nil {
return nil, err
}
for _, order := range removedOrders {
// Orders removed due to expiration have non-zero FillableTakerAssetAmounts
if order.FillableTakerAssetAmount.Cmp(big.NewInt(0)) == 0 {
continue
}
expiration := time.Unix(order.SignedOrder.ExpirationTimeSeconds.Int64(), 0)
if latestBlockTimestamp.Before(expiration) {
w.rewatchOrder(ordersColTxn, order, order.FillableTakerAssetAmount)
orderEvent := &zeroex.OrderEvent{
OrderHash: order.Hash,
SignedOrder: order.SignedOrder,
FillableTakerAssetAmount: order.FillableTakerAssetAmount,
EndState: zeroex.ESOrderUnexpired,
}
orderEvents = append(orderEvents, orderEvent)
}
}
}
return orderEvents, nil
}
func (w *Watcher) handleBlockEvents(events []*blockwatch.Event) error {
ordersColTxn := w.meshDB.Orders.OpenTransaction()
defer func() {
_ = ordersColTxn.Discard()
}()
orderHashToDBOrder := map[common.Hash]*meshdb.Order{}
orderHashToEvents := map[common.Hash][]*zeroex.ContractEvent{}
var latestBlockNumber rpc.BlockNumber
var latestBlockTimestamp time.Time
for _, event := range events {
latestBlockNumber = rpc.BlockNumber(event.BlockHeader.Number.Int64())
latestBlockTimestamp = event.BlockHeader.Timestamp
for _, log := range event.BlockHeader.Logs {
var parameters interface{}
eventType, err := w.eventDecoder.FindEventType(log)
if err != nil {
switch err.(type) {
case decoder.UntrackedTokenError:
continue
case decoder.UnsupportedEventError:
logger.WithFields(logger.Fields{
"topics": err.(decoder.UnsupportedEventError).Topics,
"contractAddress": err.(decoder.UnsupportedEventError).ContractAddress,
}).Info("unsupported event found while trying to find its event type")
continue
default:
logger.WithFields(logger.Fields{
"error": err.Error(),
}).Error("unexpected event decoder error encountered")
return err
}
}
var orders []*meshdb.Order
switch eventType {
case "ERC20TransferEvent":
var transferEvent decoder.ERC20TransferEvent
err = w.eventDecoder.Decode(log, &transferEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = transferEvent
fromOrders, err := w.findOrders(transferEvent.From, log.Address, nil)
if err != nil {
return err
}
orders = append(orders, fromOrders...)
toOrders, err := w.findOrders(transferEvent.To, log.Address, nil)
if err != nil {
return err
}
orders = append(orders, toOrders...)
case "ERC20ApprovalEvent":
var approvalEvent decoder.ERC20ApprovalEvent
err = w.eventDecoder.Decode(log, &approvalEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
// Ignores approvals set to anyone except the AssetProxy
if approvalEvent.Spender != w.contractAddresses.ERC20Proxy {
continue
}
parameters = approvalEvent
orders, err = w.findOrders(approvalEvent.Owner, log.Address, nil)
if err != nil {
return err
}
case "ERC721TransferEvent":
var transferEvent decoder.ERC721TransferEvent
err = w.eventDecoder.Decode(log, &transferEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = transferEvent
fromOrders, err := w.findOrders(transferEvent.From, log.Address, transferEvent.TokenId)
if err != nil {
return err
}
orders = append(orders, fromOrders...)
toOrders, err := w.findOrders(transferEvent.To, log.Address, transferEvent.TokenId)
if err != nil {
return err
}
orders = append(orders, toOrders...)
case "ERC721ApprovalEvent":
var approvalEvent decoder.ERC721ApprovalEvent
err = w.eventDecoder.Decode(log, &approvalEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
// Ignores approvals set to anyone except the AssetProxy
if approvalEvent.Approved != w.contractAddresses.ERC721Proxy {
continue
}
parameters = approvalEvent
orders, err = w.findOrders(approvalEvent.Owner, log.Address, approvalEvent.TokenId)
if err != nil {
return err
}
case "ERC721ApprovalForAllEvent":
var approvalForAllEvent decoder.ERC721ApprovalForAllEvent
err = w.eventDecoder.Decode(log, &approvalForAllEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
// Ignores approvals set to anyone except the AssetProxy
if approvalForAllEvent.Operator != w.contractAddresses.ERC721Proxy {
continue
}
parameters = approvalForAllEvent
orders, err = w.findOrders(approvalForAllEvent.Owner, log.Address, nil)
if err != nil {
return err
}
case "ERC1155TransferSingleEvent":
var transferEvent decoder.ERC1155TransferSingleEvent
err = w.eventDecoder.Decode(log, &transferEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
// HACK(fabio): Currently we simply revalidate all orders involving assets in this
// ERC1155 contract from this particular maker. We could however revalidate fewer orders
// by also taking into account the `ID` of the assets affected. We punt on this for now
// in order to support Augur's use-case of a dummy ERC1155 contract. In their case, we
// need to revalidate all maker orders within the single ERC1155 contract and cannot optimize
// further. In the future, we might want to special-case this broader approach for the Augur
// contract address specifically.
parameters = transferEvent
fromOrders, err := w.findOrders(transferEvent.From, log.Address, nil)
if err != nil {
return err
}
orders = append(orders, fromOrders...)
toOrders, err := w.findOrders(transferEvent.To, log.Address, nil)
if err != nil {
return err
}
orders = append(orders, toOrders...)
case "ERC1155TransferBatchEvent":
var transferEvent decoder.ERC1155TransferBatchEvent
err = w.eventDecoder.Decode(log, &transferEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = transferEvent
fromOrders, err := w.findOrders(transferEvent.From, log.Address, nil)
if err != nil {
return err
}
orders = append(orders, fromOrders...)
toOrders, err := w.findOrders(transferEvent.To, log.Address, nil)
if err != nil {
return err
}
orders = append(orders, toOrders...)
case "ERC1155ApprovalForAllEvent":
var approvalForAllEvent decoder.ERC1155ApprovalForAllEvent
err = w.eventDecoder.Decode(log, &approvalForAllEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
// Ignores approvals set to anyone except the AssetProxy
if approvalForAllEvent.Operator != w.contractAddresses.ERC1155Proxy {
continue
}
parameters = approvalForAllEvent
orders, err = w.findOrders(approvalForAllEvent.Owner, log.Address, nil)
if err != nil {
return err
}
case "WethWithdrawalEvent":
var withdrawalEvent decoder.WethWithdrawalEvent
err = w.eventDecoder.Decode(log, &withdrawalEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = withdrawalEvent
orders, err = w.findOrders(withdrawalEvent.Owner, log.Address, nil)
if err != nil {
return err
}
case "WethDepositEvent":
var depositEvent decoder.WethDepositEvent
err = w.eventDecoder.Decode(log, &depositEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = depositEvent
orders, err = w.findOrders(depositEvent.Owner, log.Address, nil)
if err != nil {
return err
}
case "ExchangeFillEvent":
var exchangeFillEvent decoder.ExchangeFillEvent
err = w.eventDecoder.Decode(log, &exchangeFillEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = exchangeFillEvent
order := w.findOrder(exchangeFillEvent.OrderHash)
if order != nil {
orders = append(orders, order)
}
case "ExchangeCancelEvent":
var exchangeCancelEvent decoder.ExchangeCancelEvent
err = w.eventDecoder.Decode(log, &exchangeCancelEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = exchangeCancelEvent
orders = []*meshdb.Order{}
order := w.findOrder(exchangeCancelEvent.OrderHash)
if order != nil {
orders = append(orders, order)
}
case "ExchangeCancelUpToEvent":
var exchangeCancelUpToEvent decoder.ExchangeCancelUpToEvent
err = w.eventDecoder.Decode(log, &exchangeCancelUpToEvent)
if err != nil {
if isNonCritical := w.checkDecodeErr(err, eventType); isNonCritical {
continue
}
return err
}
parameters = exchangeCancelUpToEvent
orders, err = w.meshDB.FindOrdersByMakerAddressAndMaxSalt(exchangeCancelUpToEvent.MakerAddress, exchangeCancelUpToEvent.OrderEpoch)
if err != nil {
logger.WithFields(logger.Fields{
"error": err.Error(),
}).Error("unexpected query error encountered")
return err
}
default:
logger.WithFields(logger.Fields{
"eventType": eventType,
"log": log,
}).Error("unknown eventType encountered")
return err
}
contractEvent := &zeroex.ContractEvent{
BlockHash: log.BlockHash,
TxHash: log.TxHash,
TxIndex: log.TxIndex,
LogIndex: log.Index,
IsRemoved: log.Removed,
Address: log.Address,
Kind: eventType,
Parameters: parameters,
}
for _, order := range orders {
orderHashToDBOrder[order.Hash] = order
if _, ok := orderHashToEvents[order.Hash]; !ok {
orderHashToEvents[order.Hash] = []*zeroex.ContractEvent{contractEvent}
} else {
orderHashToEvents[order.Hash] = append(orderHashToEvents[order.Hash], contractEvent)
}
}
}
}
orderEvents, err := w.generateExpirationOrderEventsIfAny(ordersColTxn, latestBlockTimestamp)
if err != nil {
return err
}
w.latestBlockTimestamp = latestBlockTimestamp
// This timeout of 1min is for limiting how long this call should block at the ETH RPC rate limiter
ctx, done := context.WithTimeout(context.Background(), 1*time.Minute)
defer done()
moreOrderEvents, err := w.generateOrderEventsIfChanged(ctx, ordersColTxn, orderHashToDBOrder, orderHashToEvents, latestBlockNumber)
if err != nil {
return err
}
if err := ordersColTxn.Commit(); err != nil {
logger.WithFields(logger.Fields{
"error": err.Error(),
}).Error("Failed to commit orders collection transaction")
}
orderEvents = append(orderEvents, moreOrderEvents...)
if len(orderEvents) > 0 {
w.orderFeed.Send(orderEvents)
}
return nil
}
// Cleanup re-validates all orders in DB which haven't been re-validated in
// `lastUpdatedBuffer` time to make sure all orders are still up-to-date
func (w *Watcher) Cleanup(ctx context.Context, lastUpdatedBuffer time.Duration) error {
ordersColTxn := w.meshDB.Orders.OpenTransaction()
defer func() {
_ = ordersColTxn.Discard()
}()
lastUpdatedCutOff := time.Now().Add(-lastUpdatedBuffer)
orders, err := w.meshDB.FindOrdersLastUpdatedBefore(lastUpdatedCutOff)
if err != nil {
logger.WithFields(logger.Fields{
"error": err.Error(),
"lastUpdatedCutOff": lastUpdatedCutOff,
}).Error("Failed to find orders by LastUpdatedBefore")
return err
}
orderHashToDBOrder := map[common.Hash]*meshdb.Order{}
orderHashToEvents := map[common.Hash][]*zeroex.ContractEvent{} // No events when running cleanup job
for _, order := range orders {
select {
case <-ctx.Done():
return nil
default:
}
orderHashToDBOrder[order.Hash] = order
orderHashToEvents[order.Hash] = []*zeroex.ContractEvent{}
}
// This timeout of 30min is for limiting how long this call should block at the ETH RPC rate limiter
ctx, cancel := context.WithTimeout(ctx, 30*time.Minute)
defer cancel()
orderEvents, err := w.generateOrderEventsIfChanged(ctx, ordersColTxn, orderHashToDBOrder, orderHashToEvents, rpc.LatestBlockNumber)
if err != nil {
return err
}
if err := ordersColTxn.Commit(); err != nil {
logger.WithFields(logger.Fields{
"error": err.Error(),
}).Error("Failed to commit orders collection transaction")
}
if len(orderEvents) > 0 {
w.orderFeed.Send(orderEvents)
}
return nil
}
func (w *Watcher) permanentlyDeleteStaleRemovedOrders(ctx context.Context) error {
removedOrders, err := w.meshDB.FindRemovedOrders()
if err != nil {
return err
}
for _, order := range removedOrders {
if time.Since(order.LastUpdated) > permanentlyDeleteAfter {
if err := w.permanentlyDeleteOrder(w.meshDB.Orders, order); err != nil {
return err
}
continue
}
}
return nil
}
// Add adds a 0x order to the DB and watches it for changes in fillability. It
// will no-op (and return nil) if the order has already been added. If pinned is
// true, the orders will be marked as pinned. Pinned orders will not be affected
// by any DDoS prevention or incentive mechanisms and will always stay in
// storage until they are no longer fillable.
func (w *Watcher) Add(orderInfo *ordervalidator.AcceptedOrderInfo, pinned bool) error {
if err := w.decreaseMaxExpirationTimeIfNeeded(); err != nil {
return err
}
// TODO(albrow): technically we should count the current number of orders,
// remove some if needed, and then insert the order in a single transaction to
// ensure that we don't accidentally exceed the maximum. In practice, and
// because of the way OrderWatcher works, the distinction shouldn't matter.
txn := w.meshDB.Orders.OpenTransaction()
defer func() {
_ = txn.Discard()
}()
// Final expiration time check before inserting the order. We might have just
// changed max expiration time above.
if !pinned && orderInfo.SignedOrder.ExpirationTimeSeconds.Cmp(w.maxExpirationTime) == 1 {
// HACK(albrow): This is technically not the ideal way to respond to this
// situation, but it is a lot easier to implement for the time being. In the
// future, we should return an error and then react to that error
// differently depending on whether the order was received via RPC or from a
// peer. In the former case, we should return an RPC error response
// indicating that the order was not in fact added. In the latter case, we
// should effectively no-op, neither penalizing the peer or emitting any
// order events. For now, we respond by emitting an ADDED event immediately
// followed by a STOPPED_WATCHING event. If this order was submitted via
// RPC, the RPC client will see a response that indicates the order was
// successfully added, and then it will look like we immediately stopped
// watching it. This is not too far off from what really happened but is
// slightly inefficient.
addedEvent := &zeroex.OrderEvent{
OrderHash: orderInfo.OrderHash,
SignedOrder: orderInfo.SignedOrder,
FillableTakerAssetAmount: orderInfo.FillableTakerAssetAmount,
EndState: zeroex.ESOrderAdded,
}
stoppedWatchingEvent := &zeroex.OrderEvent{
OrderHash: orderInfo.OrderHash,
SignedOrder: orderInfo.SignedOrder,
FillableTakerAssetAmount: orderInfo.FillableTakerAssetAmount,
EndState: zeroex.ESStoppedWatching,
}
w.orderFeed.Send([]*zeroex.OrderEvent{addedEvent, stoppedWatchingEvent})
return nil
}
order := &meshdb.Order{
Hash: orderInfo.OrderHash,
SignedOrder: orderInfo.SignedOrder,
LastUpdated: time.Now().UTC(),
FillableTakerAssetAmount: orderInfo.FillableTakerAssetAmount,
IsRemoved: false,
IsPinned: pinned,
}
err := txn.Insert(order)
if err != nil {
if _, ok := err.(db.AlreadyExistsError); ok {
// If we're already watching the order, that's fine in this case. Don't
// return an error.
return nil
}
return err
}
if err := txn.Commit(); err != nil {
return err
}
err = w.setupInMemoryOrderState(orderInfo.SignedOrder)
if err != nil {
return err
}
orderEvent := &zeroex.OrderEvent{
OrderHash: orderInfo.OrderHash,
SignedOrder: orderInfo.SignedOrder,
FillableTakerAssetAmount: orderInfo.FillableTakerAssetAmount,
EndState: zeroex.ESOrderAdded,
}
w.orderFeed.Send([]*zeroex.OrderEvent{orderEvent})
return nil
}
func (w *Watcher) trimOrdersAndFireEvents() error {
targetMaxOrders := int(maxOrdersTrimRatio * float64(w.maxOrders))
newMaxExpirationTime, removedOrders, err := w.meshDB.TrimOrdersByExpirationTime(targetMaxOrders)
if err != nil {
return err
}
if len(removedOrders) > 0 {
logger.WithFields(logger.Fields{
"numOrdersRemoved": len(removedOrders),
"targetMaxOrders": targetMaxOrders,
}).Debug("removing orders to make space")
}
for _, removedOrder := range removedOrders {
// Fire a "STOPPED_WATCHING" event for each order that was removed.
orderEvent := &zeroex.OrderEvent{
OrderHash: removedOrder.Hash,
SignedOrder: removedOrder.SignedOrder,
FillableTakerAssetAmount: removedOrder.FillableTakerAssetAmount,
EndState: zeroex.ESStoppedWatching,
}
w.orderFeed.Send([]*zeroex.OrderEvent{orderEvent})
// Remove in-memory state
expirationTimestamp := time.Unix(removedOrder.SignedOrder.ExpirationTimeSeconds.Int64(), 0)
w.expirationWatcher.Remove(expirationTimestamp, removedOrder.Hash.Hex())
err = w.removeAssetDataAddressFromEventDecoder(removedOrder.SignedOrder.MakerAssetData)
if err != nil {
// This should never happen since the same error would have happened when adding
// the assetData to the EventDecoder.
logger.WithFields(logger.Fields{
"error": err.Error(),
"signedOrder": removedOrder.SignedOrder,
}).Error("Unexpected error when trying to remove an assetData from decoder")
return err
}
}
if newMaxExpirationTime.Cmp(w.maxExpirationTime) == -1 {
// Decrease the max expiration time to account for the fact that orders were
// removed.
logger.WithFields(logger.Fields{
"oldMaxExpirationTime": w.maxExpirationTime.String(),
"newMaxExpirationTime": newMaxExpirationTime.String(),
}).Debug("decreasing max expiration time")
w.maxExpirationTime = newMaxExpirationTime
w.maxExpirationCounter.Reset(newMaxExpirationTime)
w.saveMaxExpirationTime(newMaxExpirationTime)
}
return nil
}
// MaxExpirationTime returns the current maximum expiration time for incoming
// orders.
func (w *Watcher) MaxExpirationTime() *big.Int {
return w.maxExpirationTime
}
func (w *Watcher) setupInMemoryOrderState(signedOrder *zeroex.SignedOrder) error {
orderHash, err := signedOrder.ComputeOrderHash()
if err != nil {
return err
}
w.eventDecoder.AddKnownExchange(signedOrder.ExchangeAddress)
err = w.addAssetDataAddressToEventDecoder(signedOrder.MakerAssetData)
if err != nil {
return err
}
expirationTimestamp := time.Unix(signedOrder.ExpirationTimeSeconds.Int64(), 0)
w.expirationWatcher.Add(expirationTimestamp, orderHash.Hex())
return nil
}
// Subscribe allows one to subscribe to the order events emitted by the OrderWatcher.
// To unsubscribe, simply call `Unsubscribe` on the returned subscription.
// The sink channel should have ample buffer space to avoid blocking other subscribers.
// Slow subscribers are not dropped.
func (w *Watcher) Subscribe(sink chan<- []*zeroex.OrderEvent) event.Subscription {
return w.orderScope.Track(w.orderFeed.Subscribe(sink))
}
func (w *Watcher) findOrder(orderHash common.Hash) *meshdb.Order {
order := meshdb.Order{}
err := w.meshDB.Orders.FindByID(orderHash.Bytes(), &order)
if err != nil {
if _, ok := err.(db.NotFoundError); ok {
// short-circuit. We expect to receive events from orders we aren't actively tracking
return nil
}
logger.WithFields(logger.Fields{
"error": err.Error(),
"orderHash": orderHash,
}).Warning("Unexpected error using FindByID for order")
return nil
}
return &order
}
func (w *Watcher) findOrders(makerAddress, tokenAddress common.Address, tokenID *big.Int) ([]*meshdb.Order, error) {
orders, err := w.meshDB.FindOrdersByMakerAddressTokenAddressAndTokenID(makerAddress, tokenAddress, tokenID)
if err != nil {
logger.WithFields(logger.Fields{
"error": err.Error(),
}).Error("unexpected query error encountered")
return nil, err
}
return orders, nil
}
func (w *Watcher) generateOrderEventsIfChanged(ctx context.Context, ordersColTxn *db.Transaction, orderHashToDBOrder map[common.Hash]*meshdb.Order, orderHashToEvents map[common.Hash][]*zeroex.ContractEvent, validationBlockNumber rpc.BlockNumber) ([]*zeroex.OrderEvent, error) {
signedOrders := []*zeroex.SignedOrder{}
for _, order := range orderHashToDBOrder {
if order.IsRemoved && time.Since(order.LastUpdated) > permanentlyDeleteAfter {
if err := w.permanentlyDeleteOrder(ordersColTxn, order); err != nil {
return nil, err
}
continue
}
signedOrders = append(signedOrders, order.SignedOrder)
}
if len(signedOrders) == 0 {
return nil, nil
}