crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

The OrderInfo struct is now returned by the getOrderInfo function

Browse Source
This commit is contained in:
Greg Hysen
2018-05-16 16:57:02 -07:00
parent c8f65a1bf9
commit 636dae6a79
8 changed files with 98 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
packages/contracts/src/contracts/current/protocol/Exchange/MixinExchangeCore.sol
View File

@@ -81,10 +81,7 @@ contract MixinExchangeCore is
returns (FillResults memory fillResults)
{
// Fetch order info
bytes32 orderHash;
uint8 orderStatus;
uint256 orderFilledAmount;
(orderStatus, orderHash, orderFilledAmount) = getOrderInfo(order);
OrderInfo memory orderInfo = getOrderInfo(order);
// Fetch taker address
address takerAddress = getCurrentContextAddress();
@@ -92,10 +89,10 @@ contract MixinExchangeCore is
// Either our context is valid or we revert
assertValidFill(
order,
orderStatus,
orderHash,
orderInfo.orderStatus,
orderInfo.orderHash,
takerAddress,
orderFilledAmount,
orderInfo.orderFilledAmount,
takerAssetFillAmount,
signature
);
@@ -104,12 +101,12 @@ contract MixinExchangeCore is
uint8 status;
(status, fillResults) = calculateFillResults(
order,
orderStatus,
orderFilledAmount,
orderInfo.orderStatus,
orderInfo.orderFilledAmount,
takerAssetFillAmount
);
if (status != uint8(Status.SUCCESS)) {
emit ExchangeStatus(uint8(status), orderHash);
emit ExchangeStatus(uint8(status), orderInfo.orderHash);
return fillResults;
}
@@ -120,8 +117,8 @@ contract MixinExchangeCore is
updateFilledState(
order,
takerAddress,
orderHash,
orderFilledAmount,
orderInfo.orderHash,
orderInfo.orderFilledAmount,
fillResults
);
return fillResults;
@@ -138,15 +135,13 @@ contract MixinExchangeCore is
returns (bool)
{
// Fetch current order status
bytes32 orderHash;
uint8 orderStatus;
(orderStatus, orderHash, ) = getOrderInfo(order);
OrderInfo memory orderInfo = getOrderInfo(order);
// Validate context
assertValidCancel(order, orderStatus, orderHash);
assertValidCancel(order, orderInfo.orderStatus, orderInfo.orderHash);
// Perform cancel
return updateCancelledState(order, orderStatus, orderHash);
return updateCancelledState(order, orderInfo.orderStatus, orderInfo.orderHash);
}
/// @dev Validates context for fillOrder. Succeeds or throws.
@@ -393,28 +388,23 @@ contract MixinExchangeCore is
/// @dev Gets information about an order: status, hash, and amount filled.
/// @param order Order to gather information on.
/// @return status Status of order. See LibStatus for a complete description of order statuses.
/// @return orderHash Keccak-256 EIP712 hash of the order.
/// @return orderFilledAmount Amount of order that has been filled.
/// @return OrderInfo Information about the order and its state.
/// See LibOrder.OrderInfo for a complete description.
function getOrderInfo(Order memory order)
public
view
returns (
uint8 orderStatus,
bytes32 orderHash,
uint256 orderFilledAmount
)
returns (LibOrder.OrderInfo memory orderInfo)
{
// Compute the order hash
orderHash = getOrderHash(order);
orderInfo.orderHash = getOrderHash(order);
// If order.makerAssetAmount is zero, we also reject the order.
// While the Exchange contract handles them correctly, they create
// edge cases in the supporting infrastructure because they have
// an 'infinite' price when computed by a simple division.
if (order.makerAssetAmount == 0) {
orderStatus = uint8(Status.ORDER_INVALID_MAKER_ASSET_AMOUNT);
return (orderStatus, orderHash, orderFilledAmount);
orderInfo.orderStatus = uint8(Status.ORDER_INVALID_MAKER_ASSET_AMOUNT);
return orderInfo;
}
// If order.takerAssetAmount is zero, then the order will always
@@ -422,35 +412,35 @@ contract MixinExchangeCore is
// Instead of distinguishing between unfilled and filled zero taker
// amount orders, we choose not to support them.
if (order.takerAssetAmount == 0) {
orderStatus = uint8(Status.ORDER_INVALID_TAKER_ASSET_AMOUNT);
return (orderStatus, orderHash, orderFilledAmount);
orderInfo.orderStatus = uint8(Status.ORDER_INVALID_TAKER_ASSET_AMOUNT);
return orderInfo;
}
// Validate order expiration
if (block.timestamp >= order.expirationTimeSeconds) {
orderStatus = uint8(Status.ORDER_EXPIRED);
return (orderStatus, orderHash, orderFilledAmount);
orderInfo.orderStatus = uint8(Status.ORDER_EXPIRED);
return orderInfo;
}
// Check if order has been cancelled
if (cancelled[orderHash]) {
orderStatus = uint8(Status.ORDER_CANCELLED);
return (orderStatus, orderHash, orderFilledAmount);
if (cancelled[orderInfo.orderHash]) {
orderInfo.orderStatus = uint8(Status.ORDER_CANCELLED);
return orderInfo;
}
if (makerEpoch[order.makerAddress] > order.salt) {
orderStatus = uint8(Status.ORDER_CANCELLED);
return (orderStatus, orderHash, orderFilledAmount);
orderInfo.orderStatus = uint8(Status.ORDER_CANCELLED);
return orderInfo;
}
// Fetch filled amount and validate order availability
orderFilledAmount = filled[orderHash];
if (orderFilledAmount >= order.takerAssetAmount) {
orderStatus = uint8(Status.ORDER_FULLY_FILLED);
return (orderStatus, orderHash, orderFilledAmount);
orderInfo.orderFilledAmount = filled[orderInfo.orderHash];
if (orderInfo.orderFilledAmount >= order.takerAssetAmount) {
orderInfo.orderStatus = uint8(Status.ORDER_FULLY_FILLED);
return orderInfo;
}
// All other statuses are ruled out: order is Fillable
orderStatus = uint8(Status.ORDER_FILLABLE);
return (orderStatus, orderHash, orderFilledAmount);
orderInfo.orderStatus = uint8(Status.ORDER_FILLABLE);
return orderInfo;
}
}

16
packages/contracts/src/contracts/current/protocol/Exchange/MixinMatchOrders.sol
View File

@@ -58,19 +58,9 @@ contract MixinMatchOrders is
public
returns (MatchedFillResults memory matchedFillResults)
{
// Get left status
OrderInfo memory leftOrderInfo;
( leftOrderInfo.orderStatus,
leftOrderInfo.orderHash,
leftOrderInfo.orderFilledAmount
) = getOrderInfo(leftOrder);
// Get right status
OrderInfo memory rightOrderInfo;
( rightOrderInfo.orderStatus,
rightOrderInfo.orderHash,
rightOrderInfo.orderFilledAmount
) = getOrderInfo(rightOrder);
// Get left & right order info
OrderInfo memory leftOrderInfo = getOrderInfo(leftOrder);
OrderInfo memory rightOrderInfo = getOrderInfo(rightOrder);
// Fetch taker address
address takerAddress = getCurrentContextAddress();

11
packages/contracts/src/contracts/current/protocol/Exchange/interfaces/IExchangeCore.sol
View File

@@ -51,15 +51,10 @@ contract IExchangeCore {
/// @dev Gets information about an order: status, hash, and amount filled.
/// @param order Order to gather information on.
/// @return status Status of order. See LibStatus for a complete description of order statuses.
/// @return orderHash Keccak-256 EIP712 hash of the order.
/// @return orderFilledAmount Amount of order that has been filled.
/// @return OrderInfo Information about the order and its state.
/// See LibOrder.OrderInfo for a complete description.
function getOrderInfo(LibOrder.Order memory order)
public
view
returns (
uint8 orderStatus,
bytes32 orderHash,
uint256 orderFilledAmount
);
returns (LibOrder.OrderInfo memory orderInfo);
}

9
packages/contracts/src/contracts/current/protocol/Exchange/libs/LibOrder.sol
View File

@@ -51,6 +51,15 @@ contract LibOrder {
bytes takerAssetData;
}
struct OrderInfo {
// See LibStatus for a complete description of order statuses
uint8 orderStatus;
// Keccak-256 EIP712 hash of the order
bytes32 orderHash;
// Amount of order that has been filled
uint256 orderFilledAmount;
}
/// @dev Calculates Keccak-256 hash of the order.
/// @param order The order structure.
/// @return Keccak-256 EIP712 hash of the order.

8
packages/contracts/src/contracts/current/protocol/Exchange/mixins/MMatchOrders.sol
View File

@@ -27,14 +27,6 @@ contract MMatchOrders is
IMatchOrders
{
/// This struct exists solely to avoid the stack limit constraint
/// in matchOrders
struct OrderInfo {
uint8 orderStatus;
bytes32 orderHash;
uint256 orderFilledAmount;
}
/// @dev Validates context for matchOrders. Succeeds or throws.
/// @param leftOrder First order to match.
/// @param rightOrder Second order to match.

8
packages/contracts/src/utils/exchange_wrapper.ts
View File

@@ -9,7 +9,7 @@ import { constants } from './constants';
import { formatters } from './formatters';
import { LogDecoder } from './log_decoder';
import { orderUtils } from './order_utils';
import { AssetProxyId, SignedOrder, SignedTransaction } from './types';
import { AssetProxyId, OrderInfo, SignedOrder, SignedTransaction } from './types';
export class ExchangeWrapper {
private _exchange: ExchangeContract;
@@ -225,10 +225,8 @@ export class ExchangeWrapper {
const filledAmount = new BigNumber(await this._exchange.filled.callAsync(orderHashHex));
return filledAmount;
}
public async getOrderInfoAsync(
signedOrder: SignedOrder,
): Promise<[number /* orderStatus */, string /* orderHash */, BigNumber /* orderTakerAssetAmountFilled */]> {
const orderInfo: [number, string, BigNumber] = await this._exchange.getOrderInfo.callAsync(signedOrder);
public async getOrderInfoAsync(signedOrder: SignedOrder): Promise<OrderInfo> {
const orderInfo = (await this._exchange.getOrderInfo.callAsync(signedOrder)) as OrderInfo;
return orderInfo;
}
public async matchOrdersAsync(

6
packages/contracts/src/utils/types.ts
View File

@@ -174,3 +174,9 @@ export interface TransferAmountsByMatchOrders {
feeReceivedLeft: BigNumber;
feeReceivedRight: BigNumber;
}
export interface OrderInfo {
orderStatus: number;
orderHash: string;
orderFilledAmount: BigNumber;
}