fix: improve the distinction between hw-wo and wo wallets

Author: angelix

…am/common/data/HwWatchOnlyCredentials.kt …mon/data/MultipleWatchOnlyCredentials.ktcommon/src/commonMain/kotlin/com/blockstream/common/data/HwWatchOnlyCredentials.kt renamed to common/src/commonMain/kotlin/com/blockstream/common/data/MultipleWatchOnlyCredentials.kt common/src/commonMain/kotlin/com/blockstream/common/data/HwWatchOnlyCredentials.kt renamed to common/src/commonMain/kotlin/com/blockstream/common/data/MultipleWatchOnlyCredentials.kt

@@ -7,23 +7,27 @@ import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.Json
 
 @Serializable
-data class HwWatchOnlyCredentials constructor(
+data class MultipleWatchOnlyCredentials constructor(
     @SerialName("credentials")
     val credentials: Map<String, WatchOnlyCredentials> = emptyMap(),
-) : GreenJson<HwWatchOnlyCredentials>() {
+) : GreenJson<MultipleWatchOnlyCredentials>() {
     override fun encodeDefaultsValues() = false
 
     override fun kSerializer() = serializer()
 
-    fun toLoginCredentials() = LoginCredentialsParams(hwWatchOnlyCredentials = this)
+    fun toLoginCredentials() = LoginCredentialsParams(multipleWatchOnlyCredentials = this)
 
-    companion object {
-        fun fromByteArray(byteArray: ByteArray): HwWatchOnlyCredentials {
+    fun isHwWatchOnly() = credentials.values.all { it.username.isNullOrBlank() && it.password.isNullOrBlank() }
+
+    fun isCoreDescriptors() = credentials.values.all { it.coreDescriptors != null }
+
+    companion object Companion {
+        fun fromByteArray(byteArray: ByteArray): MultipleWatchOnlyCredentials {
             return Json.decodeFromString(byteArray.decodeToString())
         }
 
-        fun fromWatchOnlyCredentials(network: String, watchOnlyCredentials: WatchOnlyCredentials): HwWatchOnlyCredentials {
-            return HwWatchOnlyCredentials(
+        fun fromWatchOnlyCredentials(network: String, watchOnlyCredentials: WatchOnlyCredentials): MultipleWatchOnlyCredentials {
+            return MultipleWatchOnlyCredentials(
                 mapOf(network to watchOnlyCredentials)
             )
         }

common/src/commonMain/kotlin/com/blockstream/common/gdk/GdkSession.kt

@@ -18,8 +18,8 @@ import com.blockstream.common.data.Denomination
 import com.blockstream.common.data.EnrichedAsset
 import com.blockstream.common.data.ExceptionWithSupportData
 import com.blockstream.common.data.GreenWallet
-import com.blockstream.common.data.HwWatchOnlyCredentials
 import com.blockstream.common.data.LogoutReason
+import com.blockstream.common.data.MultipleWatchOnlyCredentials
 import com.blockstream.common.data.RichWatchOnly
 import com.blockstream.common.data.SupportData
 import com.blockstream.common.database.wallet.LoginCredentials
@@ -1273,12 +1273,12 @@ class GdkSession constructor(
     suspend fun loginWatchOnly(
         wallet: GreenWallet,
         loginCredentials: LoginCredentials? = null,
-        watchOnlyCredentials: HwWatchOnlyCredentials
+        watchOnlyCredentials: MultipleWatchOnlyCredentials
     ) {
         loginWatchOnly(network = prominentNetwork(wallet, loginCredentials), wallet = wallet, watchOnlyCredentials = watchOnlyCredentials)
     }
 
-    suspend fun loginWatchOnly(network: Network, wallet: GreenWallet?, watchOnlyCredentials: HwWatchOnlyCredentials): LoginData {
+    suspend fun loginWatchOnly(network: Network, wallet: GreenWallet?, watchOnlyCredentials: MultipleWatchOnlyCredentials): LoginData {
         return loginWatchOnly(
             network = network,
             wallet = wallet,
@@ -1303,7 +1303,7 @@ class GdkSession constructor(
 
     // WO Login
     private suspend fun loginWatchOnly(network: Network, wallet: GreenWallet?, loginCredentialsParams: LoginCredentialsParams): LoginData {
-        val initNetworks = loginCredentialsParams.hwWatchOnlyCredentials?.credentials?.keys?.map {
+        val initNetworks = loginCredentialsParams.multipleWatchOnlyCredentials?.credentials?.keys?.map {
             networkBy(it)
         } ?: listOf(network)
 
@@ -1373,13 +1373,13 @@ class GdkSession constructor(
 
         // TODO move all to StateFlow
         // Warning, ordering matters for SecurityScreen
-        isHwWatchOnly = walletLoginCredentialsParams.hwWatchOnlyCredentials != null
+        isHwWatchOnly = walletLoginCredentialsParams.multipleWatchOnlyCredentials?.isHwWatchOnly() == true
         _isWatchOnly.value = walletLoginCredentialsParams.isWatchOnly
 
         isNoBlobWatchOnly = isWatchOnlyValue && richWatchOnly == null
         isRichWatchOnly = isWatchOnlyValue && richWatchOnly != null
         isCoreDescriptorWatchOnly =
-            isWatchOnlyValue && (walletLoginCredentialsParams.coreDescriptors != null || walletLoginCredentialsParams.hwWatchOnlyCredentials != null)
+            isWatchOnlyValue && (walletLoginCredentialsParams.coreDescriptors != null || walletLoginCredentialsParams.multipleWatchOnlyCredentials?.isCoreDescriptors() == true)
         isAirgapped = isWatchOnlyValue && wallet?.isHardware ?: false
 
         setupDeviceToSession(device)

common/src/commonMain/kotlin/com/blockstream/common/gdk/params/LoginCredentialsParams.kt

@@ -1,6 +1,6 @@
 package com.blockstream.common.gdk.params
 
-import com.blockstream.common.data.HwWatchOnlyCredentials
+import com.blockstream.common.data.MultipleWatchOnlyCredentials
 import com.blockstream.common.gdk.GreenJson
 import com.blockstream.common.gdk.data.Credentials
 import com.blockstream.common.gdk.data.PinData
@@ -29,7 +29,7 @@ data class LoginCredentialsParams @OptIn(ExperimentalSerializationApi::class) co
     @SerialName("core_descriptors")
     val coreDescriptors: List<String>? = null,
     @SerialName("hwWatchOnlyCredentials")
-    val hwWatchOnlyCredentials: HwWatchOnlyCredentials? = null, // this value is not used by GDK, only from the app
+    val multipleWatchOnlyCredentials: MultipleWatchOnlyCredentials? = null, // this value is not used by GDK, only from the app
     @SerialName("slip132_extended_pubkeys")
     val slip132ExtendedPubkeys: List<String>? = null,
 ) : GreenJson<LoginCredentialsParams>() {
@@ -38,10 +38,10 @@ data class LoginCredentialsParams @OptIn(ExperimentalSerializationApi::class) co
     override fun kSerializer() = serializer()
 
     val isWatchOnly
-        get() = !username.isNullOrBlank() || !slip132ExtendedPubkeys.isNullOrEmpty() || !coreDescriptors.isNullOrEmpty() || hwWatchOnlyCredentials != null
+        get() = !username.isNullOrBlank() || !slip132ExtendedPubkeys.isNullOrEmpty() || !coreDescriptors.isNullOrEmpty() || multipleWatchOnlyCredentials != null
 
     fun hwWatchOnlyCredentialsToLoginCredentialsParams(network: String): LoginCredentialsParams? {
-        return hwWatchOnlyCredentials?.credentials?.get(network)?.toLoginCredentials()
+        return multipleWatchOnlyCredentials?.credentials?.get(network)?.toLoginCredentials()
     }
 
     companion object {

common/src/commonMain/kotlin/com/blockstream/common/models/GreenViewModel.kt

@@ -22,8 +22,8 @@ import com.blockstream.common.data.Denomination
 import com.blockstream.common.data.DeviceIdentifier
 import com.blockstream.common.data.EncryptedData
 import com.blockstream.common.data.GreenWallet
-import com.blockstream.common.data.HwWatchOnlyCredentials
 import com.blockstream.common.data.LogoutReason
+import com.blockstream.common.data.MultipleWatchOnlyCredentials
 import com.blockstream.common.data.Promo
 import com.blockstream.common.data.Redact
 import com.blockstream.common.data.SupportData
@@ -1032,7 +1032,7 @@ open class GreenViewModel constructor(
             val loginData = session.loginWatchOnly(
                 network = network,
                 wallet = null,
-                watchOnlyCredentials = HwWatchOnlyCredentials.fromWatchOnlyCredentials(
+                watchOnlyCredentials = MultipleWatchOnlyCredentials.fromWatchOnlyCredentials(
                     network = network.id,
                     watchOnlyCredentials = watchOnlyCredentials
                 )
@@ -1114,7 +1114,7 @@ open class GreenViewModel constructor(
             session.loginWatchOnly(
                 network = network,
                 wallet = wallet,
-                watchOnlyCredentials = HwWatchOnlyCredentials.fromWatchOnlyCredentials(
+                watchOnlyCredentials = MultipleWatchOnlyCredentials.fromWatchOnlyCredentials(
                     network = network.id,
                     watchOnlyCredentials = watchOnlyCredentials
                 )

common/src/commonMain/kotlin/com/blockstream/common/models/login/LoginViewModel.kt

@@ -22,8 +22,8 @@ import com.blockstream.common.data.ApplicationSettings
 import com.blockstream.common.data.CredentialType
 import com.blockstream.common.data.DataState
 import com.blockstream.common.data.GreenWallet
-import com.blockstream.common.data.HwWatchOnlyCredentials
 import com.blockstream.common.data.LogoutReason
+import com.blockstream.common.data.MultipleWatchOnlyCredentials
 import com.blockstream.common.data.Redact
 import com.blockstream.common.data.SetupArgs
 import com.blockstream.common.data.SupportData
@@ -743,7 +743,7 @@ class LoginViewModel constructor(
                     val watchOnlyCredentials = (greenKeystore.decryptData(encryptedData).let {
                         when (loginCredentials.credential_type) {
                             CredentialType.KEYSTORE_PASSWORD -> {
-                                HwWatchOnlyCredentials.fromWatchOnlyCredentials(
+                                MultipleWatchOnlyCredentials.fromWatchOnlyCredentials(
                                     network = loginCredentials.network,
                                     watchOnlyCredentials = WatchOnlyCredentials(
                                         username = greenWallet.watchOnlyUsername ?: "",
@@ -753,11 +753,11 @@ class LoginViewModel constructor(
                             }
 
                             CredentialType.KEYSTORE_HW_WATCHONLY_CREDENTIALS -> {
-                                HwWatchOnlyCredentials.fromByteArray(it)
+                                MultipleWatchOnlyCredentials.fromByteArray(it)
                             }
 
                             else -> {
-                                HwWatchOnlyCredentials.fromWatchOnlyCredentials(
+                                MultipleWatchOnlyCredentials.fromWatchOnlyCredentials(
                                     network = loginCredentials.network,
                                     watchOnlyCredentials = WatchOnlyCredentials.fromByteArray(it)
                                 )
@@ -780,7 +780,7 @@ class LoginViewModel constructor(
             session.loginWatchOnly(
                 wallet = greenWallet,
                 loginCredentials = loginCredentials,
-                watchOnlyCredentials = HwWatchOnlyCredentials.fromWatchOnlyCredentials(
+                watchOnlyCredentials = MultipleWatchOnlyCredentials.fromWatchOnlyCredentials(
                     network = loginCredentials.network,
                     watchOnlyCredentials = watchOnlyCredentials.let {
                         greenWallet.watchOnlyUsername?.takeIf { it.isNotBlank() }?.let { username ->
@@ -848,7 +848,7 @@ class LoginViewModel constructor(
         login(loginCredentials = null, isWatchOnly = true, updateWatchOnlyPassword = !greenWallet.isWatchOnlySingleSig) {
             session.loginWatchOnly(
                 wallet = greenWallet,
-                watchOnlyCredentials = HwWatchOnlyCredentials.fromWatchOnlyCredentials(
+                watchOnlyCredentials = MultipleWatchOnlyCredentials.fromWatchOnlyCredentials(
                     network = greenWallet.activeNetwork,
                     watchOnlyCredentials = WatchOnlyCredentials(
                         username = watchOnlyUsername.value,

common/src/commonMain/kotlin/com/blockstream/common/usecases/EnableHardwareWatchOnlyUseCase.kt

@@ -3,7 +3,7 @@ package com.blockstream.common.usecases
 import com.blockstream.common.crypto.GreenKeystore
 import com.blockstream.common.data.CredentialType
 import com.blockstream.common.data.GreenWallet
-import com.blockstream.common.data.HwWatchOnlyCredentials
+import com.blockstream.common.data.MultipleWatchOnlyCredentials
 import com.blockstream.common.data.WatchOnlyCredentials
 import com.blockstream.common.database.Database
 import com.blockstream.common.extensions.createLoginCredentials
@@ -34,24 +34,24 @@ class EnableHardwareWatchOnlyUseCase(
             // Wait for setup to gets completed so that the active account is set
             session.setupDefaultAccounts().join()
 
-            val hwWatchOnlyCredentials =
+            val multipleWatchOnlyCredentials =
                 session.accounts.value.filter { it.isSinglesig && !it.hidden }.groupBy { it.network }.mapValues {
                     it.value.map {
                         session.getAccount(it).coreDescriptors ?: emptyList()
                     }.flatten()
                 }.map {
                     it.key.id to WatchOnlyCredentials(coreDescriptors = it.value)
                 }.toMap().let {
-                    HwWatchOnlyCredentials(credentials = it)
+                    MultipleWatchOnlyCredentials(credentials = it)
                 }
 
-            if (hwWatchOnlyCredentials.credentials.isEmpty()) {
+            if (multipleWatchOnlyCredentials.credentials.isEmpty()) {
                 logger.d { "Empty hwWatchOnlyCredentials" }
                 return
             }
 
             val encryptedData = greenKeystore.encryptData(
-                hwWatchOnlyCredentials.toJson().encodeToByteArray()
+                multipleWatchOnlyCredentials.toJson().encodeToByteArray()
             )
 
             logger.d { "Creating HW Watch-only credentials" }