Skip to content

Extract CommitParams to individual commitments #3118

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

Merged
t-bast merged 6 commits into from
Aug 19, 2025
Merged

Extract CommitParams to individual commitments #3118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
72a7d7e
Add more channel codecs v4 tests
t-bast Jun 13, 2025
e950165
Extract `CommitParams` to individual commitments
t-bast Jun 23, 2025
3872fed
Add commitment format to interactive-tx shared input
t-bast Jul 15, 2025
f7fb22e
Make channel type features non-permanent
t-bast Jul 15, 2025
010b093
fixup! Make channel type features non-permanent
t-bast Aug 19, 2025
a8bed6f
Temporarily disallow node start-up
t-bast Aug 19, 2025
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
15 changes: 6 additions & 9 deletions eclair-core/src/main/scala/fr/acinq/eclair/Features.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,15 @@ object FeatureSupport {

/** Not a sealed trait, so it can be extended by plugins. */
trait Feature {

def rfcName: String
def mandatory: Int
def optional: Int = mandatory + 1

def supportBit(support: FeatureSupport): Int = support match {
case Mandatory => mandatory
case Optional => optional
}

override def toString = rfcName
override def toString: String = rfcName
}

/** Feature scope as defined in Bolt 9. */
Expand All @@ -68,11 +66,9 @@ trait Bolt12Feature extends InvoiceFeature
*/
trait PermanentChannelFeature extends InitFeature // <- not in the spec
/**
* Permanent channel feature negotiated in the channel type. Those features take precedence over permanent channel
* features negotiated in init messages. For example, if the channel type is option_static_remotekey, then even if
* the option_anchor_outputs feature is supported by both peers, it won't apply to the channel.
* Features that can be included in the [[fr.acinq.eclair.wire.protocol.ChannelTlv.ChannelTypeTlv]].
*/
trait ChannelTypeFeature extends PermanentChannelFeature
trait ChannelTypeFeature extends InitFeature
// @formatter:on

case class UnknownFeature(bitIndex: Int)
Expand Down Expand Up @@ -275,6 +271,7 @@ object Features {
val rfcName = "option_attribution_data"
val mandatory = 36
}

case object OnionMessages extends Feature with InitFeature with NodeFeature {
val rfcName = "option_onion_messages"
val mandatory = 38
Expand All @@ -290,7 +287,7 @@ object Features {
val mandatory = 44
}

case object ScidAlias extends Feature with InitFeature with NodeFeature with ChannelTypeFeature {
case object ScidAlias extends Feature with InitFeature with NodeFeature with ChannelTypeFeature with PermanentChannelFeature {
val rfcName = "option_scid_alias"
val mandatory = 46
}
Expand All @@ -300,7 +297,7 @@ object Features {
val mandatory = 48
}

case object ZeroConf extends Feature with InitFeature with NodeFeature with ChannelTypeFeature {
case object ZeroConf extends Feature with InitFeature with NodeFeature with ChannelTypeFeature with PermanentChannelFeature {
val rfcName = "option_zeroconf"
val mandatory = 50
}
Expand Down
2 changes: 1 addition & 1 deletion eclair-core/src/main/scala/fr/acinq/eclair/SpendFromChannelAddress.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ trait SpendFromChannelAddress {
inputTx <- appKit.wallet.getTransaction(outPoint.txid)
channelKeys = appKit.nodeParams.channelKeyManager.channelKeys(ChannelConfig.standard, fundingKeyPath)
localFundingKey = channelKeys.fundingKey(fundingTxIndex)
inputInfo = InputInfo(outPoint, inputTx.txOut(outPoint.index.toInt), ByteVector.empty)
inputInfo = InputInfo(outPoint, inputTx.txOut(outPoint.index.toInt))
// classify as splice, doesn't really matter
tx = Transactions.SpliceTx(inputInfo, unsignedTx)
localSig = tx.sign(localFundingKey, remoteFundingPubkey, extraUtxos = Map.empty)
Expand Down
4 changes: 2 additions & 2 deletions eclair-core/src/main/scala/fr/acinq/eclair/balance/CheckBalance.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ object CheckBalance {
case d: DATA_SHUTDOWN => this.copy(shutdown = this.shutdown.addChannelBalance(d.commitments))
// If one of our closing transactions is in the mempool or recently confirmed, and thus included in our on-chain
// balance, we ignore this channel in our off-chain balance to avoid counting it twice.
case d: DATA_NEGOTIATING if recentlySpentInputs.contains(d.commitments.latest.commitInput.outPoint) => this
case d: DATA_NEGOTIATING_SIMPLE if recentlySpentInputs.contains(d.commitments.latest.commitInput.outPoint) => this
case d: DATA_NEGOTIATING if recentlySpentInputs.contains(d.commitments.latest.fundingInput) => this
case d: DATA_NEGOTIATING_SIMPLE if recentlySpentInputs.contains(d.commitments.latest.fundingInput) => this
// Otherwise, that means the closing transactions aren't in the mempool yet, so we include our off-chain balance.
case d: DATA_NEGOTIATING => this.copy(negotiating = this.negotiating.addChannelBalance(d.commitments))
case d: DATA_NEGOTIATING_SIMPLE => this.copy(negotiating = this.negotiating.addChannelBalance(d.commitments))
Expand Down
50 changes: 27 additions & 23 deletions eclair-core/src/main/scala/fr/acinq/eclair/channel/ChannelData.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import akka.actor.{ActorRef, PossiblyHarmful, typed}
import fr.acinq.bitcoin.scalacompat.Crypto.PublicKey
import fr.acinq.bitcoin.scalacompat.{ByteVector32, DeterministicWallet, OutPoint, Satoshi, SatoshiLong, Transaction, TxId, TxOut}
import fr.acinq.eclair.blockchain.fee.{ConfirmationTarget, FeeratePerKw}
import fr.acinq.eclair.channel.LocalFundingStatus.DualFundedUnconfirmedFundingTx
import fr.acinq.eclair.channel.fund.InteractiveTxBuilder._
import fr.acinq.eclair.channel.fund.{InteractiveTxBuilder, InteractiveTxSigningSession}
import fr.acinq.eclair.io.Peer
Expand Down Expand Up @@ -430,6 +429,7 @@ case class RevokedCommitPublished(commitTx: Transaction, localOutput_opt: Option
case class ShortIdAliases(localAlias: Alias, remoteAlias_opt: Option[Alias])

sealed trait LocalFundingStatus {
/** While the transaction is unconfirmed, we keep the funding transaction (if available) to allow rebroadcasting. */
def signedTx_opt: Option[Transaction]
/** We store local signatures for the purpose of retransmitting if the funding/splicing flow is interrupted. */
def localSigs_opt: Option[TxSignatures]
Expand Down Expand Up @@ -458,8 +458,8 @@ object LocalFundingStatus {
case class ZeroconfPublishedFundingTx(tx: Transaction, localSigs_opt: Option[TxSignatures], liquidityPurchase_opt: Option[LiquidityAds.PurchaseBasicInfo]) extends UnconfirmedFundingTx with Locked {
override val signedTx_opt: Option[Transaction] = Some(tx)
}
case class ConfirmedFundingTx(tx: Transaction, shortChannelId: RealShortChannelId, localSigs_opt: Option[TxSignatures], liquidityPurchase_opt: Option[LiquidityAds.PurchaseBasicInfo]) extends LocalFundingStatus with Locked {
override val signedTx_opt: Option[Transaction] = Some(tx)
case class ConfirmedFundingTx(txOut: TxOut, shortChannelId: RealShortChannelId, localSigs_opt: Option[TxSignatures], liquidityPurchase_opt: Option[LiquidityAds.PurchaseBasicInfo]) extends LocalFundingStatus with Locked {
override val signedTx_opt: Option[Transaction] = None
}
}

Expand Down Expand Up @@ -567,23 +567,34 @@ final case class DATA_WAIT_FOR_ACCEPT_CHANNEL(initFunder: INPUT_INIT_CHANNEL_INI
val channelId: ByteVector32 = initFunder.temporaryChannelId
}
final case class DATA_WAIT_FOR_FUNDING_INTERNAL(channelParams: ChannelParams,
channelType: SupportedChannelType,
localCommitParams: CommitParams,
remoteCommitParams: CommitParams,
fundingAmount: Satoshi,
pushAmount: MilliSatoshi,
commitTxFeerate: FeeratePerKw,
remoteFundingPubKey: PublicKey,
remoteFirstPerCommitmentPoint: PublicKey,
replyTo: akka.actor.typed.ActorRef[Peer.OpenChannelResponse]) extends TransientChannelData {
val channelId: ByteVector32 = channelParams.channelId
val commitmentFormat: CommitmentFormat = channelType.commitmentFormat
}
final case class DATA_WAIT_FOR_FUNDING_CREATED(channelParams: ChannelParams,
channelType: SupportedChannelType,
localCommitParams: CommitParams,
remoteCommitParams: CommitParams,
fundingAmount: Satoshi,
pushAmount: MilliSatoshi,
commitTxFeerate: FeeratePerKw,
remoteFundingPubKey: PublicKey,
remoteFirstPerCommitmentPoint: PublicKey) extends TransientChannelData {
val channelId: ByteVector32 = channelParams.channelId
val commitmentFormat: CommitmentFormat = channelType.commitmentFormat
}
final case class DATA_WAIT_FOR_FUNDING_SIGNED(channelParams: ChannelParams,
channelType: SupportedChannelType,
localCommitParams: CommitParams,
remoteCommitParams: CommitParams,
remoteFundingPubKey: PublicKey,
fundingTx: Transaction,
fundingTxFee: Satoshi,
Expand All @@ -593,6 +604,7 @@ final case class DATA_WAIT_FOR_FUNDING_SIGNED(channelParams: ChannelParams,
lastSent: FundingCreated,
replyTo: akka.actor.typed.ActorRef[Peer.OpenChannelResponse]) extends TransientChannelData {
val channelId: ByteVector32 = channelParams.channelId
val commitmentFormat: CommitmentFormat = channelType.commitmentFormat
}
final case class DATA_WAIT_FOR_FUNDING_CONFIRMED(commitments: Commitments,
waitingSince: BlockHeight, // how long have we been waiting for the funding tx to confirm
Expand All @@ -610,6 +622,8 @@ final case class DATA_WAIT_FOR_ACCEPT_DUAL_FUNDED_CHANNEL(init: INPUT_INIT_CHANN
}
final case class DATA_WAIT_FOR_DUAL_FUNDING_CREATED(channelId: ByteVector32,
channelParams: ChannelParams,
localCommitParams: CommitParams,
remoteCommitParams: CommitParams,
secondRemotePerCommitmentPoint: PublicKey,
localPushAmount: MilliSatoshi,
remotePushAmount: MilliSatoshi,
Expand All @@ -620,29 +634,28 @@ final case class DATA_WAIT_FOR_DUAL_FUNDING_SIGNED(channelParams: ChannelParams,
secondRemotePerCommitmentPoint: PublicKey,
localPushAmount: MilliSatoshi,
remotePushAmount: MilliSatoshi,
signingSession: InteractiveTxSigningSession.WaitingForSigs,
remoteChannelData_opt: Option[ByteVector]) extends ChannelDataWithoutCommitments
signingSession: InteractiveTxSigningSession.WaitingForSigs) extends ChannelDataWithoutCommitments
final case class DATA_WAIT_FOR_DUAL_FUNDING_CONFIRMED(commitments: Commitments,
localPushAmount: MilliSatoshi,
remotePushAmount: MilliSatoshi,
waitingSince: BlockHeight, // how long have we been waiting for a funding tx to confirm
lastChecked: BlockHeight, // last time we checked if the channel was double-spent
status: DualFundingStatus,
deferred: Option[ChannelReady]) extends ChannelDataWithCommitments {
def allFundingTxs: Seq[DualFundedUnconfirmedFundingTx] = commitments.active.map(_.localFundingStatus).collect { case fundingTx: DualFundedUnconfirmedFundingTx => fundingTx }
def latestFundingTx: DualFundedUnconfirmedFundingTx = commitments.latest.localFundingStatus.asInstanceOf[DualFundedUnconfirmedFundingTx]
def previousFundingTxs: Seq[DualFundedUnconfirmedFundingTx] = allFundingTxs diff Seq(latestFundingTx)
def allFundingTxs: Seq[LocalFundingStatus.DualFundedUnconfirmedFundingTx] = commitments.active.map(_.localFundingStatus).collect { case fundingTx: LocalFundingStatus.DualFundedUnconfirmedFundingTx => fundingTx }
def latestFundingTx: LocalFundingStatus.DualFundedUnconfirmedFundingTx = commitments.latest.localFundingStatus.asInstanceOf[LocalFundingStatus.DualFundedUnconfirmedFundingTx]
def previousFundingTxs: Seq[LocalFundingStatus.DualFundedUnconfirmedFundingTx] = allFundingTxs diff Seq(latestFundingTx)
}
final case class DATA_WAIT_FOR_DUAL_FUNDING_READY(commitments: Commitments, aliases: ShortIdAliases) extends ChannelDataWithCommitments

final case class DATA_NORMAL(commitments: Commitments,
aliases: ShortIdAliases,
lastAnnouncement_opt: Option[ChannelAnnouncement],
channelUpdate: ChannelUpdate,
spliceStatus: SpliceStatus,
localShutdown: Option[Shutdown],
remoteShutdown: Option[Shutdown],
closeStatus_opt: Option[CloseStatus],
spliceStatus: SpliceStatus) extends ChannelDataWithCommitments {
closeStatus_opt: Option[CloseStatus]) extends ChannelDataWithCommitments {
val lastAnnouncedCommitment_opt: Option[AnnouncedCommitment] = lastAnnouncement_opt.flatMap(ann => commitments.resolveCommitment(ann.shortChannelId).map(c => AnnouncedCommitment(c, ann)))
val lastAnnouncedFundingTxId_opt: Option[TxId] = lastAnnouncedCommitment_opt.map(_.fundingTxId)
val isNegotiatingQuiescence: Boolean = spliceStatus.isNegotiatingQuiescence
Expand Down Expand Up @@ -675,24 +688,21 @@ final case class DATA_CLOSING(commitments: Commitments,
remoteCommitPublished: Option[RemoteCommitPublished] = None,
nextRemoteCommitPublished: Option[RemoteCommitPublished] = None,
futureRemoteCommitPublished: Option[RemoteCommitPublished] = None,
revokedCommitPublished: List[RevokedCommitPublished] = Nil) extends ChannelDataWithCommitments {
revokedCommitPublished: List[RevokedCommitPublished] = Nil,
maxClosingFeerate_opt: Option[FeeratePerKw] = None) extends ChannelDataWithCommitments {
val spendingTxs: List[Transaction] = mutualClosePublished.map(_.tx) ::: localCommitPublished.map(_.commitTx).toList ::: remoteCommitPublished.map(_.commitTx).toList ::: nextRemoteCommitPublished.map(_.commitTx).toList ::: futureRemoteCommitPublished.map(_.commitTx).toList ::: revokedCommitPublished.map(_.commitTx)
require(spendingTxs.nonEmpty, "there must be at least one tx published in this state")
}

final case class DATA_WAIT_FOR_REMOTE_PUBLISH_FUTURE_COMMITMENT(commitments: Commitments, remoteChannelReestablish: ChannelReestablish) extends ChannelDataWithCommitments

/** Local params that apply for the channel's lifetime. */
case class LocalChannelParams(nodeId: PublicKey,
fundingKeyPath: DeterministicWallet.KeyPath,
dustLimit: Satoshi,
maxHtlcValueInFlightMsat: UInt64,
// Channel reserve applied to the remote peer, if we're not using [[Features.DualFunding]] (in
// which case the reserve is set to 1%). If the channel is spliced, this initial value will be
// ignored in favor of a 1% reserve of the resulting capacity.
initialRequestedChannelReserve_opt: Option[Satoshi],
htlcMinimum: MilliSatoshi,
toRemoteDelay: CltvExpiryDelta,
maxAcceptedHtlcs: Int,
isChannelOpener: Boolean,
paysCommitTxFees: Boolean,
upfrontShutdownScript_opt: Option[ByteVector],
Expand All @@ -704,18 +714,12 @@ case class LocalChannelParams(nodeId: PublicKey,
// The node responsible for the commit tx fees is also the node paying the mutual close fees.
// The other node's balance may be empty, which wouldn't allow them to pay the closing fees.
val paysClosingFees: Boolean = paysCommitTxFees

val proposedCommitParams: ProposedCommitParams = ProposedCommitParams(dustLimit, htlcMinimum, maxHtlcValueInFlightMsat, maxAcceptedHtlcs, toRemoteDelay)
}

/** Remote params that apply for the channel's lifetime. */
case class RemoteChannelParams(nodeId: PublicKey,
dustLimit: Satoshi,
maxHtlcValueInFlightMsat: UInt64,
// See comment in LocalChannelParams for details.
initialRequestedChannelReserve_opt: Option[Satoshi],
htlcMinimum: MilliSatoshi,
toRemoteDelay: CltvExpiryDelta,
maxAcceptedHtlcs: Int,
revocationBasepoint: PublicKey,
paymentBasepoint: PublicKey,
delayedPaymentBasepoint: PublicKey,
Expand Down
Loading