RemoteCommitPublished

data class RemoteCommitPublished(commitTx: Transaction, claimMainOutputTx: Transactions.TransactionWithInputInfo.ClaimRemoteCommitMainOutputTx?, claimHtlcTxs: Map<OutPoint, Transactions.TransactionWithInputInfo.ClaimHtlcTx?>, claimAnchorTxs: List<Transactions.TransactionWithInputInfo.ClaimAnchorOutputTx>, irrevocablySpent: Map<OutPoint, Transaction>)

Details about a force-close where they published their commitment.

Parameters

commitTx

commitment tx.

claimMainOutputTx

tx claiming our main output (if we have one).

claimHtlcTxs

txs claiming HTLCs. There will be one entry for each pending HTLC. The value will be null only for incoming HTLCs for which we don't have the preimage (we can't claim them yet).

claimAnchorTxs

txs spending anchor outputs to bump the feerate of the commitment tx (if applicable).

irrevocablySpent

map of relevant outpoints that have been spent and the confirmed transaction that spends them.

Constructors

RemoteCommitPublished

common

fun RemoteCommitPublished(commitTx: Transaction, claimMainOutputTx: Transactions.TransactionWithInputInfo.ClaimRemoteCommitMainOutputTx? = null, claimHtlcTxs: Map<OutPoint, Transactions.TransactionWithInputInfo.ClaimHtlcTx?> = emptyMap(), claimAnchorTxs: List<Transactions.TransactionWithInputInfo.ClaimAnchorOutputTx> = emptyList(), irrevocablySpent: Map<OutPoint, Transaction> = emptyMap())

Functions

isClaimHtlcSuccess

common

fun isClaimHtlcSuccess(tx: Transaction): Boolean

isClaimHtlcTimeout

common

fun isClaimHtlcTimeout(tx: Transaction): Boolean

isConfirmed

common

fun isConfirmed(): Boolean

isDone

common

fun isDone(): Boolean

A remote commit is considered done when all commitment tx outputs that we can spend have been spent and confirmed (even if the spending tx was not ours).

update

common

fun update(tx: Transaction): RemoteCommitPublished

In CLOSING state, when we are notified that a transaction has been confirmed, we check if this tx belongs in the remote commit scenario and keep track of it.

Properties

claimAnchorTxs

common

val claimAnchorTxs: List<Transactions.TransactionWithInputInfo.ClaimAnchorOutputTx>

claimHtlcTxs

common

val claimHtlcTxs: Map<OutPoint, Transactions.TransactionWithInputInfo.ClaimHtlcTx?>

claimMainOutputTx

common

val claimMainOutputTx: Transactions.TransactionWithInputInfo.ClaimRemoteCommitMainOutputTx? = null

commitTx

common

val commitTx: Transaction

irrevocablySpent

common

val irrevocablySpent: Map<OutPoint, Transaction>