From 71973569284fea9d2dee2850c960fda65f97fc44 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Wed, 29 Nov 2017 11:18:11 -0800 Subject: Add SignedOrder and TokenTradeInfo to public interface and fix a HttpClient comment --- packages/connect/CHANGELOG.md | 4 ++++ packages/connect/src/http_client.ts | 2 +- packages/connect/src/index.ts | 2 ++ packages/connect/src/types.ts | 2 ++ 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/packages/connect/CHANGELOG.md b/packages/connect/CHANGELOG.md index ec6727a12..c3435a0b8 100644 --- a/packages/connect/CHANGELOG.md +++ b/packages/connect/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +vx.x.x +------------------------ + * Add SignedOrder and TokenTradeInfo to the public interface + v0.1.0 - _November 22, 2017_ ------------------------ * Provide a HttpClient class for interacting with standard relayer api compliant HTTP urls diff --git a/packages/connect/src/http_client.ts b/packages/connect/src/http_client.ts index 3a9e11a7d..e30e03815 100644 --- a/packages/connect/src/http_client.ts +++ b/packages/connect/src/http_client.ts @@ -34,7 +34,7 @@ export class HttpClient implements Client { private apiEndpointUrl: string; /** * Instantiates a new HttpClient instance - * @param url The base url for making API calls + * @param url The relayer API base HTTP url you would like to interact with * @return An instance of HttpClient */ constructor(url: string) { diff --git a/packages/connect/src/index.ts b/packages/connect/src/index.ts index c9ebde510..8a63c41a5 100644 --- a/packages/connect/src/index.ts +++ b/packages/connect/src/index.ts @@ -6,6 +6,8 @@ export { OrderbookRequest, OrderbookResponse, OrdersRequest, + SignedOrder, TokenPairsItem, TokenPairsRequest, + TokenTradeInfo, } from './types'; diff --git a/packages/connect/src/types.ts b/packages/connect/src/types.ts index eb6df3ba9..bdbbab7c0 100644 --- a/packages/connect/src/types.ts +++ b/packages/connect/src/types.ts @@ -1,6 +1,8 @@ import {SignedOrder} from '0x.js'; import {BigNumber} from 'bignumber.js'; +export type SignedOrder = SignedOrder; + export interface Client { getTokenPairsAsync: (request?: TokenPairsRequest) => Promise; getOrdersAsync: (request?: OrdersRequest) => Promise; -- cgit v1.2.3