mirror of
https://github.com/vitorpamplona/amethyst.git
synced 2026-10-05 19:28:25 +00:00
Merge pull request #4128 from davotoula/fix/nwc-quota-exceeded-render
test(nwc): pin refusal rendering and the in-flight REQ filter hold
This commit is contained in:
David Kaspar
+105
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
* 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.nip01Core.relay.client.pool
|
||||
|
||||
import com.vitorpamplona.quartz.nip01Core.relay.client.single.IRelayClient
|
||||
import com.vitorpamplona.quartz.nip01Core.relay.commands.toClient.EoseMessage
|
||||
import com.vitorpamplona.quartz.nip01Core.relay.commands.toRelay.Command
|
||||
import com.vitorpamplona.quartz.nip01Core.relay.commands.toRelay.ReqCmd
|
||||
import com.vitorpamplona.quartz.nip01Core.relay.filters.Filter
|
||||
import com.vitorpamplona.quartz.nip01Core.relay.normalizer.NormalizedRelayUrl
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertTrue
|
||||
|
||||
/**
|
||||
* A filter change on a sub whose previous REQ is still awaiting EOSE is not sent: it
|
||||
* waits for that EOSE. Pinned as today's behaviour, not as the goal.
|
||||
*
|
||||
* NIP-47 shares one sub id across requests and publishes the request event right after
|
||||
* widening the filter with its id, so inside this window the wallet's ephemeral
|
||||
* kind-23195 reply can reach the relay before the relay knows to forward it. An instant
|
||||
* refusal (QUOTA_EXCEEDED) can land there; a reply after routing (PAYMENT_FAILED) cannot.
|
||||
* That is the suspected cause of a refusal the BrollyZapper field trip saw vanish
|
||||
* (dkamy-cy6.4); the fix is tracked in dkamy-cy6.6.
|
||||
*/
|
||||
class PoolRequestsInFlightReqDeferralTest {
|
||||
private val relay = NormalizedRelayUrl("wss://nwc.example/")
|
||||
private val subId = "nwc"
|
||||
|
||||
private class RecordingRelayClient(
|
||||
override val url: NormalizedRelayUrl,
|
||||
) : IRelayClient {
|
||||
val sent = mutableListOf<Command>()
|
||||
|
||||
override fun connect() = Unit
|
||||
|
||||
override fun needsToReconnect() = false
|
||||
|
||||
override fun connectAndSyncFiltersIfDisconnected(ignoreRetryDelays: Boolean) = Unit
|
||||
|
||||
override fun isConnected() = true
|
||||
|
||||
override fun sendOrConnectAndSync(cmd: Command) {
|
||||
sent.add(cmd)
|
||||
}
|
||||
|
||||
override fun sendIfConnected(cmd: Command) {
|
||||
sent.add(cmd)
|
||||
}
|
||||
|
||||
override fun disconnect() = Unit
|
||||
}
|
||||
|
||||
private fun nwcReplies(vararg requestIds: String) = listOf(Filter(kinds = listOf(23195), tags = mapOf("e" to requestIds.toList())))
|
||||
|
||||
private fun PoolRequests.update(
|
||||
client: RecordingRelayClient,
|
||||
filters: List<Filter>,
|
||||
) {
|
||||
val affected = addOrUpdate(subId, mapOf(relay to filters), null)
|
||||
sendToRelayIfChanged(subId, affected) { _, cmd -> client.sendOrConnectAndSync(cmd) }
|
||||
}
|
||||
|
||||
@Test
|
||||
fun aFilterChangeWaitsForTheInFlightReqsEose() =
|
||||
runTest {
|
||||
val pool = PoolRequests()
|
||||
val client = RecordingRelayClient(relay)
|
||||
|
||||
pool.update(client, nwcReplies("balance-poll"))
|
||||
assertEquals(1, client.sent.filterIsInstance<ReqCmd>().size, "the first REQ goes out")
|
||||
|
||||
// The zap's request id is added before its EOSE arrives: nothing is sent, so a
|
||||
// request event published now is on the wire ahead of the filter that catches its reply.
|
||||
pool.update(client, nwcReplies("balance-poll", "zap"))
|
||||
assertEquals(1, client.sent.filterIsInstance<ReqCmd>().size, "the widened REQ is held back")
|
||||
|
||||
pool.onIncomingMessage(client, EoseMessage(subId))
|
||||
val reqs = client.sent.filterIsInstance<ReqCmd>()
|
||||
assertEquals(2, reqs.size, "the EOSE releases it")
|
||||
assertTrue(
|
||||
reqs.last().filters.any { it.tags?.get("e")?.contains("zap") == true },
|
||||
"only then does the relay learn to forward the zap's reply",
|
||||
)
|
||||
}
|
||||
}
|
||||
+88
@@ -0,0 +1,88 @@
|
||||
/*
|
||||
* 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.nip47WalletConnect
|
||||
|
||||
import com.vitorpamplona.quartz.nip01Core.crypto.KeyPair
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.NostrSignerInternal
|
||||
import com.vitorpamplona.quartz.nip47WalletConnect.cache.NostrWalletConnectResponseCache
|
||||
import com.vitorpamplona.quartz.nip47WalletConnect.events.LnZapPaymentRequestEvent
|
||||
import com.vitorpamplona.quartz.nip47WalletConnect.events.LnZapPaymentResponseEvent
|
||||
import com.vitorpamplona.quartz.nip47WalletConnect.rpc.IErrorResponseLike
|
||||
import com.vitorpamplona.quartz.nip47WalletConnect.rpc.PayInvoiceMethod
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertIs
|
||||
|
||||
/**
|
||||
* A wallet's refusal, encrypted exactly as it sent it, decrypts through the response
|
||||
* cache the zap path reads into something with a message to render — whatever the error
|
||||
* code, over NIP-04 and NIP-44 alike. Parsing alone is pinned in [ResponseTest]; this
|
||||
* covers the wire bytes. It does not cover `LocalCache.consume` or relay delivery.
|
||||
*/
|
||||
class NwcRefusalRoundTripTest {
|
||||
private val clientSigner = NostrSignerInternal(KeyPair())
|
||||
private val walletSigner = NostrSignerInternal(KeyPair())
|
||||
|
||||
private suspend fun assertRefusalDecryptsWithMessage(
|
||||
code: String,
|
||||
message: String,
|
||||
) {
|
||||
val walletJson = """{"result_type":"pay_invoice","error":{"code":"$code","message":"$message"}}"""
|
||||
|
||||
for (useNip44 in listOf(false, true)) {
|
||||
val request =
|
||||
LnZapPaymentRequestEvent.createRequest(
|
||||
PayInvoiceMethod.create("lnbc50n1pjtest"),
|
||||
walletSigner.pubKey,
|
||||
clientSigner,
|
||||
useNip44 = useNip44,
|
||||
)
|
||||
|
||||
// Encrypted by hand rather than through LnZapPaymentResponseEvent.createResponse,
|
||||
// which re-serializes a Response: the point is the wallet's bytes, verbatim.
|
||||
val encrypted =
|
||||
if (useNip44) {
|
||||
walletSigner.nip44Encrypt(walletJson, clientSigner.pubKey)
|
||||
} else {
|
||||
walletSigner.nip04Encrypt(walletJson, clientSigner.pubKey)
|
||||
}
|
||||
val reply =
|
||||
walletSigner.sign<LnZapPaymentResponseEvent>(
|
||||
request.createdAt,
|
||||
LnZapPaymentResponseEvent.KIND,
|
||||
arrayOf(arrayOf("p", clientSigner.pubKey), arrayOf("e", request.id)),
|
||||
encrypted,
|
||||
)
|
||||
|
||||
val response = NostrWalletConnectResponseCache(clientSigner).decryptResponse(reply)
|
||||
val case = "$code over ${if (useNip44) "NIP-44" else "NIP-04"}"
|
||||
assertIs<IErrorResponseLike>(response, case)
|
||||
assertEquals(message, response.errorMessage(), case)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun quotaExceededDecryptsWithItsMessage() = runTest { assertRefusalDecryptsWithMessage("QUOTA_EXCEEDED", "this payment would exceed the connection's budget for this period") }
|
||||
|
||||
@Test
|
||||
fun paymentFailedDecryptsWithItsMessage() = runTest { assertRefusalDecryptsWithMessage("PAYMENT_FAILED", "NO_ROUTE: no route found") }
|
||||
}
|
||||
Reference in New Issue
Block a user