Add stop order mass cancellation

Fernando Fernandes · Fernando Fernandes · commit 57e2784123fc · 2022-02-16T01:40:03.000+01:00
diff --git a/Sources/SwiftTrader/Model/Error/SwiftTraderError.swift b/Sources/SwiftTrader/Model/Error/SwiftTraderError.swift
@@ -18,7 +18,10 @@ public enum SwiftTraderError: Error {
     // MARK: - Kucoin Related
     
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesAccountOverview(currencySymbol:)`.
-    case kucoinFuturesAccountOverviewError(error: Error)
+    case kucoinFuturesAccountOverview(error: Error)
+    
+    /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesCancelStopOrders(symbol:)`.
+    case kucoinFuturesCancelStopOrders(error: Error)
     
     /// Something went wrong while trying to set the target price.
     case kucoinCouldNotCalculateTheTargetPrice(input: SwiftTraderOrderInput)
@@ -27,13 +30,13 @@ public enum SwiftTraderError: Error {
     case kucoinInvalidTargetPrice(entryPrice: String, targetPrice: String)
     
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesPlaceOrder()`.
-    case kucoinPlaceOrderError(error: Error)
+    case kucoinPlaceOrder(error: Error)
     
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesOrderList(orderStatus:)`.
-    case kucoinOrderListError(error: Error)
+    case kucoinOrderList(error: Error)
     
     /// And error ocurred while executing the function `SwiftTrader.kucoinFuturesPositionList()`.
-    case kucoinPositionListError(error: Error)
+    case kucoinPositionList(error: Error)
     
     /// The response status code is something other than `200`.
     ///
diff --git a/Sources/SwiftTrader/Model/Kucoin/Order/KucoinCancelledStopOrders.swift b/Sources/SwiftTrader/Model/Kucoin/Order/KucoinCancelledStopOrders.swift
@@ -0,0 +1,18 @@
+//
+//  KucoinCancelledStopOrders.swift
+//  
+//
+//  Created by Fernando Fernandes on 16.02.22.
+//
+
+import Foundation
+
+/// Holds a list of cancelled orders.
+public struct KucoinCancelledStopOrders: Codable {
+    
+    public let cancelledOrderIDs: [String]
+    
+    enum CodingKeys: String, CodingKey {
+        case cancelledOrderIDs = "cancelledOrderIds"
+    }
+}
diff --git a/Sources/SwiftTrader/Model/Kucoin/Responses/KucoinFuturesAccountOverview.swift b/Sources/SwiftTrader/Model/Kucoin/Responses/KucoinFuturesAccountOverview.swift
diff --git a/Sources/SwiftTrader/Model/Kucoin/Responses/KucoinFuturesCancelStopOrders.swift b/Sources/SwiftTrader/Model/Kucoin/Responses/KucoinFuturesCancelStopOrders.swift
@@ -0,0 +1,16 @@
+//
+//  KucoinFuturesCancelStopOrders.swift
+//  
+//
+//  Created by Fernando Fernandes on 16.02.22.
+//
+
+import Foundation
+
+/// Kucoin "Stop Order Mass cancelation" REST API response.
+///
+/// https://docs.kucoin.com/futures/#stop-order-mass-cancelation
+public struct KucoinFuturesCancelStopOrders: Codable {
+    public let code: String
+    public let data: KucoinCancelledStopOrders
+}
diff --git a/Sources/SwiftTrader/Model/Kucoin/Responses/KucoinFuturesPositionList.swift b/Sources/SwiftTrader/Model/Kucoin/Responses/KucoinFuturesPositionList.swift
diff --git a/Sources/SwiftTrader/Model/SwiftTraderOperation.swift b/Sources/SwiftTrader/Model/SwiftTraderOperation.swift
@@ -10,6 +10,7 @@ import Foundation
 /// The currently running `SwiftTrader` operation.
 public enum SwiftTraderOperation {
     case kucoinFuturesAccountOverview
+    case kucoinFuturesCancelStopOrders
     case kucoinFuturesOrderList
     case kucoinFuturesPlaceOrder
     case kucoinFuturesPositionList
diff --git a/Sources/SwiftTrader/Network/Constants/HTTPMethod.swift b/Sources/SwiftTrader/Network/Constants/HTTPMethod.swift
@@ -9,6 +9,7 @@ import Foundation
 
 /// Holds HTTP method related constants.
 public enum HTTPMethod: String {
+    case DELETE
     case GET
     case POST
 }
diff --git a/Sources/SwiftTrader/Network/Kucoin/KucoinAPI.swift b/Sources/SwiftTrader/Network/Kucoin/KucoinAPI.swift
@@ -16,6 +16,7 @@ public struct KucoinAPI {
             static let accountOverview  = "/api/v1/account-overview"
             static let orders           = "/api/v1/orders"
             static let positions        = "/api/v1/positions"
+            static let stopOrders       = "/api/v1/stopOrders"
         }
         
         /// Returns the base `URL` based on an Xcode environment variable.
@@ -48,5 +49,6 @@ public struct KucoinAPI {
     public struct QueryParam {
         static let currency     = "currency"
         static let orderStatus  = "status"
+        static let symbol       = "symbol"
     }
 }
diff --git a/Sources/SwiftTrader/Network/Kucoin/Orders/CancelStopOrders/KucoinFuturesCancelOrdersRequest.swift b/Sources/SwiftTrader/Network/Kucoin/Orders/CancelStopOrders/KucoinFuturesCancelOrdersRequest.swift
@@ -0,0 +1,75 @@
+//
+//  KucoinFuturesCancelOrdersRequest.swift
+//  
+//
+//  Created by Fernando Fernandes on 16.02.22.
+//
+
+import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+import Logging
+
+/// A **request** for cancelling all untriggered stop orders of a given symbol (contract).
+///
+/// https://docs.kucoin.com/futures/#stop-order-mass-cancelation
+public struct KucoinFuturesCancelOrdersRequest: NetworkRequest {
+    
+    // MARK: - Properties
+    
+    public typealias DecodableModel = KucoinFuturesCancelStopOrders
+    
+    public var logger: Logger {
+        NetworkRequestLogger().default
+    }
+    
+    public var session: URLSession
+    
+    public var request: URLRequest {
+        get throws {
+            let futuresCancelOrdersResource = KucoinFuturesCancelOrdersResource(symbol: symbol)
+            var urlRequest = URLRequest(url: try futuresCancelOrdersResource.url)
+            urlRequest.httpMethod = HTTPMethod.DELETE.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 `KucoinFuturesOrdersListRequest` instance.
+    ///
+    /// - Parameters:
+    ///   - symbol: `String`, represents the specific contract for which all the untriggered stop orders will be cancelled.
+    ///   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 KucoinFuturesCancelOrdersRequest {
+    
+    func decode(_ data: Data) throws -> DecodableModel {
+        try JSONDecoder().decode(KucoinFuturesCancelStopOrders.self, from: data)
+    }
+}
diff --git a/Sources/SwiftTrader/Network/Kucoin/Orders/CancelStopOrders/KucoinFuturesCancelOrdersResource.swift b/Sources/SwiftTrader/Network/Kucoin/Orders/CancelStopOrders/KucoinFuturesCancelOrdersResource.swift
@@ -0,0 +1,48 @@
+//
+//  KucoinFuturesCancelOrdersResource.swift
+//
+//
+//  Created by Fernando Fernandes on 16.02.22.
+//
+
+import Foundation
+
+/// The **resource** for requesting the cancellation of all untriggered stop orders of a given symbol (contract).
+///
+/// https://docs.kucoin.com/futures/#stop-order-mass-cancelation
+public struct KucoinFuturesCancelOrdersResource: 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 `KucoinFuturesCancelOrdersResource` instance.
+    ///
+    /// - Parameter symbol: `String`,  represents the specific contract for which all the untriggered stop orders will be cancelled.
+    /// E.g.: "XBTUSDM".
+    init(symbol: String) {
+        self.symbol = symbol
+    }
+}
diff --git a/Sources/SwiftTrader/SwiftTrader.swift b/Sources/SwiftTrader/SwiftTrader.swift
@@ -35,6 +35,12 @@ public extension SwiftTrader {
     
     // MARK: Account Overview
     
+    /// Retrieves the overview of a Kucoin Futures account.
+    ///
+    /// https://docs.kucoin.com/futures/#account
+    ///
+    /// - Parameter currencySymbol: The `CurrencySymbol` of the account balance. The default is `.USDT`.
+    /// - Returns: An instance of `KucoinFuturesAccountOverview` or `SwiftTraderError`.
     func kucoinFuturesAccountOverview(currencySymbol: CurrencySymbol = .USDT) async throws -> Result<KucoinFuturesAccountOverview, SwiftTraderError> {
         let request = KucoinFuturesAccountOverviewRequest(
             currencySymbol: currencySymbol,
@@ -55,6 +61,13 @@ public extension SwiftTrader {
     
     // MARK: List Orders
     
+    /// Retrieves the list of active Futures orders.
+    ///
+    /// Notice: this does **not** include the list of stop orders
+    /// https://docs.kucoin.com/futures/#get-order-list
+    ///
+    /// - Parameter orderStatus: `KucoinFuturesOrderStatus`, default is `.active`.
+    /// - Returns: An instance of `KucoinFuturesOrderList` or `SwiftTraderError`.
     func kucoinFuturesOrderList(orderStatus: KucoinOrderStatus = .active) async throws -> Result<KucoinFuturesOrderList, SwiftTraderError> {
         let request = KucoinFuturesOrdersListRequest(
             orderStatus: orderStatus,
@@ -75,6 +88,13 @@ public extension SwiftTrader {
     
     // MARK: Place Orders
     
+    /// Places a Futures order.
+    ///
+    /// https://docs.kucoin.com/futures/#place-an-order
+    ///
+    /// - Parameter orderInput: `SwiftTraderOrderInput` instance that encapsulates
+    /// all the arguments required for submiting the orders.
+    /// - Returns: An instance of `KucoinFuturesPlaceOrder` or `SwiftTraderError`.
     func kucoinFuturesPlaceOrder(_ orderInput: SwiftTraderOrderInput) async throws -> Result<KucoinFuturesPlaceOrder, SwiftTraderError> {
         
         let orderParameters = try createOrderParameters(for: orderInput)
@@ -98,10 +118,37 @@ public extension SwiftTrader {
     
     // MARK: Cancel Orders
     
-#warning("TODO: https://docs.kucoin.com/futures/#stop-order-mass-cancelation")
+    /// Cancels all untriggered Futures stop orders of a given symbol (contract).
+    ///
+    /// https://docs.kucoin.com/futures/#stop-order-mass-cancelation
+    ///
+    /// - Parameter symbol: `String`, represents the specific contract for which all the untriggered stop orders will be cancelled.
+    /// - Returns: An instance of `KucoinFuturesCancelStopOrders` or `SwiftTraderError`.
+    func kucoinFuturesCancelStopOrders(symbol: String) async throws -> Result<KucoinFuturesCancelStopOrders, SwiftTraderError> {
+        let request = KucoinFuturesCancelOrdersRequest(
+            symbol: symbol,
+            kucoinAuth: kucoinAuth,
+            settings: settings.networkRequestSettings
+        )
+        switch await request.execute() {
+        case .success(let model):
+            guard let cancelledOrders = model as? KucoinFuturesCancelStopOrders else {
+                return .failure(.unexpectedResponse(modelString: "\(model)"))
+            }
+            return .success(cancelledOrders)
+        case .failure(let error):
+            let swiftTraderError = handle(networkRequestError: error, operation: .kucoinFuturesCancelStopOrders)
+            return .failure(swiftTraderError)
+        }
+    }
     
     // MARK: Positions
     
+    /// Lists open Futures positions.
+    ///
+    /// https://docs.kucoin.com/futures/#get-position-list
+    ///
+    /// - Returns: An instance of `KucoinFuturesPositionList` or `SwiftTraderError`.
     func kucoinFuturesPositionList() async throws -> Result<KucoinFuturesPositionList, SwiftTraderError> {
         let request = KucoinFuturesPositionListRequest(
             kucoinAuth: kucoinAuth,
@@ -133,13 +180,15 @@ private extension SwiftTrader {
         default:
             switch operation {
             case .kucoinFuturesAccountOverview:
-                return .kucoinFuturesAccountOverviewError(error: networkRequestError)
+                return .kucoinFuturesAccountOverview(error: networkRequestError)
+            case .kucoinFuturesCancelStopOrders:
+                return .kucoinFuturesCancelStopOrders(error: networkRequestError)
             case .kucoinFuturesOrderList:
-                return .kucoinOrderListError(error: networkRequestError)
+                return .kucoinOrderList(error: networkRequestError)
             case .kucoinFuturesPlaceOrder:
-                return .kucoinPlaceOrderError(error: networkRequestError)
+                return .kucoinPlaceOrder(error: networkRequestError)
             case .kucoinFuturesPositionList:
-                return .kucoinPositionListError(error: networkRequestError)
+                return .kucoinPositionList(error: networkRequestError)
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ import Foundation`
`9`	`9`
`10`	`10`	`/// Holds HTTP method related constants.`
`11`	`11`	`public enum HTTPMethod: String {`
	`12`	`+ case DELETE`
`12`	`13`	`case GET`
`13`	`14`	`case POST`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public struct KucoinAPI {`
`16`	`16`	`static let accountOverview = "/api/v1/account-overview"`
`17`	`17`	`static let orders = "/api/v1/orders"`
`18`	`18`	`static let positions = "/api/v1/positions"`
	`19`	`+ static let stopOrders = "/api/v1/stopOrders"`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	/// Returns the base `URL` based on an Xcode environment variable.
`@@ -48,5 +49,6 @@ public struct KucoinAPI {`
`48`	`49`	`public struct QueryParam {`
`49`	`50`	`static let currency = "currency"`
`50`	`51`	`static let orderStatus = "status"`
	`52`	`+ static let symbol = "symbol"`
`51`	`53`	`}`
`52`	`54`	`}`