Merge pull request #87 from MetaMask/analytics

Analytics

Author: elefantel

README.md

@@ -24,7 +24,7 @@ To add MetaMask iOS SDK as an SPM package to your project, in Xcode select: `Fil
     dependencies: [
         .package(
             url: "https://github.com/MetaMask/metamask-ios-sdk",
-            from: "0.2.1"
+            from: "0.2.2"
         )
     ]
 ```

Sources/metamask-ios-sdk/Classes/Analytics/Event.swift

@@ -5,6 +5,8 @@
 public enum Event: String {
     case connectionRequest = "sdk_connect_request_started"
     case connected = "sdk_connection_established"
+    case connectionAuthorised = "sdk_connection_authorized"
+    case connectionRejected = "sdk_connection_rejected"
     case disconnected = "sdk_disconnected"
 
     var name: String {

Sources/metamask-ios-sdk/Classes/Communication/SocketClient.swift

@@ -14,6 +14,7 @@ protocol CommunicationClient: AnyObject {
     var clientName: String { get }
     var dapp: Dapp? { get set }
     var deeplinkUrl: String { get }
+    var useDeeplinks: Bool { get set }
     var isConnected: Bool { get set }
     var serverUrl: String { get set }
     var hasValidSession: Bool { get }
@@ -27,6 +28,7 @@ protocol CommunicationClient: AnyObject {
     func connect()
     func disconnect()
     func clearSession()
+    func trackEvent(_ event: Event)
     func enableTracking(_ enable: Bool)
     func addRequest(_ job: @escaping RequestJob)
     func sendMessage<T: CodableData>(_ message: T, encrypt: Bool)
@@ -76,9 +78,15 @@ class SocketClient: CommunicationClient {
     var receiveResponse: ((String, [String: Any]) -> Void)?
 
     var requestJobs: [RequestJob] = []
+    
+    var useDeeplinks: Bool = false
+    
+    private var _deeplinkUrl: String {
+        useDeeplinks ? "metamask:/" : "https://metamask.app.link"
+    }
 
     var deeplinkUrl: String {
-        "https://metamask.app.link/connect?channelId="
+        "\(_deeplinkUrl)/connect?channelId="
             + channelId
             + "&comm=socket"
             + "&pubkey="
@@ -460,7 +468,10 @@ extension SocketClient {
         var parameters: [String: Any] = ["id": id]
 
         switch event {
-        case .connected, .disconnected:
+        case .connected,
+                .disconnected,
+                .connectionAuthorised,
+                .connectionRejected:
             break
         case .connectionRequest:
             let additionalParams: [String: Any] = [

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

@@ -29,6 +29,14 @@ public class Ethereum: ObservableObject {
             delegate?.enableDebug = newValue
         }
     }
+    
+    public var useDeeplinks: Bool {
+        get {
+            delegate?.useDeeplinks ?? false
+        } set {
+            delegate?.useDeeplinks = newValue
+        }
+    }
 
     /// Set and use a custom network url. Currently fully supported
     public var networkUrl: String {
@@ -79,6 +87,7 @@ public extension Ethereum {
     }
 
     func terminateConnection() {
+        delegate?.trackEvent(.connectionRejected)
         let error = RequestError(from: ["message": "The connection request has been rejected"])
         submittedRequests.forEach { key, value in
             submittedRequests[key]?.error(error)
@@ -210,6 +219,13 @@ extension Ethereum {
 
         if let error = data["error"] as? [String: Any] {
             let requestError = RequestError(from: error)
+            let method = EthereumMethod(rawValue: request.method)
+            if 
+                method == .ethRequestAccounts,
+                requestError.codeType == .userRejectedRequest
+            {
+                delegate?.trackEvent(.connectionRejected)
+            }
             sendError(requestError, id: id)
             return
         }
@@ -242,6 +258,7 @@ extension Ethereum {
         case .ethRequestAccounts:
             let result: [String] = data["result"] as? [String] ?? []
             if let account = result.first {
+                delegate?.trackEvent(.connectionAuthorised)
                 updateAccount(account)
                 sendResult(account, id: id)
             } else {

Sources/metamask-ios-sdk/Classes/SDK/MetaMaskSDK.swift

@@ -9,10 +9,12 @@ protocol SDKDelegate: AnyObject {
     var dapp: Dapp? { get set }
     var deeplinkUrl: String { get }
     var enableDebug: Bool { get set }
+    var useDeeplinks: Bool { get set }
     var networkUrl: String { get set }
     func connect()
     func disconnect()
     func clearSession()
+    func trackEvent(_ event: Event)
     func addRequest(_ job: @escaping RequestJob)
     func sendMessage<T: CodableData>(_ message: T, encrypt: Bool)
 }
@@ -32,6 +34,12 @@ public class MetaMaskSDK: ObservableObject, SDKDelegate {
             client.enableTracking(enableDebug)
         }
     }
+    
+    public var useDeeplinks: Bool = false {
+        didSet {
+            client.useDeeplinks = useDeeplinks
+        }
+    }
 
     public var isConnected: Bool {
         client.isConnected
@@ -136,3 +144,9 @@ extension MetaMaskSDK {
         client.sendMessage(message, encrypt: encrypt)
     }
 }
+
+extension MetaMaskSDK {
+    func trackEvent(_ event: Event) {
+        client.trackEvent(event)
+    }
+}

metamask-ios-sdk.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'metamask-ios-sdk'
-  s.version          = '0.2.1'
+  s.version          = '0.2.2'
   s.summary          = 'Enable users to easily connect with their MetaMask Mobile wallet.'
   s.swift_version    = '5.0'