Adds basic support for NIP-46 events.

2024-08-28 17:39:25 -04:00
parent 7d9efcd1d9
commit b5709f9527
24 changed files with 1251 additions and 2 deletions
@@ -0,0 +1,254 @@
+/**
+ * Copyright (c) 2024 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.events.nip46
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.vitorpamplona.quartz.crypto.KeyPair
+import com.vitorpamplona.quartz.events.ContactListEvent
+import com.vitorpamplona.quartz.events.Event
+import com.vitorpamplona.quartz.signers.NostrSignerInternal
+import com.vitorpamplona.quartz.utils.TimeUtils
+import junit.framework.TestCase.assertEquals
+import org.junit.Ignore
+import org.junit.Test
+import org.junit.runner.RunWith
+import java.util.concurrent.CountDownLatch
+
+@RunWith(AndroidJUnit4::class)
+internal class Nip46Test {
+    val remoteKey = NostrSignerInternal(KeyPair())
+    val signer = NostrSignerInternal(KeyPair())
+    val peer = NostrSignerInternal(KeyPair())
+
+    val dummyEvent =
+        Event(
+            id = "",
+            pubKey = "",
+            createdAt = TimeUtils.now(),
+            kind = 1,
+            tags = emptyArray(),
+            content = "test",
+            sig = "",
+        )
+
+    fun <T : BunkerMessage> encodeDecodeEvent(req: T): T {
+        var countDownLatch = CountDownLatch(1)
+        var eventStr: String? = null
+
+        NostrConnectEvent.create(req, remoteKey.pubKey, signer) {
+            eventStr = it.toJson()
+            countDownLatch.countDown()
+        }
+
+        countDownLatch.await()
+
+        countDownLatch = CountDownLatch(1)
+        var innerMessage: T? = null
+
+        (Event.fromJson(eventStr!!) as NostrConnectEvent).plainContent(signer) {
+            innerMessage = it as T
+            countDownLatch.countDown()
+        }
+
+        countDownLatch.await()
+
+        return innerMessage!!
+    }
+
+    @Test
+    fun signEncoder() {
+        val expected = BunkerRequestSign(event = dummyEvent)
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(BunkerRequestSign.METHOD_NAME, actual.method)
+        assertEquals(expected.id, actual.id)
+        assertEquals(dummyEvent.id, actual.event.id)
+    }
+
+    @Test
+    fun connectEncoder() {
+        val expected = BunkerRequestConnect(remoteKey = remoteKey.pubKey)
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+    }
+
+    @Test
+    fun pingEncoder() {
+        val expected = BunkerRequestPing()
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+    }
+
+    @Test
+    fun getPubkeyEncoder() {
+        val expected = BunkerRequestGetPublicKey()
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+    }
+
+    @Test
+    fun getRelaysEncoder() {
+        val expected = BunkerRequestGetRelays()
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+    }
+
+    @Test
+    fun testNip04Encrypt() {
+        val expected = BunkerRequestNip04Encrypt(pubKey = peer.pubKey, message = "Test")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.pubKey, actual.pubKey)
+        assertEquals(expected.message, actual.message)
+    }
+
+    @Test
+    fun testNip44Encrypt() {
+        val expected = BunkerRequestNip44Encrypt(pubKey = peer.pubKey, message = "Test")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.pubKey, actual.pubKey)
+        assertEquals(expected.message, actual.message)
+    }
+
+    @Test
+    fun testNip04Decrypt() {
+        val expected = BunkerRequestNip04Decrypt(pubKey = peer.pubKey, ciphertext = "Test")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.pubKey, actual.pubKey)
+        assertEquals(expected.ciphertext, actual.ciphertext)
+    }
+
+    @Test
+    fun testNip44Decrypt() {
+        val expected = BunkerRequestNip44Decrypt(pubKey = peer.pubKey, ciphertext = "Test")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.method, actual.method)
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.pubKey, actual.pubKey)
+        assertEquals(expected.ciphertext, actual.ciphertext)
+    }
+
+    // Responses
+
+    @Test
+    fun testAckResponse() {
+        val expected = BunkerResponseAck()
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+    }
+
+    @Test
+    fun testPongResponse() {
+        val expected = BunkerResponsePong()
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+    }
+
+    @Test
+    fun testErrorResponse() {
+        val expected = BunkerResponseError(error = "Error")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+    }
+
+    @Test
+    fun testEventResponse() {
+        val expected = BunkerResponseEvent(event = dummyEvent)
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+        assertEquals(dummyEvent.id, actual.event.id)
+    }
+
+    @Test
+    fun testPubkeyResponse() {
+        val expected = BunkerResponsePublicKey(pubkey = peer.pubKey)
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+        assertEquals(expected.pubkey, actual.pubkey)
+    }
+
+    @Test
+    fun testRelaysResponse() {
+        val expected = BunkerResponseGetRelays(relays = mapOf("url" to ContactListEvent.ReadWrite(true, false)))
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+        assertEquals(expected.relays["url"], actual.relays["url"])
+    }
+
+    @Test
+    @Ignore("Impossible to recreate the class since there are no hints on the json")
+    fun testDecryptResponse() {
+        val expected = BunkerResponseDecrypt(plaintext = "Test")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+        assertEquals(expected.plaintext, actual.plaintext)
+    }
+
+    @Test
+    @Ignore("Impossible to recreate the class since there are no hints on the json")
+    fun testEncryptResponse() {
+        val expected = BunkerResponseEncrypt(ciphertext = "Test")
+        val actual = encodeDecodeEvent(expected)
+
+        assertEquals(expected.id, actual.id)
+        assertEquals(expected.result, actual.result)
+        assertEquals(expected.error, actual.error)
+        assertEquals(expected.ciphertext, actual.ciphertext)
+    }
+}