Merge pull request #182 from synonymdev/feat/restore-settings-screen

feat: Reset and Restore settings

Author: ovitrif

app/src/main/java/to/bitkit/data/AppStorage.kt

@@ -4,34 +4,23 @@ import android.content.Context
 import android.content.SharedPreferences
 import androidx.core.content.edit
 import dagger.hilt.android.qualifiers.ApplicationContext
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.asStateFlow
 import to.bitkit.di.json
 import to.bitkit.models.BalanceState
-import to.bitkit.models.Suggestion
 import to.bitkit.utils.Logger
 import javax.inject.Inject
 import javax.inject.Singleton
 import kotlin.reflect.KProperty
 
 const val APP_PREFS = "bitkit_prefs"
 
-// TODO use dataStore
+// TODO refactor to dataStore (named 'CacheStore'?!)
 @Singleton
 class AppStorage @Inject constructor(
     @ApplicationContext private val appContext: Context,
 ) {
     val sharedPreferences: SharedPreferences
         get() = appContext.getSharedPreferences(APP_PREFS, Context.MODE_PRIVATE)
 
-    private val _removedSuggestionsFlow = MutableStateFlow<List<String>>(emptyList())
-    val removedSuggestionsFlow: Flow<List<String>> = _removedSuggestionsFlow.asStateFlow()
-
-    init {
-        _removedSuggestionsFlow.value = getRemovedSuggestionList()
-    }
-
     var onchainAddress: String by SharedPrefDelegate(Key.ONCHAIN_ADDRESS)
     var bolt11: String by SharedPrefDelegate(Key.BOLT11)
     var bip21: String by SharedPrefDelegate(Key.BIP21)
@@ -57,34 +46,15 @@ class AppStorage @Inject constructor(
         }
     }
 
-    fun addSuggestionToRemovedList(suggestion: Suggestion) {
-        val removedSuggestions =
-            sharedPreferences.getStringSet(Key.REMOVED_SUGGESTION.name, setOf<String>()).orEmpty().toMutableList()
-        if (removedSuggestions.contains(suggestion.name)) return
-
-        removedSuggestions.add(suggestion.name)
-
-        sharedPreferences.edit {
-            putStringSet(Key.REMOVED_SUGGESTION.name, removedSuggestions.toSet())
-        }
-
-        _removedSuggestionsFlow.value = removedSuggestions
-    }
-
-    private fun getRemovedSuggestionList() =
-        sharedPreferences.getStringSet(Key.REMOVED_SUGGESTION.name, setOf<String>()).orEmpty().toList()
-
     enum class Key {
         ONCHAIN_ADDRESS,
         BOLT11,
         BIP21,
         BALANCE,
-        REMOVED_SUGGESTION
     }
 
     fun clear() {
         sharedPreferences.edit { clear() }
-        _removedSuggestionsFlow.value = emptyList()
     }
 }
 

app/src/main/java/to/bitkit/data/SettingsStore.kt

@@ -10,6 +10,7 @@ import kotlinx.serialization.Serializable
 import to.bitkit.data.serializers.SettingsSerializer
 import to.bitkit.models.BitcoinDisplayUnit
 import to.bitkit.models.PrimaryDisplay
+import to.bitkit.models.Suggestion
 import to.bitkit.models.TransactionSpeed
 import to.bitkit.utils.Logger
 import javax.inject.Inject
@@ -44,6 +45,13 @@ class SettingsStore @Inject constructor(
         }
     }
 
+    suspend fun addDismissedSuggestion(suggestion: Suggestion) {
+        store.updateData { currentSettings ->
+            val updatedDismissedSuggestions = (currentSettings.dismissedSuggestions + suggestion.name).distinct()
+            currentSettings.copy(dismissedSuggestions = updatedDismissedSuggestions)
+        }
+    }
+
     suspend fun reset() {
         store.updateData { SettingsData() }
         Logger.info("Deleted all user settings data.")
@@ -82,4 +90,5 @@ data class SettingsData(
     val enableAutoReadClipboard: Boolean = false,
     val enableSendAmountWarning: Boolean = false,
     val backupVerified: Boolean = false,
+    val dismissedSuggestions: List<String> = emptyList(),
 )

app/src/main/java/to/bitkit/data/serializers/SettingsSerializer.kt

@@ -15,7 +15,7 @@ object SettingsSerializer : Serializer<SettingsData> {
         return try {
             json.decodeFromString(input.readBytes().decodeToString())
         } catch (e: SerializationException) {
-            Logger.error("Failed to deserialize settings: $e")
+            Logger.error("Failed to deserialize: $e")
             defaultValue
         }
     }

app/src/main/java/to/bitkit/data/serializers/WidgetsSerializer.kt

@@ -16,7 +16,7 @@ object WidgetsSerializer : Serializer<WidgetsData> {
         return try {
             json.decodeFromString(input.readBytes().decodeToString())
         } catch (e: SerializationException) {
-            Logger.error("Failed to deserialize settings: $e")
+            Logger.error("Failed to deserialize: $e")
             defaultValue
         }
     }

app/src/main/java/to/bitkit/repositories/WalletRepo.kt

@@ -10,7 +10,6 @@ import kotlinx.coroutines.withContext
 import kotlinx.datetime.Clock
 import org.lightningdevkit.ldknode.BalanceDetails
 import org.lightningdevkit.ldknode.Event
-import org.lightningdevkit.ldknode.Network
 import org.lightningdevkit.ldknode.Txid
 import to.bitkit.data.AppDb
 import to.bitkit.data.AppStorage
@@ -47,7 +46,6 @@ class WalletRepo @Inject constructor(
     private val settingsStore: SettingsStore,
     private val addressChecker: AddressChecker,
     private val lightningRepo: LightningRepo,
-    private val network: Network
 ) {
 
     private val _walletState = MutableStateFlow(
@@ -198,10 +196,6 @@ class WalletRepo @Inject constructor(
     }
 
     suspend fun wipeWallet(walletIndex: Int = 0): Result<Unit> = withContext(bgDispatcher) {
-        if (network != Network.REGTEST) {
-            return@withContext Result.failure(Exception("Can only wipe on regtest."))
-        }
-
         try { //TODO CLEAN ACTIVITY'S AND UPDATE STATE. CHECK ActivityListViewModel.removeAllActivities
             keychain.wipe()
             appStorage.clear()

app/src/main/java/to/bitkit/ui/ContentView.kt

@@ -25,7 +25,6 @@ import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
 import androidx.navigation.compose.navigation
 import androidx.navigation.compose.rememberNavController
-import androidx.navigation.navOptions
 import androidx.navigation.toRoute
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.delay
@@ -99,7 +98,7 @@ import to.bitkit.ui.settings.SecuritySettingsScreen
 import to.bitkit.ui.settings.SettingsScreen
 import to.bitkit.ui.settings.backups.BackupNavigationSheet
 import to.bitkit.ui.settings.backups.BackupSheet
-import to.bitkit.ui.settings.backups.RestoreWalletScreen
+import to.bitkit.ui.settings.backups.ResetAndRestoreScreen
 import to.bitkit.ui.settings.general.DefaultUnitSettingsScreen
 import to.bitkit.ui.settings.general.GeneralSettingsScreen
 import to.bitkit.ui.settings.general.LocalCurrencySettingsScreen
@@ -379,7 +378,7 @@ private fun RootNavHost(
         defaultUnitSettings(currencyViewModel, navController)
         localCurrencySettings(currencyViewModel, navController)
         backupSettings(navController)
-        restoreWalletSettings(navController)
+        resetAndRestoreSettings(navController)
         channelOrdersSettings(navController)
         orderDetailSettings(navController)
         cjitDetailSettings(navController)
@@ -780,11 +779,11 @@ private fun NavGraphBuilder.backupSettings(
     }
 }
 
-private fun NavGraphBuilder.restoreWalletSettings(
+private fun NavGraphBuilder.resetAndRestoreSettings(
     navController: NavHostController,
 ) {
-    composableWithDefaultTransitions<Routes.RestoreWalletSettings> {
-        RestoreWalletScreen(navController)
+    composableWithDefaultTransitions<Routes.ResetAndRestoreSettings> {
+        ResetAndRestoreScreen(navController)
     }
 }
 
@@ -1082,10 +1081,15 @@ private fun NavGraphBuilder.widgets(
 // endregion
 
 // region events
-fun NavController.navigateToHome() = navigate(
-    route = Routes.Home,
-    navOptions = navOptions { popUpTo(Routes.Home) }
-)
+fun NavController.navigateToHome() {
+    val popped = popBackStack<Routes.Home>(inclusive = false)
+    if (!popped) {
+        navigate(Routes.Home) {
+            popUpTo(graph.startDestinationId)
+            launchSingleTop = true
+        }
+    }
+}
 
 fun NavController.navigateToSettings() = navigate(
     route = Routes.Settings,
@@ -1151,10 +1155,6 @@ fun NavController.navigateToBackupSettings() = navigate(
     route = Routes.BackupSettings,
 )
 
-fun NavController.navigateToRestoreWalletSettings() = navigate(
-    route = Routes.RestoreWalletSettings,
-)
-
 fun NavController.navigateToChannelOrdersSettings() = navigate(
     route = Routes.ChannelOrdersSettings,
 )
@@ -1319,7 +1319,7 @@ object Routes {
     data object BackupSettings
 
     @Serializable
-    data object RestoreWalletSettings
+    data object ResetAndRestoreSettings
 
     @Serializable
     data object ChannelOrdersSettings

app/src/main/java/to/bitkit/ui/Locals.kt

@@ -28,7 +28,7 @@ val LocalSettingsViewModel = staticCompositionLocalOf<SettingsViewModel?> { null
 
 val appViewModel: AppViewModel?
     @Composable get() = LocalAppViewModel.current
-@Deprecated("Prefer inject the repositories in a specific viewmodel so you don't need to handle a nullable viewmodel")
+
 val walletViewModel: WalletViewModel?
     @Composable get() = LocalWalletViewModel.current
 

app/src/main/java/to/bitkit/ui/MainActivity.kt

@@ -220,14 +220,14 @@ class MainActivity : FragmentActivity() {
                     if (showForgotPinSheet) {
                         ForgotPinSheet(
                             onDismiss = { appViewModel.setShowForgotPin(false) },
-                            onResetClick = { walletViewModel.wipeStorage() },
+                            onResetClick = { walletViewModel.wipeWallet() },
                         )
                     }
 
                     LaunchedEffect(appViewModel) {
                         appViewModel.mainScreenEffect.collect {
                             when (it) {
-                                MainScreenEffect.WipeStorage -> walletViewModel.wipeStorage()
+                                MainScreenEffect.WipeWallet -> walletViewModel.wipeWallet()
                                 else -> Unit
                             }
                         }

app/src/main/java/to/bitkit/ui/components/AuthCheckScreen.kt

@@ -4,6 +4,7 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import androidx.navigation.NavController
+import androidx.navigation.navOptions
 import to.bitkit.ui.Routes
 import to.bitkit.ui.appViewModel
 import to.bitkit.ui.settingsViewModel
@@ -31,26 +32,36 @@ fun AuthCheckScreen(
             when (route.onSuccessActionId) {
                 AuthCheckAction.TOGGLE_BIOMETRICS -> {
                     settings.setIsBiometricEnabled(!isBiometricEnabled)
+                    navController.popBackStack()
                 }
 
                 AuthCheckAction.TOGGLE_PIN_ON_LAUNCH -> {
                     settings.setIsPinOnLaunchEnabled(!isPinOnLaunchEnabled)
+                    navController.popBackStack()
                 }
 
                 AuthCheckAction.TOGGLE_PIN_ON_IDLE -> {
                     settings.setIsPinOnIdleEnabled(!isPinOnIdleEnabled)
+                    navController.popBackStack()
                 }
 
                 AuthCheckAction.TOGGLE_PIN_FOR_PAYMENTS -> {
                     settings.setIsPinForPaymentsEnabled(!isPinForPaymentsEnabled)
+                    navController.popBackStack()
                 }
 
                 AuthCheckAction.DISABLE_PIN -> {
                     app.removePin()
+                    navController.popBackStack()
                 }
-            }
 
-            navController.popBackStack()
+                AuthCheckAction.NAV_TO_RESET -> {
+                    navController.navigate(
+                        route = Routes.ResetAndRestoreSettings,
+                        navOptions = navOptions { popUpTo(Routes.BackupSettings) }
+                    )
+                }
+            }
         },
         onBack = { navController.popBackStack() },
     )
@@ -62,4 +73,5 @@ object AuthCheckAction {
     const val TOGGLE_PIN_ON_IDLE = "TOGGLE_PIN_ON_IDLE"
     const val TOGGLE_PIN_FOR_PAYMENTS = "TOGGLE_PIN_FOR_PAYMENTS"
     const val DISABLE_PIN = "DISABLE_PIN"
+    const val NAV_TO_RESET = "NAV_TO_RESET"
 }

app/src/main/java/to/bitkit/ui/components/SheetHost.kt

@@ -1,5 +1,6 @@
 package to.bitkit.ui.components
 
+import androidx.activity.compose.BackHandler
 import androidx.compose.animation.core.animateFloatAsState
 import androidx.compose.animation.core.tween
 import androidx.compose.foundation.background
@@ -88,6 +89,15 @@ fun SheetHost(
         ) {
             content()
 
+            // Dismiss on back
+            BackHandler(enabled = scaffoldState.bottomSheetState.isVisible) {
+                println("SheetHost: BackHandler - trigger")
+                scope.launch {
+                    scaffoldState.bottomSheetState.hide()
+                    onDismiss()
+                }
+            }
+
             Scrim(scaffoldState.bottomSheetState) {
                 scope.launch {
                     scaffoldState.bottomSheetState.hide()