Merge pull request #412 from WalletConnect/develop

v0.9.3-rc.0
WalletConnect · Aug 8, 2022 · 8dda02c · 8dda02c
2 parents 6c47071 + 575c9d5
commit 8dda02c
Show file tree

Hide file tree

Showing 27 changed files with 319 additions and 45 deletions.
diff --git a/.github/actions/ci/action.yml b/.github/actions/ci/action.yml
@@ -16,7 +16,8 @@ runs:
         -project Example/ExampleApp.xcodeproj \ 
         -scheme WalletConnect \
         -clonedSourcePackagesDirPath SourcePackages \
-        -sdk iphonesimulator"
+        -destination 'platform=iOS Simulator,name=iPhone 13' \
+        test"
 
     # Integration tests
     - name: Run integration tests

diff --git a/Sources/Auth/Services/App/AuthRespondSubscriber.swift b/Sources/Auth/Services/App/AuthRespondSubscriber.swift
@@ -0,0 +1,39 @@
+import Combine
+import Foundation
+import WalletConnectUtils
+import JSONRPC
+
+class AuthRespondSubscriber {
+    private let networkingInteractor: NetworkInteracting
+    private let logger: ConsoleLogging
+    private let rpcHistory: RPCHistory
+    private var publishers = [AnyCancellable]()
+    var onResponse: ((_ id: RPCID, _ cacao: Cacao) -> Void)?
+
+    init(networkingInteractor: NetworkInteracting,
+         logger: ConsoleLogging,
+         rpcHistory: RPCHistory) {
+        self.networkingInteractor = networkingInteractor
+        self.logger = logger
+        self.rpcHistory = rpcHistory
+        subscribeForResponse()
+    }
+
+    private func subscribeForResponse() {
+        networkingInteractor.responsePublisher.sink { [unowned self] subscriptionPayload in
+            guard let request = rpcHistory.get(recordId: subscriptionPayload.request.id!)?.request,
+                  request.method == "wc_authRequest" else { return }
+            networkingInteractor.unsubscribe(topic: subscriptionPayload.topic)
+            guard let cacao = try? subscriptionPayload.request.result?.get(Cacao.self) else {
+                logger.debug("Malformed auth response params")
+                return
+            }
+            do {
+                try CacaoSignatureVerifier().verifySignature(cacao)
+                onResponse?(subscriptionPayload.request.id!, cacao)
+            } catch {
+                logger.debug("Received response with invalid signature")
+            }
+        }.store(in: &publishers)
+    }
+}
diff --git a/Sources/Auth/Services/Common/CacaoSignatureVerifier.swift b/Sources/Auth/Services/Common/CacaoSignatureVerifier.swift
@@ -0,0 +1,15 @@
+import Foundation
+
+protocol CacaoSignatureVerifying {
+    func verifySignature(_ cacao: Cacao) throws
+}
+
+class CacaoSignatureVerifier: CacaoSignatureVerifying {
+    enum Errors: Error {
+        case signatureInvalid
+    }
+
+    func verifySignature(_ cacao: Cacao) throws {
+        fatalError("not implemented")
+    }
+}
diff --git a/Sources/Auth/Services/Common/NetworkingInteractor.swift b/Sources/Auth/Services/Common/NetworkingInteractor.swift
@@ -7,7 +7,9 @@ import JSONRPC
 
 protocol NetworkInteracting {
     var requestPublisher: AnyPublisher<RequestSubscriptionPayload, Never> {get}
+    var responsePublisher: AnyPublisher<ResponseSubscriptionPayload, Never> {get}
     func subscribe(topic: String) async throws
+    func unsubscribe(topic: String)
     func request(_ request: RPCRequest, topic: String, tag: Int, envelopeType: Envelope.EnvelopeType) async throws
     func respond(topic: String, response: RPCResponse, tag: Int, envelopeType: Envelope.EnvelopeType) async throws
 }
@@ -26,6 +28,10 @@ class NetworkingInteractor: NetworkInteracting {
         requestPublisherSubject.eraseToAnyPublisher()
     }
     private let requestPublisherSubject = PassthroughSubject<RequestSubscriptionPayload, Never>()
+    var responsePublisher: AnyPublisher<ResponseSubscriptionPayload, Never> {
+        responsePublisherSubject.eraseToAnyPublisher()
+    }
+    private let responsePublisherSubject = PassthroughSubject<ResponseSubscriptionPayload, Never>()
 
     init(relayClient: RelayClient,
          serializer: Serializing,
@@ -39,6 +45,10 @@ class NetworkingInteractor: NetworkInteracting {
         try await relayClient.subscribe(topic: topic)
     }
 
+    func unsubscribe(topic: String) {
+        fatalError("not implemented")
+    }
+
     func request(_ request: RPCRequest, topic: String, tag: Int, envelopeType: Envelope.EnvelopeType) async throws {
         try rpcHistory.set(request, forTopic: topic, emmitedBy: .local)
         let message = try! serializer.serialize(topic: topic, encodable: request, envelopeType: envelopeType)

diff --git a/Sources/Auth/Services/Common/SIWEMessageFormatter.swift b/Sources/Auth/Services/Common/SIWEMessageFormatter.swift
@@ -1,11 +1,76 @@
 import Foundation
+import WalletConnectUtils
 
 protocol SIWEMessageFormatting {
-    func formatMessage(from request: AuthRequestParams) throws -> String
+    func formatMessage(from authPayload: AuthPayload, address: String) -> String
 }
 
 struct SIWEMessageFormatter: SIWEMessageFormatting {
-    func formatMessage(from request: AuthRequestParams) throws -> String {
-        fatalError("not implemented")
+    func formatMessage(from authPayload: AuthPayload, address: String) -> String {
+        SIWEMessage(domain: authPayload.domain,
+                    uri: authPayload.aud,
+                    address: address,
+                    version: authPayload.version,
+                    nonce: authPayload.nonce,
+                    chainId: authPayload.chainId,
+                    iat: authPayload.iat,
+                    nbf: authPayload.nbf,
+                    exp: authPayload.exp,
+                    statement: authPayload.statement,
+                    requestId: authPayload.requestId,
+                    resources: authPayload.resources).formatted
+    }
+}
+
+fileprivate struct SIWEMessage: Equatable {
+    let domain: String
+    let uri: String //aud
+    let address: String
+    let version: Int
+    let nonce: String
+    let chainId: String
+    let iat: String
+    let nbf: String?
+    let exp: String?
+    let statement: String?
+    let requestId: String?
+    let resources: [String]?
+
+    var formatted: String {
+        return """
+                \(domain) wants you to sign in with your Ethereum account:
+                \(address)
+                \(statementLine)
+                URI: \(uri)
+                Version: \(version)
+                Chain ID: \(chainId)
+                Nonce: \(nonce)
+                Issued At: \(iat)\(expLine)\(nbfLine)\(requestIdLine)\(resourcesSection)
+                """
+    }
+
+    var expLine: String {
+        guard  let exp = exp else { return "" }
+        return "\nExpiration Time: \(exp)"
+    }
+
+    var statementLine: String {
+        guard let statement = statement else { return "" }
+        return "\n\(statement)\n"
+    }
+
+    var nbfLine: String {
+        guard let nbf = nbf else { return "" }
+        return "\nNot Before: \(nbf)"
+    }
+
+    var requestIdLine: String {
+        guard let requestId = requestId else { return "" }
+        return "\nRequest ID: \(requestId)"
+    }
+
+    var resourcesSection: String {
+        guard let resources = resources else { return "" }
+        return resources.reduce("\nResources:") { $0 + "\n- \($1)" }
     }
 }
diff --git a/Sources/Auth/Services/Wallet/AuthRequestSubscriber.swift b/Sources/Auth/Services/Wallet/AuthRequestSubscriber.swift
@@ -6,15 +6,18 @@ import JSONRPC
 class AuthRequestSubscriber {
     private let networkingInteractor: NetworkInteracting
     private let logger: ConsoleLogging
+    private let address: String
     private var publishers = [AnyCancellable]()
     private let messageFormatter: SIWEMessageFormatting
     var onRequest: ((_ id: RPCID, _ message: String)->())?
 
     init(networkingInteractor: NetworkInteracting,
          logger: ConsoleLogging,
-         messageFormatter: SIWEMessageFormatting) {
+         messageFormatter: SIWEMessageFormatting,
+         address: String) {
         self.networkingInteractor = networkingInteractor
         self.logger = logger
+        self.address = address
         self.messageFormatter = messageFormatter
         subscribeForRequest()
     }
@@ -27,7 +30,7 @@ class AuthRequestSubscriber {
                 return
             }
             do {
-                let message = try messageFormatter.formatMessage(from: authRequestParams)
+                let message = try messageFormatter.formatMessage(from: authRequestParams.payloadParams, address: address)
                 guard let requestId = subscriptionPayload.request.id else { return }
                 onRequest?(requestId, message)
             } catch {

diff --git a/Sources/Auth/Types/AuthPayload.swift b/Sources/Auth/Types/AuthPayload.swift
@@ -1,25 +1,25 @@
 import Foundation
 
 struct AuthPayload: Codable, Equatable {
-    let type: String
-    let chainId: String
     let domain: String
     let aud: String
-    let version: String
+    let version: Int
     let nonce: String
+    let chainId: String
+    let type: String
     let iat: String
     let nbf: String?
     let exp: String?
     let statement: String?
     let requestId: String?
-    let resources: String?
+    let resources: [String]?
 
     init(requestParams: RequestParams, iat: String) {
         self.type = "eip4361"
         self.chainId = requestParams.chainId
         self.domain = requestParams.domain
         self.aud = requestParams.aud
-        self.version = "1"
+        self.version = 1
         self.nonce = requestParams.nonce
         self.iat = iat
         self.nbf = requestParams.nbf

diff --git a/Sources/Auth/Types/Cacao/Cacao.swift b/Sources/Auth/Types/Cacao/Cacao.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-struct Cacao: Codable, Equatable {
+public struct Cacao: Codable, Equatable {
     let header: CacaoHeader
     let payload: CacaoPayload
     let signature: CacaoSignature

diff --git a/Sources/Auth/Types/RequestParams.swift b/Sources/Auth/Types/RequestParams.swift
@@ -9,5 +9,5 @@ struct RequestParams {
     let exp: String?
     let statement: String?
     let requestId: String?
-    let resources: String?
+    let resources: [String]?
 }
diff --git a/Sources/Auth/Types/RequestSubscriptionPayload.swift b/Sources/Auth/Types/RequestSubscriptionPayload.swift
@@ -1,7 +1,7 @@
 import Foundation
 import JSONRPC
 
-struct RequestSubscriptionPayload: Codable {
-    let id: Int64
+struct RequestSubscriptionPayload: Codable, Equatable {
+    let topic: String
     let request: RPCRequest
 }
diff --git a/Sources/Auth/Types/ResponseSubscriptionPayload.swift b/Sources/Auth/Types/ResponseSubscriptionPayload.swift
@@ -0,0 +1,7 @@
+import Foundation
+import JSONRPC
+
+struct ResponseSubscriptionPayload: Codable, Equatable {
+    let topic: String
+    let request: RPCResponse
+}
diff --git a/Sources/WalletConnectRelay/EnvironmentInfo.swift b/Sources/WalletConnectRelay/EnvironmentInfo.swift
@@ -18,7 +18,7 @@ enum EnvironmentInfo {
     }
 
     static var sdkVersion: String {
-        "v0.9.2-rc.0"
+        "v0.9.3-rc.0"
     }
 
     static var operatingSystem: String {

diff --git a/Sources/WalletConnectSign/Engine/Common/ApproveEngine.swift b/Sources/WalletConnectSign/Engine/Common/ApproveEngine.swift
@@ -207,7 +207,7 @@ private extension ApproveEngine {
             )
             settlingProposal = proposal
 
-            Task(priority: .background) {
+            Task(priority: .high) { 
                 try? await networkingInteractor.subscribe(topic: sessionTopic)
             }
         } catch {

diff --git a/Tests/AuthTests/AuthRequstSubscriberTests.swift b/Tests/AuthTests/AuthRequstSubscriberTests.swift
@@ -17,7 +17,7 @@ class AuthRequstSubscriberTests: XCTestCase {
         messageFormatter = SIWEMessageFormatterMock()
         sut = AuthRequestSubscriber(networkingInteractor: networkingInteractor,
                                    logger: ConsoleLoggerMock(),
-                                   messageFormatter: messageFormatter)
+                                    messageFormatter: messageFormatter, address: "")
     }
 
     func testSubscribeRequest() {

diff --git a/Tests/AuthTests/Mocks/NetworkingInteractorMock.swift b/Tests/AuthTests/Mocks/NetworkingInteractorMock.swift
@@ -6,6 +6,11 @@ import WalletConnectKMS
 
 struct NetworkingInteractorMock: NetworkInteracting {
 
+    var responsePublisher: AnyPublisher<ResponseSubscriptionPayload, Never> {
+        responsePublisherSubject.eraseToAnyPublisher()
+    }
+    private let responsePublisherSubject = PassthroughSubject<ResponseSubscriptionPayload, Never>()
+
     let requestPublisherSubject = PassthroughSubject<RequestSubscriptionPayload, Never>()
     var requestPublisher: AnyPublisher<RequestSubscriptionPayload, Never> {
         requestPublisherSubject.eraseToAnyPublisher()
@@ -15,6 +20,10 @@ struct NetworkingInteractorMock: NetworkInteracting {
 
     }
 
+    func unsubscribe(topic: String) {
+
+    }
+
     func request(_ request: RPCRequest, topic: String, tag: Int, envelopeType: Envelope.EnvelopeType) async throws {
 
     }

diff --git a/Tests/AuthTests/Mocks/SIWEMessageFormatterMock.swift b/Tests/AuthTests/Mocks/SIWEMessageFormatterMock.swift
@@ -3,7 +3,7 @@ import Foundation
 
 class SIWEMessageFormatterMock: SIWEMessageFormatting {
     var formattedMessage: String!
-    func formatMessage(from request: AuthRequestParams) throws -> String {
+    func formatMessage(from authPayload: AuthPayload, address: String) -> String {
         return formattedMessage
     }
 }