From ec288ad042a9105f3a954c60aac72a1f58224743 Mon Sep 17 00:00:00 2001 From: JaredBorders Date: Fri, 15 Sep 2023 14:29:28 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20I-1:=20Add=20conditional=20order?= =?UTF-8?q?=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/interfaces/IEngine.sol | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/interfaces/IEngine.sol b/src/interfaces/IEngine.sol index 16612cd7..c05de146 100644 --- a/src/interfaces/IEngine.sol +++ b/src/interfaces/IEngine.sol @@ -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