From 17c758f8f86903ed49ca1bec663c664b5ff4e3f3 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 20 Aug 2024 09:14:47 -0400 Subject: [PATCH] Displays PoW of commitment if present. --- .../quartz/encoders/PoWRankTest.kt | 49 +++++++++++++++ .../vitorpamplona/quartz/encoders/PoWRank.kt | 63 +++++++++++++++++++ .../com/vitorpamplona/quartz/events/Event.kt | 21 +------ 3 files changed, 115 insertions(+), 18 deletions(-) create mode 100644 quartz/src/androidTest/java/com/vitorpamplona/quartz/encoders/PoWRankTest.kt create mode 100644 quartz/src/main/java/com/vitorpamplona/quartz/encoders/PoWRank.kt diff --git a/quartz/src/androidTest/java/com/vitorpamplona/quartz/encoders/PoWRankTest.kt b/quartz/src/androidTest/java/com/vitorpamplona/quartz/encoders/PoWRankTest.kt new file mode 100644 index 000000000..f38818a0a --- /dev/null +++ b/quartz/src/androidTest/java/com/vitorpamplona/quartz/encoders/PoWRankTest.kt @@ -0,0 +1,49 @@ +/** + * 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.encoders + +import androidx.test.ext.junit.runners.AndroidJUnit4 +import org.junit.Assert.assertEquals +import org.junit.Test +import org.junit.runner.RunWith + +@RunWith(AndroidJUnit4::class) +class PoWRankTest { + @Test + fun setPoW() { + assertEquals(26, PoWRank.get("00000026c91e9fc75fdb95b367776e2594b931cebda6d5ca3622501006669c9e")) + } + + @Test + fun setPoWIfCommited25() { + assertEquals(25, PoWRank.getCommited("00000026c91e9fc75fdb95b367776e2594b931cebda6d5ca3622501006669c9e", 25)) + } + + @Test + fun setPoWIfCommited26() { + assertEquals(26, PoWRank.getCommited("00000026c91e9fc75fdb95b367776e2594b931cebda6d5ca3622501006669c9e", 26)) + } + + @Test + fun setPoWIfCommited27() { + assertEquals(26, PoWRank.getCommited("00000026c91e9fc75fdb95b367776e2594b931cebda6d5ca3622501006669c9e", 27)) + } +} diff --git a/quartz/src/main/java/com/vitorpamplona/quartz/encoders/PoWRank.kt b/quartz/src/main/java/com/vitorpamplona/quartz/encoders/PoWRank.kt new file mode 100644 index 000000000..fd4a3a9a2 --- /dev/null +++ b/quartz/src/main/java/com/vitorpamplona/quartz/encoders/PoWRank.kt @@ -0,0 +1,63 @@ +/** + * 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.encoders + +class PoWRank { + companion object { + fun getCommited( + id: String, + commitedPoW: Int?, + ): Int { + val actualRank = get(id) + + return if (commitedPoW == null) { + actualRank + } else { + if (actualRank >= commitedPoW) { + commitedPoW + } else { + actualRank + } + } + } + + fun get(id: String): Int { + var rank = 0 + for (i in 0..id.length) { + if (id[i] == '0') { + rank += 4 + } else if (id[i] in '4'..'7') { + rank += 1 + break + } else if (id[i] in '2'..'3') { + rank += 2 + break + } else if (id[i] == '1') { + rank += 3 + break + } else { + break + } + } + return rank + } + } +} diff --git a/quartz/src/main/java/com/vitorpamplona/quartz/events/Event.kt b/quartz/src/main/java/com/vitorpamplona/quartz/events/Event.kt index 7437daf8a..3360bf94b 100644 --- a/quartz/src/main/java/com/vitorpamplona/quartz/events/Event.kt +++ b/quartz/src/main/java/com/vitorpamplona/quartz/events/Event.kt @@ -40,6 +40,7 @@ import com.vitorpamplona.quartz.encoders.Hex import com.vitorpamplona.quartz.encoders.HexKey import com.vitorpamplona.quartz.encoders.Nip01Serializer import com.vitorpamplona.quartz.encoders.Nip19Bech32 +import com.vitorpamplona.quartz.encoders.PoWRank import com.vitorpamplona.quartz.encoders.toHexKey import com.vitorpamplona.quartz.signers.NostrSigner import com.vitorpamplona.quartz.utils.TimeUtils @@ -256,24 +257,8 @@ open class Event( } override fun getPoWRank(): Int { - var rank = 0 - for (i in 0..id.length) { - if (id[i] == '0') { - rank += 4 - } else if (id[i] in '4'..'7') { - rank += 1 - break - } else if (id[i] in '2'..'3') { - rank += 2 - break - } else if (id[i] == '1') { - rank += 3 - break - } else { - break - } - } - return rank + val commitedPoW = tags.firstOrNull { it.size > 2 && it[0] == "nonce" }?.get(2)?.toIntOrNull() + return PoWRank.getCommited(id, commitedPoW) } override fun getGeoHash(): String? = tags.firstOrNull { it.size > 1 && it[0] == "g" }?.get(1)?.ifBlank { null }