diff options
| author | Ara Kevonian <=> | 2018-03-30 23:00:05 +0800 |
|---|---|---|
| committer | Ara Kevonian <=> | 2018-03-30 23:00:05 +0800 |
| commit | a322148631e910466d1a08dce55b5e46e76f8863 (patch) | |
| tree | 0c6142b84ca9f3bf65d2ab97887a955f7f4a0f7f | |
| parent | 57ca611e12d2e40c3f0f33023544a890be7ccb87 (diff) | |
| download | dexon-sol-tools-a322148631e910466d1a08dce55b5e46e76f8863.tar.gz dexon-sol-tools-a322148631e910466d1a08dce55b5e46e76f8863.tar.zst dexon-sol-tools-a322148631e910466d1a08dce55b5e46e76f8863.zip | |
Amended comments to clarify changes on PR #488
| -rw-r--r-- | packages/0x.js/CHANGELOG.md | 6 | ||||
| -rw-r--r-- | packages/0x.js/src/0x.ts | 1 | ||||
| -rw-r--r-- | packages/0x.js/src/types.ts | 1 |
3 files changed, 5 insertions, 3 deletions
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; |