1 files changed, 410 insertions, 22 deletions
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
index f080fba21..3c9b6bbc5 100644
--- a/packages/types/src/index.ts
+++ b/packages/types/src/index.ts
@@ -1,3 +1,5 @@
+// tslint:disable:max-file-line-count
+
 import { BigNumber } from 'bignumber.js';
 import { ContractAbi } from 'ethereum-types';
 
@@ -40,6 +42,15 @@ export interface SignedOrder extends Order {
 }
 
 /**
+ * ZeroExTransaction for use with 0x Exchange executeTransaction
+ */
+export interface ZeroExTransaction {
+    salt: BigNumber;
+    signerAddress: string;
+    data: string;
+}
+
+/**
  * Elliptic Curve signature
  */
 export interface ECSignature {
@@ -111,12 +122,14 @@ export interface OrderStateValid {
     isValid: true;
     orderHash: string;
     orderRelevantState: OrderRelevantState;
+    transactionHash?: string;
 }
 
 export interface OrderStateInvalid {
     isValid: false;
     orderHash: string;
     error: ExchangeContractErrs;
+    transactionHash?: string;
 }
 
 export type OrderState = OrderStateValid | OrderStateInvalid;
@@ -133,34 +146,12 @@ export enum SignatureType {
     Invalid,
     EIP712,
     EthSign,
-    Caller,
     Wallet,
     Validator,
     PreSigned,
-    Trezor,
     NSignatureTypes,
 }
 
-/**
- * The type of the Signer implementation. Some signer implementations use different message prefixes (e.g Trezor) or implement different
- * eth_sign behaviour (e.g Metamask). Default assumes a spec compliant `eth_sign`.
- */
-export enum SignerType {
-    Default = 'DEFAULT',
-    Ledger = 'LEDGER',
-    Metamask = 'METAMASK',
-    Trezor = 'TREZOR',
-}
-
-/**
- * Elliptic Curve signature
- */
-export interface ECSignature {
-    v: number;
-    r: string;
-    s: string;
-}
-
 export enum AssetProxyId {
     ERC20 = '0xf47261b0',
     ERC721 = '0x02571792',
@@ -177,6 +168,9 @@ export interface ERC721AssetData {
     tokenId: BigNumber;
 }
 
+export type AssetData = ERC20AssetData | ERC721AssetData;
+
+// TODO: DRY. These should be extracted from contract code.
 export enum RevertReason {
     OrderUnfillable = 'ORDER_UNFILLABLE',
     InvalidMaker = 'INVALID_MAKER',
@@ -184,10 +178,14 @@ export enum RevertReason {
     InvalidSender = 'INVALID_SENDER',
     InvalidOrderSignature = 'INVALID_ORDER_SIGNATURE',
     InvalidTakerAmount = 'INVALID_TAKER_AMOUNT',
+    DivisionByZero = 'DIVISION_BY_ZERO',
     RoundingError = 'ROUNDING_ERROR',
     InvalidSignature = 'INVALID_SIGNATURE',
     SignatureIllegal = 'SIGNATURE_ILLEGAL',
     SignatureUnsupported = 'SIGNATURE_UNSUPPORTED',
+    TakerOverpay = 'TAKER_OVERPAY',
+    OrderOverfill = 'ORDER_OVERFILL',
+    InvalidFillPrice = 'INVALID_FILL_PRICE',
     InvalidNewOrderEpoch = 'INVALID_NEW_ORDER_EPOCH',
     CompleteFillFailed = 'COMPLETE_FILL_FAILED',
     NegativeSpreadRequired = 'NEGATIVE_SPREAD_REQUIRED',
@@ -229,6 +227,14 @@ export enum RevertReason {
     Erc721InvalidSpender = 'ERC721_INVALID_SPENDER',
     Erc721ZeroOwner = 'ERC721_ZERO_OWNER',
     Erc721InvalidSelector = 'ERC721_INVALID_SELECTOR',
+    WalletError = 'WALLET_ERROR',
+    ValidatorError = 'VALIDATOR_ERROR',
+    InvalidFunctionSelector = 'INVALID_FUNCTION_SELECTOR',
+    InvalidAssetProxy = 'INVALID_ASSET_PROXY',
+    UnregisteredAssetProxy = 'UNREGISTERED_ASSET_PROXY',
+    TxFullyConfirmed = 'TX_FULLY_CONFIRMED',
+    TxNotFullyConfirmed = 'TX_NOT_FULLY_CONFIRMED',
+    TimeLockIncomplete = 'TIME_LOCK_INCOMPLETE',
 }
 
 export enum StatusCodes {
@@ -238,3 +244,385 @@ export enum StatusCodes {
     MethodNotAllowed = 405,
     GatewayTimeout = 504,
 }
+
+export interface ObjectMap<T> {
+    [key: string]: T;
+}
+
+/**
+ * baseAssetData: The address of assetData designated as the baseToken in the currency pair calculation of price
+ * quoteAssetData: The address of assetData designated as the quoteToken in the currency pair calculation of price
+ * limit: Maximum number of bids and asks in orderbook snapshot
+ */
+export interface OrdersChannelSubscriptionOpts {
+    baseAssetData: string;
+    quoteAssetData: string;
+    limit: number;
+}
+
+export type OrdersChannelMessage = UpdateOrdersChannelMessage | UnknownOrdersChannelMessage;
+
+export enum OrdersChannelMessageTypes {
+    Update = 'update',
+    Unknown = 'unknown',
+}
+
+export interface UpdateOrdersChannelMessage {
+    type: OrdersChannelMessageTypes.Update;
+    requestId: string;
+    payload: APIOrder[];
+}
+
+export interface UnknownOrdersChannelMessage {
+    type: OrdersChannelMessageTypes.Unknown;
+    requestId: string;
+    payload: undefined;
+}
+
+export enum WebsocketConnectionEventType {
+    Close = 'close',
+    Error = 'error',
+    Message = 'message',
+}
+
+export enum WebsocketClientEventType {
+    Connect = 'connect',
+    ConnectFailed = 'connectFailed',
+}
+
+export type OrdersResponse = PaginatedCollection<APIOrder>;
+
+export interface APIOrder {
+    order: SignedOrder;
+    metaData: object;
+}
+
+export interface AssetPairsRequestOpts {
+    assetDataA?: string;
+    assetDataB?: string;
+}
+
+export type AssetPairsResponse = PaginatedCollection<AssetPairsItem>;
+
+export interface AssetPairsItem {
+    assetDataA: Asset;
+    assetDataB: Asset;
+}
+
+export interface Asset {
+    assetData: string;
+    minAmount: BigNumber;
+    maxAmount: BigNumber;
+    precision: number;
+}
+
+export interface OrdersRequestOpts {
+    makerAssetProxyId?: string;
+    takerAssetProxyId?: string;
+    makerAssetAddress?: string;
+    takerAssetAddress?: string;
+    exchangeAddress?: string;
+    senderAddress?: string;
+    makerAssetData?: string;
+    takerAssetData?: string;
+    makerAddress?: string;
+    takerAddress?: string;
+    traderAddress?: string;
+    feeRecipientAddress?: string;
+}
+
+export interface OrderbookRequest {
+    baseAssetData: string;
+    quoteAssetData: string;
+}
+
+export interface OrderbookResponse {
+    bids: PaginatedCollection<APIOrder>;
+    asks: PaginatedCollection<APIOrder>;
+}
+
+export interface PaginatedCollection<T> {
+    total: number;
+    page: number;
+    perPage: number;
+    records: T[];
+}
+
+export interface OrderConfigRequest {
+    makerAddress: string;
+    takerAddress: string;
+    makerAssetAmount: BigNumber;
+    takerAssetAmount: BigNumber;
+    makerAssetData: string;
+    takerAssetData: string;
+    exchangeAddress: string;
+    expirationTimeSeconds: BigNumber;
+}
+
+export interface OrderConfigResponse {
+    makerFee: BigNumber;
+    takerFee: BigNumber;
+    feeRecipientAddress: string;
+    senderAddress: string;
+}
+
+export type FeeRecipientsResponse = PaginatedCollection<string>;
+
+export interface RequestOpts {
+    networkId?: number;
+}
+
+export interface PagedRequestOpts {
+    page?: number;
+    perPage?: number;
+}
+
+export interface TypeDocType {
+    type: TypeDocTypes;
+    value: string;
+    name: string;
+    types: TypeDocType[];
+    typeArguments?: TypeDocType[];
+    declaration: TypeDocNode;
+    elementType?: TypeDocType;
+    indexSignature?: TypeDocNode;
+    elements?: TupleElement[];
+}
+
+export interface TupleElement {
+    type: string;
+    name: string;
+}
+
+export interface TypeDocNode {
+    id?: number;
+    name?: string;
+    kind?: string;
+    defaultValue?: string;
+    kindString?: string;
+    type?: TypeDocType;
+    fileName?: string;
+    line?: number;
+    comment?: TypeDocNode;
+    text?: string;
+    shortText?: string;
+    returns?: string;
+    declaration: TypeDocNode;
+    flags?: TypeDocFlags;
+    indexSignature?: TypeDocNode;
+    signatures?: TypeDocNode[];
+    parameters?: TypeDocNode[];
+    typeParameter?: TypeDocNode[];
+    sources?: TypeDocNode[];
+    children?: TypeDocNode[];
+    groups?: TypeDocGroup[];
+}
+
+export interface TypeDocFlags {
+    isStatic?: boolean;
+    isOptional?: boolean;
+    isPublic?: boolean;
+    isExported?: boolean;
+}
+
+export interface TypeDocGroup {
+    title: string;
+    children: number[];
+}
+
+export enum TypeDocTypes {
+    Intrinsic = 'intrinsic',
+    Reference = 'reference',
+    Array = 'array',
+    StringLiteral = 'stringLiteral',
+    Reflection = 'reflection',
+    Union = 'union',
+    TypeParameter = 'typeParameter',
+    Intersection = 'intersection',
+    Tuple = 'tuple',
+    Unknown = 'unknown',
+}
+
+export interface CustomTypeChild {
+    name: string;
+    type?: Type;
+    defaultValue?: string;
+}
+
+export interface Event {
+    name: string;
+    eventArgs: EventArg[];
+}
+
+export interface EventArg {
+    isIndexed: boolean;
+    name: string;
+    type: Type;
+}
+
+export interface Property {
+    name: string;
+    type: Type;
+    source?: Source;
+    comment?: string;
+    callPath?: string;
+}
+
+export interface BaseMethod {
+    isConstructor: boolean;
+    name: string;
+    returnComment?: string | undefined;
+    callPath: string;
+    parameters: Parameter[];
+    returnType: Type;
+    comment?: string;
+}
+
+export interface BaseFunction {
+    name: string;
+    returnComment?: string | undefined;
+    parameters: Parameter[];
+    returnType: Type;
+    comment?: string;
+}
+
+export interface TypeDefinitionByName {
+    [typeName: string]: CustomType;
+}
+
+export interface DocAgnosticFormat {
+    [sectionName: string]: DocSection;
+}
+
+export interface DocSection {
+    comment: string;
+    constructors: Array<TypescriptMethod | SolidityMethod>;
+    methods: Array<TypescriptMethod | SolidityMethod>;
+    properties: Property[];
+    types: CustomType[];
+    functions: TypescriptFunction[];
+    events?: Event[];
+    externalExportToLink?: ExternalExportToLink;
+}
+
+export interface TypescriptMethod extends BaseMethod {
+    source?: Source;
+    isStatic?: boolean;
+    typeParameter?: TypeParameter;
+}
+
+export interface TypescriptFunction extends BaseFunction {
+    source?: Source;
+    typeParameter?: TypeParameter;
+    callPath: string;
+}
+
+export interface SolidityMethod extends BaseMethod {
+    isConstant?: boolean;
+    isPayable?: boolean;
+    isFallback?: boolean;
+}
+
+export interface Source {
+    fileName: string;
+    line: number;
+}
+
+export interface Parameter {
+    name: string;
+    comment: string;
+    isOptional: boolean;
+    type: Type;
+    defaultValue?: string;
+}
+
+export interface TypeParameter {
+    name: string;
+    type: Type;
+}
+
+export interface Type {
+    name: string;
+    typeDocType: TypeDocTypes;
+    value?: string;
+    isExportedClassReference?: boolean;
+    typeArguments?: Type[];
+    elementType?: ElementType;
+    types?: Type[];
+    method?: TypescriptMethod;
+    indexSignature?: IndexSignature;
+    externalLink?: string;
+    tupleElements?: Type[];
+}
+
+export interface ElementType {
+    name: string;
+    typeDocType: TypeDocTypes;
+}
+
+export interface IndexSignature {
+    keyName: string;
+    keyType: Type;
+    valueName: string;
+}
+
+export interface CustomType {
+    name: string;
+    kindString: string;
+    type?: Type;
+    method?: TypescriptMethod;
+    indexSignature?: IndexSignature;
+    defaultValue?: string;
+    comment?: string;
+    children?: CustomTypeChild[];
+}
+export interface GeneratedDocJson {
+    version: string;
+    metadata: Metadata;
+    typedocJson: TypeDocNode;
+}
+
+export interface ExportNameToTypedocNames {
+    [exportName: string]: string[];
+}
+
+export interface ExternalTypeToLink {
+    [externalTypeName: string]: string;
+}
+
+export interface ExternalExportToLink {
+    [externalExport: string]: string;
+}
+
+export interface Metadata {
+    exportPathToTypedocNames: ExportNameToTypedocNames;
+    exportPathOrder: string[];
+    externalTypeToLink: ExternalTypeToLink;
+    externalExportToLink: ExternalExportToLink;
+}
+
+export interface EIP712Parameter {
+    name: string;
+    type: string;
+}
+
+export interface EIP712Types {
+    [key: string]: EIP712Parameter[];
+}
+
+export type EIP712ObjectValue = string | number | EIP712Object;
+
+export interface EIP712Object {
+    [key: string]: EIP712ObjectValue;
+}
+
+export interface EIP712TypedData {
+    types: EIP712Types;
+    domain: EIP712Object;
+    message: EIP712Object;
+    primaryType: string;
+}
+
+export interface Stats {
+    orderCount: number;
+}