Merge pull request #25 from WalletConnect/feature/analytics

feat: analytics

Author: skibitsky

Packages/com.walletconnect.web3modal/Plugins/Web3Modal.jslib

@@ -67,9 +67,10 @@ mergeInto(LibraryManager.library, {
         const chains = parameters.chains;
 
         const enableOnramp = parameters.enableOnramp;
+        const enableAnalytics = parameters.enableAnalytics;
 
         // Load the scripts and initialize the configuration
-        import("https://cdn.jsdelivr.net/npm/@web3modal/cdn@5.0.11/dist/wagmi.js").then(CDNW3M => {
+        import("https://cdn.jsdelivr.net/npm/@web3modal/cdn@5.1.2/dist/wagmi.js").then(CDNW3M => {
             const WagmiCore = CDNW3M['WagmiCore'];
             const Chains = CDNW3M['Chains'];
             const Web3modal = CDNW3M['Web3modal'];
@@ -107,6 +108,7 @@ mergeInto(LibraryManager.library, {
                 wagmiConfig: config,
                 projectId,
                 enableOnramp: enableOnramp,
+                enableAnalytics: enableAnalytics,
                 disableAppend: true,
             });
 

Packages/com.walletconnect.web3modal/Runtime/Connectors/Connector.cs

@@ -122,6 +122,11 @@ protected virtual void OnAccountConnected(AccountConnectedEventArgs e)
         protected virtual void OnAccountDisconnected(AccountDisconnectedEventArgs e)
         {
             AccountDisconnected?.Invoke(this, e);
+
+            Web3Modal.EventsController.SendEvent(new Event
+            {
+                name = "DISCONNECT_SUCCESS"
+            });
         }
 
         protected virtual void OnAccountChanged(AccountChangedEventArgs e)

Packages/com.walletconnect.web3modal/Runtime/Connectors/WalletConnect/WalletConnectConnectionProposal.cs

@@ -34,6 +34,15 @@ private void OnSessionConnectionErrored(object sender, Exception e)
         {
             Web3Modal.NotificationController.Notify(NotificationType.Error, e.Message);
             RefreshConnection();
+
+            Web3Modal.EventsController.SendEvent(new Event
+            {
+                name = "CONNECT_ERROR",
+                properties = new System.Collections.Generic.Dictionary<string, object>
+                {
+                    { "message", e.Message }
+                }
+            });
         }
 
         private IEnumerator RefreshOnIntervalRoutine()

Packages/com.walletconnect.web3modal/Runtime/Connectors/WalletConnect/WalletConnectConnector.cs

@@ -123,7 +123,18 @@ protected override ConnectionProposal ConnectCore()
 
         protected override async Task DisconnectAsyncCore()
         {
-            await WalletConnectInstance.DisconnectAsync();
+            try
+            {
+                await WalletConnectInstance.DisconnectAsync();
+            }
+            catch (Exception)
+            {
+                Web3Modal.EventsController.SendEvent(new Event
+                {
+                    name = "DISCONNECT_ERROR"
+                });
+                throw;
+            }
         }
 
         protected override async Task ChangeActiveChainAsyncCore(Chain chain)
@@ -154,15 +165,15 @@ protected override Task<Account[]> GetAccountsCore()
             var ciapAddresses = WalletConnectInstance.SignClient.AddressProvider.AllAddresses();
             return Task.FromResult(ciapAddresses.Select(ciapAddress => new Account(ciapAddress.Address, ciapAddress.ChainId)).ToArray());
         }
-        
+
         private Account GetCurrentAccount()
         {
             var ciapAddress = WalletConnectInstance.SignClient.AddressProvider.CurrentAddress();
             return new Account(ciapAddress.Address, ciapAddress.ChainId);
         }
 
         private static bool ActiveSessionSupportsMethod(string method)
-        { 
+        {
             var @namespace = WalletConnectInstance.SignClient.AddressProvider.DefaultNamespace;
             var activeSession = WalletConnectInstance.ActiveSession;
             return activeSession.Namespaces[@namespace].Methods.Contains(method);

Packages/com.walletconnect.web3modal/Runtime/Connectors/WebGl/WebGlConnector.cs

@@ -15,12 +15,11 @@ namespace WalletConnect.Web3Modal
 #if UNITY_WEBGL
     public class WebGlConnector : Connector
     {
-
         [DllImport("__Internal")]
         private static extern void Initialize(string parameters, Action callback);
 
         private static TaskCompletionSource<bool> _initializationTaskCompletionSource;
-        
+
         private string _lastAccountStatus;
 
         public WebGlConnector()
@@ -36,28 +35,29 @@ protected override async Task InitializeAsyncCore(Web3ModalConfig web3ModalConfi
                 .Where(c => !string.IsNullOrWhiteSpace(c.ViemName))
                 .Select(c => c.ViemName)
                 .ToArray();
-            
+
             var parameters = new WebGlInitializeParameters
             {
                 projectId = walletConnectConfig.Id,
                 metadata = walletConnectConfig.Metadata,
                 chains = viemChainNames,
                 enableOnramp = web3ModalConfig.enableOnramp,
+                enableAnalytics = web3ModalConfig.enableAnalytics
             };
-            
+
             var parametersJson = JsonConvert.SerializeObject(parameters);
-            
+
 #pragma warning disable S2696
             _initializationTaskCompletionSource = new TaskCompletionSource<bool>();
 #pragma warning restore S2696
 
             Initialize(parametersJson, InitializationCallback);
 
             await _initializationTaskCompletionSource.Task;
-            
+
             WagmiInterop.InitializeEvents();
             ModalInterop.InitializeEvents();
-            
+
             WagmiInterop.WatchAccountTriggered += WatchAccountTriggeredHandler;
             WagmiInterop.WatchChainIdTriggered += WatchChainIdTriggeredHandler;
         }
@@ -79,9 +79,9 @@ protected override async Task<bool> TryResumeSessionAsyncCore()
             if (getAccountResult.isConnecting)
             {
                 var tcs = new TaskCompletionSource<bool>();
-                
+
                 WagmiInterop.WatchAccountTriggered += WagmiInteropOnWatchAccountTriggered;
-                
+
                 void WagmiInteropOnWatchAccountTriggered(GetAccountReturnType arg)
                 {
                     if (arg.isConnecting)
@@ -91,6 +91,7 @@ void WagmiInteropOnWatchAccountTriggered(GetAccountReturnType arg)
 
                     WagmiInterop.WatchAccountTriggered -= WagmiInteropOnWatchAccountTriggered;
                 }
+
                 var result = await tcs.Task;
 
                 return result;
@@ -125,12 +126,12 @@ protected override async Task<Account[]> GetAccountsCore()
                 .Select(addr => new Account(addr, chainId))
                 .ToArray();
         }
-        
+
         private void WatchAccountTriggeredHandler(GetAccountReturnType arg)
         {
             var previousLastAccountStatus = _lastAccountStatus;
             _lastAccountStatus = arg.status;
-            
+
             var account = new Account(arg.address, $"eip155:{arg.chainId}");
 
             if (_lastAccountStatus == "connected" && previousLastAccountStatus != "connected")
@@ -155,11 +156,11 @@ private void WatchChainIdTriggeredHandler(int ethChainId)
         {
             if (ethChainId == default)
                 return;
-            
+
             var chainId = $"eip155:{ethChainId}";
             OnChainChanged(new ChainChangedEventArgs(chainId));
         }
-        
+
         [MonoPInvokeCallback(typeof(Action))]
         public static void InitializationCallback()
         {
@@ -173,8 +174,9 @@ internal class WebGlInitializeParameters
         public string projectId;
         public Metadata metadata;
         public string[] chains;
-        
+
         public bool enableOnramp;
+        public bool enableAnalytics;
     }
 #endif
 }

Packages/com.walletconnect.web3modal/Runtime/Controllers/ApiController.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 using UnityEngine.Networking;
 using WalletConnect.Web3Modal.Http;
@@ -12,18 +13,19 @@ public class ApiController
     {
         private const string BasePath = "https://api.web3modal.com/";
         private const int TimoutSeconds = 5;
-        
+
         private readonly string _includedWalletIdsString = Web3Modal.Config.includedWalletIds is { Length: > 0 }
             ? string.Join(",", Web3Modal.Config.includedWalletIds)
             : null;
+
         private readonly string _excludedWalletIdsString = Web3Modal.Config.excludedWalletIds is { Length: > 0 }
             ? string.Join(",", Web3Modal.Config.excludedWalletIds)
             : null;
 
         private readonly UnityHttpClient _httpClient = new(new Uri(BasePath), TimeSpan.FromSeconds(TimoutSeconds),
             new Web3ModalApiHeaderDecorator()
         );
-        
+
         private const string Platform =
 #if UNITY_ANDROID
             "android";
@@ -44,13 +46,24 @@ public async Task<GetWalletsResponse> GetWallets(int page, int count, string sea
 
             return await _httpClient.GetAsync<GetWalletsResponse>("getWallets", new Dictionary<string, string>()
             {
-                {"page", page.ToString()},
-                {"entries", count.ToString()},
-                {"search", search},
-                {"platform", Platform},
-                {"include", _includedWalletIdsString},
-                {"exclude", _excludedWalletIdsString}
+                { "page", page.ToString() },
+                { "entries", count.ToString() },
+                { "search", search },
+                { "platform", Platform },
+                { "include", _includedWalletIdsString },
+                { "exclude", _excludedWalletIdsString }
             });
         }
+
+        public async Task<ApiGetAnalyticsConfigResponse> GetAnalyticsConfigAsync()
+        {
+            return await _httpClient.GetAsync<ApiGetAnalyticsConfigResponse>("getAnalyticsConfig");
+        }
+    }
+
+    public class ApiGetAnalyticsConfigResponse
+    {
+        public bool isAnalyticsEnabled { get; set; }
+        public bool isAppKitAuthEnabled { get; set; }
     }
 }

Packages/com.walletconnect.web3modal/Runtime/Controllers/EventsController.cs

@@ -0,0 +1,112 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using UnityEngine;
+using WalletConnect.Web3Modal.Http;
+using WalletConnectSharp.Common.Logging;
+
+namespace WalletConnect.Web3Modal
+{
+    public class EventsController
+    {
+        private const string BasePath = "https://pulse.walletconnect.org/";
+        private const int TimoutSeconds = 5;
+
+        private readonly UnityHttpClient _httpClient = new(new Uri(BasePath), TimeSpan.FromSeconds(TimoutSeconds), new PulseApiHeaderDecorator());
+
+        private AnalyticsState _state = AnalyticsState.Loading;
+
+        public async Task InitializeAsync(Web3ModalConfig config, ApiController apiController)
+        {
+#if UNITY_WEBGL && !UNITY_EDITOR
+            _state = AnalyticsState.Disabled;
+            return;
+#endif
+
+            if (!Web3Modal.Config.enableAnalytics)
+            {
+                _state = AnalyticsState.Disabled;
+                return;
+            }
+
+            await LoadRemoteAnalyticsConfig(apiController);
+        }
+
+
+        private async Task LoadRemoteAnalyticsConfig(ApiController apiController)
+        {
+            try
+            {
+                var response = await apiController.GetAnalyticsConfigAsync();
+
+                _state = response.isAnalyticsEnabled
+                    ? AnalyticsState.Enabled
+                    : AnalyticsState.Disabled;
+            }
+            catch (Exception e)
+            {
+                Debug.LogException(e);
+                _state = AnalyticsState.Disabled;
+            }
+        }
+
+        public async void SendEvent(Event @event)
+        {
+            try
+            {
+                if (_state == AnalyticsState.Disabled)
+                    return;
+
+                var request = new EventRequest
+                {
+                    eventId = Guid.NewGuid().ToString(),
+                    timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(),
+#if UNITY_ANDROID || UNITY_IOS || UNITY_VISIONOS
+                    bundleId = Application.identifier,
+#endif
+                    props = @event
+                };
+
+                var requestJson = JsonConvert.SerializeObject(request);
+
+                WCLogger.Log($"[EventsController] Sending event: {@event.name}.\n\nRequest payload:\n {requestJson}");
+
+                await _httpClient.PostAsync("e", requestJson);
+            }
+            catch (Exception e)
+            {
+                Debug.LogException(e);
+            }
+        }
+
+        private enum AnalyticsState
+        {
+            Loading,
+            Enabled,
+            Disabled
+        }
+    }
+
+    [Serializable]
+    internal struct EventRequest
+    {
+        public string eventId;
+        public long timestamp;
+        public string bundleId;
+        public Event props;
+    }
+
+    [Serializable]
+    public struct Event
+    {
+        [JsonProperty("type")]
+        public const string type = "track";
+
+        [JsonProperty("event")]
+        public string name;
+
+        [JsonProperty("properties", NullValueHandling = NullValueHandling.Ignore)]
+        public IDictionary<string, object> properties;
+    }
+}