feat: async key exchange (#182)

* feat: async key exchange

* update tests

Author: elefantel

Example/Tests/SocketClientTests.swift

@@ -111,7 +111,7 @@ class SocketClientTests: XCTestCase {
         XCTAssertTrue(socketClient.deeplinkUrl.contains("metamask:/"))
     }
 
-    func testRequestAuthorisatio() {
+    func testDeeplinkToMetaMask() {
         socketClient.useDeeplinks = true
 
         let sessionId = "mockSessionId"
@@ -124,36 +124,17 @@ class SocketClientTests: XCTestCase {
         socketClient.requestAuthorisation()
 
         let openedUrl = mockUrlOpener.openedURL?.absoluteString ?? ""
+        let originatorInfoBase64 = socketClient.originatorInfo().originatorInfo.toJsonString()?.base64Encode() ?? ""
 
         let expectedDeeplink = "metamask://connect?channelId="
         + sessionId
         + "&comm=socket"
         + "&pubkey="
         + pubkey
         + "&v=2"
-        XCTAssertEqual(openedUrl, expectedDeeplink)
-    }
-    
-    func testDeeplinkToMetaMask() {
-        socketClient.useDeeplinks = true
-
-        let sessionId = "mockSessionId"
-        let pubkey = "0x12345"
-        
-        // force keyexchange = true
-        mockKeyExchange.keysExchanged = true
-        mockKeyExchange.pubkey = pubkey
-        
-        socketClient.deeplinkToMetaMask()
+        + "&originatorInfo="
+        + originatorInfoBase64
 
-        let openedUrl = mockUrlOpener.openedURL?.absoluteString ?? ""
-        
-        let expectedDeeplink = "metamask://connect?channelId="
-        + sessionId
-        + "&comm=socket"
-        + "&pubkey="
-        + pubkey
-        + "&v=2"
         XCTAssertEqual(openedUrl, expectedDeeplink)
     }
 

Sources/metamask-ios-sdk/Classes/CommunicationLayer/SocketCommLayer/ClientEvent.swift

@@ -16,6 +16,10 @@ public struct ClientEvent {
     public static var message: String {
         "message"
     }
+    
+    public static var terminate: String {
+        "terminate"
+    }
 
     public static var joinChannel: String {
         "join_channel"

Sources/metamask-ios-sdk/Classes/CommunicationLayer/SocketCommLayer/SocketClient.swift

@@ -44,6 +44,8 @@ public class SocketClient: CommClient {
     public var trackEvent: ((Event, [String: Any]) -> Void)?
 
     var requestJobs: [RequestJob] = []
+    
+    var connectRpc: String?
 
     public var useDeeplinks: Bool = true
 
@@ -52,12 +54,30 @@ public class SocketClient: CommClient {
     }
 
     var deeplinkUrl: String {
-        "\(_deeplinkUrl)/connect?channelId="
+        let originatorInfo = OriginatorInfo(
+            title: appMetadata?.name,
+            url: appMetadata?.url,
+            icon: appMetadata?.iconUrl ?? appMetadata?.base64Icon,
+            dappId: SDKInfo.bundleIdentifier,
+            platform: SDKInfo.platform,
+            apiVersion: SDKInfo.version
+        )
+        let originatorInfoBase64 = originatorInfo.toJsonString()?.base64Encode() ?? ""
+        let rpcBase64: String? = connectRpc?.base64Encode() ?? nil
+        
+        var deeplink = "\(_deeplinkUrl)/connect?channelId="
             + channelId
             + "&comm=socket"
             + "&pubkey="
             + keyExchange.pubkey
             + "&v=2"
+            + "&originatorInfo=\(originatorInfoBase64)"
+        
+        if let requestBase64 = rpcBase64 {
+            deeplink += "&rpc=\(requestBase64)"
+            connectRpc = nil // reset rpc request
+        }
+        return deeplink
     }
 
     private var isV2Protocol: Bool = false
@@ -90,6 +110,7 @@ public class SocketClient: CommClient {
 
     public func connect(with request: String?) {
         if channel.isConnected { return }
+        self.connectRpc = request
 
         setupClient()
         if isReconnection {
@@ -112,6 +133,7 @@ public class SocketClient: CommClient {
         session.clear()
         disconnect()
         keyExchange.reset()
+        channel.emit(ClientEvent.terminate, ["channelId": channelId,"clientType": "dapp"])
     }
 
     private func initiateKeyExchange() {
@@ -201,11 +223,13 @@ extension SocketClient {
         channel.on(ClientEvent.config(on: channelId)) { [weak self] data in
             guard
                 let self = self,
-                let message = data.first as? [String: Bool],
-                let persistence = message["persistence"]
+                let message = data.first as? [String: Any],
+                let persistence = message["persistence"] as? Bool,
+                let walletKey = message["walletKey"] as? String
             else { return }
 
             isV2Protocol = persistence
+            keyExchange.setTheirPublicKey(walletKey)
 
             if isV2Protocol {
                 isReady = true
@@ -315,6 +339,7 @@ extension SocketClient {
     }
 
     func handleMessage(_ msg: [String: Any]) {
+        
         if isKeyExchangeMessage(msg) {
             handleReceiveKeyExchange(msg)
             return
@@ -376,6 +401,9 @@ extension SocketClient {
             Logging.log("Received wallet info")
             isReady = true
         } else if let data = json["data"] as? [String: Any] {
+            if let walletKey = data["walletKey"] as? String {
+                keyExchange.setTheirPublicKey(walletKey)
+            }
             handleResponse?(data)
         }
     }

Sources/metamask-ios-sdk/Classes/Crypto/KeyExchange.swift

@@ -144,7 +144,6 @@ public class KeyExchange {
             let publicKey = message.pubkey,
             !publicKey.isEmpty {
             setTheirPublicKey(publicKey)
-            keysExchanged = true
 
             if message.v == 2 {
                 self.storage.save(string: privateKey, key: privateKeyStorageKey)
@@ -180,10 +179,12 @@ public class KeyExchange {
     }
 
     public func setTheirPublicKey(_ publicKey: String?) {
-        if let theirPubKey = publicKey {
-            theirPublicKey = theirPubKey
-            storage.save(string: theirPubKey, key: theirPubliKeyStorageKey)
-        }
+        guard let theirPubKey = publicKey else { return }
+        
+        theirPublicKey = theirPubKey
+        keysExchanged = true
+        storage.save(string: theirPubKey, key: theirPubliKeyStorageKey)
+        storage.save(string: privateKey, key: privateKeyStorageKey)
     }
 
     public static func isHandshakeRestartMessage(_ message: [String: Any]) -> Bool {
@@ -234,11 +235,10 @@ public class KeyExchange {
             throw KeyExchangeError.keysNotExchanged
         }
 
-        let decryted = try encyption.decrypt(
+        return try encyption.decrypt(
             message,
             privateKey: privateKey
         ).trimEscapingChars()
-        return decryted
     }
 }
 

Sources/metamask-ios-sdk/Classes/Ethereum/Ethereum.swift

@@ -207,18 +207,18 @@ public class Ethereum {
             params: [message]
         )
         connected = true
+        
+        let requestJson = connectSignRequest.toJsonString() ?? ""
 
         if commClient is SocketClient {
-            commClient.connect(with: nil)
+            commClient.connect(with: requestJson)
             return performRequest(connectSignRequest)
         }
 
         let submittedRequest = SubmittedRequest(method: connectSignRequest.method)
         submittedRequests[connectSignRequest.id] = submittedRequest
         let publisher = submittedRequests[connectSignRequest.id]?.publisher
 
-        let requestJson = connectSignRequest.toJsonString() ?? ""
-
         commClient.connect(with: requestJson)
 
         return publisher
@@ -238,7 +238,6 @@ public class Ethereum {
 
         switch transport {
         case .socket:
-            commClient.connect(with: nil)
 
             // React Native SDK has request params as Data
             if let paramsData = req.params as? Data {
@@ -255,8 +254,10 @@ public class Ethereum {
                     method: connectWithRequest.method,
                     params: connectWithParams
                 )
+                commClient.connect(with: connectRequest.toJsonString())
                 return performRequest(connectRequest)
             } else {
+                commClient.connect(with: connectWithRequest.toJsonString())
                 return performRequest(connectWithRequest)
             }
         case .deeplinking:

Sources/metamask-ios-sdk/Classes/Models/OriginatorInfo.swift

@@ -5,7 +5,7 @@
 
 import Foundation
 
-public struct OriginatorInfo: CodableData {
+public struct OriginatorInfo: CodableData, Mappable {
     public let title: String?
     public let url: String?
     public let icon: String?