feat(castor)!: http did resolver (#221)

Signed-off-by: goncalo-frade-iohk <[email protected]>

Author: goncalo-frade-iohk

Core/Sources/Helpers/OneOrMany.swift

@@ -86,7 +86,7 @@
 /// - Parameters:
 ///   - encoder: The encoder to write data to.
 /// - Throws: An error if encoding fails.
-public enum OneOrMany<T: RawCodable>: RawCodable {
+public enum OneOrMany<T: Codable>: RawCodable {
     case one(T)
     case many([T])
 

EdgeAgentSDK/Authenticate/Sources/AuthenticateChallenged.swift

@@ -25,8 +25,8 @@ public struct AuthenticateChallenged {
             masterPublicKey: publicKey,
             services: [.init(
                 id: "deeplink",
-                type: ["deeplink"],
-                serviceEndpoint: [.init(uri: scheme.scheme + "://" + scheme.host)]
+                type: .one("deeplink"),
+                serviceEndpoint: .one(.init(uri: scheme.scheme + "://" + scheme.host))
             )]
         )
     }
@@ -65,8 +65,8 @@ public struct AuthenticateChallenged {
         let didDocument = try await castor.resolveDID(did: did)
 
         guard let service = didDocument.services
-            .first(where: { $0.type.contains(where: { $0 == "deeplink" }) })?
-            .serviceEndpoint.first?.uri
+            .first(where: { $0.type.array.contains(where: { $0 == "deeplink" }) })?
+            .serviceEndpoint.array.first?.uri
         else { throw AuthenticateError.cannotFindDeepLinkServiceError }
 
         guard

EdgeAgentSDK/Authenticate/Sources/AuthenticateChallenger.swift

@@ -25,8 +25,8 @@ public struct AuthenticateChallenger {
             masterPublicKey: publicKey,
             services: [.init(
                 id: "deeplink",
-                type: ["deeplink"],
-                serviceEndpoint: [.init(uri: scheme.scheme + "://" + scheme.host)]
+                type: .one("deeplink"),
+                serviceEndpoint: .one(.init(uri: scheme.scheme + "://" + scheme.host))
             )]
         )
     }
@@ -54,8 +54,8 @@ public struct AuthenticateChallenger {
         let didDocument = try await castor.resolveDID(did: did)
 
         guard let service = didDocument.services
-            .first(where: { $0.type.contains(where: { $0 == "deeplink" }) })?
-            .serviceEndpoint.first?.uri
+            .first(where: { $0.type.array.contains(where: { $0 == "deeplink" }) })?
+            .serviceEndpoint.array.first?.uri
         else { throw AuthenticateError.cannotFindDeepLinkServiceError }
 
         guard

EdgeAgentSDK/Builders/Sources/CastorBuilder.swift

@@ -8,7 +8,7 @@ public struct CastorBuilder {
         self.apollo = apollo
     }
 
-    public func build() -> Castor {
+    public func build(resolvers: [DIDResolverDomain] = []) -> Castor {
         CastorImpl(apollo: apollo)
     }
 }

EdgeAgentSDK/Castor/Sources/CastorImpl.swift

@@ -11,7 +11,10 @@ public struct CastorImpl {
         self.logger = SDKLogger(category: LogComponent.castor)
         self.apollo = apollo
         self.resolvers = resolvers + [
-            LongFormPrismDIDResolver(apollo: apollo, logger: logger),
+            CompactPrismDIDResolver(
+                longFormResolver: LongFormPrismDIDResolver(apollo: apollo, logger: logger),
+                shortFormResolver: EndpointShortFormPrismDIDRemoteResolver.githubResolver()
+            ),
             PeerDIDResolver()
         ]
     }

EdgeAgentSDK/Castor/Sources/Operations/CreatePeerDIDOperation.swift

@@ -23,10 +23,10 @@ struct CreatePeerDIDOperation {
             authenticationKeys: authenticationKeys,
             agreementKeys: agreementKeys,
             services: services.flatMap { service in
-                service.serviceEndpoint.map {
+                service.serviceEndpoint.array.map {
                     AnyCodable(dictionaryLiteral:
-                        ("id", service.id),
-                        ("type", service.type.first ?? ""),
+                        ("id", service.id ?? ""),
+                        ("type", service.type.array.first ?? ""),
                         ("serviceEndpoint", [
                             "uri" : $0.uri,
                             "accept" : $0.accept,

EdgeAgentSDK/Castor/Sources/Operations/CreatePrismDIDOperation.swift

@@ -45,9 +45,9 @@ struct CreatePrismDIDOperation {
         didData.publicKeys = try publicKeys.map { try $0.toProto() }
         didData.services = services.map {
             var service = Io_Iohk_Atala_Prism_Protos_Service()
-            service.id = $0.id
-            service.type = $0.type.first ?? ""
-            service.serviceEndpoint = $0.serviceEndpoint.map { $0.uri }
+            service.id = $0.id ?? ""
+            service.type = $0.type.array.first ?? ""
+            service.serviceEndpoint = $0.serviceEndpoint.array.map { $0.uri }
             return service
         }
 

EdgeAgentSDK/Castor/Sources/Resolvers/CompactPrismDIDResolver.swift

@@ -0,0 +1,27 @@
+import Domain
+
+public struct CompactPrismDIDResolver: DIDResolverDomain {
+    public let method = "prism"
+    let longFormResolver: DIDResolverDomain
+    let shortFormResolver: DIDResolverDomain
+
+    init(longFormResolver: DIDResolverDomain, shortFormResolver: DIDResolverDomain) {
+        self.longFormResolver = longFormResolver
+        self.shortFormResolver = shortFormResolver
+    }
+
+    public func resolve(did: Domain.DID) async throws -> Domain.DIDDocument {
+        do {
+            return try await shortFormResolver.resolve(did: did)
+        } catch {
+            guard did.isLongFormDID() else { throw error }
+            return try await longFormResolver.resolve(did: did)
+        }
+    }
+}
+
+private extension DID {
+    func isLongFormDID() -> Bool {
+        return string.split(separator: ":").count > 3
+    }
+}

EdgeAgentSDK/Castor/Sources/Resolvers/EndpointShortFormPrismDIDRemoteResolver.swift

@@ -0,0 +1,38 @@
+import Domain
+import Foundation
+
+public protocol DIDDocumentUrlBuilder {
+    func didDocumentEndpoint(did: DID) throws -> String
+}
+
+public protocol DIDDocumentSerializer {
+    func serialize(data: Data) throws -> DIDDocument
+}
+
+public struct EndpointShortFormPrismDIDRemoteResolver: DIDResolverDomain {
+    public let method = "prism"
+    let urlBuilder: DIDDocumentUrlBuilder
+    let downloader: Downloader
+    let serializer: DIDDocumentSerializer
+
+    init(urlBuilder: DIDDocumentUrlBuilder, downloader: Downloader, serializer: DIDDocumentSerializer) {
+        self.urlBuilder = urlBuilder
+        self.downloader = downloader
+        self.serializer = serializer
+    }
+
+    public func resolve(did: DID) async throws -> DIDDocument {
+        let did = try did.removingPrismLongForm()
+        let data = try await downloader.downloadFromEndpoint(urlOrDID: urlBuilder.didDocumentEndpoint(did: did))
+        return try serializer.serialize(data: data)
+    }
+}
+
+private extension DID {
+    func removingPrismLongForm() throws -> DID {
+        let separated = string
+            .split(separator: ":")
+        let shortForm = separated.prefix(3).joined(separator: ":")
+        return try DID(string: shortForm)
+    }
+}

EdgeAgentSDK/Castor/Sources/Resolvers/GitHubPrismDIDResolver.swift

@@ -0,0 +1,59 @@
+import Domain
+import Foundation
+
+public extension EndpointShortFormPrismDIDRemoteResolver {
+    static func githubResolver() -> Self {
+        .init(
+            urlBuilder: GitHubResolverURLBuilder(),
+            downloader: DownloadDataWithResolver(),
+            serializer: GitHubResolverDIDDocumentSerializer()
+        )
+    }
+}
+
+public struct GitHubResolverURLBuilder: DIDDocumentUrlBuilder {
+    let baseURL = "https://raw.githubusercontent.com/FabioPinheiro/prism-vdr/refs/heads/main/mainnet/diddoc/"
+
+    public func didDocumentEndpoint(did: DID) throws -> String {
+        return baseURL.appending(did.string)
+    }
+}
+
+public struct GitHubResolverDIDDocumentSerializer: DIDDocumentSerializer {
+    let coder: JSONDecoder
+
+    init(coder: JSONDecoder = .normalized) {
+        self.coder = coder
+    }
+
+    public func serialize(data: Data) throws -> DIDDocument {
+        return try coder.decode(DIDDocument.self, from: data)
+    }
+}
+
+fileprivate struct DownloadDataWithResolver: Downloader {
+
+    func downloadFromEndpoint(urlOrDID: String) async throws -> Data {
+        let url: URL
+
+        if let validUrl = URL(string: urlOrDID.replacingOccurrences(of: "host.docker.internal", with: "localhost")) {
+            url = validUrl
+        } else {
+            throw CommonError.invalidURLError(url: urlOrDID)
+        }
+
+        let (data, urlResponse) = try await URLSession.shared.data(from: url)
+
+        guard
+            let code = (urlResponse as? HTTPURLResponse)?.statusCode,
+            200...299 ~= code
+        else {
+            throw CommonError.httpError(
+                code: (urlResponse as? HTTPURLResponse)?.statusCode ?? 500,
+                message: String(data: data, encoding: .utf8) ?? ""
+            )
+        }
+
+        return data
+    }
+}