Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixup! Rework liquidity purchase storage in DB (#749) #750

Merged
merged 1 commit into from
Jan 29, 2025
Merged

fixup! Rework liquidity purchase storage in DB (#749) #750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion modules/core/src/commonMain/kotlin/fr/acinq/lightning/db/PaymentsDb.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ sealed class OnChainOutgoingPayment : OutgoingPayment() {
/** If some liquidity was purchased, we paid a service fee on top of the mining fee. */
override val fees: MilliSatoshi get() = miningFee.toMilliSatoshi() + serviceFee

val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails? get() = liquidityPurchase?.let { LiquidityAds.LiquidityTransactionDetails(txId, miningFee, it) }
abstract val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails?

/** Helper method to facilitate updating child classes */
fun setLocked(lockedAt: Long): OnChainOutgoingPayment =
Expand Down Expand Up @@ -537,6 +537,7 @@ data class SpliceOutgoingPayment(
override val lockedAt: Long?,
) : OnChainOutgoingPayment() {
override val amount: MilliSatoshi = recipientAmount.toMilliSatoshi() + fees
override val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails? get() = liquidityPurchase?.let { LiquidityAds.LiquidityTransactionDetails(txId, miningFee, it) }
}

/** A splice transaction that only bumps the fees of the parent splice transactions. */
Expand All @@ -551,6 +552,7 @@ data class SpliceCpfpOutgoingPayment(
) : OnChainOutgoingPayment() {
override val amount: MilliSatoshi = miningFee.toMilliSatoshi()
override val liquidityPurchase: LiquidityAds.Purchase? = null
override val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails? = null
}

/** An on-chain transaction that only purchases inbound liquidity, triggered by the wallet user. */
Expand All @@ -565,6 +567,7 @@ data class ManualLiquidityPurchasePayment(
override val lockedAt: Long?,
) : OnChainOutgoingPayment() {
override val amount: MilliSatoshi = fees
override val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails get() = LiquidityAds.LiquidityTransactionDetails(txId, miningFee, liquidityPurchase)
}

/**
Expand All @@ -588,6 +591,7 @@ data class AutomaticLiquidityPurchasePayment(
val incomingPaymentReceivedAt: Long?,
) : OnChainOutgoingPayment() {
override val amount: MilliSatoshi = fees
override val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails get() = LiquidityAds.LiquidityTransactionDetails(txId, miningFee, liquidityPurchase)
}

data class ChannelCloseOutgoingPayment(
Expand All @@ -612,4 +616,5 @@ data class ChannelCloseOutgoingPayment(
}
override val amount: MilliSatoshi = (recipientAmount + miningFee).toMilliSatoshi()
override val liquidityPurchase: LiquidityAds.Purchase? = null
override val liquidityPurchaseDetails: LiquidityAds.LiquidityTransactionDetails? = null
}
14 changes: 7 additions & 7 deletions ...ore/src/commonTest/kotlin/fr/acinq/lightning/payment/IncomingPaymentHandlerTestsCommon.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -873,7 +873,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
// - After the splice completes, Alice sends a second HTLC to Bob with the funding fee deduced
// - Bob accepts the MPP set
run {
val fundingFee = purchase.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = purchase.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)
val htlc = makeUpdateAddHtlc(1, channelId, paymentHandler, incomingPayment.paymentHash, makeMppPayload(amount2, totalAmount, paymentSecret), fundingFee = fundingFee)
assertTrue(htlc.amountMsat < amount2)
Expand Down Expand Up @@ -926,7 +926,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
// - After the splice completes, Alice sends a second HTLC to Bob without deducting the funding fee (it was paid from the channel balance)
// - Bob accepts the MPP set
run {
val fundingFee = purchase.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = purchase.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)
assertEquals(0.msat, fundingFee.amount)
val htlc = makeUpdateAddHtlc(7, channelId, paymentHandler, incomingPayment.paymentHash, makeMppPayload(amount, amount, paymentSecret), fundingFee = fundingFee)
Expand Down Expand Up @@ -980,7 +980,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
)
val payment = AutomaticLiquidityPurchasePayment(UUID.randomUUID(), purchase.fees.miningFee, channelId, TxId(randomBytes32()), purchase, 0, null, null, null)
paymentHandler.db.addOutgoingPayment(payment)
val fundingFee = payment.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = payment.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)

// Step 1 of 2:
Expand Down Expand Up @@ -1024,7 +1024,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
)
val payment = AutomaticLiquidityPurchasePayment(UUID.randomUUID(), purchase.fees.miningFee, channelId, TxId(randomBytes32()), purchase, 0, null, null, null)
paymentHandler.db.addOutgoingPayment(payment)
val fundingFee = payment.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = payment.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)
assertTrue(fundingFee.amount > 0.msat)

Expand Down Expand Up @@ -1063,7 +1063,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
)
val payment = AutomaticLiquidityPurchasePayment(UUID.randomUUID(), purchase.fees.miningFee, channelId, TxId(randomBytes32()), purchase, 0, null, null, null)
paymentHandler.db.addOutgoingPayment(payment)
val fundingFee = payment.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = payment.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)
assertEquals(0.msat, fundingFee.amount)

Expand Down Expand Up @@ -1091,7 +1091,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
)
val payment = AutomaticLiquidityPurchasePayment(UUID.randomUUID(), purchase.fees.miningFee, channelId, TxId(randomBytes32()), purchase, 0, null, null, null)
paymentHandler.db.addOutgoingPayment(payment)
val fundingFee = payment.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = payment.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)

val add = makeUpdateAddHtlc(0, channelId, paymentHandler, incomingPayment.paymentHash, makeMppPayload(defaultAmount, defaultAmount, paymentSecret), fundingFee = fundingFee)
Expand Down Expand Up @@ -1727,7 +1727,7 @@ class IncomingPaymentHandlerTestsCommon : LightningTestSuite() {
)
val payment = AutomaticLiquidityPurchasePayment(UUID.randomUUID(), purchase.fees.miningFee + 500.sat, channelId, TxId(randomBytes32()), purchase, 0, null, null, null)
paymentHandler.db.addOutgoingPayment(payment)
val fundingFee = payment.liquidityPurchaseDetails?.htlcFundingFee
val fundingFee = payment.liquidityPurchaseDetails.htlcFundingFee
assertNotNull(fundingFee)
assertTrue(fundingFee.amount > 0.msat)

Expand Down