Merge pull request #67 from Web3Auth/config-update

Make redirectUrl mandatory in W3AInitParams

Author: chaitanyapotti

Sources/Web3Auth/Types.swift

@@ -176,7 +176,7 @@ public struct W3ALoginConfig: Codable {
 }
 
 public struct W3AInitParams: Codable {
-    public init(clientId: String, network: Network, buildEnv: BuildEnv? = BuildEnv.production, sdkUrl: URL? = nil, walletSdkUrl: URL? = nil, redirectUrl: String? = nil, loginConfig: [String: W3ALoginConfig]? = nil, whiteLabel: W3AWhiteLabelData? = nil, chainNamespace: ChainNamespace? = ChainNamespace.eip155, useCoreKitKey: Bool? = false, mfaSettings: MfaSettings? = nil, sessionTime: Int = 86400) {
+    public init(clientId: String, network: Network, buildEnv: BuildEnv? = BuildEnv.production, sdkUrl: URL? = nil, walletSdkUrl: URL? = nil, redirectUrl: String, loginConfig: [String: W3ALoginConfig]? = nil, whiteLabel: W3AWhiteLabelData? = nil, chainNamespace: ChainNamespace? = ChainNamespace.eip155, useCoreKitKey: Bool? = false, mfaSettings: MfaSettings? = nil, sessionTime: Int = 86400) {
         self.clientId = clientId
         self.network = network
         self.buildEnv = buildEnv
@@ -199,13 +199,13 @@ public struct W3AInitParams: Codable {
         self.sessionTime = min(7 * 86400, sessionTime)
     }
 
-    public init(clientId: String, network: Network) {
+    public init(clientId: String, network: Network, redirectUrl: String) {
         self.clientId = clientId
         self.network = network
         buildEnv = BuildEnv.production
         sdkUrl = URL(string: getSdkUrl(buildEnv: buildEnv))
         walletSdkUrl = URL(string: getWalletSdkUrl(buildEnv: self.buildEnv))
-        redirectUrl = nil
+        self.redirectUrl = redirectUrl
         loginConfig = nil
         whiteLabel = nil
         chainNamespace = ChainNamespace.eip155
@@ -220,7 +220,7 @@ public struct W3AInitParams: Codable {
     let buildEnv: BuildEnv?
     var sdkUrl: URL?
     var walletSdkUrl: URL?
-    var redirectUrl: String?
+    var redirectUrl: String
     let loginConfig: [String: W3ALoginConfig]?
     let whiteLabel: W3AWhiteLabelData?
     let chainNamespace: ChainNamespace?
@@ -246,7 +246,7 @@ public struct W3AInitParams: Codable {
         } else {
             walletSdkUrl = URL(string: getWalletSdkUrl(buildEnv: buildEnv))
         }
-        redirectUrl = try values.decodeIfPresent(String.self, forKey: .redirectUrl)
+        redirectUrl = try values.decode(String.self, forKey: .redirectUrl)
         loginConfig = try values.decodeIfPresent([String: W3ALoginConfig].self, forKey: .loginConfig)
         whiteLabel = try values.decodeIfPresent(W3AWhiteLabelData.self, forKey: .whiteLabel)
         chainNamespace = try values.decodeIfPresent(ChainNamespace.self, forKey: .chainNamespace) ?? ChainNamespace.eip155

Sources/Web3Auth/Util.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-func plistValues(_ bundle: Bundle) -> (clientId: String, network: Network)? {
+func plistValues(_ bundle: Bundle) -> (clientId: String, network: Network, redirectUrl: String)? {
     guard
         let path = bundle.path(forResource: "Web3Auth", ofType: "plist"),
         let values = NSDictionary(contentsOfFile: path) as? [String: Any]
@@ -12,13 +12,14 @@ func plistValues(_ bundle: Bundle) -> (clientId: String, network: Network)? {
     guard
         let clientId = values["ClientId"] as? String,
         let networkValue = values["Network"] as? String,
+        let redirectUrl = values["RedirectUrl"] as? String,
         let network = Network(rawValue: networkValue)
     else {
         print("Web3Auth.plist file at \(path) is missing or having incorrect 'ClientId' and/or 'Network' entries!")
         print("File currently has the following entries: \(values)")
         return nil
     }
-    return (clientId: clientId, network: network)
+    return (clientId: clientId, network: network, redirectUrl)
 }
 
 func decodedBase64(_ base64URLSafe: String) -> Data? {

Sources/Web3Auth/Web3Auth.swift

@@ -94,7 +94,11 @@ public class Web3Auth: NSObject {
      */
     public convenience init(_ bundle: Bundle = Bundle.main) async {
         let values = plistValues(bundle)!
-        await self.init(W3AInitParams(clientId: values.clientId, network: values.network))
+        await self.init(W3AInitParams(
+            clientId: values.clientId,
+            network: values.network,
+            redirectUrl: values.redirectUrl
+        ))
     }
 
     /**

Web3authSwiftSdkDemo/Web3authSwiftSdkDemo/ViewModel.swift

@@ -21,6 +21,7 @@ class ViewModel: ObservableObject {
     @Published var showError: Bool = false
     var errorMessage: String = ""
     private var clientID: String = "BG4pe3aBso5SjVbpotFQGnXVHgxhgOxnqnNBKyjfEJ3izFvIVWUaMIzoCrAfYag8O6t6a6AOvdLcS4JR2sQMjR4"
+    private var redirectUrl: String = "com.web3auth.sdkapp://auth"
     private var network: Network = .sapphire_devnet
     private var buildEnv: BuildEnv = .testing
     //  private var clientID: String = "BEaGnq-mY0ZOXk2UT1ivWUe0PZ_iJX4Vyb6MtpOp7RMBu_6ErTrATlfuK3IaFcvHJr27h6L1T4owkBH6srLphIw"
@@ -37,7 +38,7 @@ class ViewModel: ObservableObject {
         typeOfLogin: TypeOfLogin.jwt,
         clientId: "d84f6xvbdV75VTGmHiMWfZLeSPk8M07C"
     )
-
+    
     func setup() async {
         guard web3Auth == nil else { return }
         await MainActor.run(body: {
@@ -58,7 +59,7 @@ class ViewModel: ObservableObject {
             navigationTitle = loggedIn ? "UserInfo" : "SignIn"
         })
     }
-
+    
     @MainActor func handleUserDetails() {
         do {
             loggedIn = true
@@ -70,57 +71,64 @@ class ViewModel: ObservableObject {
             showError = true
         }
     }
-
+    
     func getSignResponse() -> SignResponse? {
         return try? Web3Auth.getSignResponse()
     }
-
+    
     func login(provider: Web3AuthProvider) {
         Task {
             do {
                 _ = try await web3Auth?.login(W3ALoginParams(loginProvider: provider,
-                                                                 extraLoginOptions: ExtraLoginOptions(display: nil, prompt: nil, max_age: nil, ui_locales: nil, id_token_hint: nil, id_token: nil, login_hint: "[email protected]", acr_values: nil, scope: nil, audience: nil, connection: nil, domain: nil, client_id: nil, redirect_uri: nil, leeway: nil, verifierIdField: nil, isVerifierIdCaseSensitive: nil, additionalParams: nil),
-                                                                 mfaLevel: .DEFAULT,
-                                                                 curve: .SECP256K1
-                    ))
+                                                             extraLoginOptions: ExtraLoginOptions(display: nil, prompt: nil, max_age: nil, ui_locales: nil, id_token_hint: nil, id_token: nil, login_hint: "[email protected]", acr_values: nil, scope: nil, audience: nil, connection: nil, domain: nil, client_id: nil, redirect_uri: nil, leeway: nil, verifierIdField: nil, isVerifierIdCaseSensitive: nil, additionalParams: nil),
+                                                             mfaLevel: .DEFAULT,
+                                                             curve: .SECP256K1
+                                                            ))
                 await handleUserDetails()
             } catch {
                 print("Error")
             }
         }
     }
-
+    
     func loginWithGoogle(provider: Web3AuthProvider) {
         Task {
             do {
-                web3Auth = await Web3Auth(.init(clientId: clientID, network: network, buildEnv: buildEnv, useCoreKitKey: useCoreKit))
+                web3Auth = await Web3Auth(.init(
+                    clientId: clientID,
+                    network: network,
+                    buildEnv: buildEnv,
+                    redirectUrl: redirectUrl,
+                    useCoreKitKey: useCoreKit
+                ))
                 _ = try await web3Auth?.login(W3ALoginParams(loginProvider: provider,
-                                                                 mfaLevel: .DEFAULT,
-                                                                 curve: .SECP256K1
-                    ))
+                                                             mfaLevel: .DEFAULT,
+                                                             curve: .SECP256K1
+                                                            ))
                 await handleUserDetails()
             } catch {
                 print("Error")
             }
         }
     }
-
+    
     func loginWithGoogleCustomVerifier() {
         Task {
             do {
                 web3Auth = await Web3Auth(.init(
                     clientId: clientID,
                     network: network,
                     buildEnv: buildEnv,
+                    redirectUrl: redirectUrl,
                     loginConfig: [
                         "random":
-                            .init(
-                                verifier: "w3a-agg-example",
-                                typeOfLogin: .google,
-                                name: "Web3Auth-Aggregate-Verifier-Google-Example",
-                                clientId: "774338308167-q463s7kpvja16l4l0kko3nb925ikds2p.apps.googleusercontent.com",
-                                verifierSubIdentifier: "w3a-google"
-                            )
+                                .init(
+                                    verifier: "w3a-agg-example",
+                                    typeOfLogin: .google,
+                                    name: "Web3Auth-Aggregate-Verifier-Google-Example",
+                                    clientId: "774338308167-q463s7kpvja16l4l0kko3nb925ikds2p.apps.googleusercontent.com",
+                                    verifierSubIdentifier: "w3a-google"
+                                )
                     ]
                 )
                 )
@@ -138,7 +146,7 @@ class ViewModel: ObservableObject {
             }
         }
     }
-
+    
     @MainActor func logout() {
         Task {
             do {
@@ -150,7 +158,7 @@ class ViewModel: ObservableObject {
             }
         }
     }
-
+    
     @MainActor func launchWalletServices() {
         Task {
             do {
@@ -161,13 +169,14 @@ class ViewModel: ObservableObject {
             }
         }
     }
-
+    
     @MainActor func enableMFA() {
         Task {
             do {
                 web3Auth = await Web3Auth(W3AInitParams(clientId: clientID,
                                                         network: network,
                                                         buildEnv: buildEnv,
+                                                        redirectUrl: redirectUrl,
                                                         whiteLabel: W3AWhiteLabelData(appName: "Web3Auth Stub", defaultLanguage: .en, mode: .dark, theme: ["primary": "#123456"])))
                 _ = try await self.web3Auth?.enableMFA()
             } catch {
@@ -176,7 +185,7 @@ class ViewModel: ObservableObject {
             }
         }
     }
-
+    
     @MainActor func request() {
         Task {
             do {
@@ -197,14 +206,17 @@ class ViewModel: ObservableObject {
             }
         }
     }
-
+    
     func whitelabelLogin() {
         Task.detached { [unowned self] in
             do {
-                web3Auth = await Web3Auth(W3AInitParams(clientId: clientID,
-                                                        network: network,
-                                                        buildEnv: buildEnv,
-                                                        whiteLabel: W3AWhiteLabelData(appName: "Web3Auth Stub", defaultLanguage: .en, mode: .dark, theme: ["primary": "#123456"])))
+                web3Auth = await Web3Auth(
+                    W3AInitParams(
+                        clientId: clientID,
+                        network: network,
+                        buildEnv: buildEnv,
+                        redirectUrl: redirectUrl,
+                        whiteLabel: W3AWhiteLabelData(appName: "Web3Auth Stub", defaultLanguage: .en, mode: .dark, theme: ["primary": "#123456"])))
                 _ = try await self.web3Auth?
                     .login(W3ALoginParams(loginProvider: .GOOGLE))
                 await handleUserDetails()