Commitments

data class Commitments(channelConfig: ChannelConfig, channelFeatures: ChannelFeatures, localParams: LocalParams, remoteParams: RemoteParams, channelFlags: Byte, localCommit: LocalCommit, remoteCommit: RemoteCommit, localChanges: LocalChanges, remoteChanges: RemoteChanges, localNextHtlcId: Long, remoteNextHtlcId: Long, payments: Map<Long, UUID>, remoteNextCommitInfo: Either<WaitingForRevocation, PublicKey>, commitInput: Transactions.InputInfo, remotePerCommitmentSecrets: ShaChain, channelId: ByteVector32, remoteChannelData: EncryptedChannelData)

about remoteNextCommitInfo: we either:

have built and signed their next commit tx with their next revocation hash which can now be discarded
have their next per-commitment point So, when we've signed and sent a commit message and are waiting for their revocation message, theirNextCommitInfo is their next commit tx. The rest of the time, it is their next per-commitment point

Constructors

Commitments

common

fun Commitments(channelConfig: ChannelConfig, channelFeatures: ChannelFeatures, localParams: LocalParams, remoteParams: RemoteParams, channelFlags: Byte, localCommit: LocalCommit, remoteCommit: RemoteCommit, localChanges: LocalChanges, remoteChanges: RemoteChanges, localNextHtlcId: Long, remoteNextHtlcId: Long, payments: Map<Long, UUID>, remoteNextCommitInfo: Either<WaitingForRevocation, PublicKey>, commitInput: Transactions.InputInfo, remotePerCommitmentSecrets: ShaChain, channelId: ByteVector32, remoteChannelData: EncryptedChannelData = EncryptedChannelData.empty)

Types

Companion

common

object Companion

Functions

almostTimedOutIncomingHtlcs

common

fun almostTimedOutIncomingHtlcs(blockHeight: Long, fulfillSafety: CltvExpiryDelta): Set<UpdateAddHtlc>

Incoming HTLCs that are close to timing out are potentially dangerous. If we released the pre-image for those HTLCs, we need to get a remote signed updated commitment that removes this HTLC. Otherwise when we get close to the timeout, we risk an on-chain race condition between their HTLC timeout and our HTLC success in case of a force-close.

availableBalanceForReceive

common

fun availableBalanceForReceive(): MilliSatoshi

availableBalanceForSend

common

fun availableBalanceForSend(): MilliSatoshi

hasNoPendingHtlcs

common

fun hasNoPendingHtlcs(): Boolean

hasNoPendingHtlcsOrFeeUpdate

common

fun hasNoPendingHtlcsOrFeeUpdate(): Boolean

isMoreRecent

common

fun isMoreRecent(other: Commitments): Boolean

localHasChanges

common

fun localHasChanges(): Boolean

localHasUnsignedOutgoingHtlcs

common

fun localHasUnsignedOutgoingHtlcs(): Boolean

localHasUnsignedOutgoingUpdateFee

common

fun localHasUnsignedOutgoingUpdateFee(): Boolean

nothingAtStake

common

fun nothingAtStake(): Boolean

receiveAdd

common

fun receiveAdd(add: UpdateAddHtlc): Either<ChannelException, Commitments>

receiveCommit

common

fun receiveCommit(commit: CommitSig, keyManager: KeyManager, log: Logger): Either<ChannelException, Pair<Commitments, RevokeAndAck>>

receiveFail

common

fun receiveFail(fail: UpdateFailHtlc): Either<ChannelException, Triple<Commitments, UUID, UpdateAddHtlc>>

receiveFailMalformed

common

fun receiveFailMalformed(fail: UpdateFailMalformedHtlc): Either<ChannelException, Triple<Commitments, UUID, UpdateAddHtlc>>

receiveFee

common

fun receiveFee(fee: UpdateFee, feerateTolerance: FeerateTolerance): Either<ChannelException, Commitments>

receiveFulfill

common

fun receiveFulfill(fulfill: UpdateFulfillHtlc): Either<ChannelException, Triple<Commitments, UUID, UpdateAddHtlc>>

receiveRevocation

common

fun receiveRevocation(revocation: RevokeAndAck): Either<ChannelException, Pair<Commitments, List<ChannelAction>>>

remoteHasChanges

common

fun remoteHasChanges(): Boolean

remoteHasUnsignedOutgoingHtlcs

common

fun remoteHasUnsignedOutgoingHtlcs(): Boolean

remoteHasUnsignedOutgoingUpdateFee

common

fun remoteHasUnsignedOutgoingUpdateFee(): Boolean

sendAdd

common

fun sendAdd(cmd: CMD_ADD_HTLC, paymentId: UUID, blockHeight: Long): Either<ChannelException, Pair<Commitments, UpdateAddHtlc>>

sendCommit

common

fun sendCommit(keyManager: KeyManager, log: Logger): Either<ChannelException, Pair<Commitments, CommitSig>>

sendFail

common

fun sendFail(cmd: CMD_FAIL_HTLC, nodeSecret: PrivateKey): Either<ChannelException, Pair<Commitments, UpdateFailHtlc>>

sendFailMalformed

common

fun sendFailMalformed(cmd: CMD_FAIL_MALFORMED_HTLC): Either<ChannelException, Pair<Commitments, UpdateFailMalformedHtlc>>

sendFee

common

fun sendFee(cmd: CMD_UPDATE_FEE): Either<ChannelException, Pair<Commitments, UpdateFee>>

sendFulfill

common

fun sendFulfill(cmd: CMD_FULFILL_HTLC): Either<ChannelException, Pair<Commitments, UpdateFulfillHtlc>>

timedOutOutgoingHtlcs

common

fun timedOutOutgoingHtlcs(blockHeight: Long): Set<UpdateAddHtlc>

updateFeatures

common

fun updateFeatures(localInit: Init, remoteInit: Init): Commitments

Properties

channelConfig

common

val channelConfig: ChannelConfig

channelFeatures

common

val channelFeatures: ChannelFeatures

channelFlags

common

val channelFlags: Byte

channelId

common

val channelId: ByteVector32

commitInput

common

val commitInput: Transactions.InputInfo

localChanges

common

val localChanges: LocalChanges

localCommit

common

val localCommit: LocalCommit

localNextHtlcId

common

val localNextHtlcId: Long

localParams

common

val localParams: LocalParams

payments

common

val payments: Map<Long, UUID>

remoteChanges

common

val remoteChanges: RemoteChanges

remoteChannelData

common

val remoteChannelData: EncryptedChannelData

remoteCommit

common

val remoteCommit: RemoteCommit

remoteNextCommitInfo

common

val remoteNextCommitInfo: Either<WaitingForRevocation, PublicKey>

remoteNextHtlcId

common

val remoteNextHtlcId: Long

remoteParams

common

val remoteParams: RemoteParams

remotePerCommitmentSecrets

common

val remotePerCommitmentSecrets: ShaChain