#454 Update WalletConnectURI with API identifier prefix

Sources/WalletConnectUtils/WalletConnectURI.swift

@@ -2,42 +2,60 @@ import Foundation
 
 public struct WalletConnectURI: Equatable {
 
+    public enum TargetAPI: String, CaseIterable {
+        case sign
+        case chat
+        case auth
+    }
+
     public let topic: String
     public let version: String
     public let symKey: String
     public let relay: RelayProtocolOptions
 
-    public init(topic: String, symKey: String, relay: RelayProtocolOptions) {
+    public var api: TargetAPI {
+        apiType ?? .sign
+    }
+
+    public var absoluteString: String {
+        if let api = apiType {
+            return "wc:\(api.rawValue)-\(topic)@\(version)?symKey=\(symKey)&\(relayQuery)"
+        }
+        return "wc:\(topic)@\(version)?symKey=\(symKey)&\(relayQuery)"
+    }
+
+    private let apiType: TargetAPI?
+
+    public init(topic: String, symKey: String, relay: RelayProtocolOptions, api: TargetAPI? = nil) {
         self.version = "2"
         self.topic = topic
         self.symKey = symKey
         self.relay = relay
+        self.apiType = api
     }
 
     public init?(string: String) {
-        guard string.hasPrefix("wc:") else {
-            return nil
-        }
-        let urlString = !string.hasPrefix("wc://") ? string.replacingOccurrences(of: "wc:", with: "wc://") : string
-        guard let components = URLComponents(string: urlString) else {
+        guard let components = Self.parseURIComponents(from: string) else {
             return nil
         }
         let query: [String: String]? = components.queryItems?.reduce(into: [:]) { $0[$1.name] = $1.value }
 
-        guard let topic = components.user,
-              let version = components.host,
-              let symKey = query?["symKey"],
-              let relayProtocol = query?["relay-protocol"]
-        else { return nil }
+        guard
+            let userString = components.user,
+            let version = components.host,
+            let symKey = query?["symKey"],
+            let relayProtocol = query?["relay-protocol"]
+        else {
+            return nil
+        }
+        let uriUser = Self.parseURIUser(from: userString)
         let relayData = query?["relay-data"]
+
         self.version = version
-        self.topic = topic
+        self.topic = uriUser.topic
         self.symKey = symKey
         self.relay = RelayProtocolOptions(protocol: relayProtocol, data: relayData)
-    }
-
-    public var absoluteString: String {
-        return "wc:\(topic)@\(version)?symKey=\(symKey)&\(relayQuery)"
+        self.apiType = uriUser.api
     }
 
     private var relayQuery: String {
@@ -47,4 +65,21 @@ public struct WalletConnectURI: Equatable {
         }
         return query
     }
+
+    private static func parseURIComponents(from string: String) -> URLComponents? {
+        guard string.hasPrefix("wc:") else {
+            return nil
+        }
+        let urlString = !string.hasPrefix("wc://") ? string.replacingOccurrences(of: "wc:", with: "wc://") : string
+        return URLComponents(string: urlString)
+    }
+
+    private static func parseURIUser(from string: String) -> (topic: String, api: TargetAPI?) {
+        let splits = string.split(separator: "-")
+        if splits.count == 2, let apiFromPrefix = TargetAPI(rawValue: String(splits[0])) {
+            return (String(splits[1]), apiFromPrefix)
+        } else {
+            return (string, nil)
+        }
+    }
 }

Tests/WalletConnectUtilsTests/WalletConnectURITests.swift

@@ -0,0 +1,91 @@
+import XCTest
+@testable import WalletConnectUtils
+
+private func stubURI(api: WalletConnectURI.TargetAPI? = nil) -> (uri: WalletConnectURI, string: String) {
+    let topic = Data.randomBytes(count: 32).toHexString()
+    let symKey = Data.randomBytes(count: 32).toHexString()
+    let protocolName = "irn"
+    let uriBase = api == nil ? "wc:" : "wc:\(api!.rawValue)-"
+    let uriString = "\(uriBase)\(topic)@2?symKey=\(symKey)&relay-protocol=\(protocolName)"
+    let uri = WalletConnectURI(
+        topic: topic,
+        symKey: symKey,
+        relay: RelayProtocolOptions(protocol: protocolName, data: nil),
+        api: api)
+    return (uri, uriString)
+}
+
+final class WalletConnectURITests: XCTestCase {
+
+    // MARK: - Init URI with string
+
+    func testInitURIToString() {
+        let input = stubURI()
+        let uriString = input.uri.absoluteString
+        let outputURI = WalletConnectURI(string: uriString)
+        XCTAssertEqual(input.uri, outputURI)
+        XCTAssertEqual(input.string, outputURI?.absoluteString)
+    }
+
+    func testInitStringToURI() {
+        let inputURIString = stubURI().string
+        let uri = WalletConnectURI(string: inputURIString)
+        let outputURIString = uri?.absoluteString
+        XCTAssertEqual(inputURIString, outputURIString)
+    }
+
+    func testInitStringToURIAlternate() {
+        let expectedString = stubURI().string
+        let inputURIString = expectedString.replacingOccurrences(of: "wc:", with: "wc://")
+        let uri = WalletConnectURI(string: inputURIString)
+        let outputURIString = uri?.absoluteString
+        XCTAssertEqual(expectedString, outputURIString)
+    }
+
+    // MARK: - Init URI with prefix API identifier
+
+    func testInitFromPrefixedURIString() {
+        WalletConnectURI.TargetAPI.allCases.forEach { api in
+            let uriString = stubURI(api: api).string
+            let uri = WalletConnectURI(string: uriString)
+            XCTAssertEqual(uri?.api, api)
+            XCTAssertEqual(uri?.absoluteString, uriString)
+        }
+    }
+
+    func testAbsentPrefixFallbackToSign() {
+        let input = stubURI()
+        let uriFromParams = input.uri
+        let uriFromString = WalletConnectURI(string: input.string)
+        XCTAssertEqual(uriFromParams.api, .sign)
+        XCTAssertEqual(uriFromString?.api, .sign)
+    }
+
+    // MARK: - Init URI failure cases
+
+    func testInitFailsBadScheme() {
+        let inputURIString = stubURI().string.replacingOccurrences(of: "wc:", with: "")
+        let uri = WalletConnectURI(string: inputURIString)
+        XCTAssertNil(uri)
+    }
+
+    func testInitFailsMalformedURL() {
+        let inputURIString = "wc://<"
+        let uri = WalletConnectURI(string: inputURIString)
+        XCTAssertNil(uri)
+    }
+
+    func testInitFailsNoSymKeyParam() {
+        let input = stubURI()
+        let inputURIString = input.string.replacingOccurrences(of: "symKey=\(input.uri.symKey)", with: "")
+        let uri = WalletConnectURI(string: inputURIString)
+        XCTAssertNil(uri)
+    }
+
+    func testInitFailsNoRelayParam() {
+        let input = stubURI()
+        let inputURIString = input.string.replacingOccurrences(of: "&relay-protocol=\(input.uri.relay.protocol)", with: "")
+        let uri = WalletConnectURI(string: inputURIString)
+        XCTAssertNil(uri)
+    }
+}