aboutsummaryrefslogtreecommitdiffstats
path: root/packages/order-watcher/src/types.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/order-watcher/src/types.ts')
-rw-r--r--packages/order-watcher/src/types.ts97
1 files changed, 0 insertions, 97 deletions
diff --git a/packages/order-watcher/src/types.ts b/packages/order-watcher/src/types.ts
deleted file mode 100644
index 2b529a939..000000000
--- a/packages/order-watcher/src/types.ts
+++ /dev/null
@@ -1,97 +0,0 @@
-import { OrderState, SignedOrder } from '@0x/types';
-import { LogEntryEvent } from 'ethereum-types';
-
-export enum OrderWatcherError {
- SubscriptionAlreadyPresent = 'SUBSCRIPTION_ALREADY_PRESENT',
- SubscriptionNotFound = 'SUBSCRIPTION_NOT_FOUND',
-}
-
-export type EventWatcherCallback = (err: null | Error, log?: LogEntryEvent) => void;
-
-/**
- * orderExpirationCheckingIntervalMs: How often to check for expired orders. Default=50.
- * eventPollingIntervalMs: How often to poll the Ethereum node for new events. Default=200.
- * expirationMarginMs: Amount of time before order expiry that you'd like to be notified
- * of an orders expiration. Default=0.
- * cleanupJobIntervalMs: How often to run a cleanup job which revalidates all the orders. Default=1hr.
- * isVerbose: Weather the order watcher should be verbose. Default=true.
- */
-export interface OrderWatcherConfig {
- orderExpirationCheckingIntervalMs: number;
- eventPollingIntervalMs: number;
- expirationMarginMs: number;
- cleanupJobIntervalMs: number;
- isVerbose: boolean;
-}
-
-export type OnOrderStateChangeCallback = (err: Error | null, orderState?: OrderState) => void;
-
-export enum InternalOrderWatcherError {
- NoAbiDecoder = 'NO_ABI_DECODER',
- ZrxNotInTokenRegistry = 'ZRX_NOT_IN_TOKEN_REGISTRY',
- WethNotInTokenRegistry = 'WETH_NOT_IN_TOKEN_REGISTRY',
-}
-
-export enum OrderWatcherMethod {
- // Methods initiated by the user.
- GetStats = 'GET_STATS',
- AddOrder = 'ADD_ORDER',
- RemoveOrder = 'REMOVE_ORDER',
- // These are spontaneous; they are primarily orderstate changes.
- Update = 'UPDATE',
- // `subscribe` and `unsubscribe` are methods of OrderWatcher, but we don't
- // need to expose them to the WebSocket server user because the user implicitly
- // subscribes and unsubscribes by connecting and disconnecting from the server.
-}
-
-// Users have to create a json object of this format and attach it to
-// the data field of their WebSocket message to interact with the server.
-export type WebSocketRequest = AddOrderRequest | RemoveOrderRequest | GetStatsRequest;
-
-export interface AddOrderRequest {
- id: number;
- jsonrpc: string;
- method: OrderWatcherMethod.AddOrder;
- params: { signedOrder: SignedOrder };
-}
-
-export interface RemoveOrderRequest {
- id: number;
- jsonrpc: string;
- method: OrderWatcherMethod.RemoveOrder;
- params: { orderHash: string };
-}
-
-export interface GetStatsRequest {
- id: number;
- jsonrpc: string;
- method: OrderWatcherMethod.GetStats;
-}
-
-// Users should expect a json object of this format in the data field
-// of the WebSocket messages that the server sends out.
-export type WebSocketResponse = SuccessfulWebSocketResponse | ErrorWebSocketResponse;
-
-export interface SuccessfulWebSocketResponse {
- id: number;
- jsonrpc: string;
- method: OrderWatcherMethod;
- result: OrderState | GetStatsResult | undefined; // result is undefined for ADD_ORDER and REMOVE_ORDER
-}
-
-export interface ErrorWebSocketResponse {
- id: number | null;
- jsonrpc: string;
- method: null;
- error: JSONRPCError;
-}
-
-export interface JSONRPCError {
- code: number;
- message: string;
- data?: string | object;
-}
-
-export interface GetStatsResult {
- orderCount: number;
-}