Update messages with latest spec changes, add tests for all of them (#37)

Author: amika-sq

Package.swift

@@ -16,7 +16,7 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/Frizlab/swift-typeid.git", from: "0.3.0"),
         .package(url: "https://github.com/flight-school/anycodable.git", from: "0.6.7"),
-        .package(url: "https://github.com/TBD54566975/web5-swift", exact: "0.0.3"),
+        .package(url: "https://github.com/TBD54566975/web5-swift", exact: "0.0.4"),
         .package(url: "https://github.com/allegro/swift-junit.git", from: "2.1.0"),
         .package(url: "https://github.com/pointfreeco/swift-custom-dump.git", from: "1.1.2"),
     ],

Sources/tbDEX/HttpClient/HttpClient.swift

@@ -65,7 +65,12 @@ public enum HttpClient {
     private static func getPFIServiceEndpoint(pfiDIDURI: String) async -> String? {
         let resolutionResult = await DIDResolver.resolve(didURI: pfiDIDURI)
         if let service = resolutionResult.didDocument?.service?.first(where: { $0.type == "PFI" }) {
-            return service.serviceEndpoint
+            switch service.serviceEndpoint {
+            case let .one(uri):
+                return uri
+            case let .many(uris):
+                return uris.first
+            }
         } else {
             return nil
         }

Sources/tbDEX/Protocol/Models/Message.swift

@@ -45,16 +45,18 @@ public struct Message<D: MessageData>: Codable, Equatable {
         try CryptoUtils.digest(data: data, metadata: metadata)
     }
 
-    mutating func sign(did: BearerDID, keyAlias: String? = nil) throws {
+    public mutating func sign(did: BearerDID, keyAlias: String? = nil) throws {
         signature = try JWS.sign(
             did: did,
             payload: try digest(),
-            detached: true,
-            verificationMethodID: keyAlias
+            options: .init(
+                detached: true,
+                verificationMethodID: keyAlias
+            )
         )
     }
 
-    func verify() async throws -> Bool {
+    public func verify() async throws -> Bool {
         return try await JWS.verify(
             compactJWS: signature,
             detachedPayload: try digest(),
@@ -74,6 +76,8 @@ public enum MessageKind: String, Codable {
     case orderStatus = "orderstatus"
 }
 
+// MARK: - MessageData
+
 /// The actual content for a `Message`.
 public protocol MessageData: Codable, Equatable {
 

Sources/tbDEX/Protocol/Models/Messages/Close.swift

@@ -13,4 +13,11 @@ public struct CloseData: MessageData {
     public func kind() -> MessageKind {
         return .close
     }
+
+    /// Default Initializer
+    public init(
+        reason: String? = nil
+    ) {
+        self.reason = reason
+    }
 }

Sources/tbDEX/Protocol/Models/Messages/Order.swift

@@ -11,4 +11,7 @@ public struct OrderData: MessageData {
         return .order
     }
 
+    /// Default Initializer
+    public init() {}
+
 }

Sources/tbDEX/Protocol/Models/Messages/OrderStatus.swift

@@ -13,4 +13,11 @@ public struct OrderStatusData: MessageData {
     public func kind() -> MessageKind {
         return .orderStatus
     }
+
+    /// Default Initializer
+    public init(
+        orderStatus: String
+    ) {
+        self.orderStatus = orderStatus
+    }
 }

Sources/tbDEX/Protocol/Models/Messages/Quote.swift

@@ -16,12 +16,20 @@ public struct QuoteData: MessageData {
     /// The amount of payout currency that Alice will receive
     public let payout: QuoteDetails
 
-    /// Object that describes how to pay the PFI, and how to get paid by the PFI (e.g. BTC address, payment link)
-    public let paymentInstructions: PaymentInstructions?
-
     public func kind() -> MessageKind {
         return .quote
     }
+
+    /// Default Initializer
+    public init(
+        expiresAt: Date,
+        payin: QuoteDetails,
+        payout: QuoteDetails
+    ) {
+        self.expiresAt = expiresAt
+        self.payin = payin
+        self.payout = payout
+    }
 }
 
 /// Details about a quoted amount
@@ -38,19 +46,21 @@ public struct QuoteDetails: Codable, Equatable {
     /// The amount paid in fees
     public let fee: String?
 
-}
-
-/// Instructions about how one can pay or be paid by the PFI
-///
-/// [Specification Reference](https://github.com/TBD54566975/tbdex/tree/main/specs/protocol#paymentinstructions)
-public struct PaymentInstructions: Codable, Equatable {
-
-    /// Link or Instruction describing how to pay the PFI.
-    public let payin: PaymentInstruction?
-
-    /// Link or Instruction describing how to get paid by the PFI
-    public let payout: PaymentInstruction?
-
+    /// Object that describes how to pay the PFI, and how to get paid by the PFI (e.g. BTC address, payment link)
+    public let paymentInstruction: PaymentInstruction?
+
+    /// Default Initializer
+    public init(
+        currencyCode: String, 
+        amount: String,
+        fee: String? = nil,
+        paymentInstruction: PaymentInstruction? = nil
+    ) {
+        self.currencyCode = currencyCode
+        self.amount = amount
+        self.fee = fee
+        self.paymentInstruction = paymentInstruction
+    }
 }
 
 /// Instruction about how to pay or be paid by the PFI
@@ -64,4 +74,12 @@ public struct PaymentInstruction: Codable, Equatable {
     /// Instruction on how Alice can pay PFI, or how Alice can be paid by the PFI
     public let instruction: String?
 
+    /// Default Initializer
+    public init(
+        link: String? = nil,
+        instruction: String? = nil
+    ) {
+        self.link = link
+        self.instruction = instruction
+    }
 }

Sources/tbDEX/Protocol/Models/Messages/RFQ.swift

@@ -1,8 +1,31 @@
 import AnyCodable
 import Foundation
+import TypeID
 
 public typealias RFQ = Message<RFQData>
 
+extension RFQ {
+
+    public init(
+        to: String,
+        from: String,
+        data: RFQData
+    ) {
+        let id = TypeID(prefix: data.kind().rawValue)!
+        self.metadata = MessageMetadata(
+            id: id,
+            kind: data.kind(),
+            from: from,
+            to: to,
+            exchangeID: id.rawValue,
+            createdAt: Date()
+        )
+        self.data = data
+        self.private = nil
+    }
+
+}
+
 /// Data that makes up a RFQ Message.
 ///
 /// [Specification Reference](https://github.com/TBD54566975/tbdex/tree/main/specs/protocol#rfq-request-for-quote)
@@ -27,6 +50,19 @@ public struct RFQData: MessageData {
         return .rfq
     }
 
+    public init(
+        offeringId: String,
+        payinAmount: String,
+        claims: [String],
+        payinMethod: SelectedPaymentMethod,
+        payoutMethod: SelectedPaymentMethod
+    ) {
+        self.offeringId = offeringId
+        self.payinAmount = payinAmount
+        self.claims = claims
+        self.payinMethod = payinMethod
+        self.payoutMethod = payoutMethod
+    }
 }
 
 /// Details about a selected payment method
@@ -39,4 +75,12 @@ public struct SelectedPaymentMethod: Codable, Equatable {
 
     /// An object containing the properties defined in an Offering's `requiredPaymentDetails` json schema
     public let paymentDetails: AnyCodable?
+
+    public init(
+        kind: String,
+        paymentDetails: AnyCodable? = nil
+    ) {
+        self.kind = kind
+        self.paymentDetails = paymentDetails
+    }
 }

Sources/tbDEX/Protocol/Models/Resource.swift

@@ -38,16 +38,18 @@ public struct Resource<D: ResourceData>: Codable, Equatable {
         try CryptoUtils.digest(data: data, metadata: metadata)
     }
 
-    mutating func sign(did: BearerDID, keyAlias: String? = nil) async throws {
+    public mutating func sign(did: BearerDID, keyAlias: String? = nil) throws {
         self.signature = try JWS.sign(
             did: did,
             payload: try digest(),
-            detached: true,
-            verificationMethodID: keyAlias
+            options: .init(
+                detached: true,
+                verificationMethodID: keyAlias
+            )
         )
     }
 
-    func verify() async throws -> Bool {
+    public func verify() async throws -> Bool {
         return try await JWS.verify(
             compactJWS: signature,
             detachedPayload: try digest(),

Sources/tbDEX/Protocol/Models/Resources/Offering.swift

@@ -21,8 +21,12 @@ public struct OfferingData: ResourceData {
     /// Details about the currency that the PFI is selling.
     public let payoutCurrency: CurrencyDetails
 
-    /// A list of payment methods the counterparty (Alice) can choose to send payment to the PFI from in order to
-    /// qualify for this offering.
+    /// A list of payment methods the counterparty (Alice) can choose to send payment
+    /// to the PFI from in order to qualify for this offering.
+    public let payinMethods: [PaymentMethod]
+
+    /// A list of payment methods the counterparty (Alice) can choose to receive payment
+    /// from the PFI in order to qualify for this offering.
     public let payoutMethods: [PaymentMethod]
 
     // TODO: amika - Update to PresentationDefinitionV2, requires third-party or custom implementation