feat: rename InvoiceTagEntity.kt to TagMetadataEntity.kt and add more parameters

Author: jvsena42

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

@@ -19,22 +19,22 @@ import dagger.assisted.AssistedInject
 import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.flow.Flow
 import to.bitkit.BuildConfig
-import to.bitkit.data.dao.InvoiceTagDao
+import to.bitkit.data.dao.TagMetadataDao
 import to.bitkit.data.entities.ConfigEntity
-import to.bitkit.data.entities.InvoiceTagEntity
+import to.bitkit.data.entities.TagMetadataEntity
 import to.bitkit.data.typeConverters.StringListConverter
 
 @Database(
     entities = [
         ConfigEntity::class,
-        InvoiceTagEntity::class,
+        TagMetadataEntity::class,
     ],
-    version = 2,
+    version = 3,
 )
 @TypeConverters(StringListConverter::class)
 abstract class AppDb : RoomDatabase() {
     abstract fun configDao(): ConfigDao
-    abstract fun invoiceTagDao(): InvoiceTagDao
+    abstract fun tagMetadataDao(): TagMetadataDao
 
     companion object {
         private const val DB_NAME = "${BuildConfig.APPLICATION_ID}.sqlite"

app/src/main/java/to/bitkit/data/dao/InvoiceTagDao.kt

@@ -0,0 +1,60 @@
+package to.bitkit.data.dao
+
+import androidx.room.Dao
+import androidx.room.Delete
+import androidx.room.Insert
+import androidx.room.OnConflictStrategy
+import androidx.room.Query
+import to.bitkit.data.entities.TagMetadataEntity
+
+@Dao
+interface TagMetadataDao {
+
+    @Insert(onConflict = OnConflictStrategy.REPLACE)
+    suspend fun saveTagMetadata(tagMetadata: TagMetadataEntity)
+
+    @Query("SELECT * FROM tag_metadata")
+    suspend fun getAll(): List<TagMetadataEntity>
+
+    // Search by payment hash (for invoices)
+    @Query("SELECT * FROM tag_metadata WHERE paymentHash = :paymentHash LIMIT 1")
+    suspend fun searchByPaymentHash(paymentHash: String): TagMetadataEntity?
+
+    // Search by transaction ID
+    @Query("SELECT * FROM tag_metadata WHERE txId = :txId LIMIT 1")
+    suspend fun searchByTxId(txId: String): TagMetadataEntity?
+
+    // Search by address
+    @Query("SELECT * FROM tag_metadata WHERE address = :address")
+    suspend fun searchByAddress(address: String): List<TagMetadataEntity>
+
+    // Search by primary key (id)
+    @Query("SELECT * FROM tag_metadata WHERE id = :id LIMIT 1")
+    suspend fun searchById(id: String): TagMetadataEntity?
+
+    // Get all receive transactions
+    @Query("SELECT * FROM tag_metadata WHERE isReceive = 1")
+    suspend fun getAllReceiveTransactions(): List<TagMetadataEntity>
+
+    // Get all send transactions
+    @Query("SELECT * FROM tag_metadata WHERE isReceive = 0")
+    suspend fun getAllSendTransactions(): List<TagMetadataEntity>
+
+    @Delete
+    suspend fun deleteTagMetadata(tagMetadata: TagMetadataEntity)
+
+    @Query("DELETE FROM tag_metadata WHERE paymentHash = :paymentHash")
+    suspend fun deleteByPaymentHash(paymentHash: String)
+
+    @Query("DELETE FROM tag_metadata WHERE txId = :txId")
+    suspend fun deleteByTxId(txId: String)
+
+    @Query("DELETE FROM tag_metadata WHERE id = :id")
+    suspend fun deleteById(id: String)
+
+    @Query("DELETE FROM tag_metadata")
+    suspend fun deleteAll()
+
+    @Query("DELETE FROM tag_metadata WHERE createdAt < :expirationTimeStamp")
+    suspend fun deleteExpired(expirationTimeStamp: Long)
+}

app/src/main/java/to/bitkit/data/dao/TagMetadataDao.kt

@@ -0,0 +1,21 @@
+package to.bitkit.data.entities
+
+import androidx.room.Entity
+import androidx.room.PrimaryKey
+
+@Entity(tableName = "tag_metadata")
+/**
+ * @param id This will be paymentHash, txId, or address depending on context
+ * @param txId on-chain transaction id
+ * @param address on-chain address
+ * @param isReceive true for receive, false for send
+ * */
+data class TagMetadataEntity(
+    @PrimaryKey val id: String,
+    val paymentHash: String? = null,
+    val txId: String? = null,
+    val address: String,
+    val isReceive: Boolean,
+    val tags: List<String>,
+    val createdAt: Long,
+)

app/src/main/java/to/bitkit/data/entities/InvoiceTagEntity.kt

@@ -20,7 +20,7 @@ import org.lightningdevkit.ldknode.Txid
 import to.bitkit.data.AppDb
 import to.bitkit.data.CacheStore
 import to.bitkit.data.SettingsStore
-import to.bitkit.data.entities.InvoiceTagEntity
+import to.bitkit.data.entities.TagMetadataEntity
 import to.bitkit.data.keychain.Keychain
 import to.bitkit.di.BgDispatcher
 import to.bitkit.env.Env
@@ -440,10 +440,12 @@ class WalletRepo @Inject constructor(
             }
 
             paymentHashOrAddress?.let {
-                db.invoiceTagDao().saveInvoice(
-                    invoiceTag = InvoiceTagEntity(
-                        paymentHash = paymentHashOrAddress,
+                db.tagMetadataDao().saveTagMetadata(
+                    tagMetadata = TagMetadataEntity(
+                        id = paymentHashOrAddress,
                         tags = tags,
+                        address = "",
+                        isReceive = true,
                         createdAt = System.currentTimeMillis()
                     )
                 )
@@ -453,17 +455,18 @@ class WalletRepo @Inject constructor(
         }
     }
 
-    suspend fun getAllInvoiceTags() : Result<List<InvoiceTagEntity>> = withContext(bgDispatcher) {
+    suspend fun getAllInvoiceTags(): Result<List<TagMetadataEntity>> = withContext(bgDispatcher) {
         return@withContext runCatching {
-            db.invoiceTagDao().getAll()
+            db.tagMetadataDao().getAll()
         }
     }
 
-    suspend fun searchInvoice(txId: Txid): Result<InvoiceTagEntity> = withContext(bgDispatcher) {
+    suspend fun searchInvoiceByPaymentHash(paymentHash: String): Result<TagMetadataEntity> = withContext(bgDispatcher) {
         return@withContext try {
-            val invoiceTag = db.invoiceTagDao().searchInvoice(paymentHash = txId) ?: return@withContext Result.failure(
-                Exception("Invoice not found")
-            )
+            val invoiceTag =
+                db.tagMetadataDao().searchByPaymentHash(paymentHash = paymentHash) ?: return@withContext Result.failure(
+                    Exception("Invoice not found")
+                )
             Result.success(invoiceTag)
         } catch (e: Throwable) {
             Logger.error("searchInvoice error", e, context = TAG)
@@ -473,15 +476,15 @@ class WalletRepo @Inject constructor(
 
     suspend fun deleteInvoice(txId: Txid) = withContext(bgDispatcher) {
         try {
-            db.invoiceTagDao().deleteInvoiceByPaymentHash(paymentHash = txId)
+            db.tagMetadataDao().deleteByPaymentHash(paymentHash = txId)
         } catch (e: Throwable) {
             Logger.error("deleteInvoice error", e, context = TAG)
         }
     }
 
     suspend fun deleteAllInvoices() = withContext(bgDispatcher) {
         try {
-            db.invoiceTagDao().deleteAllInvoices()
+            db.tagMetadataDao().deleteAll()
         } catch (e: Throwable) {
             Logger.error("deleteAllInvoices error", e, context = TAG)
         }
@@ -490,7 +493,7 @@ class WalletRepo @Inject constructor(
     suspend fun deleteExpiredInvoices() = withContext(bgDispatcher) {
         try {
             val twoDaysAgoMillis = Clock.System.now().minus(2.days).toEpochMilliseconds()
-            db.invoiceTagDao().deleteExpiredInvoices(expirationTimeStamp = twoDaysAgoMillis)
+            db.tagMetadataDao().deleteExpired(expirationTimeStamp = twoDaysAgoMillis)
         } catch (e: Throwable) {
             Logger.error("deleteExpiredInvoices error", e, context = TAG)
         }

app/src/main/java/to/bitkit/data/entities/TagMetadataEntity.kt

@@ -261,7 +261,7 @@ class AppViewModel @Inject constructor(
     }
 
     private suspend fun handleTags(event: Event.PaymentReceived) {
-        val tags = walletRepo.searchInvoice(txId = event.paymentHash).getOrNull()?.tags.orEmpty()
+        val tags = walletRepo.searchInvoiceByPaymentHash(paymentHash = event.paymentHash).getOrNull()?.tags.orEmpty()
         activityRepo.addTagsToTransaction(
             paymentHashOrTxId = event.paymentHash,
             type = ActivityFilter.LIGHTNING,