Skip to content

Commit

Permalink
📚 I-1: Add conditional order documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JaredBorders committed Sep 15, 2023
1 parent 2718eab commit ec288ad
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/interfaces/IEngine.sol
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,17 @@ interface IEngine {
CONDITIONAL ORDER MANAGEMENT
//////////////////////////////////////////////////////////////*/

/// In order for a conditional order to be committed and then executed there are a number of requirements that need to be met:
///
/// (1) The account must have sufficient snxUSD collateral to handle the order
/// (2) The account must not have another order committed
/// (3) The order’s set `acceptablePrice` needs to be met both on committing the order and when it gets executed
/// (users should choose a value for this that is likely to execute based on the conditions set)
/// (4) The order can only be executed within Synthetix’s set settlement window
/// (5) There must be a keeper that executes a conditional order
///
/// @notice There is no guarantee a conditional order will be executed

/// @notice execute a conditional order
/// @param _co the conditional order
/// @param _signature the signature of the conditional order
Expand Down

0 comments on commit ec288ad

Please sign in to comment.