Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Commit

Permalink
Merge pull request #1087 from 0xProject/addTxHashToOrderState
Browse files Browse the repository at this point in the history 
Add transactionHash to OrderState and emit it from OrderWatcher
  • Loading branch information
@fabioberger
fabioberger authored Sep 25, 2018
2 parents 7570f3d + 5afc739 commit b73df28
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 13 deletions.
4 changes: 3 additions & 1 deletion packages/order-utils/src/order_state_utils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -134,13 +134,15 @@ export class OrderStateUtils {
isValid: true,
orderHash,
orderRelevantState,
transactionHash,
};
return orderState;
} else {
const orderState: OrderStateInvalid = {
isValid: false,
orderHash,
error: orderValidationResult.error,
transactionHash,
};
return orderState;
}
Expand Down
20 changes: 20 additions & 0 deletions packages/order-utils/test/order_state_utils_test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
});
});
5 changes: 5 additions & 0 deletions packages/order-watcher/CHANGELOG.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
"note":
"Fix misunderstanding about blockstream interface callbacks and pass the raw JSON RPC responses to it",
"pr": 1080
},
{
"note":
"Add `transactionHash` to `OrderState` emitted by `OrderWatcher` subscriptions if the order's state change originated from a transaction.",
"pr": 1087
}
]
},
Expand Down
25 changes: 13 additions & 12 deletions packages/order-watcher/src/order_watcher/order_watcher.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@ export class OrderWatcher {
return; // noop
}
const decodedLog = (maybeDecodedLog as any) as LogWithDecodedArgs<ContractEventArgs>;
const transactionHash = decodedLog.transactionHash;
switch (decodedLog.event) {
case ERC20TokenEvents.Approval:
case ERC721TokenEvents.Approval: {
Expand All @@ -290,7 +291,7 @@ export class OrderWatcher {
args._owner,
tokenAssetData,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
} else {
// ERC721
Expand All @@ -303,7 +304,7 @@ export class OrderWatcher {
args._owner,
tokenAssetData,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
}
}
Expand All @@ -322,7 +323,7 @@ export class OrderWatcher {
args._from,
tokenAssetData,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
} else {
// ERC721
Expand All @@ -336,7 +337,7 @@ export class OrderWatcher {
args._from,
tokenAssetData,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
}
}
Expand All @@ -350,7 +351,7 @@ export class OrderWatcher {
args._owner,
tokenAddress,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
}
case WETH9Events.Deposit: {
Expand All @@ -363,7 +364,7 @@ export class OrderWatcher {
args._owner,
tokenAssetData,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
}
case WETH9Events.Withdrawal: {
Expand All @@ -376,7 +377,7 @@ export class OrderWatcher {
args._owner,
tokenAssetData,
);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
}
case ExchangeEvents.Fill: {
Expand All @@ -387,7 +388,7 @@ export class OrderWatcher {
const orderHash = args.orderHash;
const isOrderWatched = !_.isUndefined(this._orderByOrderHash[orderHash]);
if (isOrderWatched) {
await this._emitRevalidateOrdersAsync([orderHash]);
await this._emitRevalidateOrdersAsync([orderHash], transactionHash);
}
break;
}
Expand All @@ -399,7 +400,7 @@ export class OrderWatcher {
const orderHash = args.orderHash;
const isOrderWatched = !_.isUndefined(this._orderByOrderHash[orderHash]);
if (isOrderWatched) {
await this._emitRevalidateOrdersAsync([orderHash]);
await this._emitRevalidateOrdersAsync([orderHash], transactionHash);
}
break;
}
Expand All @@ -410,20 +411,20 @@ export class OrderWatcher {
this._orderFilledCancelledLazyStore.deleteAllIsCancelled();
// Revalidate orders
const orderHashes = this._dependentOrderHashesTracker.getDependentOrderHashesByMaker(args.makerAddress);
await this._emitRevalidateOrdersAsync(orderHashes);
await this._emitRevalidateOrdersAsync(orderHashes, transactionHash);
break;
}

default:
throw errorUtils.spawnSwitchErr('decodedLog.event', decodedLog.event);
}
}
private async _emitRevalidateOrdersAsync(orderHashes: string[]): Promise<void> {
private async _emitRevalidateOrdersAsync(orderHashes: string[], transactionHash?: string): Promise<void> {
for (const orderHash of orderHashes) {
const signedOrder = this._orderByOrderHash[orderHash];
// Most of these calls will never reach the network because the data is fetched from stores
// and only updated when cache is invalidated
const orderState = await this._orderStateUtils.getOpenOrderStateAsync(signedOrder);
const orderState = await this._orderStateUtils.getOpenOrderStateAsync(signedOrder, transactionHash);
if (_.isUndefined(this._callbackIfExists)) {
break; // Unsubscribe was called
}
Expand Down
26 changes: 26 additions & 0 deletions packages/order-watcher/test/order_watcher_test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,32 @@ describe('OrderWatcher', () => {
await contractWrappers.exchange.fillOrderAsync(signedOrder, fillableAmount, takerAddress);
})().catch(done);
});
it('should include transactionHash in emitted orderStateInvalid when watched order fully filled', (done: DoneCallback) => {
(async () => {
signedOrder = await fillScenarios.createFillableSignedOrderAsync(
makerAssetData,
takerAssetData,
makerAddress,
takerAddress,
fillableAmount,
);
await orderWatcher.addOrderAsync(signedOrder);

let transactionHash: string;
const callback = callbackErrorReporter.reportNodeCallbackErrors(done)((orderState: OrderState) => {
expect(orderState.isValid).to.be.false();
const invalidOrderState = orderState as OrderStateInvalid;
expect(invalidOrderState.transactionHash).to.be.equal(transactionHash);
});
orderWatcher.subscribe(callback);

transactionHash = await contractWrappers.exchange.fillOrderAsync(
signedOrder,
fillableAmount,
takerAddress,
);
})().catch(done);
});
it('should emit orderStateValid when watched order partially filled', (done: DoneCallback) => {
(async () => {
signedOrder = await fillScenarios.createFillableSignedOrderAsync(
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,14 @@ export interface OrderStateValid {
isValid: true;
orderHash: string;
orderRelevantState: OrderRelevantState;
transactionHash?: string;
}

export interface OrderStateInvalid {
isValid: false;
orderHash: string;
error: ExchangeContractErrs;
transactionHash?: string;
}

export type OrderState = OrderStateValid | OrderStateInvalid;
Expand Down

0 comments on commit b73df28

Please sign in to comment.