diff options
author | Fabio Berger <me@fabioberger.com> | 2017-11-11 22:45:50 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-11-11 22:45:50 +0800 |
commit | d4f763aa68b62b33e82af438e11b07d0e741973e (patch) | |
tree | ad5393ed00c86ff034ed663c88e549cc7ffbd495 | |
parent | 4e708c81ca3309e1ac9ac195e3169c09d5358abb (diff) | |
download | dexon-sol-tools-d4f763aa68b62b33e82af438e11b07d0e741973e.tar.gz dexon-sol-tools-d4f763aa68b62b33e82af438e11b07d0e741973e.tar.zst dexon-sol-tools-d4f763aa68b62b33e82af438e11b07d0e741973e.zip |
Add comment above orderStateWatcher class
-rw-r--r-- | src/order_watcher/order_state_watcher.ts | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/order_watcher/order_state_watcher.ts b/src/order_watcher/order_state_watcher.ts index 303ec8bd3..f1b757abf 100644 --- a/src/order_watcher/order_state_watcher.ts +++ b/src/order_watcher/order_state_watcher.ts @@ -35,6 +35,12 @@ interface OrderByOrderHash { [orderHash: string]: SignedOrder; } +/** + * This class includes all the functionality related to watching a set of orders + * for potential changes in order validity/fillability. The orderWatcher notifies + * the subscriber of these changes so that a final decison can be made on whether + * the order should be deemed invalid. + */ export class OrderStateWatcher { private _orders: OrderByOrderHash; private _dependentOrderHashes: DependentOrderHashes; |