feat: add public contact payments

Author: ben-kaufman

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Support public Paykit contact payments #924
+
 ### Changed
 - Improve Pubky profile restore, contact editing, and contact routing flows #905
 

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

@@ -100,6 +100,8 @@ data class SettingsData(
     val hasSeenShopIntro: Boolean = false,
     val hasSeenProfileIntro: Boolean = false,
     val hasSeenContactsIntro: Boolean = false,
+    val hasConfirmedPublicPaykitEndpoints: Boolean = false,
+    val sharesPublicPaykitEndpoints: Boolean = false,
     val quickPayIntroSeen: Boolean = false,
     val bgPaymentsIntroSeen: Boolean = false,
     val isQuickPayEnabled: Boolean = false,

app/src/main/java/to/bitkit/env/Env.kt

@@ -169,7 +169,7 @@ internal object Env {
                 Network.BITCOIN -> ""
                 else -> "staging."
             }
-            return "/pub/$pubkyDomain/:rw,/pub/${prefix}pubky.app/:r,/pub/${prefix}paykit/v0/:rw"
+            return "/pub/$pubkyDomain/:rw,/pub/${prefix}pubky.app/:r,/pub/paykit/v0/:rw"
         }
 
     val homegateUrl: String

app/src/main/java/to/bitkit/ext/Activities.kt

@@ -92,6 +92,7 @@ fun LightningActivity.Companion.create(
     fee: ULong = 0u,
     message: String = "",
     preimage: String? = null,
+    contact: String? = null,
     createdAt: ULong? = timestamp,
     updatedAt: ULong? = createdAt,
     seenAt: ULong? = null,
@@ -105,6 +106,7 @@ fun LightningActivity.Companion.create(
     message = message,
     timestamp = timestamp,
     preimage = preimage,
+    contact = contact,
     createdAt = createdAt,
     updatedAt = updatedAt,
     seenAt = seenAt,
@@ -128,6 +130,7 @@ fun OnchainActivity.Companion.create(
     confirmTimestamp: ULong? = null,
     channelId: String? = null,
     transferTxId: String? = null,
+    contact: String? = null,
     createdAt: ULong? = timestamp,
     updatedAt: ULong? = createdAt,
     seenAt: ULong? = null,
@@ -148,6 +151,7 @@ fun OnchainActivity.Companion.create(
     confirmTimestamp = confirmTimestamp,
     channelId = channelId,
     transferTxId = transferTxId,
+    contact = contact,
     createdAt = createdAt,
     updatedAt = updatedAt,
     seenAt = seenAt,

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

@@ -33,12 +33,14 @@ import org.lightningdevkit.ldknode.TransactionDetails
 import to.bitkit.data.CacheStore
 import to.bitkit.data.dto.PendingBoostActivity
 import to.bitkit.di.BgDispatcher
+import to.bitkit.di.IoDispatcher
 import to.bitkit.ext.amountOnClose
 import to.bitkit.ext.matchesPaymentId
 import to.bitkit.ext.nowMillis
 import to.bitkit.ext.nowTimestamp
 import to.bitkit.ext.rawId
 import to.bitkit.models.ActivityBackupV1
+import to.bitkit.models.PubkyPublicKeyFormat
 import to.bitkit.services.CoreService
 import to.bitkit.utils.AppError
 import to.bitkit.utils.Logger
@@ -55,6 +57,7 @@ private const val MS_SYNC_TIMEOUT = 40_000L
 @Singleton
 class ActivityRepo @Inject constructor(
     @BgDispatcher private val bgDispatcher: CoroutineDispatcher,
+    @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
     private val coreService: CoreService,
     private val lightningRepo: LightningRepo,
     private val blocktankRepo: BlocktankRepo,
@@ -338,6 +341,79 @@ class ActivityRepo @Inject constructor(
         }
     }
 
+    suspend fun contactActivities(publicKey: String): Result<List<Activity>> = withContext(ioDispatcher) {
+        runCatching {
+            val normalizedKey = PubkyPublicKeyFormat.normalized(publicKey) ?: publicKey
+            getActivities(
+                filter = ActivityFilter.ALL,
+                sortDirection = SortDirection.DESC,
+            ).getOrThrow().filter { activity ->
+                when (activity) {
+                    is Activity.Lightning -> PubkyPublicKeyFormat.matches(activity.v1.contact, normalizedKey)
+                    is Activity.Onchain -> PubkyPublicKeyFormat.matches(activity.v1.contact, normalizedKey)
+                }
+            }
+        }.onFailure {
+            Logger.error("Failed to load contact activities for '$publicKey'", it, context = TAG)
+        }
+    }
+
+    suspend fun setContact(
+        contactPublicKey: String,
+        forPaymentId: String,
+        syncLdkPayments: Boolean = true,
+    ): Result<Unit> = withContext(ioDispatcher) {
+        runCatching {
+            if (syncLdkPayments) {
+                lightningRepo.getPayments().onSuccess {
+                    syncLdkNodePayments(it).getOrThrow()
+                }.getOrThrow()
+            }
+
+            val normalizedKey = PubkyPublicKeyFormat.normalized(contactPublicKey) ?: contactPublicKey
+            val activity = findActivityForPaymentId(forPaymentId, syncLdkPayments)
+            if (activity == null) {
+                Logger.warn(
+                    "Skipped setting contact for payment '$forPaymentId' because activity was not found",
+                    context = TAG,
+                )
+                return@runCatching
+            }
+            if (PubkyPublicKeyFormat.matches(activity.contact(), normalizedKey)) {
+                return@runCatching
+            }
+
+            val updatedAt = nowTimestamp().epochSecond.toULong()
+            val updatedActivity = activity.withContact(normalizedKey, updatedAt)
+            updateActivity(updatedActivity.rawId(), updatedActivity).getOrThrow()
+        }.onFailure {
+            Logger.error("Failed to set contact for payment '$forPaymentId'", it, context = TAG)
+        }
+    }
+
+    private suspend fun findActivityForPaymentId(forPaymentId: String, syncLdkPayments: Boolean): Activity? {
+        val activity = getActivityByPaymentId(forPaymentId)
+        if (activity != null) return activity
+        if (!syncLdkPayments) return null
+
+        syncActivities().getOrThrow()
+        return getActivityByPaymentId(forPaymentId)
+    }
+
+    private suspend fun getActivityByPaymentId(forPaymentId: String): Activity? =
+        coreService.activity.getActivity(forPaymentId)
+            ?: getOnchainActivityByTxId(forPaymentId)?.let { Activity.Onchain(it) }
+
+    private fun Activity.contact(): String? = when (this) {
+        is Activity.Lightning -> v1.contact
+        is Activity.Onchain -> v1.contact
+    }
+
+    private fun Activity.withContact(normalizedKey: String, updatedAt: ULong): Activity = when (this) {
+        is Activity.Lightning -> Activity.Lightning(v1.copy(contact = normalizedKey, updatedAt = updatedAt))
+        is Activity.Onchain -> Activity.Onchain(v1.copy(contact = normalizedKey, updatedAt = updatedAt))
+    }
+
     suspend fun getClosedChannels(
         sortDirection: SortDirection = SortDirection.ASC,
     ): Result<List<ClosedChannelDetails>> = withContext(bgDispatcher) {
@@ -515,6 +591,7 @@ class ActivityRepo @Inject constructor(
                         message = "",
                         timestamp = now,
                         preimage = null,
+                        contact = null,
                         createdAt = now,
                         updatedAt = null,
                         seenAt = null,

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

@@ -3,6 +3,7 @@ package to.bitkit.repositories
 import android.graphics.Bitmap
 import android.graphics.BitmapFactory
 import coil3.ImageLoader
+import com.synonym.paykit.FfiPaymentEntry
 import io.ktor.client.HttpClient
 import io.ktor.client.call.body
 import io.ktor.client.request.post
@@ -46,6 +47,7 @@ import kotlin.math.min
 enum class PubkyAuthState { Idle, Authenticating, Authenticated }
 
 sealed class PubkyContactError(message: String) : AppError(message) {
+    data object AlreadyExists : PubkyContactError("Contact already exists")
     data object CannotAddSelf : PubkyContactError("Cannot add your own pubky as a contact")
     data object InvalidFormat : PubkyContactError("Invalid pubky key format")
 }
@@ -280,6 +282,34 @@ class PubkyRepo @Inject constructor(
 
     // endregion
 
+    // region Payment endpoints
+
+    suspend fun getPaymentList(publicKey: String): Result<List<FfiPaymentEntry>> = withContext(ioDispatcher) {
+        runCatching {
+            pubkyService.getPaymentList(publicKey.ensurePubkyPrefix())
+        }
+    }
+
+    suspend fun setPaymentEndpoint(methodId: String, endpointData: String): Result<Unit> = withContext(ioDispatcher) {
+        runCatching {
+            pubkyService.setPaymentEndpoint(methodId, endpointData)
+        }
+    }
+
+    suspend fun removePaymentEndpoint(methodId: String): Result<Unit> = withContext(ioDispatcher) {
+        runCatching {
+            pubkyService.removePaymentEndpoint(methodId)
+        }
+    }
+
+    suspend fun currentPublicKey(): Result<String?> = withContext(ioDispatcher) {
+        runCatching {
+            pubkyService.currentPublicKey()?.ensurePubkyPrefix()
+        }
+    }
+
+    // endregion
+
     // region Profile loading
 
     suspend fun loadProfile() {
@@ -918,11 +948,17 @@ class PubkyRepo @Inject constructor(
 
     private fun requireAddableContactPublicKey(publicKey: String): String {
         val prefixedKey = PubkyPublicKeyFormat.normalized(publicKey)
-            ?: throw PubkyContactError.InvalidFormat
-        if (_publicKey.value == prefixedKey) {
-            throw PubkyContactError.CannotAddSelf
+        contactValidationError(prefixedKey)?.let { throw it }
+        return checkNotNull(prefixedKey) { "Normalized pubky key is required" }
+    }
+
+    private fun contactValidationError(prefixedKey: String?): PubkyContactError? {
+        if (prefixedKey == null) return PubkyContactError.InvalidFormat
+        if (_publicKey.value == prefixedKey) return PubkyContactError.CannotAddSelf
+        if (_contacts.value.any { PubkyPublicKeyFormat.matches(it.publicKey, prefixedKey) }) {
+            return PubkyContactError.AlreadyExists
         }
-        return prefixedKey
+        return null
     }
 
     private fun String.ensurePubkyPrefix(): String =