Merge pull request #3092 from vitorpamplona/claude/adoring-galileo-ws6FG

Add NIP-78 AppDataEvent (kind 78) and refactor AppSpecificDataEvent
This commit is contained in:
Vitor Pamplona
2026-05-28 18:08:33 -04:00
committed by GitHub
4 changed files with 85 additions and 26 deletions
@@ -54,11 +54,11 @@ class AppSpecificState(
suspend fun saveNewAppSpecificData(): AppSpecificDataEvent {
val toInternal = settings.syncedSettings.toInternal()
return AppSpecificDataEvent.create(
dTag = APP_SPECIFIC_DATA_D_TAG,
description = signer.nip44Encrypt(JsonMapper.toJson(toInternal), signer.pubKey),
otherTags = emptyArray(),
signer = signer,
return signer.sign(
AppSpecificDataEvent.build(
dTag = APP_SPECIFIC_DATA_D_TAG,
description = signer.nip44Encrypt(JsonMapper.toJson(toInternal), signer.pubKey),
),
)
}
@@ -0,0 +1,68 @@
/*
* Copyright (c) 2025 Vitor Pamplona
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
* Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package com.vitorpamplona.quartz.nip78AppData
import androidx.compose.runtime.Immutable
import com.vitorpamplona.quartz.nip01Core.core.Event
import com.vitorpamplona.quartz.nip01Core.core.HexKey
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
import com.vitorpamplona.quartz.nip01Core.tags.dTag.DTag
import com.vitorpamplona.quartz.nip01Core.tags.dTag.dTag
import com.vitorpamplona.quartz.nip31Alts.alt
import com.vitorpamplona.quartz.utils.TimeUtils
/**
* NIP-78 — Arbitrary custom app data, normal-event flavor.
*
* Kind 78 is the non-replaceable counterpart to [AppSpecificDataEvent] (kind
* 30078). Use it when an app needs to store and query multiple events of the
* same type. The spec recommends using unique tags (including `d` tags) for
* grouping related events; the `d` tag here does NOT make the event
* addressable, it is just a free-form grouping key.
*/
@Immutable
class AppDataEvent(
id: HexKey,
pubKey: HexKey,
createdAt: Long,
tags: Array<Array<String>>,
content: String,
sig: HexKey,
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
fun dTag(): String = tags.dTag()
companion object {
const val KIND = 78
const val ALT = "Arbitrary app data"
fun build(
content: String,
dTag: String? = null,
createdAt: Long = TimeUtils.now(),
initializer: TagArrayBuilder<AppDataEvent>.() -> Unit = {},
) = eventTemplate<AppDataEvent>(KIND, content, createdAt) {
alt(ALT)
dTag?.let { addUnique(DTag.assemble(it)) }
initializer()
}
}
}
@@ -23,9 +23,11 @@ package com.vitorpamplona.quartz.nip78AppData
import com.vitorpamplona.quartz.nip01Core.core.Address
import com.vitorpamplona.quartz.nip01Core.core.BaseAddressableEvent
import com.vitorpamplona.quartz.nip01Core.core.HexKey
import com.vitorpamplona.quartz.nip01Core.signers.NostrSigner
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
import com.vitorpamplona.quartz.nip01Core.tags.aTag.ATag
import com.vitorpamplona.quartz.nip31Alts.AltTag
import com.vitorpamplona.quartz.nip01Core.tags.dTag.dTag
import com.vitorpamplona.quartz.nip31Alts.alt
import com.vitorpamplona.quartz.utils.TimeUtils
class AppSpecificDataEvent(
@@ -52,28 +54,15 @@ class AppSpecificDataEvent(
dTag: String,
): ATag = ATag(KIND, pubkey, dTag, null)
suspend fun create(
fun build(
dTag: String,
description: String,
otherTags: Array<Array<String>>,
signer: NostrSigner,
createdAt: Long = TimeUtils.now(),
): AppSpecificDataEvent {
val withD =
if (otherTags.any { it.size > 1 && it[0] == "d" && it[1] == dTag }) {
otherTags
} else {
otherTags.filter { it.size > 0 && it[0] != "d" }.toTypedArray() + arrayOf("d", dTag)
}
val newTags =
if (withD.none { it.size > 0 && it[0] == "alt" }) {
withD + AltTag.assemble(ALT)
} else {
withD
}
return signer.sign(createdAt, KIND, newTags, description)
initializer: TagArrayBuilder<AppSpecificDataEvent>.() -> Unit = {},
) = eventTemplate<AppSpecificDataEvent>(KIND, description, createdAt) {
alt(ALT)
dTag(dTag)
initializer()
}
}
}
@@ -218,6 +218,7 @@ import com.vitorpamplona.quartz.nip72ModCommunities.approval.CommunityPostApprov
import com.vitorpamplona.quartz.nip72ModCommunities.definition.CommunityDefinitionEvent
import com.vitorpamplona.quartz.nip72ModCommunities.follow.CommunityListEvent
import com.vitorpamplona.quartz.nip75ZapGoals.GoalEvent
import com.vitorpamplona.quartz.nip78AppData.AppDataEvent
import com.vitorpamplona.quartz.nip78AppData.AppSpecificDataEvent
import com.vitorpamplona.quartz.nip7DThreads.ThreadEvent
import com.vitorpamplona.quartz.nip84Highlights.HighlightEvent
@@ -322,6 +323,7 @@ class EventFactory {
AppCurationSetEvent.KIND -> AppCurationSetEvent(id, pubKey, createdAt, tags, content, sig)
AppDefinitionEvent.KIND -> AppDefinitionEvent(id, pubKey, createdAt, tags, content, sig)
AppRecommendationEvent.KIND -> AppRecommendationEvent(id, pubKey, createdAt, tags, content, sig)
AppDataEvent.KIND -> AppDataEvent(id, pubKey, createdAt, tags, content, sig)
AppSpecificDataEvent.KIND -> AppSpecificDataEvent(id, pubKey, createdAt, tags, content, sig)
AttestationEvent.KIND -> AttestationEvent(id, pubKey, createdAt, tags, content, sig)
AttestationRequestEvent.KIND -> AttestationRequestEvent(id, pubKey, createdAt, tags, content, sig)