Style improvements to the match orders typescript test class

This commit is contained in:
Greg Hysen
2018-05-16 17:27:43 -07:00
parent 28bb11217c
commit e748e1891b

View File

@@ -158,7 +158,6 @@ export class MatchOrderTester {
return [expectedNewERC20BalancesByOwner, expectedNewERC721TokenIdsByOwner]; return [expectedNewERC20BalancesByOwner, expectedNewERC721TokenIdsByOwner];
} }
/// @dev Compares a pair of ERC20 balances and a pair of ERC721 token owners. /// @dev Compares a pair of ERC20 balances and a pair of ERC721 token owners.
/// @param expectedNewERC20BalancesByOwner Expected ERC20 balances. /// @param expectedNewERC20BalancesByOwner Expected ERC20 balances.
/// @param realERC20BalancesByOwner Actual ERC20 balances. /// @param realERC20BalancesByOwner Actual ERC20 balances.
@@ -193,7 +192,6 @@ export class MatchOrderTester {
const erc721TokenIdsMatch = _.isEqual(sortedExpectedNewERC721TokenIdsByOwner, sortedNewERC721TokenIdsByOwner); const erc721TokenIdsMatch = _.isEqual(sortedExpectedNewERC721TokenIdsByOwner, sortedNewERC721TokenIdsByOwner);
return erc721TokenIdsMatch; return erc721TokenIdsMatch;
} }
/// @dev Constructs new MatchOrderTester. /// @dev Constructs new MatchOrderTester.
/// @param exchangeWrapper Used to call to the Exchange. /// @param exchangeWrapper Used to call to the Exchange.
/// @param erc20Wrapper Used to fetch ERC20 balances. /// @param erc20Wrapper Used to fetch ERC20 balances.
@@ -203,7 +201,6 @@ export class MatchOrderTester {
this._erc20Wrapper = erc20Wrapper; this._erc20Wrapper = erc20Wrapper;
this._erc721Wrapper = erc721Wrapper; this._erc721Wrapper = erc721Wrapper;
} }
/// @dev Matches two complementary orders and validates results. /// @dev Matches two complementary orders and validates results.
/// Validation either succeeds or throws. /// Validation either succeeds or throws.
/// @param signedOrderLeft First matched order. /// @param signedOrderLeft First matched order.
@@ -231,21 +228,21 @@ export class MatchOrderTester {
const feeRecipientAddressLeft = signedOrderLeft.feeRecipientAddress; const feeRecipientAddressLeft = signedOrderLeft.feeRecipientAddress;
const feeRecipientAddressRight = signedOrderRight.feeRecipientAddress; const feeRecipientAddressRight = signedOrderRight.feeRecipientAddress;
// Verify Left order preconditions // Verify Left order preconditions
const takerAssetFilledAmountBeforeLeft = await this._exchangeWrapper.getTakerAssetFilledAmountAsync( const orderFilledAmountLeft = await this._exchangeWrapper.getTakerAssetFilledAmountAsync(
orderUtils.getOrderHashHex(signedOrderLeft), orderUtils.getOrderHashHex(signedOrderLeft),
); );
const expectedLeftOrderFillAmoutBeforeMatch = initialTakerAssetFilledAmountLeft const expectedOrderFilledAmountLeft = initialTakerAssetFilledAmountLeft
? initialTakerAssetFilledAmountLeft ? initialTakerAssetFilledAmountLeft
: new BigNumber(0); : new BigNumber(0);
expect(takerAssetFilledAmountBeforeLeft).to.be.bignumber.equal(expectedLeftOrderFillAmoutBeforeMatch); expect(expectedOrderFilledAmountLeft).to.be.bignumber.equal(orderFilledAmountLeft);
// Verify Right order preconditions // Verify Right order preconditions
const takerAssetFilledAmountBeforeRight = await this._exchangeWrapper.getTakerAssetFilledAmountAsync( const orderFilledAmountRight = await this._exchangeWrapper.getTakerAssetFilledAmountAsync(
orderUtils.getOrderHashHex(signedOrderRight), orderUtils.getOrderHashHex(signedOrderRight),
); );
const expectedRightOrderFillAmoutBeforeMatch = initialTakerAssetFilledAmountRight const expectedOrderFilledAmountRight = initialTakerAssetFilledAmountRight
? initialTakerAssetFilledAmountRight ? initialTakerAssetFilledAmountRight
: new BigNumber(0); : new BigNumber(0);
expect(takerAssetFilledAmountBeforeRight).to.be.bignumber.equal(expectedRightOrderFillAmoutBeforeMatch); expect(expectedOrderFilledAmountRight).to.be.bignumber.equal(orderFilledAmountRight);
// Match left & right orders // Match left & right orders
await this._exchangeWrapper.matchOrdersAsync(signedOrderLeft, signedOrderRight, takerAddress); await this._exchangeWrapper.matchOrdersAsync(signedOrderLeft, signedOrderRight, takerAddress);
const newERC20BalancesByOwner = await this._erc20Wrapper.getBalancesAsync(); const newERC20BalancesByOwner = await this._erc20Wrapper.getBalancesAsync();
@@ -254,8 +251,8 @@ export class MatchOrderTester {
const expectedTransferAmounts = await this._calculateExpectedTransferAmountsAsync( const expectedTransferAmounts = await this._calculateExpectedTransferAmountsAsync(
signedOrderLeft, signedOrderLeft,
signedOrderRight, signedOrderRight,
expectedLeftOrderFillAmoutBeforeMatch, orderFilledAmountLeft,
expectedRightOrderFillAmoutBeforeMatch, orderFilledAmountRight,
); );
let expectedERC20BalancesByOwner: ERC20BalancesByOwner; let expectedERC20BalancesByOwner: ERC20BalancesByOwner;
let expectedERC721TokenIdsByOwner: ERC721TokenIdsByOwner; let expectedERC721TokenIdsByOwner: ERC721TokenIdsByOwner;
@@ -278,24 +275,23 @@ export class MatchOrderTester {
expect(expectedBalancesMatchRealBalances).to.be.true(); expect(expectedBalancesMatchRealBalances).to.be.true();
return [newERC20BalancesByOwner, newERC721TokenIdsByOwner]; return [newERC20BalancesByOwner, newERC721TokenIdsByOwner];
} }
/// @dev Calculates expected transfer amounts between order makers, fee recipients, and /// @dev Calculates expected transfer amounts between order makers, fee recipients, and
/// the taker when two orders are matched. /// the taker when two orders are matched.
/// @param signedOrderLeft First matched order. /// @param signedOrderLeft First matched order.
/// @param signedOrderRight Second matched order. /// @param signedOrderRight Second matched order.
/// @param expectedLeftOrderFillAmoutBeforeMatch How much we expect the left order has been filled, prior to matching orders. /// @param orderFilledAmountLeft How much left order has been filled, prior to matching orders.
/// @param expectedRightOrderFillAmoutBeforeMatch How much we expect the right order has been filled, prior to matching orders. /// @param orderFilledAmountRight How much the right order has been filled, prior to matching orders.
/// @return TransferAmounts A struct containing the expected transfer amounts. /// @return TransferAmounts A struct containing the expected transfer amounts.
private async _calculateExpectedTransferAmountsAsync( private async _calculateExpectedTransferAmountsAsync(
signedOrderLeft: SignedOrder, signedOrderLeft: SignedOrder,
signedOrderRight: SignedOrder, signedOrderRight: SignedOrder,
expectedLeftOrderFillAmoutBeforeMatch: BigNumber, orderFilledAmountLeft: BigNumber,
expectedRightOrderFillAmoutBeforeMatch: BigNumber, orderFilledAmountRight: BigNumber,
): Promise<TransferAmounts> { ): Promise<TransferAmounts> {
let amountBoughtByLeftMaker = await this._exchangeWrapper.getTakerAssetFilledAmountAsync( let amountBoughtByLeftMaker = await this._exchangeWrapper.getTakerAssetFilledAmountAsync(
orderUtils.getOrderHashHex(signedOrderLeft), orderUtils.getOrderHashHex(signedOrderLeft),
); );
amountBoughtByLeftMaker = amountBoughtByLeftMaker.minus(expectedLeftOrderFillAmoutBeforeMatch); amountBoughtByLeftMaker = amountBoughtByLeftMaker.minus(orderFilledAmountLeft);
const amountSoldByLeftMaker = amountBoughtByLeftMaker const amountSoldByLeftMaker = amountBoughtByLeftMaker
.times(signedOrderLeft.makerAssetAmount) .times(signedOrderLeft.makerAssetAmount)
.dividedToIntegerBy(signedOrderLeft.takerAssetAmount); .dividedToIntegerBy(signedOrderLeft.takerAssetAmount);
@@ -306,7 +302,7 @@ export class MatchOrderTester {
let amountBoughtByRightMaker = await this._exchangeWrapper.getTakerAssetFilledAmountAsync( let amountBoughtByRightMaker = await this._exchangeWrapper.getTakerAssetFilledAmountAsync(
orderUtils.getOrderHashHex(signedOrderRight), orderUtils.getOrderHashHex(signedOrderRight),
); );
amountBoughtByRightMaker = amountBoughtByRightMaker.minus(expectedRightOrderFillAmoutBeforeMatch); amountBoughtByRightMaker = amountBoughtByRightMaker.minus(orderFilledAmountRight);
const amountSoldByRightMaker = amountBoughtByRightMaker const amountSoldByRightMaker = amountBoughtByRightMaker
.times(signedOrderRight.makerAssetAmount) .times(signedOrderRight.makerAssetAmount)
.dividedToIntegerBy(signedOrderRight.takerAssetAmount); .dividedToIntegerBy(signedOrderRight.takerAssetAmount);