Amended comments to clarify changes on PR #488

This commit is contained in:
Ara Kevonian
2018-03-30 08:00:05 -07:00
parent 57ca611e12
commit a322148631
3 changed files with 5 additions and 3 deletions

View File

@@ -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_

View File

@@ -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.
*/

View File

@@ -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;