nick/amethyst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

feat: implement NIP-32 Labeling protocol in quartz

Browse Source 
Add kind 1985 LabelEvent with L (namespace) and l (label) tag support
for distributed moderation, content classification, and license assignment.
Includes tag parsers, builder extensions, self-reporting helpers, and tests.

https://claude.ai/code/session_011t5ZoP1BdgZTT5Cen9GH5z
This commit is contained in:
Claude
2026-03-28 03:57:46 +00:00
parent 007a0b0d43
commit aa15085f40
9 changed files with 730 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
quartz/src/commonTest/kotlin/com/vitorpamplona/quartz/nip32Labeling/LabelEventTest.kt
+189
View File
@@ -0,0 +1,189 @@
/*
* 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.nip32Labeling
import com.vitorpamplona.quartz.nip01Core.core.Event
import com.vitorpamplona.quartz.nip01Core.crypto.KeyPair
import com.vitorpamplona.quartz.nip01Core.signers.NostrSignerInternal
import com.vitorpamplona.quartz.nip32Labeling.tags.LabelTag
import com.vitorpamplona.quartz.utils.EventFactory
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertIs
import kotlin.test.assertTrue
class LabelEventTest {
private val signer = NostrSignerInternal(KeyPair())
private val testEventId = "a".repeat(64)
private val testPubKey = "b".repeat(64)
@Test
fun testBuildEventLabel() {
val labels = listOf(LabelTag("approve", "nip28.moderation"))
val template =
LabelEvent.buildEventLabel(
labeledEventId = testEventId,
labels = labels,
content = "Approved for channel",
)
assertEquals(1985, template.kind)
assertEquals("Approved for channel", template.content)
val hasLabelNamespace = template.tags.any { it[0] == "L" && it[1] == "nip28.moderation" }
assertTrue(hasLabelNamespace, "Should have L namespace tag")
val hasLabel = template.tags.any { it[0] == "l" && it[1] == "approve" && it[2] == "nip28.moderation" }
assertTrue(hasLabel, "Should have l label tag")
val hasEventRef = template.tags.any { it[0] == "e" && it[1] == testEventId }
assertTrue(hasEventRef, "Should have e tag targeting labeled event")
}
@Test
fun testBuildPubKeyLabel() {
val labels = listOf(LabelTag("permies", "#t"))
val template =
LabelEvent.buildPubKeyLabel(
labeledPubKey = testPubKey,
labels = labels,
content = "",
)
assertEquals(1985, template.kind)
val hasPubKeyRef = template.tags.any { it[0] == "p" && it[1] == testPubKey }
assertTrue(hasPubKeyRef, "Should have p tag targeting labeled pubkey")
val hasNamespace = template.tags.any { it[0] == "L" && it[1] == "#t" }
assertTrue(hasNamespace, "Should have L namespace tag")
val hasLabel = template.tags.any { it[0] == "l" && it[1] == "permies" && it[2] == "#t" }
assertTrue(hasLabel, "Should have l label tag")
}
@Test
fun testBuildMultipleLabels() {
val labels =
listOf(
LabelTag("IT-MI", "ISO-3166-2"),
LabelTag("en", "ISO-639-1"),
)
val template = LabelEvent.build(labels = labels)
val namespaces =
template.tags
.filter { it[0] == "L" }
.map { it[1] }
.toSet()
assertEquals(setOf("ISO-3166-2", "ISO-639-1"), namespaces)
val labelTags = template.tags.filter { it[0] == "l" }
assertEquals(2, labelTags.size)
}
@Test
fun testEventFactoryCreatesLabelEvent() {
val event =
EventFactory.create<Event>(
id = testEventId,
pubKey = testPubKey,
createdAt = 1234567890L,
kind = 1985,
tags =
arrayOf(
arrayOf("L", "license"),
arrayOf("l", "MIT", "license"),
arrayOf("e", testEventId),
),
content = "",
sig = "c".repeat(128),
)
assertIs<LabelEvent>(event)
assertEquals(1985, event.kind)
val labels = event.labels()
assertEquals(1, labels.size)
assertEquals("MIT", labels[0].label)
assertEquals("license", labels[0].namespace)
val namespaces = event.namespaces()
assertEquals(1, namespaces.size)
assertEquals("license", namespaces[0].namespace)
}
@Test
fun testLabelsByNamespace() {
val event =
EventFactory.create<LabelEvent>(
id = testEventId,
pubKey = testPubKey,
createdAt = 1234567890L,
kind = 1985,
tags =
arrayOf(
arrayOf("L", "license"),
arrayOf("L", "ISO-639-1"),
arrayOf("l", "MIT", "license"),
arrayOf("l", "en", "ISO-639-1"),
arrayOf("e", testEventId),
),
content = "",
sig = "c".repeat(128),
)
val licenseLabels = event.labelsByNamespace("license")
assertEquals(1, licenseLabels.size)
assertEquals("MIT", licenseLabels[0].label)
val languageLabels = event.labelsByNamespace("ISO-639-1")
assertEquals(1, languageLabels.size)
assertEquals("en", languageLabels[0].label)
}
@Test
fun testLabeledTargets() {
val event =
EventFactory.create<LabelEvent>(
id = testEventId,
pubKey = testPubKey,
createdAt = 1234567890L,
kind = 1985,
tags =
arrayOf(
arrayOf("L", "ugc"),
arrayOf("l", "funny", "ugc"),
arrayOf("e", testEventId),
arrayOf("p", testPubKey),
arrayOf("t", "bitcoin"),
arrayOf("r", "wss://relay.example.com"),
),
content = "",
sig = "c".repeat(128),
)
assertEquals(listOf(testEventId), event.labeledEvents())
assertEquals(listOf(testPubKey), event.labeledPubKeys())
assertEquals(listOf("bitcoin"), event.labeledHashtags())
assertEquals(listOf("wss://relay.example.com"), event.labeledRelayUrls())
}
}
quartz/src/commonTest/kotlin/com/vitorpamplona/quartz/nip32Labeling/LabelTagTest.kt
+156
View File
@@ -0,0 +1,156 @@
/*
* 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.nip32Labeling
import com.vitorpamplona.quartz.nip32Labeling.tags.LabelNamespaceTag
import com.vitorpamplona.quartz.nip32Labeling.tags.LabelTag
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
import kotlin.test.assertNull
import kotlin.test.assertTrue
class LabelTagTest {
@Test
fun testParseLabelWithNamespace() {
val tag = arrayOf("l", "MIT", "license")
val label = LabelTag.parse(tag)
assertNotNull(label)
assertEquals("MIT", label.label)
assertEquals("license", label.namespace)
}
@Test
fun testParseLabelWithoutNamespaceDefaultsToUgc() {
val tag = arrayOf("l", "my-label")
val label = LabelTag.parse(tag)
assertNotNull(label)
assertEquals("my-label", label.label)
assertEquals("ugc", label.namespace)
}
@Test
fun testParseLabelWithEmptyNamespaceDefaultsToUgc() {
val tag = arrayOf("l", "my-label", "")
val label = LabelTag.parse(tag)
assertNotNull(label)
assertEquals("my-label", label.label)
assertEquals("ugc", label.namespace)
}
@Test
fun testParseLabelReturnsNullForInvalidTag() {
assertNull(LabelTag.parse(arrayOf("l")))
assertNull(LabelTag.parse(arrayOf("l", "")))
assertNull(LabelTag.parse(arrayOf("e", "something")))
assertNull(LabelTag.parse(arrayOf()))
}
@Test
fun testParseLabelValue() {
val tag = arrayOf("l", "en", "ISO-639-1")
assertEquals("en", LabelTag.parseLabel(tag))
}
@Test
fun testAssembleLabel() {
val assembled = LabelTag.assemble("MIT", "license")
assertEquals(3, assembled.size)
assertEquals("l", assembled[0])
assertEquals("MIT", assembled[1])
assertEquals("license", assembled[2])
}
@Test
fun testRoundTrip() {
val original = LabelTag("approve", "nip28.moderation")
val assembled = original.toTagArray()
val parsed = LabelTag.parse(assembled)
assertNotNull(parsed)
assertEquals(original, parsed)
}
@Test
fun testIsTagged() {
assertTrue(LabelTag.isTagged(arrayOf("l", "something")))
assertTrue(LabelTag.isTagged(arrayOf("l", "MIT", "license")))
}
@Test
fun testIsTaggedWithValue() {
assertTrue(LabelTag.isTagged(arrayOf("l", "MIT", "license"), "MIT"))
}
@Test
fun testIsTaggedWithNamespace() {
assertTrue(LabelTag.isTaggedWithNamespace(arrayOf("l", "MIT", "license"), "license"))
}
@Test
fun testParseNamespace() {
val tag = arrayOf("L", "license")
val namespace = LabelNamespaceTag.parse(tag)
assertNotNull(namespace)
assertEquals("license", namespace.namespace)
}
@Test
fun testParseNamespaceReturnsNullForInvalid() {
assertNull(LabelNamespaceTag.parse(arrayOf("L")))
assertNull(LabelNamespaceTag.parse(arrayOf("L", "")))
assertNull(LabelNamespaceTag.parse(arrayOf("l", "something")))
}
@Test
fun testAssembleNamespace() {
val assembled = LabelNamespaceTag.assemble("com.example.ontology")
assertEquals(2, assembled.size)
assertEquals("L", assembled[0])
assertEquals("com.example.ontology", assembled[1])
}
@Test
fun testNamespaceRoundTrip() {
val original = LabelNamespaceTag("ISO-639-1")
val assembled = original.toTagArray()
val parsed = LabelNamespaceTag.parse(assembled)
assertNotNull(parsed)
assertEquals(original, parsed)
}
@Test
fun testTagAssociationNamespace() {
val ns = LabelNamespaceTag("#t")
assertTrue(ns.isTagAssociation())
}
@Test
fun testParseNamespaceValue() {
assertEquals("ugc", LabelNamespaceTag.parseNamespace(arrayOf("L", "ugc")))
assertNull(LabelNamespaceTag.parseNamespace(arrayOf("l", "ugc")))
}
}