aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-11-18 03:06:10 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2017-11-18 03:06:10 +0800
commitd3e03744cdbc12bd1956fd5d921fc2331e4ee5cf (patch)
tree49c340732cf406f99932fdfb294b8fcad051e711
parent34926eb66ae6ea105f7f2e029c65c4d44025a655 (diff)
downloaddexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.tar
dexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.tar.gz
dexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.tar.bz2
dexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.tar.lz
dexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.tar.xz
dexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.tar.zst
dexon-sol-tools-d3e03744cdbc12bd1956fd5d921fc2331e4ee5cf.zip
Improve the comment
-rw-r--r--packages/0x.js/src/order_watcher/expiration_watcher.ts3
1 files changed, 2 insertions, 1 deletions
diff --git a/packages/0x.js/src/order_watcher/expiration_watcher.ts b/packages/0x.js/src/order_watcher/expiration_watcher.ts
index 1a9e9a418..5153cd8b9 100644
--- a/packages/0x.js/src/order_watcher/expiration_watcher.ts
+++ b/packages/0x.js/src/order_watcher/expiration_watcher.ts
@@ -10,7 +10,8 @@ import {ZeroEx} from '../0x';
const DEFAULT_ORDER_EXPIRATION_CHECKING_INTERVAL_MS = 50;
/**
- * This class includes all the functionality related to prunning expired orders
+ * This class includes the functionality to detect expired orders.
+ * It stores them in a min heap by expiration time and checks for expired ones every `orderExpirationCheckingIntervalMs`
*/
export class ExpirationWatcher {
private orderHashHeapByExpiration: Heap<string>;