aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/test/exchange_wrapper_test.ts
blob: cfc390bae833b686f317b454ca9119264ce3c83e (plain) (blame)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
import { BlockchainLifecycle, devConstants, web3Factory } from '@0xproject/dev-utils';
import { BlockParamLiteral } from '@0xproject/types';
import { BigNumber } from '@0xproject/utils';
import * as chai from 'chai';
import * as _ from 'lodash';
import 'mocha';
import * as Web3 from 'web3';

import {
    BlockRange,
    DecodedLogEvent,
    ExchangeContractErrs,
    ExchangeEvents,
    LogCancelContractEventArgs,
    LogFillContractEventArgs,
    OrderCancellationRequest,
    OrderFillRequest,
    SignedOrder,
    Token,
    ZeroEx,
} from '../src';
import { DoneCallback } from '../src/types';

import { chaiSetup } from './utils/chai_setup';
import { constants } from './utils/constants';
import { FillScenarios } from './utils/fill_scenarios';
import { reportNodeCallbackErrors } from './utils/report_callback_errors';
import { TokenUtils } from './utils/token_utils';
import { web3, web3Wrapper } from './utils/web3_wrapper';

chaiSetup.configure();
const expect = chai.expect;
const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);

const NON_EXISTENT_ORDER_HASH = '0x79370342234e7acd6bbeac335bd3bb1d368383294b64b8160a00f4060e4d3777';

describe('ExchangeWrapper', () => {
    let zeroEx: ZeroEx;
    let tokenUtils: TokenUtils;
    let tokens: Token[];
    let userAddresses: string[];
    let zrxTokenAddress: string;
    let fillScenarios: FillScenarios;
    let exchangeContractAddress: string;
    const config = {
        networkId: constants.TESTRPC_NETWORK_ID,
    };
    before(async () => {
        zeroEx = new ZeroEx(web3.currentProvider, config);
        exchangeContractAddress = zeroEx.exchange.getContractAddress();
        userAddresses = await zeroEx.getAvailableAddressesAsync();
        tokens = await zeroEx.tokenRegistry.getTokensAsync();
        tokenUtils = new TokenUtils(tokens);
        zrxTokenAddress = tokenUtils.getProtocolTokenOrThrow().address;
        fillScenarios = new FillScenarios(zeroEx, userAddresses, tokens, zrxTokenAddress, exchangeContractAddress);
        await fillScenarios.initTokenBalancesAsync();
    });
    beforeEach(async () => {
        await blockchainLifecycle.startAsync();
    });
    afterEach(async () => {
        await blockchainLifecycle.revertAsync();
    });
    describe('fillOrKill order(s)', () => {
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let coinbase: string;
        let makerAddress: string;
        let takerAddress: string;
        let feeRecipient: string;
        const takerTokenFillAmount = new BigNumber(5);
        before(async () => {
            [coinbase, makerAddress, takerAddress, feeRecipient] = userAddresses;
            tokens = await zeroEx.tokenRegistry.getTokensAsync();
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
        });
        describe('#batchFillOrKillAsync', () => {
            it('successfully batch fillOrKill', async () => {
                const fillableAmount = new BigNumber(5);
                const partialFillTakerAmount = new BigNumber(2);
                const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                const anotherSignedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                const orderFillRequests = [
                    {
                        signedOrder,
                        takerTokenFillAmount: partialFillTakerAmount,
                    },
                    {
                        signedOrder: anotherSignedOrder,
                        takerTokenFillAmount: partialFillTakerAmount,
                    },
                ];
                await zeroEx.exchange.batchFillOrKillAsync(orderFillRequests, takerAddress);
            });
            describe('order transaction options', () => {
                let signedOrder: SignedOrder;
                let orderFillRequests: OrderFillRequest[];
                const fillableAmount = new BigNumber(5);
                beforeEach(async () => {
                    signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        makerAddress,
                        takerAddress,
                        fillableAmount,
                    );
                    orderFillRequests = [
                        {
                            signedOrder,
                            takerTokenFillAmount: new BigNumber(0),
                        },
                    ];
                });
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrKillAsync(orderFillRequests, takerAddress),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrKillAsync(orderFillRequests, takerAddress, {
                            shouldValidate: true,
                        }),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrKillAsync(orderFillRequests, takerAddress, {
                            shouldValidate: false,
                        }),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
            });
        });
        describe('#fillOrKillOrderAsync', () => {
            let signedOrder: SignedOrder;
            const fillableAmount = new BigNumber(5);
            beforeEach(async () => {
                signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
            });
            describe('successful fills', () => {
                it('should fill a valid order', async () => {
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        fillableAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        0,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        0,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        fillableAmount,
                    );
                    await zeroEx.exchange.fillOrKillOrderAsync(signedOrder, takerTokenFillAmount, takerAddress);
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(takerTokenFillAmount),
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        takerTokenFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        takerTokenFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(takerTokenFillAmount),
                    );
                });
                it('should partially fill a valid order', async () => {
                    const partialFillAmount = new BigNumber(3);
                    await zeroEx.exchange.fillOrKillOrderAsync(signedOrder, partialFillAmount, takerAddress);
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(partialFillAmount),
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        partialFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        partialFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(partialFillAmount),
                    );
                });
            });
            describe('order transaction options', () => {
                const emptyFillableAmount = new BigNumber(0);
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(
                        zeroEx.exchange.fillOrKillOrderAsync(signedOrder, emptyFillableAmount, takerAddress),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.fillOrKillOrderAsync(signedOrder, emptyFillableAmount, takerAddress, {
                            shouldValidate: true,
                        }),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.fillOrKillOrderAsync(signedOrder, emptyFillableAmount, takerAddress, {
                            shouldValidate: false,
                        }),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
            });
        });
    });
    describe('fill order(s)', () => {
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let coinbase: string;
        let makerAddress: string;
        let takerAddress: string;
        let feeRecipient: string;
        const fillableAmount = new BigNumber(5);
        const takerTokenFillAmount = new BigNumber(5);
        const shouldThrowOnInsufficientBalanceOrAllowance = true;
        before(async () => {
            [coinbase, makerAddress, takerAddress, feeRecipient] = userAddresses;
            tokens = await zeroEx.tokenRegistry.getTokensAsync();
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
        });
        describe('#fillOrderAsync', () => {
            describe('successful fills', () => {
                it('should fill a valid order', async () => {
                    const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        makerAddress,
                        takerAddress,
                        fillableAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        fillableAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        0,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        0,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        fillableAmount,
                    );
                    const txHash = await zeroEx.exchange.fillOrderAsync(
                        signedOrder,
                        takerTokenFillAmount,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(takerTokenFillAmount),
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        takerTokenFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        takerTokenFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(takerTokenFillAmount),
                    );
                });
                it('should partially fill the valid order', async () => {
                    const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        makerAddress,
                        takerAddress,
                        fillableAmount,
                    );
                    const partialFillAmount = new BigNumber(3);
                    const txHash = await zeroEx.exchange.fillOrderAsync(
                        signedOrder,
                        partialFillAmount,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(partialFillAmount),
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, makerAddress)).to.be.bignumber.equal(
                        partialFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(makerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        partialFillAmount,
                    );
                    expect(await zeroEx.token.getBalanceAsync(takerTokenAddress, takerAddress)).to.be.bignumber.equal(
                        fillableAmount.minus(partialFillAmount),
                    );
                });
                it('should fill the valid orders with fees', async () => {
                    const makerFee = new BigNumber(1);
                    const takerFee = new BigNumber(2);
                    const signedOrder = await fillScenarios.createFillableSignedOrderWithFeesAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        makerFee,
                        takerFee,
                        makerAddress,
                        takerAddress,
                        fillableAmount,
                        feeRecipient,
                    );
                    const txHash = await zeroEx.exchange.fillOrderAsync(
                        signedOrder,
                        takerTokenFillAmount,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    expect(await zeroEx.token.getBalanceAsync(zrxTokenAddress, feeRecipient)).to.be.bignumber.equal(
                        makerFee.plus(takerFee),
                    );
                });
            });
            describe('order transaction options', () => {
                let signedOrder: SignedOrder;
                const emptyFillTakerAmount = new BigNumber(0);
                beforeEach(async () => {
                    signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        makerAddress,
                        takerAddress,
                        fillableAmount,
                    );
                });
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(
                        zeroEx.exchange.fillOrderAsync(
                            signedOrder,
                            emptyFillTakerAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.fillOrderAsync(
                            signedOrder,
                            emptyFillTakerAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                            {
                                shouldValidate: true,
                            },
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.fillOrderAsync(
                            signedOrder,
                            emptyFillTakerAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                            {
                                shouldValidate: false,
                            },
                        ),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
            });
            describe('negative fill amount', async () => {
                let signedOrder: SignedOrder;
                const negativeFillTakerAmount = new BigNumber(-100);
                beforeEach(async () => {
                    signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        makerAddress,
                        takerAddress,
                        fillableAmount,
                    );
                });
                it('should not allow the exchange wrapper to fill if amount is negative', async () => {
                    return expect(
                        zeroEx.exchange.fillOrderAsync(
                            signedOrder,
                            negativeFillTakerAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejected();
                });
            });
        });
        describe('#batchFillOrdersAsync', () => {
            let signedOrder: SignedOrder;
            let signedOrderHashHex: string;
            let anotherSignedOrder: SignedOrder;
            let anotherOrderHashHex: string;
            let orderFillBatch: OrderFillRequest[];
            beforeEach(async () => {
                signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                signedOrderHashHex = ZeroEx.getOrderHashHex(signedOrder);
                anotherSignedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                anotherOrderHashHex = ZeroEx.getOrderHashHex(anotherSignedOrder);
            });
            describe('successful batch fills', () => {
                beforeEach(() => {
                    orderFillBatch = [
                        {
                            signedOrder,
                            takerTokenFillAmount,
                        },
                        {
                            signedOrder: anotherSignedOrder,
                            takerTokenFillAmount,
                        },
                    ];
                });
                it('should throw if a batch is empty', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrdersAsync(
                            [],
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.BatchOrdersMustHaveAtLeastOneItem);
                });
                it('should successfully fill multiple orders', async () => {
                    const txHash = await zeroEx.exchange.batchFillOrdersAsync(
                        orderFillBatch,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    const filledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(signedOrderHashHex);
                    const anotherFilledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(anotherOrderHashHex);
                    expect(filledAmount).to.be.bignumber.equal(takerTokenFillAmount);
                    expect(anotherFilledAmount).to.be.bignumber.equal(takerTokenFillAmount);
                });
            });
            describe('order transaction options', () => {
                beforeEach(async () => {
                    const emptyFillTakerAmount = new BigNumber(0);
                    orderFillBatch = [
                        {
                            signedOrder,
                            takerTokenFillAmount: emptyFillTakerAmount,
                        },
                        {
                            signedOrder: anotherSignedOrder,
                            takerTokenFillAmount: emptyFillTakerAmount,
                        },
                    ];
                });
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrdersAsync(
                            orderFillBatch,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrdersAsync(
                            orderFillBatch,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                            {
                                shouldValidate: true,
                            },
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrdersAsync(
                            orderFillBatch,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                            {
                                shouldValidate: false,
                            },
                        ),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
            });
            describe('negative batch fill amount', async () => {
                beforeEach(async () => {
                    const negativeFillTakerAmount = new BigNumber(-100);
                    orderFillBatch = [
                        {
                            signedOrder,
                            takerTokenFillAmount,
                        },
                        {
                            signedOrder: anotherSignedOrder,
                            takerTokenFillAmount: negativeFillTakerAmount,
                        },
                    ];
                });
                it('should not allow the exchange wrapper to batch fill if any amount is negative', async () => {
                    return expect(
                        zeroEx.exchange.batchFillOrdersAsync(
                            orderFillBatch,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejected();
                });
            });
        });
        describe('#fillOrdersUpTo', () => {
            let signedOrder: SignedOrder;
            let signedOrderHashHex: string;
            let anotherSignedOrder: SignedOrder;
            let anotherOrderHashHex: string;
            let signedOrders: SignedOrder[];
            const fillUpToAmount = fillableAmount.plus(fillableAmount).minus(1);
            beforeEach(async () => {
                signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                signedOrderHashHex = ZeroEx.getOrderHashHex(signedOrder);
                anotherSignedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                anotherOrderHashHex = ZeroEx.getOrderHashHex(anotherSignedOrder);
                signedOrders = [signedOrder, anotherSignedOrder];
            });
            describe('successful batch fills', () => {
                it('should throw if a batch is empty', async () => {
                    return expect(
                        zeroEx.exchange.fillOrdersUpToAsync(
                            [],
                            fillUpToAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.BatchOrdersMustHaveAtLeastOneItem);
                });
                it('should successfully fill up to specified amount when all orders are fully funded', async () => {
                    const txHash = await zeroEx.exchange.fillOrdersUpToAsync(
                        signedOrders,
                        fillUpToAmount,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    const filledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(signedOrderHashHex);
                    const anotherFilledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(anotherOrderHashHex);
                    expect(filledAmount).to.be.bignumber.equal(fillableAmount);
                    const remainingFillAmount = fillableAmount.minus(1);
                    expect(anotherFilledAmount).to.be.bignumber.equal(remainingFillAmount);
                });
                it('should successfully fill up to specified amount and leave the rest of the orders untouched', async () => {
                    const txHash = await zeroEx.exchange.fillOrdersUpToAsync(
                        signedOrders,
                        fillableAmount,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    const filledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(signedOrderHashHex);
                    const zeroAmount = await zeroEx.exchange.getFilledTakerAmountAsync(anotherOrderHashHex);
                    expect(filledAmount).to.be.bignumber.equal(fillableAmount);
                    expect(zeroAmount).to.be.bignumber.equal(0);
                });
                it('should successfully fill up to specified amount even if filling all orders would fail', async () => {
                    const missingBalance = new BigNumber(1); // User will still have enough balance to fill up to 9,
                    // but won't have 10 to fully fill all orders in a batch.
                    await zeroEx.token.transferAsync(makerTokenAddress, makerAddress, coinbase, missingBalance);
                    const txHash = await zeroEx.exchange.fillOrdersUpToAsync(
                        signedOrders,
                        fillUpToAmount,
                        shouldThrowOnInsufficientBalanceOrAllowance,
                        takerAddress,
                    );
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    const filledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(signedOrderHashHex);
                    const anotherFilledAmount = await zeroEx.exchange.getFilledTakerAmountAsync(anotherOrderHashHex);
                    expect(filledAmount).to.be.bignumber.equal(fillableAmount);
                    const remainingFillAmount = fillableAmount.minus(1);
                    expect(anotherFilledAmount).to.be.bignumber.equal(remainingFillAmount);
                });
            });
            describe('failed batch fills', () => {
                it("should fail validation if user doesn't have enough balance without fill up to", async () => {
                    const missingBalance = new BigNumber(2); // User will only have enough balance to fill up to 8
                    await zeroEx.token.transferAsync(makerTokenAddress, makerAddress, coinbase, missingBalance);
                    return expect(
                        zeroEx.exchange.fillOrdersUpToAsync(
                            signedOrders,
                            fillUpToAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.InsufficientMakerBalance);
                });
            });
            describe('order transaction options', () => {
                const emptyFillUpToAmount = new BigNumber(0);
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(
                        zeroEx.exchange.fillOrdersUpToAsync(
                            signedOrders,
                            emptyFillUpToAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.fillOrdersUpToAsync(
                            signedOrders,
                            emptyFillUpToAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                            {
                                shouldValidate: true,
                            },
                        ),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.fillOrdersUpToAsync(
                            signedOrders,
                            emptyFillUpToAmount,
                            shouldThrowOnInsufficientBalanceOrAllowance,
                            takerAddress,
                            {
                                shouldValidate: false,
                            },
                        ),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderFillAmountZero);
                });
            });
        });
    });
    describe('cancel order(s)', () => {
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let coinbase: string;
        let makerAddress: string;
        let takerAddress: string;
        const fillableAmount = new BigNumber(5);
        let signedOrder: SignedOrder;
        let orderHashHex: string;
        const cancelAmount = new BigNumber(3);
        beforeEach(async () => {
            [coinbase, makerAddress, takerAddress] = userAddresses;
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
            signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                makerAddress,
                takerAddress,
                fillableAmount,
            );
            orderHashHex = ZeroEx.getOrderHashHex(signedOrder);
        });
        describe('#cancelOrderAsync', () => {
            describe('successful cancels', () => {
                it('should cancel an order', async () => {
                    const txHash = await zeroEx.exchange.cancelOrderAsync(signedOrder, cancelAmount);
                    await zeroEx.awaitTransactionMinedAsync(txHash);
                    const cancelledAmount = await zeroEx.exchange.getCancelledTakerAmountAsync(orderHashHex);
                    expect(cancelledAmount).to.be.bignumber.equal(cancelAmount);
                });
            });
            describe('order transaction options', () => {
                const emptyCancelTakerTokenAmount = new BigNumber(0);
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(
                        zeroEx.exchange.cancelOrderAsync(signedOrder, emptyCancelTakerTokenAmount),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderCancelAmountZero);
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.cancelOrderAsync(signedOrder, emptyCancelTakerTokenAmount, {
                            shouldValidate: true,
                        }),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderCancelAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.cancelOrderAsync(signedOrder, emptyCancelTakerTokenAmount, {
                            shouldValidate: false,
                        }),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderCancelAmountZero);
                });
            });
        });
        describe('#batchCancelOrdersAsync', () => {
            let anotherSignedOrder: SignedOrder;
            let anotherOrderHashHex: string;
            let cancelBatch: OrderCancellationRequest[];
            beforeEach(async () => {
                anotherSignedOrder = await fillScenarios.createFillableSignedOrderAsync(
                    makerTokenAddress,
                    takerTokenAddress,
                    makerAddress,
                    takerAddress,
                    fillableAmount,
                );
                anotherOrderHashHex = ZeroEx.getOrderHashHex(anotherSignedOrder);
                cancelBatch = [
                    {
                        order: signedOrder,
                        takerTokenCancelAmount: cancelAmount,
                    },
                    {
                        order: anotherSignedOrder,
                        takerTokenCancelAmount: cancelAmount,
                    },
                ];
            });
            describe('failed batch cancels', () => {
                it('should throw when orders have different makers', async () => {
                    const signedOrderWithDifferentMaker = await fillScenarios.createFillableSignedOrderAsync(
                        makerTokenAddress,
                        takerTokenAddress,
                        takerAddress,
                        takerAddress,
                        fillableAmount,
                    );
                    return expect(
                        zeroEx.exchange.batchCancelOrdersAsync([
                            cancelBatch[0],
                            {
                                order: signedOrderWithDifferentMaker,
                                takerTokenCancelAmount: cancelAmount,
                            },
                        ]),
                    ).to.be.rejectedWith(ExchangeContractErrs.MultipleMakersInSingleCancelBatchDisallowed);
                });
            });
            describe('successful batch cancels', () => {
                it('should cancel a batch of orders', async () => {
                    await zeroEx.exchange.batchCancelOrdersAsync(cancelBatch);
                    const cancelledAmount = await zeroEx.exchange.getCancelledTakerAmountAsync(orderHashHex);
                    const anotherCancelledAmount = await zeroEx.exchange.getCancelledTakerAmountAsync(
                        anotherOrderHashHex,
                    );
                    expect(cancelledAmount).to.be.bignumber.equal(cancelAmount);
                    expect(anotherCancelledAmount).to.be.bignumber.equal(cancelAmount);
                });
            });
            describe('order transaction options', () => {
                beforeEach(async () => {
                    const emptyTakerTokenCancelAmount = new BigNumber(0);
                    cancelBatch = [
                        {
                            order: signedOrder,
                            takerTokenCancelAmount: emptyTakerTokenCancelAmount,
                        },
                        {
                            order: anotherSignedOrder,
                            takerTokenCancelAmount: emptyTakerTokenCancelAmount,
                        },
                    ];
                });
                it('should validate when orderTransactionOptions are not present', async () => {
                    return expect(zeroEx.exchange.batchCancelOrdersAsync(cancelBatch)).to.be.rejectedWith(
                        ExchangeContractErrs.OrderCancelAmountZero,
                    );
                });
                it('should validate when orderTransactionOptions specify to validate', async () => {
                    return expect(
                        zeroEx.exchange.batchCancelOrdersAsync(cancelBatch, {
                            shouldValidate: true,
                        }),
                    ).to.be.rejectedWith(ExchangeContractErrs.OrderCancelAmountZero);
                });
                it('should not validate when orderTransactionOptions specify not to validate', async () => {
                    return expect(
                        zeroEx.exchange.batchCancelOrdersAsync(cancelBatch, {
                            shouldValidate: false,
                        }),
                    ).to.not.be.rejectedWith(ExchangeContractErrs.OrderCancelAmountZero);
                });
            });
        });
    });
    describe('tests that require partially filled order', () => {
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let takerAddress: string;
        let fillableAmount: BigNumber;
        let partialFillAmount: BigNumber;
        let signedOrder: SignedOrder;
        let orderHash: string;
        before(() => {
            takerAddress = userAddresses[1];
            tokenUtils = new TokenUtils(tokens);
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
        });
        beforeEach(async () => {
            fillableAmount = new BigNumber(5);
            partialFillAmount = new BigNumber(2);
            signedOrder = await fillScenarios.createPartiallyFilledSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                takerAddress,
                fillableAmount,
                partialFillAmount,
            );
            orderHash = ZeroEx.getOrderHashHex(signedOrder);
        });
        describe('#getUnavailableTakerAmountAsync', () => {
            it('should throw if passed an invalid orderHash', async () => {
                const invalidOrderHashHex = '0x123';
                return expect(zeroEx.exchange.getUnavailableTakerAmountAsync(invalidOrderHashHex)).to.be.rejected();
            });
            it('should return zero if passed a valid but non-existent orderHash', async () => {
                const unavailableValueT = await zeroEx.exchange.getUnavailableTakerAmountAsync(NON_EXISTENT_ORDER_HASH);
                expect(unavailableValueT).to.be.bignumber.equal(0);
            });
            it('should return the unavailableValueT for a valid and partially filled orderHash', async () => {
                const unavailableValueT = await zeroEx.exchange.getUnavailableTakerAmountAsync(orderHash);
                expect(unavailableValueT).to.be.bignumber.equal(partialFillAmount);
            });
        });
        describe('#getFilledTakerAmountAsync', () => {
            it('should throw if passed an invalid orderHash', async () => {
                const invalidOrderHashHex = '0x123';
                return expect(zeroEx.exchange.getFilledTakerAmountAsync(invalidOrderHashHex)).to.be.rejected();
            });
            it('should return zero if passed a valid but non-existent orderHash', async () => {
                const filledValueT = await zeroEx.exchange.getFilledTakerAmountAsync(NON_EXISTENT_ORDER_HASH);
                expect(filledValueT).to.be.bignumber.equal(0);
            });
            it('should return the filledValueT for a valid and partially filled orderHash', async () => {
                const filledValueT = await zeroEx.exchange.getFilledTakerAmountAsync(orderHash);
                expect(filledValueT).to.be.bignumber.equal(partialFillAmount);
            });
        });
        describe('#getCancelledTakerAmountAsync', () => {
            it('should throw if passed an invalid orderHash', async () => {
                const invalidOrderHashHex = '0x123';
                return expect(zeroEx.exchange.getCancelledTakerAmountAsync(invalidOrderHashHex)).to.be.rejected();
            });
            it('should return zero if passed a valid but non-existent orderHash', async () => {
                const cancelledValueT = await zeroEx.exchange.getCancelledTakerAmountAsync(NON_EXISTENT_ORDER_HASH);
                expect(cancelledValueT).to.be.bignumber.equal(0);
            });
            it('should return the cancelledValueT for a valid and partially filled orderHash', async () => {
                const cancelledValueT = await zeroEx.exchange.getCancelledTakerAmountAsync(orderHash);
                expect(cancelledValueT).to.be.bignumber.equal(0);
            });
            it('should return the cancelledValueT for a valid and cancelled orderHash', async () => {
                const cancelAmount = fillableAmount.minus(partialFillAmount);
                await zeroEx.exchange.cancelOrderAsync(signedOrder, cancelAmount);
                const cancelledValueT = await zeroEx.exchange.getCancelledTakerAmountAsync(orderHash);
                expect(cancelledValueT).to.be.bignumber.equal(cancelAmount);
            });
        });
    });
    describe('#subscribe', () => {
        const indexFilterValues = {};
        const shouldThrowOnInsufficientBalanceOrAllowance = true;
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let coinbase: string;
        let takerAddress: string;
        let makerAddress: string;
        let fillableAmount: BigNumber;
        let signedOrder: SignedOrder;
        const takerTokenFillAmountInBaseUnits = new BigNumber(1);
        const cancelTakerAmountInBaseUnits = new BigNumber(1);
        before(() => {
            [coinbase, makerAddress, takerAddress] = userAddresses;
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
        });
        beforeEach(async () => {
            fillableAmount = new BigNumber(5);
            signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                makerAddress,
                takerAddress,
                fillableAmount,
            );
        });
        afterEach(async () => {
            zeroEx.exchange.unsubscribeAll();
        });
        // Hack: Mocha does not allow a test to be both async and have a `done` callback
        // Since we need to await the receipt of the event in the `subscribe` callback,
        // we do need both. A hack is to make the top-level a sync fn w/ a done callback and then
        // wrap the rest of the test in an async block
        // Source: https://github.com/mochajs/mocha/issues/2407
        it('Should receive the LogFill event when an order is filled', (done: DoneCallback) => {
            (async () => {
                const callback = reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<LogFillContractEventArgs>) => {
                        expect(logEvent.log.event).to.be.equal(ExchangeEvents.LogFill);
                    },
                );
                zeroEx.exchange.subscribe(ExchangeEvents.LogFill, indexFilterValues, callback);
                await zeroEx.exchange.fillOrderAsync(
                    signedOrder,
                    takerTokenFillAmountInBaseUnits,
                    shouldThrowOnInsufficientBalanceOrAllowance,
                    takerAddress,
                );
            })().catch(done);
        });
        it('Should receive the LogCancel event when an order is cancelled', (done: DoneCallback) => {
            (async () => {
                const callback = reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<LogCancelContractEventArgs>) => {
                        expect(logEvent.log.event).to.be.equal(ExchangeEvents.LogCancel);
                    },
                );
                zeroEx.exchange.subscribe(ExchangeEvents.LogCancel, indexFilterValues, callback);
                await zeroEx.exchange.cancelOrderAsync(signedOrder, cancelTakerAmountInBaseUnits);
            })().catch(done);
        });
        it('Outstanding subscriptions are cancelled when zeroEx.setProvider called', (done: DoneCallback) => {
            (async () => {
                const callbackNeverToBeCalled = reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<LogFillContractEventArgs>) => {
                        done(new Error('Expected this subscription to have been cancelled'));
                    },
                );
                zeroEx.exchange.subscribe(ExchangeEvents.LogFill, indexFilterValues, callbackNeverToBeCalled);

                const newProvider = web3Factory.getRpcProvider();
                zeroEx.setProvider(newProvider, constants.TESTRPC_NETWORK_ID);

                const callback = reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<LogFillContractEventArgs>) => {
                        expect(logEvent.log.event).to.be.equal(ExchangeEvents.LogFill);
                    },
                );
                zeroEx.exchange.subscribe(ExchangeEvents.LogFill, indexFilterValues, callback);
                await zeroEx.exchange.fillOrderAsync(
                    signedOrder,
                    takerTokenFillAmountInBaseUnits,
                    shouldThrowOnInsufficientBalanceOrAllowance,
                    takerAddress,
                );
            })().catch(done);
        });
        it('Should cancel subscription when unsubscribe called', (done: DoneCallback) => {
            (async () => {
                const callbackNeverToBeCalled = reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<LogFillContractEventArgs>) => {
                        done(new Error('Expected this subscription to have been cancelled'));
                    },
                );
                const subscriptionToken = zeroEx.exchange.subscribe(
                    ExchangeEvents.LogFill,
                    indexFilterValues,
                    callbackNeverToBeCalled,
                );
                zeroEx.exchange.unsubscribe(subscriptionToken);
                await zeroEx.exchange.fillOrderAsync(
                    signedOrder,
                    takerTokenFillAmountInBaseUnits,
                    shouldThrowOnInsufficientBalanceOrAllowance,
                    takerAddress,
                );
                done();
            })().catch(done);
        });
    });
    describe('#getOrderHashHexUsingContractCallAsync', () => {
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let makerAddress: string;
        let takerAddress: string;
        const fillableAmount = new BigNumber(5);
        before(async () => {
            [, makerAddress, takerAddress] = userAddresses;
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
        });
        it("get's the same hash as the local function", async () => {
            const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                makerAddress,
                takerAddress,
                fillableAmount,
            );
            const orderHash = ZeroEx.getOrderHashHex(signedOrder);
            const orderHashFromContract = await (zeroEx.exchange as any)._getOrderHashHexUsingContractCallAsync(
                signedOrder,
            );
            expect(orderHash).to.equal(orderHashFromContract);
        });
    });
    describe('#getZRXTokenAddressAsync', () => {
        it('gets the same token as is in token registry', () => {
            const zrxAddress = zeroEx.exchange.getZRXTokenAddress();
            const zrxToken = tokenUtils.getProtocolTokenOrThrow();
            expect(zrxAddress).to.equal(zrxToken.address);
        });
    });
    describe('#getLogsAsync', () => {
        let makerTokenAddress: string;
        let takerTokenAddress: string;
        let makerAddress: string;
        let takerAddress: string;
        const fillableAmount = new BigNumber(5);
        const shouldThrowOnInsufficientBalanceOrAllowance = true;
        const blockRange: BlockRange = {
            fromBlock: 0,
            toBlock: BlockParamLiteral.Latest,
        };
        let txHash: string;
        before(async () => {
            [, makerAddress, takerAddress] = userAddresses;
            const [makerToken, takerToken] = tokenUtils.getDummyTokens();
            makerTokenAddress = makerToken.address;
            takerTokenAddress = takerToken.address;
        });
        it('should get logs with decoded args emitted by LogFill', async () => {
            const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                makerAddress,
                takerAddress,
                fillableAmount,
            );
            txHash = await zeroEx.exchange.fillOrderAsync(
                signedOrder,
                fillableAmount,
                shouldThrowOnInsufficientBalanceOrAllowance,
                takerAddress,
            );
            await zeroEx.awaitTransactionMinedAsync(txHash);
            const eventName = ExchangeEvents.LogFill;
            const indexFilterValues = {};
            const logs = await zeroEx.exchange.getLogsAsync(eventName, blockRange, indexFilterValues);
            expect(logs).to.have.length(1);
            expect(logs[0].event).to.be.equal(eventName);
        });
        it('should only get the logs with the correct event name', async () => {
            const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                makerAddress,
                takerAddress,
                fillableAmount,
            );
            txHash = await zeroEx.exchange.fillOrderAsync(
                signedOrder,
                fillableAmount,
                shouldThrowOnInsufficientBalanceOrAllowance,
                takerAddress,
            );
            await zeroEx.awaitTransactionMinedAsync(txHash);
            const differentEventName = ExchangeEvents.LogCancel;
            const indexFilterValues = {};
            const logs = await zeroEx.exchange.getLogsAsync(differentEventName, blockRange, indexFilterValues);
            expect(logs).to.have.length(0);
        });
        it('should only get the logs with the correct indexed fields', async () => {
            const signedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                makerAddress,
                takerAddress,
                fillableAmount,
            );
            txHash = await zeroEx.exchange.fillOrderAsync(
                signedOrder,
                fillableAmount,
                shouldThrowOnInsufficientBalanceOrAllowance,
                takerAddress,
            );
            await zeroEx.awaitTransactionMinedAsync(txHash);

            const differentMakerAddress = userAddresses[2];
            const anotherSignedOrder = await fillScenarios.createFillableSignedOrderAsync(
                makerTokenAddress,
                takerTokenAddress,
                differentMakerAddress,
                takerAddress,
                fillableAmount,
            );
            txHash = await zeroEx.exchange.fillOrderAsync(
                anotherSignedOrder,
                fillableAmount,
                shouldThrowOnInsufficientBalanceOrAllowance,
                takerAddress,
            );
            await zeroEx.awaitTransactionMinedAsync(txHash);

            const eventName = ExchangeEvents.LogFill;
            const indexFilterValues = {
                maker: differentMakerAddress,
            };
            const logs = await zeroEx.exchange.getLogsAsync<LogFillContractEventArgs>(
                eventName,
                blockRange,
                indexFilterValues,
            );
            expect(logs).to.have.length(1);
            const args = logs[0].args;
            expect(args.maker).to.be.equal(differentMakerAddress);
        });
    });
}); // tslint:disable:max-file-line-count