Add transactionHash to OrderState and emit it from OrderWatcher subscription

packages/order-utils/src/order_state_utils.ts

@@ -114,7 +114,7 @@ export class OrderStateUtils {
      * @return State relevant to the signedOrder, as well as whether the signedOrder is "valid".
      * Validity is defined as a non-zero amount of the order can still be filled.
      */
-    public async getOpenOrderStateAsync(signedOrder: SignedOrder): Promise<OrderState> {
+    public async getOpenOrderStateAsync(signedOrder: SignedOrder, transactionHash?: string): Promise<OrderState> {
         const orderRelevantState = await this.getOpenOrderRelevantStateAsync(signedOrder);
         const orderHash = orderHashUtils.getOrderHashHex(signedOrder);
         const isOrderCancelled = await this._orderFilledCancelledFetcher.isOrderCancelledAsync(orderHash);
@@ -134,6 +134,7 @@ export class OrderStateUtils {
                 isValid: true,
                 orderHash,
                 orderRelevantState,
+                transactionHash,
             };
             return orderState;
         } else {
@@ -141,6 +142,7 @@ export class OrderStateUtils {
                 isValid: false,
                 orderHash,
                 error: orderValidationResult.error,
+                transactionHash,
             };
             return orderState;
         }

packages/order-utils/test/order_state_utils_test.ts

@@ -120,5 +120,25 @@ describe('OrderStateUtils', () => {
             const orderState = await orderStateUtils.getOpenOrderStateAsync(signedOrder);
             expect(orderState.isValid).to.eq(false);
         });
+        it('should include the transactionHash in orderState if supplied in method invocation', async () => {
+            const makerAssetAmount = new BigNumber(10);
+            const takerAssetAmount = new BigNumber(10000000000000000);
+            const takerBalance = takerAssetAmount;
+            const orderFilledAmount = new BigNumber(0);
+            const mockBalanceFetcher = buildMockBalanceFetcher(takerBalance);
+            const mockOrderFilledFetcher = buildMockOrderFilledFetcher(orderFilledAmount);
+            const [signedOrder] = testOrderFactory.generateTestSignedOrders(
+                {
+                    makerAssetAmount,
+                    takerAssetAmount,
+                },
+                1,
+            );
+
+            const orderStateUtils = new OrderStateUtils(mockBalanceFetcher, mockOrderFilledFetcher);
+            const transactionHash = '0xdeadbeef';
+            const orderState = await orderStateUtils.getOpenOrderStateAsync(signedOrder, transactionHash);
+            expect(orderState.transactionHash).to.eq(transactionHash);
+        });
     });
 });