aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/src
diff options
context:
space:
mode:
authorAra Kevonian <=>2018-03-30 23:00:05 +0800
committerAra Kevonian <=>2018-03-30 23:00:05 +0800
commita322148631e910466d1a08dce55b5e46e76f8863 (patch)
tree0c6142b84ca9f3bf65d2ab97887a955f7f4a0f7f /packages/0x.js/src
parent57ca611e12d2e40c3f0f33023544a890be7ccb87 (diff)
downloaddexon-sol-tools-a322148631e910466d1a08dce55b5e46e76f8863.tar.gz
dexon-sol-tools-a322148631e910466d1a08dce55b5e46e76f8863.tar.zst
dexon-sol-tools-a322148631e910466d1a08dce55b5e46e76f8863.zip
Amended comments to clarify changes on PR #488
Diffstat (limited to 'packages/0x.js/src')
-rw-r--r--packages/0x.js/src/0x.ts1
-rw-r--r--packages/0x.js/src/types.ts1
2 files changed, 2 insertions, 0 deletions
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;