feat: add logs

thunderbiscuit · thunderbiscuit · commit d0f0bdf5fbeb · 2025-03-02T23:07:40.000-05:00
diff --git a/app/src/main/java/org/bitcoindevkit/devkitwallet/domain/DwLogger.kt b/app/src/main/java/org/bitcoindevkit/devkitwallet/domain/DwLogger.kt
@@ -5,17 +5,27 @@
 
 package org.bitcoindevkit.devkitwallet.domain
 
+import java.time.Instant
+import java.time.ZoneId
+import java.time.temporal.ChronoUnit
+
 object DwLogger {
     private const val MAX_LOGS = 5000
     private val logEntries = ArrayDeque<String>(MAX_LOGS)
     private val lock = Any()
 
-    fun log(tag: String, message: String) {
+    fun log(tag: LogLevel, message: String) {
         synchronized(lock) {
             if (logEntries.size >= MAX_LOGS) {
                 logEntries.removeLast()
             }
-            logEntries.addFirst("${System.currentTimeMillis()} [$tag]: $message")
+            val millis = System.currentTimeMillis()
+            val dateTime = Instant.ofEpochMilli(millis)
+                .atZone(ZoneId.systemDefault())
+                .toLocalDateTime()
+                .truncatedTo(ChronoUnit.SECONDS)
+
+            logEntries.addFirst("$dateTime $tag $message")
         }
     }
 
@@ -24,4 +34,18 @@ object DwLogger {
             return logEntries.toList()
         }
     }
+
+    enum class LogLevel {
+        INFO,
+        WARN,
+        ERROR;
+
+        override fun toString(): String {
+            return when (this) {
+                INFO ->  "[INFO] "
+                WARN ->  "[WARN] "
+                ERROR -> "[ERROR]"
+            }
+        }
+    }
 }
diff --git a/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/DevkitWalletActivity.kt b/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/DevkitWalletActivity.kt
@@ -21,6 +21,7 @@ import org.bitcoindevkit.devkitwallet.data.SingleWallet
 import org.bitcoindevkit.devkitwallet.data.UserPreferences
 import org.bitcoindevkit.devkitwallet.data.UserPreferencesSerializer
 import org.bitcoindevkit.devkitwallet.domain.DwLogger
+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO
 import org.bitcoindevkit.devkitwallet.domain.UserPreferencesRepository
 import org.bitcoindevkit.devkitwallet.domain.Wallet
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
@@ -42,7 +43,7 @@ class DevkitWalletActivity : AppCompatActivity() {
         super.onCreate(savedInstanceState)
 
         // Initialize Devkit Wallet Logger (used in the LogsScreen)
-        DwLogger.log("INFO", "Devkit Wallet app started")
+        DwLogger.log(INFO, "Devkit Wallet app started")
 
         val userPreferencesRepository = UserPreferencesRepository(userPreferencesStore)
         val onBuildWalletButtonClicked: (WalletCreateType) -> Unit = { walletCreateType ->
@@ -96,7 +97,7 @@ class DevkitWalletActivity : AppCompatActivity() {
 
             setContent {
                 if (!onboardingDone) {
-                    DwLogger.log("INFO", "First time opening the app, triggering onboarding screen")
+                    DwLogger.log(INFO, "First time opening the app, triggering onboarding screen")
                     OnboardingScreen(onFinishOnboarding)
                 } else {
                     DevkitTheme {
diff --git a/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/ui/screens/intro/ActiveWalletsScreen.kt b/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/ui/screens/intro/ActiveWalletsScreen.kt
@@ -25,6 +25,8 @@ import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import androidx.navigation.NavController
 import org.bitcoindevkit.devkitwallet.data.SingleWallet
+import org.bitcoindevkit.devkitwallet.domain.DwLogger
+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO
 import org.bitcoindevkit.devkitwallet.presentation.WalletCreateType
 import org.bitcoindevkit.devkitwallet.presentation.theme.DevkitWalletColors
 import org.bitcoindevkit.devkitwallet.presentation.theme.quattroRegular
@@ -81,7 +83,10 @@ fun ActiveWalletCard(wallet: SingleWallet, onBuildWalletButtonClicked: (WalletCr
             )
             // Padding inside the card
             .padding(horizontal = 4.dp, vertical = 8.dp)
-            .clickable { onBuildWalletButtonClicked(WalletCreateType.LOADEXISTING(wallet)) },
+            .clickable {
+                DwLogger.log(INFO, "Activating existing wallet: ${wallet.name}")
+                onBuildWalletButtonClicked(WalletCreateType.LOADEXISTING(wallet))
+            },
         verticalArrangement = Arrangement.SpaceBetween,
         horizontalAlignment = Alignment.Start
     ) {
diff --git a/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/ui/screens/intro/CreateNewWallet.kt b/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/ui/screens/intro/CreateNewWallet.kt
@@ -31,6 +31,8 @@ import androidx.navigation.NavController
 import org.bitcoindevkit.Network
 import org.bitcoindevkit.devkitwallet.data.ActiveWalletScriptType
 import org.bitcoindevkit.devkitwallet.data.NewWalletConfig
+import org.bitcoindevkit.devkitwallet.domain.DwLogger
+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO
 import org.bitcoindevkit.devkitwallet.presentation.WalletCreateType
 import org.bitcoindevkit.devkitwallet.presentation.theme.DevkitWalletColors
 import org.bitcoindevkit.devkitwallet.presentation.theme.monoRegular
@@ -126,9 +128,8 @@ internal fun CreateNewWalletScreen(
                             network = selectedNetwork.value,
                             scriptType = selectedScriptType.value
                         )
-                        onBuildWalletButtonClicked(
-                            WalletCreateType.FROMSCRATCH(newWalletConfig)
-                        )
+                        DwLogger.log(INFO, "Creating new wallet named ${newWalletConfig.name}")
+                        onBuildWalletButtonClicked(WalletCreateType.FROMSCRATCH(newWalletConfig))
                     }
                 )
             }
diff --git a/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/ui/screens/intro/RecoverWalletScreen.kt b/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/ui/screens/intro/RecoverWalletScreen.kt
@@ -49,6 +49,8 @@ import org.bitcoindevkit.Mnemonic
 import org.bitcoindevkit.Network
 import org.bitcoindevkit.devkitwallet.data.ActiveWalletScriptType
 import org.bitcoindevkit.devkitwallet.data.RecoverWalletConfig
+import org.bitcoindevkit.devkitwallet.domain.DwLogger
+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO
 import org.bitcoindevkit.devkitwallet.domain.bip39WordList
 import org.bitcoindevkit.devkitwallet.domain.createScriptAppropriateDescriptor
 import org.bitcoindevkit.devkitwallet.presentation.WalletCreateType
@@ -228,6 +230,7 @@ internal fun RecoverWalletScreen(onAction: (WalletCreateType) -> Unit, navContro
                                 changeDescriptor = changeDescriptor,
                                 recoveryPhrase = parsingResult.recoveryPhrase
                             )
+                            DwLogger.log(INFO, "Recovering wallet with recovery phrase (name: $walletName)")
                             onAction(WalletCreateType.RECOVER(recoverWalletConfig))
                         }
                     }
@@ -244,6 +247,7 @@ internal fun RecoverWalletScreen(onAction: (WalletCreateType) -> Unit, navContro
                             changeDescriptor = changeDescriptor,
                             recoveryPhrase = null
                         )
+                        DwLogger.log(INFO, "Recovering wallet with descriptors (name: $walletName)")
                         onAction(WalletCreateType.RECOVER(recoverWalletConfig))
                     }
                 }
diff --git a/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/viewmodels/AddressViewModel.kt b/app/src/main/java/org/bitcoindevkit/devkitwallet/presentation/viewmodels/AddressViewModel.kt
@@ -10,6 +10,8 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
 import androidx.lifecycle.ViewModel
 import org.bitcoindevkit.AddressInfo
+import org.bitcoindevkit.devkitwallet.domain.DwLogger
+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO
 import org.bitcoindevkit.devkitwallet.domain.Wallet
 import org.bitcoindevkit.devkitwallet.presentation.viewmodels.mvi.ReceiveScreenAction
 import org.bitcoindevkit.devkitwallet.presentation.viewmodels.mvi.ReceiveScreenState
@@ -26,6 +28,8 @@ internal class AddressViewModel(private val wallet: Wallet) : ViewModel() {
 
     private fun updateAddress() {
         val newAddress: AddressInfo = wallet.getNewAddress()
+        DwLogger.log(INFO, "Revealing new address at index ${newAddress.index}")
+
         state = ReceiveScreenState(
             address = newAddress.address.toString(),
             addressIndex = newAddress.index

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ import androidx.navigation.NavController`
`31`	`31`	`import org.bitcoindevkit.Network`
`32`	`32`	`import org.bitcoindevkit.devkitwallet.data.ActiveWalletScriptType`
`33`	`33`	`import org.bitcoindevkit.devkitwallet.data.NewWalletConfig`
	`34`	`+import org.bitcoindevkit.devkitwallet.domain.DwLogger`
	`35`	`+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO`
`34`	`36`	`import org.bitcoindevkit.devkitwallet.presentation.WalletCreateType`
`35`	`37`	`import org.bitcoindevkit.devkitwallet.presentation.theme.DevkitWalletColors`
`36`	`38`	`import org.bitcoindevkit.devkitwallet.presentation.theme.monoRegular`
`@@ -126,9 +128,8 @@ internal fun CreateNewWalletScreen(`
`126`	`128`	`network = selectedNetwork.value,`
`127`	`129`	`scriptType = selectedScriptType.value`
`128`	`130`	`)`
`129`		`- onBuildWalletButtonClicked(`
`130`		`- WalletCreateType.FROMSCRATCH(newWalletConfig)`
`131`		`- )`
	`131`	`+ DwLogger.log(INFO, "Creating new wallet named ${newWalletConfig.name}")`
	`132`	`+ onBuildWalletButtonClicked(WalletCreateType.FROMSCRATCH(newWalletConfig))`
`132`	`133`	`}`
`133`	`134`	`)`
`134`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ import org.bitcoindevkit.Mnemonic`
`49`	`49`	`import org.bitcoindevkit.Network`
`50`	`50`	`import org.bitcoindevkit.devkitwallet.data.ActiveWalletScriptType`
`51`	`51`	`import org.bitcoindevkit.devkitwallet.data.RecoverWalletConfig`
	`52`	`+import org.bitcoindevkit.devkitwallet.domain.DwLogger`
	`53`	`+import org.bitcoindevkit.devkitwallet.domain.DwLogger.LogLevel.INFO`
`52`	`54`	`import org.bitcoindevkit.devkitwallet.domain.bip39WordList`
`53`	`55`	`import org.bitcoindevkit.devkitwallet.domain.createScriptAppropriateDescriptor`
`54`	`56`	`import org.bitcoindevkit.devkitwallet.presentation.WalletCreateType`
`@@ -228,6 +230,7 @@ internal fun RecoverWalletScreen(onAction: (WalletCreateType) -> Unit, navContro`
`228`	`230`	`changeDescriptor = changeDescriptor,`
`229`	`231`	`recoveryPhrase = parsingResult.recoveryPhrase`
`230`	`232`	`)`
	`233`	`+ DwLogger.log(INFO, "Recovering wallet with recovery phrase (name: $walletName)")`
`231`	`234`	`onAction(WalletCreateType.RECOVER(recoverWalletConfig))`
`232`	`235`	`}`
`233`	`236`	`}`
`@@ -244,6 +247,7 @@ internal fun RecoverWalletScreen(onAction: (WalletCreateType) -> Unit, navContro`
`244`	`247`	`changeDescriptor = changeDescriptor,`
`245`	`248`	`recoveryPhrase = null`
`246`	`249`	`)`
	`250`	`+ DwLogger.log(INFO, "Recovering wallet with descriptors (name: $walletName)")`
`247`	`251`	`onAction(WalletCreateType.RECOVER(recoverWalletConfig))`
`248`	`252`	`}`
`249`	`253`	`}`