From 9bfdfe61e2634c7b1d225fe6a0d09c6622dd1d48 Mon Sep 17 00:00:00 2001
From: Bastien Teinturier <31281497+t-bast@users.noreply.github.com>
Date: Tue, 8 Oct 2024 16:12:29 +0200
Subject: [PATCH] Clarify when the `WithFeeCredit` liquidity purchase is used
 (#708)

Whenever we consume some of our fee credit for a liquidity purchase, we
will use a `WithFeeCredit` purchase, even if we cannot pay the entire
fee with our fee credit.
---
 src/commonMain/kotlin/fr/acinq/lightning/wire/LiquidityAds.kt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/commonMain/kotlin/fr/acinq/lightning/wire/LiquidityAds.kt b/src/commonMain/kotlin/fr/acinq/lightning/wire/LiquidityAds.kt
index 290ac3ba6..5aba765ab 100644
--- a/src/commonMain/kotlin/fr/acinq/lightning/wire/LiquidityAds.kt
+++ b/src/commonMain/kotlin/fr/acinq/lightning/wire/LiquidityAds.kt
@@ -324,6 +324,7 @@ object LiquidityAds {
         abstract val paymentDetails: PaymentDetails
 
         data class Standard(override val amount: Satoshi, override val fees: Fees, override val paymentDetails: PaymentDetails) : Purchase()
+        /** The liquidity purchase was paid (partially or entirely) using [fr.acinq.lightning.Feature.FundingFeeCredit]. */
         data class WithFeeCredit(override val amount: Satoshi, override val fees: Fees, val feeCreditUsed: MilliSatoshi, override val paymentDetails: PaymentDetails) : Purchase()
     }