Parameterize orders placing

Author: Fernando Fernandes

Sources/SwiftTrader/SwiftTraderError+Kucoin.swift renamed to Sources/SwiftTrader/Model/Error/SwiftTraderError+Kucoin.swift

@@ -15,49 +15,49 @@ public struct KucoinOrderParameters {
     // MARK: - Properties
 
     public let clientOid = UUID().uuidString
-    public let side: KucoinOrderSide
     public let symbol: String
+    public let side: KucoinOrderSide
     public let type: KucoinOrderType
     public let stop: KucoinOrderStop
     public let stopPriceType: KucoinOrderStopPriceType
     public let stopPrice: String
+    public let price: String
     public let reduceOnly: Bool
     public let closeOrder: Bool
-    public let price: String
 
     // MARK: - Lifecycle
 
-    public init(side: KucoinOrderSide,
-                symbol: String,
+    public init(symbol: String,
+                side: KucoinOrderSide,
                 type: KucoinOrderType,
                 stop: KucoinOrderStop,
                 stopPriceType: KucoinOrderStopPriceType,
                 stopPrice: String,
+                price: String,
                 reduceOnly: Bool,
-                closeOrder: Bool,
-                price: String) {
-        self.side = side
+                closeOrder: Bool) {
         self.symbol = symbol
+        self.side = side
         self.type = type
         self.stop = stop
         self.stopPriceType = stopPriceType
         self.stopPrice = stopPrice
+        self.price = price
         self.reduceOnly = reduceOnly
         self.closeOrder = closeOrder
-        self.price = price
     }
 }
 
 /// Holds the keys of the parameters for placing a Kucoin order.
 public enum KucoinOrderParameterKey: String {
     case clientOid
-    case side
     case symbol
+    case side
     case type
     case stop
     case stopPriceType
     case stopPrice
+    case price
     case reduceOnly
     case closeOrder
-    case price
 }

Sources/SwiftTrader/SwiftTraderError.swift renamed to Sources/SwiftTrader/Model/Error/SwiftTraderError.swift

@@ -0,0 +1,14 @@
+//
+//  SwiftTraderExchange.swift
+//
+//
+//  Created by Fernando Fernandes on 16.01.22.
+//
+
+import Foundation
+
+/// The list of supported exchanges.
+public enum SwiftTraderExchange: String, Codable {
+    case Binance
+    case Kucoin
+}

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

@@ -0,0 +1,37 @@
+//
+//  SwiftTraderOrderInput.swift
+//  
+//
+//  Created by Fernando Fernandes on 11.02.22.
+//
+
+import Foundation
+
+/// Encapsulates all the arguments required for submiting orders to supported exchanges.
+public struct SwiftTraderOrderInput {
+    
+    // MARK: - Properties
+    
+    public let exchange: SwiftTraderExchange
+    public let ticker: String
+    public let entryPrice: Double
+    public let currentPrice: Double
+    public let profitPercentage: Double
+    public let offset: Double
+    
+    // MARK: - Lifecycle
+    
+    public init(exchange: SwiftTraderExchange,
+                ticker: String,
+                entryPrice: Double,
+                currentPrice: Double,
+                profitPercentage: Double,
+                offset: Double) {
+        self.exchange = exchange
+        self.ticker = ticker
+        self.entryPrice = entryPrice
+        self.currentPrice = currentPrice
+        self.profitPercentage = profitPercentage
+        self.offset = offset
+    }
+}

Sources/SwiftTrader/Model/SwiftTraderExchange.swift

@@ -0,0 +1,21 @@
+//
+//  HTTPHeader.swift
+//  
+//
+//  Created by Fernando Fernandes on 10.02.22.
+//
+
+import Foundation
+
+/// Holds HTTP header related constants.
+public struct HTTPHeader {
+
+    public struct Field {
+        static let contentType  = "Content-Type"
+        static let accept       = "Accept"
+    }
+    
+    public struct Value {
+        static let applicationJSON = "application/json"
+    }
+}

Sources/SwiftTrader/SwiftTraderOperation.swift renamed to Sources/SwiftTrader/Model/SwiftTraderOperation.swift

@@ -7,6 +7,7 @@
 
 import Foundation
 
+/// Holds HTTP method related constants.
 public enum HTTPMethod: String {
     case GET
     case POST

Sources/SwiftTrader/Model/SwiftTraderOrderInput.swift

@@ -32,28 +32,17 @@ public struct KucoinFuturesPlaceOrdersRequest: NetworkRequest {
             var urlRequest = URLRequest(url: try futuresPlaceOrderResource.url)
             urlRequest.httpMethod = HTTPMethod.POST.rawValue
 
-            #warning("TODO: This has to be parameterized")
-            var json = [String:Any]()
-            json["clientOid"] = UUID().uuidString
-            json["side"] = "sell"
-            json["symbol"] = "XBTUSDTM"
-            json["type"] = "limit"
-            json["stop"] = "down"
-            json["stopPriceType"] = "TP"
-            json["stopPrice"] = "44970"
-            json["reduceOnly"] = true
-            json["closeOrder"] = true
-            json["price"] = "44970"
-            
+            // Parameters
+            let parametersJSON = createJSONParameters(from: orderParameters)
             do {
-                let data = try JSONSerialization.data(withJSONObject: json, options: [])
+                let data = try JSONSerialization.data(withJSONObject: parametersJSON, options: [])
                 urlRequest.httpBody = data
-                urlRequest.addValue("application/json", forHTTPHeaderField: "Content-Type")
-                urlRequest.addValue("application/json", forHTTPHeaderField: "Accept")
+                urlRequest.addValue(HTTPHeader.Value.applicationJSON, forHTTPHeaderField: HTTPHeader.Field.contentType)
+                urlRequest.addValue(HTTPHeader.Value.applicationJSON, forHTTPHeaderField: HTTPHeader.Field.accept)
             } catch {
-                #warning("TODO: handle error")
-                print("EEEERRRRRROOORRR")
+                throw NetworkRequestError.invalidJSONParameters(error: error)
             }
+            
             try KucoinAPI.setRequestHeaderFields(request: &urlRequest, kucoinAuth: kucoinAuth)
             return urlRequest
         }
@@ -63,7 +52,7 @@ public struct KucoinFuturesPlaceOrdersRequest: NetworkRequest {
 
     // MARK: Private
 
-    private let parameters: KucoinOrderParameters
+    private let orderParameters: KucoinOrderParameters
 
     private let kucoinAuth: KucoinAuth
 
@@ -72,15 +61,15 @@ public struct KucoinFuturesPlaceOrdersRequest: NetworkRequest {
     /// Creates a new `KucoinFuturesPlaceOrdersRequest` instance.
     ///
     /// - Parameters:
-    ///   - parameters: `KucoinOrderParameters` that defines an order.
+    ///   - orderParameters: `KucoinOrderParameters`, which define an order.
     ///   - kucoinAuth: Kucoin authentication data.
     ///   - session: `URLSession`, default is `.shared`.
     ///   - settings: `NetworkRequestSettings`.
-    public init(parameters: KucoinOrderParameters,
+    public init(orderParameters: KucoinOrderParameters,
                 kucoinAuth: KucoinAuth,
                 session: URLSession = .shared,
                 settings: NetworkRequestSettings) {
-        self.parameters = parameters
+        self.orderParameters = orderParameters
         self.kucoinAuth = kucoinAuth
         self.session = session
         self.settings = settings
@@ -95,3 +84,23 @@ public extension KucoinFuturesPlaceOrdersRequest {
         try JSONDecoder().decode(KucoinFuturesPlaceOrder.self, from: data)
     }
 }
+
+// MARK: - Private
+
+private extension KucoinFuturesPlaceOrdersRequest {
+    
+    func createJSONParameters(from orderParameters: KucoinOrderParameters) -> [String: Any] {
+        [
+            KucoinOrderParameterKey.clientOid.rawValue: UUID().uuidString,
+            KucoinOrderParameterKey.symbol.rawValue: orderParameters.symbol,
+            KucoinOrderParameterKey.side.rawValue: orderParameters.side.rawValue,
+            KucoinOrderParameterKey.type.rawValue: orderParameters.type.rawValue,
+            KucoinOrderParameterKey.stop.rawValue: orderParameters.stop.rawValue,
+            KucoinOrderParameterKey.stopPriceType.rawValue: orderParameters.stopPriceType.rawValue,
+            KucoinOrderParameterKey.stopPrice.rawValue: orderParameters.stopPrice,
+            KucoinOrderParameterKey.price.rawValue: orderParameters.price,
+            KucoinOrderParameterKey.reduceOnly.rawValue: orderParameters.reduceOnly,
+            KucoinOrderParameterKey.closeOrder.rawValue: orderParameters.closeOrder
+        ]
+    }
+}

Sources/SwiftTrader/Network/Constants/HTTPHeader.swift

@@ -22,6 +22,11 @@ public enum NetworkRequestError: Error {
     /// Could not instantiate a valid `URLRequest` (e.g.: `NetworkRequest.getter:request`).
     case invalidRequest(error: Error)
 
+    /// `JSONSerialization` could not produce a valid `JSON` from given parameters.
+    ///
+    /// E.g.: a `JSON` object could not be created from an instance of `KucoinOrderParameters`.
+    case invalidJSONParameters(error: Error)
+    
     /// Could not instantiate a `URLComponents` struct using the given `String` URL.
     case invalidURLString(urlString: String)