Merge pull request #1202 from WalletConnect/native-redirect

Native Redirect
WalletConnect · Nov 1, 2023 · b9b59ad · b9b59ad
2 parents 3bb4d86 + 56aa06f
commit b9b59ad
Show file tree

Hide file tree

Showing 34 changed files with 174 additions and 95 deletions.
diff --git a/Example/DApp/Auth/AuthCoordinator.swift b/Example/DApp/Auth/AuthCoordinator.swift
@@ -29,7 +29,8 @@ final class AuthCoordinator {
             name: "Swift Dapp",
             description: "WalletConnect DApp sample",
             url: "wallet.connect",
-            icons: ["https://avatars.githubusercontent.com/u/37784886"])
+            icons: ["https://avatars.githubusercontent.com/u/37784886"],
+            redirect: AppMetadata.Redirect(native: "dapp://", universal: nil))
 
         Pair.configure(metadata: metadata)
         navigationController.viewControllers = [authViewController]

diff --git a/Example/DApp/Info.plist b/Example/DApp/Info.plist
@@ -2,6 +2,19 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+	<key>CFBundleURLTypes</key>
+	<array>
+		<dict>
+			<key>CFBundleTypeRole</key>
+			<string>Editor</string>
+			<key>CFBundleURLSchemes</key>
+			<array>
+				<string>dapp</string>
+			</array>
+		</dict>
+	</array>
+	<key>ITSAppUsesNonExemptEncryption</key>
+	<false/>
 	<key>LSApplicationQueriesSchemes</key>
 	<array>
 		<string>metamask</string>
@@ -11,12 +24,6 @@
 		<string>rainbow</string>
 		<string>spot</string>
 	</array>
-	<key>CFBundleVersion</key>
-	<string>7</string>
-	<key>CFBundleShortVersionString</key>
-	<string>$(MARKETING_VERSION)</string>
-	<key>ITSAppUsesNonExemptEncryption</key>
-	<false/>
 	<key>PROJECT_ID</key>
 	<string>$(PROJECT_ID)</string>
 	<key>UIApplicationSceneManifest</key>

diff --git a/Example/DApp/SceneDelegate.swift b/Example/DApp/SceneDelegate.swift
@@ -19,7 +19,8 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
             name: "Swift Dapp",
             description: "WalletConnect DApp sample",
             url: "wallet.connect",
-            icons: ["https://avatars.githubusercontent.com/u/37784886"]
+            icons: ["https://avatars.githubusercontent.com/u/37784886"],
+            redirect: AppMetadata.Redirect(native: "dapp://", universal: nil)
         )
 
         WalletConnectModal.configure(

diff --git a/Example/DApp/Sign/Connect/ConnectViewController.swift b/Example/DApp/Sign/Connect/ConnectViewController.swift
@@ -62,7 +62,7 @@ class ConnectViewController: UIViewController, UITableViewDataSource, UITableVie
     }
 
     @objc func connectWithExampleWallet() {
-        let url = URL(string: "walletapp://wc?uri=\(uri.deeplinkUri)")!
+        let url = URL(string: "walletapp://wc?uri=\(uri.deeplinkUri.removingPercentEncoding!)")!
         DispatchQueue.main.async {
             UIApplication.shared.open(url, options: [:]) { [weak self] _ in
                 self?.dismiss(animated: true, completion: nil)

diff --git a/Example/DApp/Sign/SignCoordinator.swift b/Example/DApp/Sign/SignCoordinator.swift
@@ -24,7 +24,9 @@ final class SignCoordinator {
             name: "Swift Dapp",
             description: "WalletConnect DApp sample",
             url: "wallet.connect",
-            icons: ["https://avatars.githubusercontent.com/u/37784886"])
+            icons: ["https://avatars.githubusercontent.com/u/37784886"],
+            redirect: AppMetadata.Redirect(native: "dapp://", universal: nil)
+        )
 
         Pair.configure(metadata: metadata)
 #if DEBUG

diff --git a/Example/ExampleApp.xcodeproj/project.pbxproj b/Example/ExampleApp.xcodeproj/project.pbxproj
@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 52;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -231,6 +231,7 @@
 		A74D32BA2A1E25AD00CB8536 /* QueryParameters.swift in Sources */ = {isa = PBXBuildFile; fileRef = A74D32B92A1E25AD00CB8536 /* QueryParameters.swift */; };
 		C5133A78294125CC00A8314C /* Web3 in Frameworks */ = {isa = PBXBuildFile; productRef = C5133A77294125CC00A8314C /* Web3 */; };
 		C53AA4362941251C008EA57C /* DefaultSignerFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = A59CF4F5292F83D50031A42F /* DefaultSignerFactory.swift */; };
+		C54C24902AEB1B5600DA4BF6 /* WalletConnectRouter in Frameworks */ = {isa = PBXBuildFile; productRef = C54C248F2AEB1B5600DA4BF6 /* WalletConnectRouter */; };
 		C55D347F295DD7140004314A /* AuthRequestModule.swift in Sources */ = {isa = PBXBuildFile; fileRef = C55D347A295DD7140004314A /* AuthRequestModule.swift */; };
 		C55D3480295DD7140004314A /* AuthRequestPresenter.swift in Sources */ = {isa = PBXBuildFile; fileRef = C55D347B295DD7140004314A /* AuthRequestPresenter.swift */; };
 		C55D3481295DD7140004314A /* AuthRequestRouter.swift in Sources */ = {isa = PBXBuildFile; fileRef = C55D347C295DD7140004314A /* AuthRequestRouter.swift */; };
@@ -750,6 +751,7 @@
 				C56EE255293F569A004840D1 /* Starscream in Frameworks */,
 				A5B6C0F52A6EAB2800927332 /* WalletConnectNotify in Frameworks */,
 				C56EE27B293F56F8004840D1 /* WalletConnectAuth in Frameworks */,
+				C54C24902AEB1B5600DA4BF6 /* WalletConnectRouter in Frameworks */,
 				84943C7D2A9BA328007EBAC2 /* Mixpanel in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -2058,6 +2060,7 @@
 				84943C7C2A9BA328007EBAC2 /* Mixpanel */,
 				A59D25ED2AB3672700D7EA3A /* AsyncButton */,
 				A5F1526E2ACDC46B00D745A6 /* Web3ModalUI */,
+				C54C248F2AEB1B5600DA4BF6 /* WalletConnectRouter */,
 			);
 			productName = ChatWallet;
 			productReference = C56EE21B293F55ED004840D1 /* WalletApp.app */;
@@ -3449,6 +3452,10 @@
 			package = A5AE354528A1A2AC0059AE8A /* XCRemoteSwiftPackageReference "Web3" */;
 			productName = Web3;
 		};
+		C54C248F2AEB1B5600DA4BF6 /* WalletConnectRouter */ = {
+			isa = XCSwiftPackageProductDependency;
+			productName = WalletConnectRouter;
+		};
 		C55D349829630D440004314A /* Web3Wallet */ = {
 			isa = XCSwiftPackageProductDependency;
 			productName = Web3Wallet;

diff --git a/Example/IntegrationTests/Auth/AuthTests.swift b/Example/IntegrationTests/Auth/AuthTests.swift
@@ -55,7 +55,7 @@ final class AuthTests: XCTestCase {
             networkingClient: networkingClient)
 
         let authClient = AuthClientFactory.create(
-            metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),
+            metadata: AppMetadata(name: name, description: "", url: "", icons: [""], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             projectId: InputConfig.projectId,
             crypto: DefaultCryptoProvider(),
             logger: logger,

diff --git a/Example/IntegrationTests/Pairing/PairingTests.swift b/Example/IntegrationTests/Pairing/PairingTests.swift
@@ -63,7 +63,7 @@ final class PairingTests: XCTestCase {
         appPairingClient = pairingClient
 
         appAuthClient = AuthClientFactory.create(
-            metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),
+            metadata: AppMetadata(name: name, description: "", url: "", icons: [""], redirect: AppMetadata.Redirect(native: "dapp://", universal: nil)),
             projectId: InputConfig.projectId,
             crypto: DefaultCryptoProvider(),
             logger: notifyLogger,
@@ -88,7 +88,7 @@ final class PairingTests: XCTestCase {
             logger: notifyLogger
         )
         appAuthClient = AuthClientFactory.create(
-            metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),
+            metadata: AppMetadata(name: name, description: "", url: "", icons: [""], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             projectId: InputConfig.projectId,
             crypto: DefaultCryptoProvider(),
             logger: notifyLogger,

diff --git a/Example/IntegrationTests/Sign/SignClientTests.swift b/Example/IntegrationTests/Sign/SignClientTests.swift
@@ -37,7 +37,7 @@ final class SignClientTests: XCTestCase {
             networkingClient: networkingClient
         )
         let client = SignClientFactory.create(
-            metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),
+            metadata: AppMetadata(name: name, description: "", url: "", icons: [""], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             logger: logger,
             keyValueStorage: keyValueStorage,
             keychainStorage: keychain,
@@ -437,7 +437,7 @@ final class SignClientTests: XCTestCase {
             requiredNamespaces: requiredNamespaces,
             optionalNamespaces: optionalNamespaces,
             sessionProperties: nil,
-            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [])), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
+            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil))), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
         )
 
         let sessionNamespaces = try AutoNamespaces.build(
@@ -505,11 +505,11 @@ final class SignClientTests: XCTestCase {
         let sessionProposal = Session.Proposal(
             id: "",
             pairingTopic: "",
-            proposer: AppMetadata(name: "", description: "", url: "", icons: []),
+            proposer: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             requiredNamespaces: requiredNamespaces,
             optionalNamespaces: optionalNamespaces,
             sessionProperties: nil,
-            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [])), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
+            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil))), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
         )
 
         let sessionNamespaces = try AutoNamespaces.build(
@@ -563,11 +563,11 @@ final class SignClientTests: XCTestCase {
         let sessionProposal = Session.Proposal(
             id: "",
             pairingTopic: "",
-            proposer: AppMetadata(name: "", description: "", url: "", icons: []),
+            proposer: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             requiredNamespaces: requiredNamespaces,
             optionalNamespaces: optionalNamespaces,
             sessionProperties: nil,
-            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [])), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
+            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil))), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
         )
 
         let sessionNamespaces = try AutoNamespaces.build(
@@ -629,11 +629,11 @@ final class SignClientTests: XCTestCase {
         let sessionProposal = Session.Proposal(
             id: "",
             pairingTopic: "",
-            proposer: AppMetadata(name: "", description: "", url: "", icons: []),
+            proposer: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             requiredNamespaces: requiredNamespaces,
             optionalNamespaces: optionalNamespaces,
             sessionProperties: nil,
-            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [])), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
+            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil))), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
         )
 
         do {
@@ -692,11 +692,11 @@ final class SignClientTests: XCTestCase {
         let sessionProposal = Session.Proposal(
             id: "",
             pairingTopic: "",
-            proposer: AppMetadata(name: "", description: "", url: "", icons: []),
+            proposer: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             requiredNamespaces: requiredNamespaces,
             optionalNamespaces: optionalNamespaces,
             sessionProperties: nil,
-            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [])), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
+            proposal: SessionProposal(relays: [], proposer: Participant(publicKey: "", metadata: AppMetadata(name: "", description: "", url: "", icons: [], redirect: AppMetadata.Redirect(native: "", universal: nil))), requiredNamespaces: [:], optionalNamespaces: [:], sessionProperties: [:])
         )
 
         do {

diff --git a/Example/IntegrationTests/Stubs/Stubs.swift b/Example/IntegrationTests/Stubs/Stubs.swift
@@ -29,7 +29,8 @@ extension AppMetadata {
             name: "WalletConnectSwift",
             description: "WalletConnectSwift",
             url: "https://walletconnect.com",
-            icons: []
+            icons: [],
+            redirect: AppMetadata.Redirect(native: "dapp://", universal: nil)
         )
     }
 }
diff --git a/Example/IntegrationTests/XPlatform/Web3Wallet/XPlatformW3WTests.swift b/Example/IntegrationTests/XPlatform/Web3Wallet/XPlatformW3WTests.swift
@@ -49,7 +49,7 @@ final class XPlatformW3WTests: XCTestCase {
             networkingClient: networkingClient)
 
         let signClient = SignClientFactory.create(
-            metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),
+            metadata: AppMetadata(name: name, description: "", url: "", icons: [""], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             logger: signLogger,
             keyValueStorage: keyValueStorage,
             keychainStorage: keychain,
@@ -58,7 +58,7 @@ final class XPlatformW3WTests: XCTestCase {
         )
 
         let authClient = AuthClientFactory.create(
-            metadata: AppMetadata(name: name, description: "", url: "", icons: [""]),
+            metadata: AppMetadata(name: name, description: "", url: "", icons: [""], redirect: AppMetadata.Redirect(native: "", universal: nil)),
             projectId: InputConfig.projectId,
             crypto: DefaultCryptoProvider(),
             logger: authLogger,

diff --git a/Example/WalletApp/ApplicationLayer/ConfigurationService.swift b/Example/WalletApp/ApplicationLayer/ConfigurationService.swift
@@ -13,7 +13,8 @@ final class ConfigurationService {
             name: "Example Wallet",
             description: "wallet description",
             url: "example.wallet",
-            icons: ["https://avatars.githubusercontent.com/u/37784886"]
+            icons: ["https://avatars.githubusercontent.com/u/37784886"], 
+            redirect: AppMetadata.Redirect(native: "walletapp://", universal: nil)
         )
 
         Web3Wallet.configure(metadata: metadata, crypto: DefaultCryptoProvider(), environment: BuildConfiguration.shared.apnsEnvironment)

diff --git a/Example/WalletApp/PresentationLayer/Wallet/AuthRequest/AuthRequestInteractor.swift b/Example/WalletApp/PresentationLayer/Wallet/AuthRequest/AuthRequestInteractor.swift
@@ -1,5 +1,7 @@
 import Foundation
+
 import Web3Wallet
+import WalletConnectRouter
 
 final class AuthRequestInteractor {
 
@@ -16,10 +18,16 @@ final class AuthRequestInteractor {
             privateKey: Data(hex: importAccount.privateKey),
             type: .eip191)
         try await Web3Wallet.instance.respond(requestId: request.id, signature: signature, from: account)
+
+        /* Redirect */
+        WalletConnectRouter.goBack(uri: request.requester.redirect.native)
     }
 
     func reject(request: AuthRequest) async throws {
         try await Web3Wallet.instance.reject(requestId: request.id)
+
+        /* Redirect */
+        WalletConnectRouter.goBack(uri: request.requester.redirect.native)
     }
 
     func formatted(request: AuthRequest, account: Account) -> String {

diff --git a/Example/WalletApp/PresentationLayer/Wallet/SessionProposal/SessionProposalInteractor.swift b/Example/WalletApp/PresentationLayer/Wallet/SessionProposal/SessionProposalInteractor.swift
@@ -1,6 +1,7 @@
 import Foundation
 
 import Web3Wallet
+import WalletConnectRouter
 
 final class SessionProposalInteractor {
     func approve(proposal: Session.Proposal, account: Account) async throws {
@@ -28,9 +29,15 @@ final class SessionProposalInteractor {
             accounts: supportedAccounts
         )
         try await Web3Wallet.instance.approve(proposalId: proposal.id, namespaces: sessionNamespaces, sessionProperties: proposal.sessionProperties)
+
+        /* Redirect */
+        WalletConnectRouter.goBack(uri: proposal.proposer.redirect.native)
     }
 
     func reject(proposal: Session.Proposal) async throws {
         try await Web3Wallet.instance.reject(proposalId: proposal.id, reason: .userRejected)
+
+        /* Redirect */
+        WalletConnectRouter.goBack(uri: proposal.proposer.redirect.native)
     }
 }
diff --git a/Example/WalletApp/PresentationLayer/Wallet/SessionRequest/SessionRequestInteractor.swift b/Example/WalletApp/PresentationLayer/Wallet/SessionRequest/SessionRequestInteractor.swift
@@ -1,5 +1,7 @@
 import Foundation
+
 import Web3Wallet
+import WalletConnectRouter
 
 final class SessionRequestInteractor {
     func approve(sessionRequest: Request, importAccount: ImportAccount) async throws {
@@ -10,6 +12,12 @@ final class SessionRequestInteractor {
                 requestId: sessionRequest.id,
                 response: .response(result)
             )
+
+            /* Redirect */
+            let session = getSession(topic: sessionRequest.topic)
+            if let uri = session?.peer.redirect.native {
+                WalletConnectRouter.goBack(uri: uri)
+            }
         } catch {
             throw error
         }
@@ -21,6 +29,12 @@ final class SessionRequestInteractor {
             requestId: sessionRequest.id,
             response: .error(.init(code: 0, message: ""))
         )
+
+        /* Redirect */
+        let session = getSession(topic: sessionRequest.topic)
+        if let uri = session?.peer.redirect.native {
+            WalletConnectRouter.goBack(uri: uri)
+        }
     }
 
     func getSession(topic: String) -> Session? {

diff --git a/Package.swift b/Package.swift
@@ -33,7 +33,7 @@ let package = Package(
             targets: ["WalletConnectPush"]),
         .library(
             name: "WalletConnectRouter",
-            targets: ["WalletConnectRouter"]),
+            targets: ["WalletConnectRouter", "WalletConnectRouterLegacy"]),
         .library(
             name: "WalletConnectNetworking",
             targets: ["WalletConnectNetworking"]),
@@ -119,9 +119,14 @@ let package = Package(
         .target(
             name: "WalletConnectNetworking",
             dependencies: ["HTTPClient", "WalletConnectRelay"]),
+        .target(
+            name: "WalletConnectRouterLegacy",
+            dependencies: [],
+            path: "Sources/WalletConnectRouter/RouterLegacy"),
         .target(
             name: "WalletConnectRouter",
-            dependencies: []),
+            dependencies: ["WalletConnectRouterLegacy"],
+            path: "Sources/WalletConnectRouter/Router"),
         .target(
             name: "WalletConnectVerify",
             dependencies: ["WalletConnectUtils", "WalletConnectNetworking"]),

diff --git a/Sources/Auth/Services/Wallet/PendingRequestsProvider.swift b/Sources/Auth/Services/Wallet/PendingRequestsProvider.swift
@@ -17,7 +17,7 @@ class PendingRequestsProvider {
             .filter {$0.request.method == "wc_authRequest"}
             .compactMap {
                 guard let params = try? $0.request.params?.get(AuthRequestParams.self) else { return nil }
-                return AuthRequest(id: $0.request.id!, topic: $0.topic, payload: params.payloadParams)
+                return AuthRequest(id: $0.request.id!, topic: $0.topic, payload: params.payloadParams, requester: params.requester.metadata)
             }
 
         return pendingRequests.map { ($0, try? verifyContextStore.get(key: $0.id.string)) }

diff --git a/Sources/Auth/Services/Wallet/WalletRequestSubscriber.swift b/Sources/Auth/Services/Wallet/WalletRequestSubscriber.swift
@@ -36,10 +36,10 @@ class WalletRequestSubscriber {
         pairingRegisterer.register(method: AuthRequestProtocolMethod())
             .sink { [unowned self] (payload: RequestSubscriptionPayload<AuthRequestParams>) in
                 logger.debug("WalletRequestSubscriber: Received request")
-                
+
                 pairingRegisterer.setReceived(pairingTopic: payload.topic)
 
-                let request = AuthRequest(id: payload.id, topic: payload.topic, payload: payload.request.payloadParams)
+                let request = AuthRequest(id: payload.id, topic: payload.topic, payload: payload.request.payloadParams, requester: payload.request.requester.metadata)
 
                 Task(priority: .high) {
                     let assertionId = payload.decryptedPayload.sha256().toHexString()

diff --git a/Sources/Auth/Types/Public/AuthRequest.swift b/Sources/Auth/Types/Public/AuthRequest.swift
@@ -4,4 +4,5 @@ public struct AuthRequest: Equatable, Codable {
     public let id: RPCID
     public let topic: String
     public let payload: AuthPayload
+    public let requester: AppMetadata
 }