Add comment above orderStateWatcher class

This commit is contained in:
Fabio Berger
2017-11-11 09:45:50 -05:00
parent 4e708c81ca
commit d4f763aa68

View File

@@ -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;