fix: pairing events, more docs

WalletConnect · Nov 3, 2023 · e5557f5 · e5557f5
1 parent 28e899d
commit e5557f5
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 3 deletions.
diff --git a/WalletConnectSharp.Sign/Engine.cs b/WalletConnectSharp.Sign/Engine.cs
@@ -97,6 +97,7 @@ private void WrapPairingEvents()
         {
             this.Client.Core.Pairing.PairingPinged += (sender, @event) => this.PairingPinged?.Invoke(sender, @event);
             this.Client.Core.Pairing.PairingDeleted += (sender, @event) => this.PairingDeleted?.Invoke(sender, @event);
+            this.Client.Core.Pairing.PairingExpired += (sender, @event) => this.PairingExpired?.Invoke(sender, @event);
         }
 
         private void RegisterExpirerEvents()
@@ -125,7 +126,7 @@ private void RegisterRelayerEvents()
         /// This event is invoked when the given pairing has expired
         /// Event Side: Wallet
         /// </summary>
-        public event EventHandler<PairingStruct> PairingExpired;
+        public event EventHandler<PairingEvent> PairingExpired;
 
         /// <summary>
         /// This event is invoked when a new session is proposed. This is usually invoked

diff --git a/WalletConnectSharp.Sign/Interfaces/IEngineAPI.cs b/WalletConnectSharp.Sign/Interfaces/IEngineAPI.cs
@@ -14,34 +14,96 @@ namespace WalletConnectSharp.Sign.Interfaces
     /// </summary>
     public interface IEngineAPI
     {
+        /// <summary>
+        /// This event is invoked when the given session has expired
+        /// Event Side: dApp & Wallet
+        /// </summary>
         event EventHandler<SessionStruct> SessionExpired;
 
-        event EventHandler<PairingStruct> PairingExpired;
+        /// <summary>
+        /// This event is invoked when the given pairing has expired
+        /// Event Side: Wallet
+        /// </summary>
+        event EventHandler<PairingEvent> PairingExpired;
 
+        /// <summary>
+        /// This event is invoked when a new session is proposed. This is usually invoked
+        /// after a new pairing has been activated from a URI
+        /// Event Side: Wallet
+        /// </summary>
         event EventHandler<SessionProposalEvent> SessionProposed;
 
+        /// <summary>
+        /// This event is invoked when a proposed session has been connected to a wallet. This event is
+        /// triggered after the session has been approved by a wallet
+        /// Event Side: dApp
+        /// </summary>
         event EventHandler<SessionStruct> SessionConnected;
 
+        /// <summary>
+        /// This event is invoked when a proposed session connection failed with an error
+        /// Event Side: dApp
+        /// </summary>
         event EventHandler<Exception> SessionConnectionErrored;
 
+        /// <summary>
+        /// This event is invoked when a given session sent a update request. 
+        /// Event Side: Wallet
+        /// </summary>
         event EventHandler<SessionUpdateEvent> SessionUpdateRequest;
 
+        /// <summary>
+        /// This event is invoked when a given session sent a extend request.
+        /// Event Side: Wallet
+        /// </summary>
         event EventHandler<SessionEvent> SessionExtendRequest;
 
+        /// <summary>
+        /// This event is invoked when a given session update request was successful.
+        /// Event Side: dApp
+        /// </summary>
         event EventHandler<SessionEvent> SessionUpdated;
 
+        /// <summary>
+        /// This event is invoked when a given session extend request was successful.
+        /// Event Side: dApp
+        /// </summary>
         event EventHandler<SessionEvent> SessionExtended;
 
+        /// <summary>
+        /// This event is invoked when a given session has been pinged
+        /// Event Side: dApp & Wallet
+        /// </summary>
         event EventHandler<SessionEvent> SessionPinged;
 
+        /// <summary>
+        /// This event is invoked whenever a session has been deleted
+        /// Event Side: dApp & Wallet
+        /// </summary>
         event EventHandler<SessionEvent> SessionDeleted;
 
+        /// <summary>
+        /// This event is invoked whenever a session has been rejected
+        /// Event Side: Wallet
+        /// </summary>
         event EventHandler<SessionStruct> SessionRejected;
 
+        /// <summary>
+        /// This event is invoked whenever a session has been approved
+        /// Event Side: Wallet
+        /// </summary>
         event EventHandler<SessionStruct> SessionApproved; 
 
+        /// <summary>
+        /// This event is invoked whenever a pairing is pinged
+        /// Event Side: dApp & Wallet
+        /// </summary>
         event EventHandler<PairingEvent> PairingPinged;
 
+        /// <summary>
+        /// This event is invoked whenever a pairing is deleted
+        /// Event Side: dApp & Wallet
+        /// </summary>
         event EventHandler<PairingEvent> PairingDeleted;
 
         /// <summary>

diff --git a/WalletConnectSharp.Sign/WalletConnectSignClient.cs b/WalletConnectSharp.Sign/WalletConnectSignClient.cs
@@ -115,7 +115,7 @@ public int Version
 
 
         public event EventHandler<SessionStruct> SessionExpired;
-        public event EventHandler<PairingStruct> PairingExpired;
+        public event EventHandler<PairingEvent> PairingExpired;
         public event EventHandler<SessionProposalEvent> SessionProposed;
         public event EventHandler<SessionStruct> SessionConnected;
         public event EventHandler<Exception> SessionConnectionErrored;
@@ -226,6 +226,8 @@ private void WrapEngineEvents()
             Engine.SessionApproved += (sender, @struct) => this.SessionApproved?.Invoke(sender, @struct);
             Engine.SessionExtended += (sender, @event) => this.SessionExtended?.Invoke(sender, @event);
             Engine.SessionUpdated += (sender, @event) => this.SessionUpdated?.Invoke(sender, @event);
+            Engine.PairingDeleted += (sender, @event) => this.PairingDeleted?.Invoke(sender, @event);
+            Engine.PairingPinged += (sender, @event) => this.PairingPinged?.Invoke(sender, @event);
         }
 
         /// <summary>