OrderMixin

Regular Limit Order mixin

Derives

Functions

remaining

function remaining(
  bytes32 orderHash
) external returns (uint256)

Returns unfilled amount for order. Throws if order does not exist

Parameters:

remainingRaw

function remainingRaw(
  bytes32 orderHash
) external returns (uint256)

Returns unfilled amount for order

Parameters:

Return Values:

remainingsRaw

function remainingsRaw(
  bytes32[] orderHashes
) external returns (uint256[])

Same as remainingRaw but for multiple orders

Parameters:

simulateCalls

function simulateCalls(
  address[] targets,
  bytes[] data
) external

Calls every target with corresponding data. Then reverts with CALL_RESULTS_0101011 where zeroes and ones denote failure or success of the corresponding call

Parameters:

cancelOrder

function cancelOrder(
  struct OrderLib.Order order
) external

Cancels order by setting remaining amount to zero

Parameters:

fillOrder

function fillOrder(
  struct OrderLib.Order order,
  bytes signature,
  bytes interaction,
  uint256 makingAmount,
  uint256 takingAmount,
  uint256 thresholdAmount
) external returns (uint256, uint256)

Fills an order. If one doesn't exist (first fill) it will be created using order.makerAssetData

Parameters:

fillOrderToWithPermit

function fillOrderToWithPermit(
  struct OrderLib.Order order,
  bytes signature,
  bytes interaction,
  uint256 makingAmount,
  uint256 takingAmount,
  uint256 thresholdAmount,
  address target,
  bytes permit
) external returns (uint256, uint256)

Same as fillOrder but calls permit first, allowing to approve token spending and make a swap in one transaction. Also allows to specify funds destination instead of msg.sender

See tests for examples

Parameters:

fillOrderTo

function fillOrderTo(
  struct OrderLib.Order order_,
  bytes signature,
  bytes interaction,
  uint256 makingAmount,
  uint256 takingAmount,
  uint256 thresholdAmount,
  address target
) public returns (uint256, uint256)

Same as fillOrder but allows to specify funds destination instead of msg.sender

Parameters:

checkPredicate

function checkPredicate(
  struct OrderLib.Order order
) public returns (bool)

Checks order predicate

Parameters:

hashOrder

function hashOrder(
  struct OrderLib.Order order
) public returns (bytes32)

Parameters:

Events

OrderFilled

event OrderFilled(
  address maker,
  bytes32 orderHash,
  uint256 remaining
)

Emitted every time order gets filled, including partial fills

Parameters:

OrderCanceled

event OrderCanceled(
  address maker,
  bytes32 orderHash,
  uint256 remainingRaw
)

Emitted when order gets cancelled

Parameters:

Last updated