/
types.ts
789 lines (723 loc) · 23.2 KB
/
types.ts
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
import { SignedOrder } from '@0x/order-utils';
import { BigNumber } from '@0x/utils';
import { SupportedProvider, ZeroExProvider } from 'ethereum-types';
export { SignedOrder } from '@0x/order-utils';
export { BigNumber } from '@0x/utils';
export { SupportedProvider } from 'ethereum-types';
// TODO(jalextowle): De-duplicate this type by creating a @0x/mesh-types package.
/** @ignore */
export interface StringifiedSignedOrder {
makerAddress: string;
makerAssetData: string;
makerAssetAmount: string;
makerFee: string;
makerFeeAssetData: string;
takerAddress: string;
takerAssetData: string;
takerFeeAssetData: string;
takerAssetAmount: string;
takerFee: string;
senderAddress: string;
feeRecipientAddress: string;
expirationTimeSeconds: string;
salt: string;
exchangeAddress: string;
chainId: string;
signature: string;
}
/** @ignore */
export interface WrapperOrderWithMetadata extends StringifiedSignedOrder {
hash: string;
fillableTakerAssetAmount: string;
}
/** @ignore */
export interface WrapperGetOrdersResponse {
timestamp: string;
ordersInfos: WrapperOrderInfo[];
}
export interface GetOrdersResponse {
timestamp: number;
ordersInfos: OrderInfo[];
}
/** @ignore */
export interface WrapperOrderInfo {
orderHash: string;
signedOrder: WrapperSignedOrder;
fillableTakerAssetAmount: string;
}
export interface OrderInfo {
orderHash: string;
signedOrder: SignedOrder;
fillableTakerAssetAmount: BigNumber;
}
/**
* An interface for JSON schema types, which are used for custom order filters.
*/
export interface JsonSchema {
id?: string;
$schema?: string;
$ref?: string;
title?: string;
description?: string;
multipleOf?: number;
maximum?: number;
exclusiveMaximum?: boolean;
minimum?: number;
exclusiveMinimum?: boolean;
maxLength?: number;
minLength?: number;
pattern?: string | RegExp;
additionalItems?: boolean | JsonSchema;
items?: JsonSchema | JsonSchema[];
maxItems?: number;
minItems?: number;
uniqueItems?: boolean;
maxProperties?: number;
minProperties?: number;
required?: string[];
additionalProperties?: boolean | JsonSchema;
definitions?: {
[name: string]: JsonSchema;
};
properties?: {
[name: string]: JsonSchema;
};
patternProperties?: {
[name: string]: JsonSchema;
};
dependencies?: {
[name: string]: JsonSchema | string[];
};
enum?: any[];
// NOTE(albrow): This interface type is based on
// https://github.com/tdegrunt/jsonschema/blob/9cb2cf847a33abb76b694c6ed4d8d12ef2037201/lib/index.d.ts#L50
// but modified to include the 'const' field from the JSON Schema
// specification draft 6 (https://json-schema.org/understanding-json-schema/reference/generic.html#constant-values)
// See also: https://github.com/tdegrunt/jsonschema/issues/271
const?: any;
type?: string | string[];
format?: string;
allOf?: JsonSchema[];
anyOf?: JsonSchema[];
oneOf?: JsonSchema[];
not?: JsonSchema;
}
// Note(albrow): This is currently copied over from core/core.go. We need to keep
// both definitions in sync, so if you change one you must also change the
// other.
/**
* A set of configuration options for Mesh.
*/
export interface Config {
// Verbosity is the logging verbosity. Defaults to Verbosity.Error meaning
// only errors will be logged.
verbosity?: Verbosity;
// The URL of an Ethereum node which supports the Ethereum JSON RPC API.
// Used to validate and watch orders.
ethereumRPCURL?: string;
// EthereumChainID is the chain ID specifying which Ethereum chain you wish to
// run your Mesh node for
ethereumChainID: number;
// UseBootstrapList is whether to bootstrap the DHT by connecting to a
// specific set of peers.
useBootstrapList?: boolean;
// bootstrapList is a list of multiaddresses to use for bootstrapping the
// DHT (e.g.,
// "/ip4/3.214.190.67/tcp/60558/ipfs/16Uiu2HAmGx8Z6gdq5T5AQE54GMtqDhDFhizywTy1o28NJbAMMumF").
// Defaults to the hard-coded default bootstrap list.
bootstrapList?: string[];
// The polling interval (in seconds) to wait before checking for a new
// Ethereum block that might contain transactions that impact the
// fillability of orders stored by Mesh. Different chains have different
// block producing intervals: POW chains are typically slower (e.g.,
// Mainnet) and POA chains faster (e.g., Kovan) so one should adjust the
// polling interval accordingly. Defaults to 5.
blockPollingIntervalSeconds?: number;
// The maximum request Content-Length accepted by the backing Ethereum RPC
// endpoint used by Mesh. Geth & Infura both limit a request's content
// length to 1024 * 512 Bytes. Parity and Alchemy have much higher limits.
// When batch validating 0x orders, we will fit as many orders into a
// request without crossing the max content length. The default value is
// appropriate for operators using Geth or Infura. If using Alchemy or
// Parity, feel free to double the default max in order to reduce the number
// of RPC calls made by Mesh. Defaults to 524288 bytes.
ethereumRPCMaxContentLength?: number;
// Determines whether or not Mesh should limit the number of Ethereum RPC
// requests it sends. It defaults to true. Disabling Ethereum RPC rate
// limiting can reduce latency for receiving order events in some network
// conditions, but can also potentially lead to higher costs or other rate
// limiting issues outside of Mesh, depending on your Ethereum RPC provider.
// If set to false, ethereumRPCMaxRequestsPer24HrUTC and
// ethereumRPCMaxRequestsPerSecond will have no effect.
enableEthereumRPCRateLimiting?: boolean;
// A cap on the number of Ethereum JSON-RPC requests a Mesh node will make
// per 24hr UTC time window (time window starts and ends at midnight UTC).
// It defaults to 200k but can be increased well beyond this limit depending
// on your infrastructure or Ethereum RPC provider.
ethereumRPCMaxRequestsPer24HrUTC?: number;
// A cap on the number of Ethereum JSON-RPC requests a Mesh node will make
// per second. This limits the concurrency of these requests and prevents
// the Mesh node from getting rate-limited. It defaults to the recommended
// 30 rps for Infura's free tier, and can be increased to 100 rpc for pro
// users, and potentially higher on alternative infrastructure.
ethereumRPCMaxRequestsPerSecond?: number;
// A set of custom addresses to use for the configured network ID. The
// contract addresses for most common networks are already included by
// default, so this is typically only needed for testing on custom networks.
// The given addresses are added to the default list of addresses for known
// chains and overriding any contract addresses for known chains is not
// allowed. The addresses for exchange, devUtils, erc20Proxy, and
// erc721Proxy are required for each chain. For example:
//
// {
// exchange: "0x48bacb9266a570d521063ef5dd96e61686dbe788",
// devUtils: "0x38ef19fdf8e8415f18c307ed71967e19aac28ba1",
// erc20Proxy: "0x1dc4c1cefef38a777b15aa20260a54e584b16c48",
// erc721Proxy: "0x1d7022f5b17d2f8b695918fb48fa1089c9f85401"
// }
//
customContractAddresses?: ContractAddresses;
// The maximum number of orders that Mesh will keep in storage. As the
// number of orders in storage grows, Mesh will begin enforcing a limit on
// maximum expiration time for incoming orders and remove any orders with an
// expiration time too far in the future. Defaults to 100,000.
maxOrdersInStorage?: number;
// A a JSON Schema object which will be used for validating incoming orders.
// If provided, Mesh will only receive orders from other peers in the
// network with the same filter.
//
// Here is an example filter which will only allow orders with a specific
// makerAssetData:
//
// {
// properties: {
// makerAssetData: {
// const: "0xf47261b0000000000000000000000000871dd7c2b4b25e1aa18728e9d5f2af4c4e431f5c"
// }
// }
// }
//
// Note that you only need to include the requirements for your specific
// application in the filter. The default requirements for a valid order (e.g.
// all the required fields) are automatically included. For more information
// on JSON Schemas, see https://json-schema.org/
customOrderFilter?: JsonSchema;
// Offers the ability to use your own web3 provider for all Ethereum RPC
// requests instead of the default.
web3Provider?: SupportedProvider;
// The maximum number of bytes per second that a peer is allowed to send before
// failing the bandwidth check. Defaults to 5 MiB.
maxBytesPerSecond?: number;
}
export interface ContractAddresses {
exchange: string;
devUtils: string;
erc20Proxy: string;
erc721Proxy: string;
erc1155Proxy: string;
weth9?: string;
zrxToken?: string;
}
export enum Verbosity {
Panic = 0,
Fatal = 1,
Error = 2,
Warn = 3,
Info = 4,
Debug = 5,
Trace = 6,
}
/**
* The global entrypoint for creating a new MeshWrapper.
* @ignore
*/
export interface ZeroExMesh {
newWrapperAsync(config: WrapperConfig): Promise<MeshWrapper>;
}
/**
* A direct translation of the MeshWrapper type in Go. Its API exposes only
* simple JavaScript types like number and string, some of which will be
* converted. For example, we will convert some strings to BigNumbers.
* @ignore
*/
export interface MeshWrapper {
startAsync(): Promise<void>;
onError(handler: (err: Error) => void): void;
onOrderEvents(handler: (events: WrapperOrderEvent[]) => void): void;
getStatsAsync(): Promise<WrapperStats>;
getOrdersForPageAsync(perPage: number, minOrderHash?: string): Promise<WrapperGetOrdersResponse>;
addOrdersAsync(orders: WrapperSignedOrder[], pinned: boolean): Promise<WrapperValidationResults>;
// GraphQL API
gqlAddOrdersAsync(newOrders: WrapperSignedOrder[], pinned: boolean): Promise<WrapperAddOrderResults>;
gqlGetOrderAsync(orderHash: string): Promise<WrapperOrderWithMetadata>;
gqlFindOrdersAsync(
sort: WrapperOrderSort[],
filters: WrapperOrderFilter[],
limit: number,
): Promise<WrapperOrderWithMetadata[]>;
gqlGetStatsAsync(): Promise<WrapperStats>; // This will not populate the `secondaryRendevous` field
}
/**
* The type for configuration exposed by MeshWrapper.
* @ignore
*/
export interface WrapperConfig {
verbosity?: number;
ethereumRPCURL?: string;
ethereumChainID: number;
useBootstrapList?: boolean;
bootstrapList?: string; // comma-separated string instead of an array of strings.
blockPollingIntervalSeconds?: number;
ethereumRPCMaxContentLength?: number;
ethereumRPCMaxRequestsPer24HrUTC?: number;
ethereumRPCMaxRequestsPerSecond?: number;
enableEthereumRPCRateLimiting?: boolean;
customContractAddresses?: string; // json-encoded string instead of Object.
maxOrdersInStorage?: number;
customOrderFilter?: string; // json-encoded string instead of Object
web3Provider?: ZeroExProvider; // Standardized ZeroExProvider instead the more permissive SupportedProvider interface
maxBytesPerSecond?: number;
}
/** @ignore */
export interface WrapperOrder {
makerAddress: string;
makerAssetData: string;
makerAssetAmount: string;
makerFee: string;
makerFeeAssetData: string;
takerAddress: string;
takerAssetData: string;
takerFeeAssetData: string;
takerAssetAmount: string;
takerFee: string;
senderAddress: string;
feeRecipientAddress: string;
expirationTimeSeconds: string;
salt: string;
exchangeAddress: string;
chainId: number;
}
/** @ignore */
export interface WrapperSignedOrder extends WrapperOrder {
signature: string;
}
export interface ERC20TransferEvent {
from: string;
to: string;
value: BigNumber;
}
/** @ignore */
export interface WrapperERC20TransferEvent {
from: string;
to: string;
value: string;
}
export interface ERC20ApprovalEvent {
owner: string;
spender: string;
value: BigNumber;
}
/** @ignore */
export interface WrapperERC20ApprovalEvent {
owner: string;
spender: string;
value: string;
}
export interface ERC721TransferEvent {
from: string;
to: string;
tokenId: BigNumber;
}
/** @ignore */
export interface WrapperERC721TransferEvent {
from: string;
to: string;
tokenId: string;
}
export interface ERC721ApprovalEvent {
owner: string;
approved: string;
tokenId: BigNumber;
}
/** @ignore */
export interface WrapperERC721ApprovalEvent {
owner: string;
approved: string;
tokenId: string;
}
export interface ERC721ApprovalForAllEvent {
owner: string;
operator: string;
approved: boolean;
}
export interface ERC1155TransferSingleEvent {
operator: string;
from: string;
to: string;
id: BigNumber;
value: BigNumber;
}
/** @ignore */
export interface WrapperERC1155TransferSingleEvent {
operator: string;
from: string;
to: string;
id: string;
value: string;
}
export interface ERC1155TransferBatchEvent {
operator: string;
from: string;
to: string;
ids: BigNumber[];
values: BigNumber[];
}
/** @ignore */
export interface WrapperERC1155TransferBatchEvent {
operator: string;
from: string;
to: string;
ids: string[];
values: string[];
}
export interface ERC1155ApprovalForAllEvent {
owner: string;
operator: string;
approved: boolean;
}
export interface ExchangeFillEvent {
makerAddress: string;
takerAddress: string;
senderAddress: string;
feeRecipientAddress: string;
makerAssetFilledAmount: BigNumber;
takerAssetFilledAmount: BigNumber;
makerFeePaid: BigNumber;
takerFeePaid: BigNumber;
protocolFeePaid: BigNumber;
orderHash: string;
makerAssetData: string;
takerAssetData: string;
makerFeeAssetData: string;
takerFeeAssetData: string;
}
/** @ignore */
export interface WrapperExchangeFillEvent {
makerAddress: string;
takerAddress: string;
senderAddress: string;
feeRecipientAddress: string;
makerAssetFilledAmount: string;
takerAssetFilledAmount: string;
makerFeePaid: string;
takerFeePaid: string;
protocolFeePaid: string;
orderHash: string;
makerAssetData: string;
takerAssetData: string;
makerFeeAssetData: string;
takerFeeAssetData: string;
}
export interface ExchangeCancelEvent {
makerAddress: string;
senderAddress: string;
feeRecipientAddress: string;
orderHash: string;
makerAssetData: string;
takerAssetData: string;
}
export interface ExchangeCancelUpToEvent {
makerAddress: string;
orderSenderAddress: string;
orderEpoch: BigNumber;
}
/** @ignore */
export interface WrapperExchangeCancelUpToEvent {
makerAddress: string;
orderSenderAddress: string;
orderEpoch: string;
}
export interface WethWithdrawalEvent {
owner: string;
value: BigNumber;
}
/** @ignore */
export interface WrapperWethWithdrawalEvent {
owner: string;
value: string;
}
export interface WethDepositEvent {
owner: string;
value: BigNumber;
}
/** @ignore */
export interface WrapperWethDepositEvent {
owner: string;
value: string;
}
export enum ContractEventKind {
ERC20TransferEvent = 'ERC20TransferEvent',
ERC20ApprovalEvent = 'ERC20ApprovalEvent',
ERC721TransferEvent = 'ERC721TransferEvent',
ERC721ApprovalEvent = 'ERC721ApprovalEvent',
ERC721ApprovalForAllEvent = 'ERC721ApprovalForAllEvent',
ERC1155ApprovalForAllEvent = 'ERC1155ApprovalForAllEvent',
ERC1155TransferSingleEvent = 'ERC1155TransferSingleEvent',
ERC1155TransferBatchEvent = 'ERC1155TransferBatchEvent',
ExchangeFillEvent = 'ExchangeFillEvent',
ExchangeCancelEvent = 'ExchangeCancelEvent',
ExchangeCancelUpToEvent = 'ExchangeCancelUpToEvent',
WethDepositEvent = 'WethDepositEvent',
WethWithdrawalEvent = 'WethWithdrawalEvent',
}
/** @ignore */
export type WrapperContractEventParameters =
| WrapperERC20TransferEvent
| WrapperERC20ApprovalEvent
| WrapperERC721TransferEvent
| WrapperERC721ApprovalEvent
| WrapperExchangeFillEvent
| WrapperExchangeCancelUpToEvent
| WrapperWethWithdrawalEvent
| WrapperWethDepositEvent
| ERC721ApprovalForAllEvent
| ExchangeCancelEvent
| WrapperERC1155TransferSingleEvent
| WrapperERC1155TransferBatchEvent
| ERC1155ApprovalForAllEvent;
/** @ignore */
export type ContractEventParameters =
| ERC20TransferEvent
| ERC20ApprovalEvent
| ERC721TransferEvent
| ERC721ApprovalEvent
| ExchangeFillEvent
| ExchangeCancelUpToEvent
| WethWithdrawalEvent
| WethDepositEvent
| ERC721ApprovalForAllEvent
| ExchangeCancelEvent
| ERC1155TransferSingleEvent
| ERC1155TransferBatchEvent
| ERC1155ApprovalForAllEvent;
export interface ContractEvent {
blockHash: string;
txHash: string;
txIndex: number;
logIndex: number;
isRemoved: boolean;
address: string;
kind: ContractEventKind;
parameters: ContractEventParameters;
}
/**
* The type for order events exposed by MeshWrapper.
* @ignore
*/
export interface WrapperContractEvent {
blockHash: string;
txHash: string;
txIndex: number;
logIndex: number;
isRemoved: boolean;
address: string;
kind: string;
parameters: WrapperContractEventParameters;
}
export enum OrderEventEndState {
Invalid = 'INVALID',
Added = 'ADDED',
Filled = 'FILLED',
FullyFilled = 'FULLY_FILLED',
Cancelled = 'CANCELLED',
Expired = 'EXPIRED',
Unexpired = 'UNEXPIRED',
Unfunded = 'UNFUNDED',
FillabilityIncreased = 'FILLABILITY_INCREASED',
StoppedWatching = 'STOPPED_WATCHING',
}
/** @ignore */
export interface WrapperOrderEvent {
timestamp: string;
orderHash: string;
signedOrder: WrapperSignedOrder;
endState: OrderEventEndState;
fillableTakerAssetAmount: string;
contractEvents: WrapperContractEvent[];
}
/**
* Order events are fired by Mesh whenever an order is added, canceled, expired,
* or filled.
*/
export interface OrderEvent {
timestampMs: number;
orderHash: string;
signedOrder: SignedOrder;
endState: OrderEventEndState;
fillableTakerAssetAmount: BigNumber;
contractEvents: ContractEvent[];
}
/** @ignore */
export interface WrapperAddOrderResults {
accepted: WrapperAcceptedOrderResult[];
rejected: WrapperRejectedOrderResult[];
}
/** @ignore */
export interface WrapperAcceptedOrderResult {
order: WrapperOrderWithMetadata;
isNew: boolean;
}
/**
* TODO(jalextowle): Remove duplicate type after the @0x/mesh-types package has
* been created.
* @ignore
*/
export enum RejectedOrderCode {
EthRpcRequestFailed = 'ETH_RPC_REQUEST_FAILED',
OrderHasInvalidMakerAssetAmount = 'ORDER_HAS_INVALID_MAKER_ASSET_AMOUNT',
OrderHasInvalidTakerAssetAmount = 'ORDER_HAS_INVALID_TAKER_ASSET_AMOUNT',
OrderExpired = 'ORDER_EXPIRED',
OrderFullyFilled = 'ORDER_FULLY_FILLED',
OrderCancelled = 'ORDER_CANCELLED',
OrderUnfunded = 'ORDER_UNFUNDED',
OrderHasInvalidMakerAssetData = 'ORDER_HAS_INVALID_MAKER_ASSET_DATA',
OrderHasInvalidMakerFeeAssetData = 'ORDER_HAS_INVALID_MAKER_FEE_ASSET_DATA',
OrderHasInvalidTakerAssetData = 'ORDER_HAS_INVALID_TAKER_ASSET_DATA',
OrderHasInvalidTakerFeeAssetData = 'ORDER_HAS_INVALID_TAKER_FEE_ASSET_DATA',
OrderHasInvalidSignature = 'ORDER_HAS_INVALID_SIGNATURE',
OrderMaxExpirationExceeded = 'ORDER_MAX_EXPIRATION_EXCEEDED',
InternalError = 'INTERNAL_ERROR',
MaxOrderSizeExceeded = 'MAX_ORDER_SIZE_EXCEEDED',
OrderAlreadyStoredAndUnfillable = 'ORDER_ALREADY_STORED_AND_UNFILLABLE',
OrderForIncorrectChain = 'ORDER_FOR_INCORRECT_CHAIN',
IncorrectExchangeAddress = 'INCORRECT_EXCHANGE_ADDRESS',
SenderAddressNotAllowed = 'SENDER_ADDRESS_NOT_ALLOWED',
DatabaseFullOfOrders = 'DATABASE_FULL_OF_ORDERS',
TakerAddressNotAllowed = 'TAKER_ADDRESS_NOT_ALLOWED',
}
/** @ignore */
export interface WrapperRejectedOrderResult {
hash: string;
order: StringifiedSignedOrder;
code: RejectedOrderCode;
message: string;
}
/** @ignore */
export interface WrapperValidationResults {
accepted: WrapperAcceptedOrderInfo[];
rejected: WrapperRejectedOrderInfo[];
}
/** @ignore */
export interface WrapperAcceptedOrderInfo {
orderHash: string;
signedOrder: WrapperSignedOrder;
fillableTakerAssetAmount: string;
isNew: boolean;
}
/** @ignore */
export interface WrapperRejectedOrderInfo {
orderHash: string;
signedOrder: WrapperSignedOrder;
kind: RejectedOrderKind;
status: RejectedOrderStatus;
}
/**
* Indicates which orders where accepted, which were rejected, and why.
*/
export interface ValidationResults {
accepted: AcceptedOrderInfo[];
rejected: RejectedOrderInfo[];
}
/**
* Info for any orders that were accepted.
*/
export interface AcceptedOrderInfo {
orderHash: string;
signedOrder: SignedOrder;
fillableTakerAssetAmount: BigNumber;
isNew: boolean;
}
/**
* Info for any orders that were rejected, including the reason they were
* rejected.
*/
export interface RejectedOrderInfo {
orderHash: string;
signedOrder: SignedOrder;
kind: RejectedOrderKind;
status: RejectedOrderStatus;
}
/**
* A set of categories for rejected orders.
*/
export enum RejectedOrderKind {
ZeroExValidation = 'ZEROEX_VALIDATION',
MeshError = 'MESH_ERROR',
MeshValidation = 'MESH_VALIDATION',
}
/**
* Provides more information about why an order was rejected.
*/
export interface RejectedOrderStatus {
code: string;
message: string;
}
/** @ignore */
export interface WrapperLatestBlock {
number: string;
hash: string;
}
export interface LatestBlock {
number: BigNumber;
hash: string;
}
/** @ignore */
export interface WrapperStats {
version: string;
pubSubTopic: string;
rendezvous: string;
secondaryRendezvous: string[];
peerID: string;
ethereumChainID: number;
latestBlock: WrapperLatestBlock;
numPeers: number;
numOrders: number;
numOrdersV4: number;
numOrdersIncludingRemoved: number;
numOrdersIncludingRemovedV4: number;
numPinnedOrders: number;
numPinnedOrdersV4: number;
maxExpirationTime: string; // string instead of BigNumber
startOfCurrentUTCDay: string; // string instead of Date
ethRPCRequestsSentInCurrentUTCDay: number;
ethRPCRateLimitExpiredRequests: number;
}
export interface Stats {
version: string;
pubSubTopic: string;
rendezvous: string;
secondaryRendezvous: string[];
peerID: string;
ethereumChainID: number;
latestBlock?: LatestBlock;
numPeers: number;
numOrders: number;
numOrdersIncludingRemoved: number;
numPinnedOrders: number;
maxExpirationTime: BigNumber;
startOfCurrentUTCDay: Date;
ethRPCRequestsSentInCurrentUTCDay: number;
ethRPCRateLimitExpiredRequests: number;
}
/** @ignore */
export interface WrapperOrderSort {
field: string;
direction: string;
}
/** @ignore */
export interface WrapperOrderFilter {
field: string;
kind: string;
value: any;
}
// tslint:disable-next-line:max-file-line-count