Add capability to list untriggered stop orders

Author: Fernando Fernandes

Sources/SwiftTrader/Model/Error/SwiftTraderError.swift

@@ -40,7 +40,7 @@ public enum SwiftTraderError: Error {
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesCancelStopOrders(symbol:)`.
     case kucoinFuturesCancelStopOrders(error: Error)
 
-    // MARK: Order
+    // MARK: Orders
 
     /// Something went wrong while trying to set the target price.
     case kucoinCouldNotCalculateTheTargetPrice(input: SwiftTraderStopLimitOrderInput)
@@ -55,13 +55,16 @@ public enum SwiftTraderError: Error {
     case kucoinInvalidTargetPriceHigher(entryPrice: String, targetPrice: String)
 
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesOrderList(orderStatus:)`.
-    case kucoinOrderList(error: Error)
+    case kucoinFuturesOrderList(error: Error)
+    
+    /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesStopOrderList(symbol:)`.
+    case kucoinFuturesStopOrderList(error: Error)
 
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesPlaceStopLimitOrder()`.
-    case kucoinPlaceStopLimitOrder(error: Error)
+    case kucoinFuturesPlaceStopLimitOrder(error: Error)
 
     // MARK: Positions
 
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesPositionList()`.
-    case kucoinPositionList(error: Error)
+    case kucoinFuturesPositionList(error: Error)
 }

Sources/SwiftTrader/Model/Kucoin/Order/KucoinFuturesOrderList.swift

@@ -134,7 +134,7 @@ public struct KucoinFuturesOrder: Codable {
             self.stop = nil
         }
 
-        self.stopTriggered = try container.decode(Bool.self, forKey: .stopTriggered)
+        self.stopTriggered = try container.decodeIfPresent(Bool.self, forKey: .stopTriggered) ?? false
         self.stopPrice = try container.decodeIfPresent(String.self, forKey: .stopPrice)
         self.leverage = try container.decode(String.self, forKey: .leverage)
         self.reduceOnly = try container.decode(Bool.self, forKey: .reduceOnly)

Sources/SwiftTrader/Model/SwiftTraderOperation.swift

@@ -12,6 +12,7 @@ public enum SwiftTraderOperation {
     case kucoinFuturesAccountOverview
     case kucoinFuturesCancelStopOrders
     case kucoinFuturesOrderList
+    case kucoinFuturesStopOrderList
     case kucoinFuturesPlaceStopLimitOrder
     case kucoinFuturesPositionList
 }

Sources/SwiftTrader/Network/Kucoin/KucoinAPI.swift

@@ -47,8 +47,8 @@ public struct KucoinAPI {
     }
 
     public struct QueryParam {
-        static let currency     = "currency"
-        static let orderStatus  = "status"
-        static let symbol       = "symbol"
+        public static let currency     = "currency"
+        public static let orderStatus  = "status"
+        public static let symbol       = "symbol"
     }
 }

Sources/SwiftTrader/Network/Kucoin/Orders/CancelStopOrders/KucoinFuturesCancelOrdersRequest.swift

@@ -11,7 +11,7 @@ import FoundationNetworking
 #endif
 import Logging
 
-/// A **request** for cancelling all untriggered stop orders of a given symbol (contract).
+/// A **request** for cancelling all untriggered stop orders of a given (contract) symbol.
 ///
 /// https://docs.kucoin.com/futures/#stop-order-mass-cancelation
 public struct KucoinFuturesCancelOrdersRequest: NetworkRequest {

Sources/SwiftTrader/Network/Kucoin/Orders/CancelStopOrders/KucoinFuturesCancelOrdersResource.swift

@@ -7,7 +7,7 @@
 
 import Foundation
 
-/// The **resource** for requesting the cancellation of all untriggered stop orders of a given symbol (contract).
+/// The **resource** for requesting the cancellation of all untriggered stop orders of a given (contract) symbol.
 ///
 /// https://docs.kucoin.com/futures/#stop-order-mass-cancelation
 public struct KucoinFuturesCancelOrdersResource: NetworkResource {

Sources/SwiftTrader/Network/Kucoin/Orders/ListStopOrders/KucoinFuturesListStopOrdersRequest.swift

@@ -0,0 +1,75 @@
+//
+//  KucoinFuturesListStopOrdersRequest.swift
+//  
+//
+//  Created by Fernando Fernandes on 02.03.22.
+//
+
+import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+import Logging
+
+/// A **request** for listing all untriggered stop orders of a given (contract) symbol.
+///
+/// https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+public struct KucoinFuturesListStopOrdersRequest: NetworkRequest {
+    
+    // MARK: - Properties
+    
+    public typealias DecodableModel = KucoinFuturesOrderList
+    
+    public var logger: Logger {
+        NetworkRequestLogger().default
+    }
+    
+    public var session: URLSession
+    
+    public var request: URLRequest {
+        get throws {
+            let futuresListOrdersResource = KucoinFuturesListStopOrdersResource(symbol: symbol)
+            var urlRequest = URLRequest(url: try futuresListOrdersResource.url)
+            urlRequest.httpMethod = HTTPMethod.GET.rawValue
+            try KucoinAPI.setRequestHeaderFields(request: &urlRequest, kucoinAuth: kucoinAuth)
+            return urlRequest
+        }
+    }
+    
+    public var settings: NetworkRequestSettings
+    
+    // MARK: Private
+    
+    private let symbol: String
+    
+    private let kucoinAuth: KucoinAuth
+    
+    // MARK: - Lifecycle
+    
+    /// Creates a new `KucoinFuturesListStopOrdersRequest` instance.
+    ///
+    /// - Parameters:
+    ///   - symbol: `String`, represents the specific contract for which all the untriggered stop orders will be listed.
+    ///   E.g.: "XBTUSDM".
+    ///   - kucoinAuth: Kucoin authentication data.
+    ///   - session: `URLSession`, default is `.shared`.
+    ///   - settings: `NetworkRequestSettings`.
+    public init(symbol: String,
+                kucoinAuth: KucoinAuth,
+                session: URLSession = .shared,
+                settings: NetworkRequestSettings) {
+        self.symbol = symbol
+        self.kucoinAuth = kucoinAuth
+        self.session = session
+        self.settings = settings
+    }
+}
+
+// MARK: - Network Request Protocol
+
+public extension KucoinFuturesListStopOrdersRequest {
+    
+    func decode(_ data: Data) throws -> DecodableModel {
+        try JSONDecoder().decode(KucoinFuturesOrderList.self, from: data)
+    }
+}

Sources/SwiftTrader/Network/Kucoin/Orders/ListStopOrders/KucoinFuturesListStopOrdersResource.swift

@@ -0,0 +1,48 @@
+//
+//  KucoinFuturesListStopOrdersResource.swift
+//
+//
+//  Created by Fernando Fernandes on 02.03.22.
+//
+
+import Foundation
+
+/// The **resource** for requesting the list of all untriggered stop orders of a given (contract) symbol.
+///
+/// https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+public struct KucoinFuturesListStopOrdersResource: NetworkResource {
+    
+    // MARK: - Properties
+    
+    public var url: URL {
+        get throws {
+            let baseURLString = KucoinAPI.Futures.baseURL()
+            guard var urlComponents = URLComponents(string: baseURLString) else {
+                throw NetworkRequestError.invalidURLString(urlString: baseURLString)
+            }
+            urlComponents.path = KucoinAPI.Futures.Path.stopOrders
+            let queryItems = [
+                URLQueryItem(name: KucoinAPI.QueryParam.symbol, value: symbol)
+            ]
+            urlComponents.queryItems = queryItems
+            guard let url = urlComponents.url else {
+                throw NetworkRequestError.invalidURLString(urlString: baseURLString)
+            }
+            return url
+        }
+    }
+    
+    // MARK: Private
+    
+    private let symbol: String
+    
+    // MARK: - Lifecycle
+    
+    /// Creates a new `KucoinFuturesListStopOrdersResource` instance.
+    ///
+    /// - Parameter symbol: `String`,  represents the specific contract for which all the untriggered stop orders will be listed.
+    /// E.g.: "XBTUSDM".
+    init(symbol: String) {
+        self.symbol = symbol
+    }
+}

Sources/SwiftTrader/SwiftTrader.swift

@@ -61,6 +61,30 @@ public extension SwiftTrader {
 
     // MARK: List Orders
 
+    /// Retrieves the list of un-triggered stop orders.
+    ///
+    /// https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+    ///
+    /// - Parameter orderStatus: `KucoinFuturesOrderStatus`, default is `.active`.
+    /// - Returns: An instance of `KucoinFuturesOrderList` or `SwiftTraderError`.
+    func kucoinFuturesStopOrderList(symbol: String) async throws -> Result<KucoinFuturesOrderList, SwiftTraderError> {
+        let request = KucoinFuturesListStopOrdersRequest(
+            symbol: symbol,
+            kucoinAuth: kucoinAuth,
+            settings: settings.networkRequestSettings
+        )
+        switch await request.execute() {
+        case .success(let model):
+            guard let stopOrders = model as? KucoinFuturesOrderList else {
+                return .failure(.unexpectedResponse(modelString: "\(model)"))
+            }
+            return .success(stopOrders)
+        case .failure(let error):
+            let swiftTraderError = handle(networkRequestError: error, operation: .kucoinFuturesStopOrderList)
+            return .failure(swiftTraderError)
+        }
+    }
+    
     /// Retrieves the list of active Futures orders.
     ///
     /// Notice: this does **not** include the list of stop orders
@@ -198,12 +222,14 @@ private extension SwiftTrader {
                 return .kucoinFuturesAccountOverview(error: networkRequestError)
             case .kucoinFuturesCancelStopOrders:
                 return .kucoinFuturesCancelStopOrders(error: networkRequestError)
+            case .kucoinFuturesStopOrderList:
+                return .kucoinFuturesStopOrderList(error: networkRequestError)
             case .kucoinFuturesOrderList:
-                return .kucoinOrderList(error: networkRequestError)
+                return .kucoinFuturesOrderList(error: networkRequestError)
             case .kucoinFuturesPlaceStopLimitOrder:
-                return .kucoinPlaceStopLimitOrder(error: networkRequestError)
+                return .kucoinFuturesPlaceStopLimitOrder(error: networkRequestError)
             case .kucoinFuturesPositionList:
-                return .kucoinPositionList(error: networkRequestError)
+                return .kucoinFuturesPositionList(error: networkRequestError)
             }
         }
     }