aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2017-11-30 03:18:11 +0800
committerBrandon Millman <brandon.millman@gmail.com>2017-11-30 03:27:34 +0800
commit71973569284fea9d2dee2850c960fda65f97fc44 (patch)
tree49b6f14354082afc7b28d64c3e4bdf15ffafa876 /packages/connect
parenta75d547af6438292e832907f98227f10cff7e41c (diff)
downloaddexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.tar
dexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.tar.gz
dexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.tar.bz2
dexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.tar.lz
dexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.tar.xz
dexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.tar.zst
dexon-sol-tools-71973569284fea9d2dee2850c960fda65f97fc44.zip
Add SignedOrder and TokenTradeInfo to public interface and fix a HttpClient comment
Diffstat (limited to 'packages/connect')
-rw-r--r--packages/connect/CHANGELOG.md4
-rw-r--r--packages/connect/src/http_client.ts2
-rw-r--r--packages/connect/src/index.ts2
-rw-r--r--packages/connect/src/types.ts2
4 files changed, 9 insertions, 1 deletions
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<TokenPairsItem[]>;
getOrdersAsync: (request?: OrdersRequest) => Promise<SignedOrder[]>;