From d4f763aa68b62b33e82af438e11b07d0e741973e Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Sat, 11 Nov 2017 09:45:50 -0500 Subject: Add comment above orderStateWatcher class --- src/order_watcher/order_state_watcher.ts | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/order_watcher/order_state_watcher.ts') 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; -- cgit v1.2.3