Merge pull request #1280 from WalletConnect/feat/notify/sbs_in_responses

[Notify/Wallet Sample] Notify Client Refactor

Author: Elyniss

protocol/notify/src/androidTest/kotlin/com/walletconnect/notify/test/scenario/ClientInstrumentedActivityScenario.kt

@@ -54,13 +54,13 @@ class ClientInstrumentedActivityScenario : TestRule, ActivityScenario() {
         val isPrimaryReady = MutableStateFlow(false)
         val isSecondaryReady = MutableStateFlow(false)
 
-        TestClient.Primary.notifyClient.unregister(Notify.Params.Unregistration(TestClient.caip10account), { identityKey ->
+        TestClient.Primary.notifyClient.unregister(Notify.Params.Unregister(TestClient.caip10account), { identityKey ->
             Timber.d("Primary unregister: $identityKey")
             isPrimaryReady.value = true
         }, { error ->
             Timber.e(error.throwable)
         })
-        TestClient.Secondary.notifyClient.unregister(Notify.Params.Unregistration(TestClient.caip10account), { identityKey ->
+        TestClient.Secondary.notifyClient.unregister(Notify.Params.Unregister(TestClient.caip10account), { identityKey ->
             Timber.d("Secondary unregister: $identityKey")
             isSecondaryReady.value = true
         }, { error ->

protocol/notify/src/main/kotlin/com/walletconnect/notify/client/Notify.kt

@@ -10,27 +10,6 @@ import com.walletconnect.foundation.common.model.PrivateKey
 object Notify {
 
     sealed class Model {
-
-        @Deprecated("We renamed sealed class to Notification for consistency")
-        sealed class Message : Model() {
-            abstract val title: String
-            abstract val body: String
-
-            data class Simple(
-                override val title: String,
-                override val body: String,
-            ) : Message()
-
-            data class Decrypted(
-                override val title: String,
-                override val body: String,
-                val icon: String?,
-                val url: String?,
-                val type: String,
-                val topic: String,
-            ) : Message()
-        }
-
         sealed class Notification : Model() {
             abstract val title: String
             abstract val body: String
@@ -50,9 +29,6 @@ object Notify {
             ) : Notification()
         }
 
-        @Deprecated("We renamed data class to NotificationRecord for consistency")
-        data class MessageRecord(val id: String, val topic: String, val publishedAt: Long, val message: Message) : Model()
-
         data class NotificationRecord(val id: String, val topic: String, val publishedAt: Long, val message: Notification, val metadata: Core.Model.AppMetaData) : Model()
 
         data class Subscription(
@@ -90,29 +66,27 @@ object Notify {
     }
 
     sealed class Event {
+        data class Notification (val notification: Model.NotificationRecord) : Event()
 
-        @Deprecated("We renamed data class to Notification for consistency")
-        data class Message(val message: Model.MessageRecord) : Event()
-
-        data class Notification(val notification: Model.NotificationRecord) : Event()
-
-        data class Delete(val topic: String) : Event()
-
-        sealed class Subscription : Event() {
-
-            data class Result(val subscription: Model.Subscription) : Subscription()
+        data class SubscriptionsChanged(val subscriptions: List<Model.Subscription>) : Event()
+    }
 
-            data class Error(val id: Long, val reason: String) : Subscription()
+    // todo: move to model
+    sealed interface Result {
+        sealed interface Subscribe {
+            data class Success(val subscription: Model.Subscription) : Subscribe
+            data class Error(val error: Model.Error) : Subscribe
         }
 
-        sealed class Update : Event() {
-
-            data class Result(val subscription: Model.Subscription) : Update()
-
-            data class Error(val id: Long, val reason: String) : Update()
+        sealed interface UpdateSubscription {
+            data class Success(val subscription: Model.Subscription) : UpdateSubscription
+            data class Error(val error: Model.Error) : UpdateSubscription
         }
 
-        data class SubscriptionsChanged(val subscriptions: List<Model.Subscription>) : Event()
+        sealed interface DeleteSubscription {
+            data class Success(val topic: String) : DeleteSubscription
+            data class Error(val error: Model.Error) : DeleteSubscription
+        }
     }
 
     sealed class Params {
@@ -121,36 +95,22 @@ object Notify {
 
         data class Subscribe(val appDomain: Uri, val account: String) : Params()
 
-        data class Update(val topic: String, val scope: List<String>) : Params()
-
-        data class NotificationTypes(val appDomain: String) : Params()
+        data class UpdateSubscription(val topic: String, val scope: List<String>) : Params()
 
-        @Deprecated("We renamed function to getNotificationHistory for consistency")
-        data class MessageHistory(val topic: String) : Params()
+        data class GetNotificationTypes(val appDomain: String) : Params()
 
-        data class NotificationHistory(val topic: String) : Params()
+        data class GetNotificationHistory(val topic: String) : Params()
 
         data class DeleteSubscription(val topic: String) : Params()
 
-        @Deprecated("We renamed function to deleteNotification for consistency")
-        data class DeleteMessage(val id: Long) : Params()
-
-        data class DeleteNotification(val id: Long) : Params()
-
-        @Deprecated("We renamed function to decryptNotification for consistency")
-        data class DecryptMessage(val topic: String, val encryptedMessage: String) : Params()
-
         data class DecryptNotification(val topic: String, val encryptedMessage: String) : Params()
 
-        @Deprecated("We changed the registration flow to be more secure. Please use PrepareRegistration and Register instead")
-        data class Registration(val account: String, val domain: String, val onSign: (String) -> Model.Cacao.Signature?, val isLimited: Boolean = false) : Params()
-
         data class PrepareRegistration(val account: String, val domain: String, val allApps: Boolean = true) : Params()
 
         data class Register(val cacaoPayloadWithIdentityPrivateKey: Model.CacaoPayloadWithIdentityPrivateKey, val signature: Model.Cacao.Signature) : Params()
 
         data class IsRegistered(val account: String, val domain: String, val allApps: Boolean = true) : Params()
 
-        data class Unregistration(val account: String) : Params()
+        data class Unregister (val account: String) : Params()
     }
 }

protocol/notify/src/main/kotlin/com/walletconnect/notify/client/NotifyInterface.kt

@@ -2,18 +2,9 @@ package com.walletconnect.notify.client
 
 interface NotifyInterface {
     interface Delegate {
-
-        fun onNotifySubscription(notifySubscribe: Notify.Event.Subscription)
-
-        @Deprecated("We renamed this function to onNotifyMessage for consistency. Using both onNotifyMessage and onNotifyNotification will result in duplicate notifications")
-        fun onNotifyMessage(notifyMessage: Notify.Event.Message)
-
+        //todo: migration guide and remove all deprecations
         fun onNotifyNotification(notifyNotification: Notify.Event.Notification)
 
-        fun onNotifyDelete(notifyDelete: Notify.Event.Delete)
-
-        fun onNotifyUpdate(notifyUpdate: Notify.Event.Update)
-
         fun onError(error: Notify.Model.Error)
 
         fun onSubscriptionsChanged(subscriptionsChanged: Notify.Event.SubscriptionsChanged)
@@ -23,51 +14,45 @@ interface NotifyInterface {
 
     fun setDelegate(delegate: Delegate)
 
-    fun subscribe(params: Notify.Params.Subscribe, onSuccess: () -> Unit, onError: (Notify.Model.Error) -> Unit)
-
-    fun update(params: Notify.Params.Update, onSuccess: () -> Unit, onError: (Notify.Model.Error) -> Unit)
-
     /**
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
-    fun getNotificationTypes(params: Notify.Params.NotificationTypes): Map<String, Notify.Model.NotificationType>
+    fun subscribe(params: Notify.Params.Subscribe) : Notify.Result.Subscribe
 
     /**
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
-    fun getActiveSubscriptions(): Map<String, Notify.Model.Subscription>
+    fun updateSubscription(params: Notify.Params.UpdateSubscription) : Notify.Result.UpdateSubscription
 
     /**
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
-    @Deprecated("We renamed this function to getNotificationHistory for consistency")
-    fun getMessageHistory(params: Notify.Params.MessageHistory): Map<Long, Notify.Model.MessageRecord>
-
+    fun deleteSubscription(params: Notify.Params.DeleteSubscription): Notify.Result.DeleteSubscription
 
     /**
      * Caution: This function is blocking and runs on the current thread.
      * It is advised that this function be called from background operation
      */
-    fun getNotificationHistory(params: Notify.Params.NotificationHistory): Map<Long, Notify.Model.NotificationRecord>
-
-    fun deleteSubscription(params: Notify.Params.DeleteSubscription, onSuccess: () -> Unit, onError: (Notify.Model.Error) -> Unit)
+    fun getNotificationTypes(params: Notify.Params.GetNotificationTypes): Map<String, Notify.Model.NotificationType>
 
-    @Deprecated("We renamed this function to deleteNotification for consistency")
-    fun deleteNotifyMessage(params: Notify.Params.DeleteMessage, onSuccess: () -> Unit, onError: (Notify.Model.Error) -> Unit)
+    /**
+     * Caution: This function is blocking and runs on the current thread.
+     * It is advised that this function be called from background operation
+     */
+    fun getActiveSubscriptions(): Map<String, Notify.Model.Subscription>
 
-    fun deleteNotification(params: Notify.Params.DeleteNotification, onSuccess: () -> Unit, onError: (Notify.Model.Error) -> Unit)
+    /**
+     * Caution: This function is blocking and runs on the current thread.
+     * It is advised that this function be called from background operation
+     */
+    fun getNotificationHistory(params: Notify.Params.GetNotificationHistory): Map<Long, Notify.Model.NotificationRecord>
 
-    @Deprecated("We renamed this function to decryptNotification for consistency")
-    fun decryptMessage(params: Notify.Params.DecryptMessage, onSuccess: (Notify.Model.Message.Decrypted) -> Unit, onError: (Notify.Model.Error) -> Unit)
 
     fun decryptNotification(params: Notify.Params.DecryptNotification, onSuccess: (Notify.Model.Notification.Decrypted) -> Unit, onError: (Notify.Model.Error) -> Unit)
 
-    @Deprecated("We changed the registration flow to be more secure. Please use prepareRegistration and register instead")
-    fun register(params: Notify.Params.Registration, onSuccess: (String) -> Unit, onError: (Notify.Model.Error) -> Unit)
-
     fun register(params: Notify.Params.Register, onSuccess: (String) -> Unit, onError: (Notify.Model.Error) -> Unit)
 
     fun prepareRegistration(params: Notify.Params.PrepareRegistration, onSuccess: (Notify.Model.CacaoPayloadWithIdentityPrivateKey, String) -> Unit, onError: (Notify.Model.Error) -> Unit)
@@ -78,5 +63,5 @@ interface NotifyInterface {
      */
     fun isRegistered(params: Notify.Params.IsRegistered): Boolean
 
-    fun unregister(params: Notify.Params.Unregistration, onSuccess: (String) -> Unit, onError: (Notify.Model.Error) -> Unit)
+    fun unregister(params: Notify.Params.Unregister, onSuccess: (String) -> Unit, onError: (Notify.Model.Error) -> Unit)
 }