Merge pull request #706 from WalletConnect/feature/identity-keys

[Chat] Identity and Invite keys registration
WalletConnect · Feb 13, 2023 · 7cb30ae · 7cb30ae
2 parents 5891389 + 2e17fa4
commit 7cb30ae
Show file tree

Hide file tree

Showing 68 changed files with 840 additions and 257 deletions.
diff --git a/Example/ExampleApp.xcodeproj/xcshareddata/xcschemes/WalletConnectJWT.xcscheme b/Example/ExampleApp.xcodeproj/xcshareddata/xcschemes/WalletConnectJWT.xcscheme
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1410"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "WalletConnectJWT"
+               BuildableName = "WalletConnectJWT"
+               BlueprintName = "WalletConnectJWT"
+               ReferencedContainer = "container:..">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "WalletConnectJWT"
+            BuildableName = "WalletConnectJWT"
+            BlueprintName = "WalletConnectJWT"
+            ReferencedContainer = "container:..">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/Example/ExampleApp.xcodeproj/xcshareddata/xcschemes/WalletConnectSigner.xcscheme b/Example/ExampleApp.xcodeproj/xcshareddata/xcschemes/WalletConnectSigner.xcscheme
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1410"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "WalletConnectSigner"
+               BuildableName = "WalletConnectSigner"
+               BlueprintName = "WalletConnectSigner"
+               ReferencedContainer = "container:..">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "WalletConnectSigner"
+            BuildableName = "WalletConnectSigner"
+            BlueprintName = "WalletConnectSigner"
+            ReferencedContainer = "container:..">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/Example/IntegrationTests/Auth/AuthTests.swift b/Example/IntegrationTests/Auth/AuthTests.swift
@@ -83,7 +83,8 @@ final class AuthTests: XCTestCase {
             Task(priority: .high) {
                 let signerFactory = DefaultSignerFactory()
                 let signer = MessageSignerFactory(signerFactory: signerFactory).create(projectId: InputConfig.projectId)
-                let signature = try! signer.sign(payload: request.payload, address: walletAccount.address, privateKey: prvKey, type: .eip191)
+                let payload = try! request.payload.cacaoPayload(address: walletAccount.address)
+                let signature = try! signer.sign(payload: payload, privateKey: prvKey, type: .eip191)
                 try! await walletAuthClient.respond(requestId: request.id, signature: signature, from: walletAccount)
             }
         }

diff --git a/Example/IntegrationTests/Auth/Signer/CacaoSignerTests.swift b/Example/IntegrationTests/Auth/Signer/CacaoSignerTests.swift
@@ -45,12 +45,10 @@ class CacaoSignerTest: XCTestCase {
 
     func testCacaoSign() throws {
         let address = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
-        let formatted = try SIWEMessageFormatter().formatMessage(
-            from: payload,
-            address: address
-        )
+        let cacaoPayload = try payload.cacaoPayload(address: address)
+        let formatted = try SIWECacaoFormatter().formatMessage(from: cacaoPayload)
         XCTAssertEqual(formatted, message)
-        XCTAssertEqual(try signer.sign(payload: payload, address: address, privateKey: privateKey, type: .eip191), signature)
+        XCTAssertEqual(try signer.sign(payload: cacaoPayload, privateKey: privateKey, type: .eip191), signature)
     }
 
     func testCacaoVerify() async throws {

diff --git a/Example/IntegrationTests/Auth/Signer/EIP1271VerifierTests.swift b/Example/IntegrationTests/Auth/Signer/EIP1271VerifierTests.swift
@@ -1,6 +1,7 @@
 import Foundation
 import XCTest
 @testable import Auth
+@testable import WalletConnectSigner
 import JSONRPC
 
 class EIP1271VerifierTests: XCTestCase {

diff --git a/Example/IntegrationTests/Auth/Signer/EIP191VerifierTests.swift b/Example/IntegrationTests/Auth/Signer/EIP191VerifierTests.swift
@@ -1,6 +1,7 @@
 import Foundation
 import XCTest
 @testable import Auth
+@testable import WalletConnectSigner
 
 class EIP191VerifierTests: XCTestCase {
 

diff --git a/Example/IntegrationTests/Chat/RegistryTests.swift b/Example/IntegrationTests/Chat/RegistryTests.swift
@@ -6,4 +6,50 @@ import WalletConnectUtils
 
 final class RegistryTests: XCTestCase {
 
+    let account = Account("eip155:1:0x15bca56b6e2728aec2532df9d436bd1600e86688")!
+    let privateKey = Data(hex: "305c6cde3846927892cd32762f6120539f3ec74c9e3a16b9b798b1e85351ae2a")
+
+    var sut: IdentityRegisterService!
+    var storage: IdentityStorage!
+    var signer: CacaoMessageSigner!
+
+    override func setUp() {
+        let keyserverURL = URL(string: "https://staging.keys.walletconnect.com")!
+        let httpService = HTTPNetworkClient(host: keyserverURL.host!)
+        let accountService = AccountService(currentAccount: account)
+        let identityNetworkService = IdentityNetworkService(accountService: accountService, httpService: httpService)
+        storage = IdentityStorage(keychain: KeychainStorageMock())
+        sut = IdentityRegisterService(
+            keyserverURL: keyserverURL,
+            identityStorage: storage,
+            identityNetworkService: identityNetworkService,
+            iatProvader: DefaultIATProvider(),
+            messageFormatter: SIWECacaoFormatter()
+        )
+        signer = MessageSignerFactory(signerFactory: DefaultSignerFactory()).create(projectId: InputConfig.projectId)
+    }
+
+    func testRegisterIdentityAndInviteKey() async throws {
+        var message: String!
+        let publicKey = try await sut.registerIdentity(account: account, isPrivate: false) { msg in
+            message = msg
+            return try! signer.sign(message: msg, privateKey: privateKey, type: .eip191)
+        }
+
+        let cacao = try await sut.resolveIdentity(publicKey: publicKey)
+        XCTAssertEqual(try SIWECacaoFormatter().formatMessage(from: cacao.p), message)
+
+        let recovered = storage.getIdentityKey(for: account)!.publicKey.hexRepresentation
+        XCTAssertEqual(publicKey, recovered)
+
+        let inviteKey = try await sut.registerInvite(account: account, isPrivate: false, onSign: { msg in
+            return try! signer.sign(message: msg, privateKey: privateKey, type: .eip191)
+        })
+
+        let recoveredKey = storage.getInviteKey(for: account)!
+        XCTAssertEqual(inviteKey, recoveredKey.publicKey.hexRepresentation)
+
+        let resolvedKey = try await sut.resolveInvite(account: account)
+        XCTAssertEqual(inviteKey, resolvedKey)
+    }
 }
diff --git a/Example/WalletApp/PresentationLayer/Wallet/AuthRequest/AuthRequestInteractor.swift b/Example/WalletApp/PresentationLayer/Wallet/AuthRequest/AuthRequestInteractor.swift
@@ -8,8 +8,7 @@ final class AuthRequestInteractor {
     func approve(request: AuthRequest) async throws {
         let privateKey = Data(hex: "e56da0e170b5e09a8bb8f1b693392c7d56c3739a9c75740fbc558a2877868540")
         let signature = try signer.sign(
-            payload: request.payload,
-            address: account.address,
+            payload: request.payload.cacaoPayload(address: account.address),
             privateKey: privateKey,
             type: .eip191)
         try await Web3Wallet.instance.respond(requestId: request.id, signature: signature, from: account)

diff --git a/Package.swift b/Package.swift
@@ -56,7 +56,7 @@ let package = Package(
             path: "Sources/Chat"),
         .target(
             name: "Auth",
-            dependencies: ["WalletConnectPairing"],
+            dependencies: ["WalletConnectPairing", "WalletConnectSigner"],
             path: "Sources/Auth"),
         .target(
             name: "Web3Wallet",
@@ -72,7 +72,7 @@ let package = Package(
             path: "Sources/WalletConnectEcho"),
         .target(
             name: "WalletConnectRelay",
-            dependencies: ["WalletConnectKMS"],
+            dependencies: ["WalletConnectJWT"],
             path: "Sources/WalletConnectRelay",
             resources: [.copy("PackageConfig.json")]),
         .target(
@@ -85,6 +85,12 @@ let package = Package(
         .target(
             name: "Web3Inbox",
             dependencies: ["WalletConnectChat"]),
+        .target(
+            name: "WalletConnectSigner",
+            dependencies: ["WalletConnectNetworking"]),
+        .target(
+            name: "WalletConnectJWT",
+            dependencies: ["WalletConnectKMS"]),
         .target(
             name: "WalletConnectUtils",
             dependencies: ["JSONRPC"]),

diff --git a/Sources/Auth/AuthClient.swift b/Sources/Auth/AuthClient.swift
@@ -89,12 +89,12 @@ public class AuthClient: AuthClientProtocol {
 
     /// Query pending authentication requests
     /// - Returns: Pending authentication requests
-    public func getPendingRequests(account: Account) throws -> [AuthRequest] {
-        return try pendingRequestsProvider.getPendingRequests(account: account)
+    public func getPendingRequests() throws -> [AuthRequest] {
+        return try pendingRequestsProvider.getPendingRequests()
     }
 
     public func formatMessage(payload: AuthPayload, address: String) throws -> String {
-        return try SIWEMessageFormatter().formatMessage(from: payload, address: address)
+        return try SIWECacaoFormatter().formatMessage(from: payload.cacaoPayload(address: address))
     }
 
     private func setUpPublishers() {

diff --git a/Sources/Auth/AuthClientFactory.swift b/Sources/Auth/AuthClientFactory.swift
@@ -42,7 +42,7 @@ public struct AuthClientFactory {
 
         let kms = KeyManagementService(keychain: keychainStorage)
         let history = RPCHistoryFactory.createForNetwork(keyValueStorage: keyValueStorage)
-        let messageFormatter = SIWEMessageFormatter()
+        let messageFormatter = SIWECacaoFormatter()
         let appRequestService = AppRequestService(networkingInteractor: networkingClient, kms: kms, appMetadata: metadata, logger: logger, iatProvader: iatProvider)
         let messageSignerFactory = MessageSignerFactory(signerFactory: signerFactory)
         let messageSigner = messageSignerFactory.create(projectId: projectId)

diff --git a/Sources/Auth/AuthClientProtocol.swift b/Sources/Auth/AuthClientProtocol.swift
@@ -7,5 +7,5 @@ public protocol AuthClientProtocol {
     func formatMessage(payload: AuthPayload, address: String) throws -> String
     func respond(requestId: RPCID, signature: CacaoSignature, from account: Account) async throws
     func reject(requestId: RPCID) async throws
-    func getPendingRequests(account: Account) throws -> [AuthRequest]
+    func getPendingRequests() throws -> [AuthRequest]
 }
diff --git a/Sources/Auth/AuthImports.swift b/Sources/Auth/AuthImports.swift
@@ -1,3 +1,4 @@
 #if !CocoaPods
 @_exported import WalletConnectPairing
+@_exported import WalletConnectSigner
 #endif
diff --git a/Sources/Auth/Services/App/AppRespondSubscriber.swift b/Sources/Auth/Services/App/AppRespondSubscriber.swift
@@ -6,7 +6,7 @@ class AppRespondSubscriber {
     private let logger: ConsoleLogging
     private let rpcHistory: RPCHistory
     private let signatureVerifier: MessageSignatureVerifying
-    private let messageFormatter: SIWEMessageFormatting
+    private let messageFormatter: SIWECacaoFormatting
     private let pairingRegisterer: PairingRegisterer
     private var publishers = [AnyCancellable]()
 
@@ -17,7 +17,7 @@ class AppRespondSubscriber {
          rpcHistory: RPCHistory,
          signatureVerifier: MessageSignatureVerifying,
          pairingRegisterer: PairingRegisterer,
-         messageFormatter: SIWEMessageFormatting) {
+         messageFormatter: SIWECacaoFormatting) {
         self.networkingInteractor = networkingInteractor
         self.logger = logger
         self.rpcHistory = rpcHistory
@@ -52,8 +52,7 @@ class AppRespondSubscriber {
 
                 guard
                     let recovered = try? messageFormatter.formatMessage(
-                        from: requestPayload.payloadParams,
-                        address: address
+                        from: requestPayload.payloadParams.cacaoPayload(address: address)
                     ), recovered == message
                 else { self.onResponse?(requestId, .failure(.messageCompromised)); return }
 

diff --git a/Sources/Auth/Services/Common/IATProvider.swift b/Sources/Auth/Services/Common/IATProvider.swift