From a322148631e910466d1a08dce55b5e46e76f8863 Mon Sep 17 00:00:00 2001
From: Ara Kevonian <=>
Date: Fri, 30 Mar 2018 08:00:05 -0700
Subject: Amended comments to clarify changes on PR #488

---
 packages/0x.js/CHANGELOG.md | 6 +++---
 packages/0x.js/src/0x.ts    | 1 +
 packages/0x.js/src/types.ts | 1 +
 3 files changed, 5 insertions(+), 3 deletions(-)

(limited to 'packages')

diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md
index ab656349f..af63118a7 100644
--- a/packages/0x.js/CHANGELOG.md
+++ b/packages/0x.js/CHANGELOG.md
@@ -3,9 +3,9 @@
 ## v0.34.0 - _TBD_
 
     * Fix the bug causing `zeroEx.exchange.fillOrdersUpToAsync` validation to fail if there were some extra orders passed (#470)
-    * Remove automatic instantiation of `zeroEx.orderStateWatcher`
-    * Add `zeroEx.createOrderStateWatcher` to allow creating arbitrary number of OrderStateWatchers
-    * Added `stateLayer` setting to `OrderStateWatcherConfig` so OrderStateWatcher can be set to monitor different blockchain state layers
+    * Remove automatic instantiation of `zeroEx.orderStateWatcher` (#488)
+    * Add `zeroEx.createOrderStateWatcher` to allow creating arbitrary number of OrderStateWatchers (#488)
+    * Added `stateLayer` setting to `OrderStateWatcherConfig` so OrderStateWatcher can be set to monitor different blockchain state layers (#488)
 
 ## v0.33.2 - _March 18, 2018_
 
diff --git a/packages/0x.js/src/0x.ts b/packages/0x.js/src/0x.ts
index 418d0ba34..7627f1d6e 100644
--- a/packages/0x.js/src/0x.ts
+++ b/packages/0x.js/src/0x.ts
@@ -326,6 +326,7 @@ export class ZeroEx {
     }
     /**
      * Instantiates and returns a new OrderStateWatcher instance.
+     * Defaults to watching the pending state.
      * @param   config      The configuration object. Look up the type for the description.
      * @return  An instance of the 0x.js OrderStateWatcher class.
      */
diff --git a/packages/0x.js/src/types.ts b/packages/0x.js/src/types.ts
index a13004720..8dede4b50 100644
--- a/packages/0x.js/src/types.ts
+++ b/packages/0x.js/src/types.ts
@@ -169,6 +169,7 @@ export type Web3Provider = Web3.Provider;
  * expirationMarginMs: Amount of time before order expiry that you'd like to be notified
  * of an orders expiration. Defaults: 0
  * cleanupJobIntervalMs: How often to run a cleanup job which revalidates all the orders. Defaults: 1h
+ * stateLayer: Optional blockchain state layer OrderWatcher will monitor for new events. Defaults: pending
  */
 export interface OrderStateWatcherConfig {
     orderExpirationCheckingIntervalMs?: number;
-- 
cgit v1.2.3