From 83a36bc4b60726bd95736e62281540ccc22b1766 Mon Sep 17 00:00:00 2001 From: fragosti Date: Mon, 20 Aug 2018 17:18:08 -0700 Subject: Improve documentation --- packages/0x.js/src/artifacts/ZRXToken.json | 5 +++++ packages/connect/CHANGELOG.json | 3 ++- packages/connect/src/http_client.ts | 13 ++++++++----- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/packages/0x.js/src/artifacts/ZRXToken.json b/packages/0x.js/src/artifacts/ZRXToken.json index 0ce91c1c1..3142e379b 100644 --- a/packages/0x.js/src/artifacts/ZRXToken.json +++ b/packages/0x.js/src/artifacts/ZRXToken.json @@ -10022,6 +10022,11 @@ } }, "networks": { + "42": { + "address": "0x6ff6c0ff1d68b964901f986d4c9fa3ac68346570", + "links": {}, + "constructorArgs": "[]" + }, "50": { "address": "0x871dd7c2b4b25e1aa18728e9d5f2af4c4e431f5c", "links": {}, diff --git a/packages/connect/CHANGELOG.json b/packages/connect/CHANGELOG.json index 1f17392a9..618694b5f 100644 --- a/packages/connect/CHANGELOG.json +++ b/packages/connect/CHANGELOG.json @@ -3,7 +3,8 @@ "version": "2.0.0", "changes": [ { - "note": "Updated for SRA v2" + "note": "Updated for SRA v2", + "pr": 974 } ] }, diff --git a/packages/connect/src/http_client.ts b/packages/connect/src/http_client.ts index 93f4eeb05..1b30bebf3 100644 --- a/packages/connect/src/http_client.ts +++ b/packages/connect/src/http_client.ts @@ -56,7 +56,7 @@ export class HttpClient implements Client { } /** * Retrieve assetData pair info from the API - * @param requestOpts Options specifying assetData information to retrieve and page information, defaults to { page: 1, perPage: 100 } + * @param requestOpts Options specifying assetData information to retrieve, page information, and network id. * @return The resulting AssetPairsItems that match the request */ public async getAssetPairsAsync( @@ -76,7 +76,7 @@ export class HttpClient implements Client { } /** * Retrieve orders from the API - * @param requestOpts Options specifying orders to retrieve and page information, defaults to { page: 1, perPage: 100 } + * @param requestOpts Options specifying orders to retrieve and page information, page information, and network id. * @return The resulting SignedOrders that match the request */ public async getOrdersAsync( @@ -114,7 +114,7 @@ export class HttpClient implements Client { /** * Retrieve an orderbook from the API * @param request An OrderbookRequest instance describing the specific orderbook to retrieve - * @param requestOpts Options specifying page information, defaults to { page: 1, perPage: 100 } + * @param requestOpts Options specifying page information, and network id. * @return The resulting OrderbookResponse that matches the request */ public async getOrderbookAsync( @@ -135,7 +135,8 @@ export class HttpClient implements Client { } /** * Retrieve fee information from the API - * @param request A OrderConfigRequest instance describing the specific fees to retrieve + * @param request A OrderConfigRequest instance describing the specific fees to retrieve + * @param requestOpts Options specifying network id. * @return The resulting OrderConfigResponse that matches the request */ public async getOrderConfigAsync( @@ -155,7 +156,8 @@ export class HttpClient implements Client { return fees; } /** - * Retrieve the list of fee recipient addresses used by + * Retrieve the list of fee recipient addresses used by the relayer. + * @param requestOpts Options specifying page information, and network id. */ public async getFeeRecipientsAsync(requestOpts?: RequestOpts & PagedRequestOpts): Promise { if (!_.isUndefined(requestOpts)) { @@ -172,6 +174,7 @@ export class HttpClient implements Client { /** * Submit a signed order to the API * @param signedOrder A SignedOrder instance to submit + * @param requestOpts Options specifying network id. */ public async submitOrderAsync(signedOrder: SignedOrder, requestOpts?: RequestOpts): Promise { assert.doesConformToSchema('signedOrder', signedOrder, schemas.signedOrderSchema); -- cgit v1.2.3