Limit Order Book
Last updated
Was this helpful?
Last updated
Was this helpful?
The LimitOrderBook is deployed on xDai at 0x02e7B722E178518Ae07a596A7cb5F88B313c453a
The source code can be found at
The functions allowing you to create orders are functionally very similar. We will give an overview of the parameters common to all orders and then discuss their differences.
Please ensure that you have familiarised yourself with the different .
This function is used to add Limit Orders.
_limitPrice
the price for the limit order.
A limit buy order will be executed when the current price is less than limitPrice.
A limit sell order is executed when the current price is greater than limitPrice
This function is used to add Stop Orders.
_stopPrice
the price for the stop order.
A stop market buy order will be executed when the current price is greater than stopPrice.
A stop market sell order is executed when the current price is lesser than stopPrice
This function is used to add Stop-Limit orders. Stop-Limit orders
_stopPrice
the price for the stop limit order.
A stop limit buy order will be executed when the current price is greater than stopPrice.
A stop limit sell order is executed when the current price is lesser than stopPrice
_limitPrice
the order must also satisfy the limit conditions in order to be valid
This function is used to add a trailing Stop order with an absolute value
_trail
represents the absolute value of the trail between the price of the asset and the trigger(stop) price. This will clearly be different for different assets.
This function is used to add trailing Stop orders with percentage value
_trailPct
This number represents the trail value as a percentage of the asset price (must be between 0 and 1)
A value of 0.1 (formatted to 18 decimal places) will therefore signify 10%
This function is used to add trailing Stop Limit orders with absolute values
_trail
is exactly similar to the trailing stop market orders
_gap
will specify the gap between the trailing stop price and the trailing limit price.
This function is used to add a trailing Stop Limit order with percentage values.
_trailPct
is exactly similar to the trailing stop market orders
_gapPct
will specify the gap between the trailing stop price and the trailing limit price as a percentage.
This function allows a user to modify their own order. All the parameters are functionally similar to their counterparts in the addOrder functions.
order_id
is the id of the order you are attempting to change.
Although the option exists to modify the stop price and limit price for all order types, changing the limit price of a stop order (or vice versa) will not turn it into a stop-limit order.
This function allows users to modify their trailing orders.
_newStop
and _newLimit
are functionally similar to the trail and gap parameters discussed above.
If the order is percentage, this function will expect percentage inputs.
This function allows users to delete their own orders
This function is used by keepers/users to execute orders once their conditions have been achieved
This function is used to update the trigger prices for the trailing orders.
_reserveIndex
is used by the contract to verify previous prices of assets in order to update trailing prices. The ClearingHouse contract keeps a store of previous prices from ReserveSnapshotted. These prices can be queries using getPriceAtSnapshot()