Package fr.acinq.lightning.wire

Types

AcceptChannel

common

data class AcceptChannel(temporaryChannelId: ByteVector32, dustLimitSatoshis: Satoshi, maxHtlcValueInFlightMsat: Long, channelReserveSatoshis: Satoshi, htlcMinimumMsat: MilliSatoshi, minimumDepth: Long, toSelfDelay: CltvExpiryDelta, maxAcceptedHtlcs: Int, fundingPubkey: PublicKey, revocationBasepoint: PublicKey, paymentBasepoint: PublicKey, delayedPaymentBasepoint: PublicKey, htlcBasepoint: PublicKey, firstPerCommitmentPoint: PublicKey, tlvStream: TlvStream<ChannelTlv>) : ChannelMessage, HasTemporaryChannelId

AmountBelowMinimum

common

data class AmountBelowMinimum(amount: MilliSatoshi, update: ChannelUpdate) : FailureMessage, Update

AnnouncementMessage

common

interface AnnouncementMessage : RoutingMessage

AnnouncementSignatures

common

data class AnnouncementSignatures(channelId: ByteVector32, shortChannelId: ShortChannelId, nodeSignature: ByteVector64, bitcoinSignature: ByteVector64) : RoutingMessage, HasChannelId

BadOnion

common

interface BadOnion

ChannelAnnouncement

common

data class ChannelAnnouncement(nodeSignature1: ByteVector64, nodeSignature2: ByteVector64, bitcoinSignature1: ByteVector64, bitcoinSignature2: ByteVector64, features: Features, chainHash: ByteVector32, shortChannelId: ShortChannelId, nodeId1: PublicKey, nodeId2: PublicKey, bitcoinKey1: PublicKey, bitcoinKey2: PublicKey, unknownFields: ByteVector) : AnnouncementMessage, HasChainHash

ChannelDisabled

common

data class ChannelDisabled(messageFlags: Byte, channelFlags: Byte, update: ChannelUpdate) : FailureMessage, Update

ChannelMessage

common

interface ChannelMessage

ChannelReestablish

common

data class ChannelReestablish(channelId: ByteVector32, nextLocalCommitmentNumber: Long, nextRemoteRevocationNumber: Long, yourLastCommitmentSecret: PrivateKey, myCurrentPerCommitmentPoint: PublicKey, tlvStream: TlvStream<ChannelReestablishTlv>) : HasChannelId, HasEncryptedChannelData

ChannelReestablishTlv

common

sealed class ChannelReestablishTlv : Tlv

ChannelTlv

common

sealed class ChannelTlv : Tlv

ChannelUpdate

common

data class ChannelUpdate(signature: ByteVector64, chainHash: ByteVector32, shortChannelId: ShortChannelId, timestampSeconds: Long, messageFlags: Byte, channelFlags: Byte, cltvExpiryDelta: CltvExpiryDelta, htlcMinimumMsat: MilliSatoshi, feeBaseMsat: MilliSatoshi, feeProportionalMillionths: Long, htlcMaximumMsat: MilliSatoshi?, unknownFields: ByteVector) : AnnouncementMessage, HasTimestamp, HasChainHash

ClosingSigned

common

data class ClosingSigned(channelId: ByteVector32, feeSatoshis: Satoshi, signature: ByteVector64, tlvStream: TlvStream<ClosingSignedTlv>) : ChannelMessage, HasChannelId, HasEncryptedChannelData

ClosingSignedTlv

common

sealed class ClosingSignedTlv : Tlv

CommitSig

common

data class CommitSig(channelId: ByteVector32, signature: ByteVector64, htlcSignatures: List<ByteVector64>, tlvStream: TlvStream<CommitSigTlv>) : HtlcMessage, HasChannelId, HasEncryptedChannelData

CommitSigTlv

common

sealed class CommitSigTlv : Tlv

EncryptedChannelData

common

data class EncryptedChannelData(data: ByteVector)

Error

common

data class Error(channelId: ByteVector32, data: ByteVector) : SetupMessage, HasChannelId

ExpiryTooFar

common

object ExpiryTooFar : FailureMessage

ExpiryTooSoon

common

data class ExpiryTooSoon(update: ChannelUpdate) : FailureMessage, Update

FailureMessage

common

sealed class FailureMessage

FCMToken

common

data class FCMToken(token: ByteVector) : LightningMessage

FeeInsufficient

common

data class FeeInsufficient(amount: MilliSatoshi, update: ChannelUpdate) : FailureMessage, Update

FinalIncorrectCltvExpiry

common

data class FinalIncorrectCltvExpiry(expiry: CltvExpiry) : FailureMessage

FinalIncorrectHtlcAmount

common

data class FinalIncorrectHtlcAmount(amount: MilliSatoshi) : FailureMessage

FundingCreated

common

data class FundingCreated(temporaryChannelId: ByteVector32, fundingTxid: ByteVector32, fundingOutputIndex: Int, signature: ByteVector64) : ChannelMessage, HasTemporaryChannelId

FundingLocked

common

data class FundingLocked(channelId: ByteVector32, nextPerCommitmentPoint: PublicKey) : ChannelMessage, HasChannelId

FundingSigned

common

data class FundingSigned(channelId: ByteVector32, signature: ByteVector64, tlvStream: TlvStream<FundingSignedTlv>) : ChannelMessage, HasChannelId, HasEncryptedChannelData

FundingSignedTlv

common

sealed class FundingSignedTlv : Tlv

GenericTlv

common

data class GenericTlv(tag: Long, value: ByteVector) : Tlv

Generic tlv type we fallback to if we don't understand the incoming tlv.

HasChainHash

common

interface HasChainHash : LightningMessage

HasChannelId

common

interface HasChannelId : LightningMessage

HasEncryptedChannelData

common

interface HasEncryptedChannelData : LightningMessage

HasTemporaryChannelId

common

interface HasTemporaryChannelId : LightningMessage

HasTimestamp

common

interface HasTimestamp : LightningMessage

HtlcMessage

common

interface HtlcMessage : LightningMessage

HtlcSettlementMessage

common

interface HtlcSettlementMessage : UpdateMessage

IncorrectCltvExpiry

common

data class IncorrectCltvExpiry(expiry: CltvExpiry, update: ChannelUpdate) : FailureMessage, Update

IncorrectOrUnknownPaymentDetails

common

data class IncorrectOrUnknownPaymentDetails(amount: MilliSatoshi, height: Long) : FailureMessage, Perm

Init

common

data class Init(features: ByteVector, tlvs: TlvStream<InitTlv>) : SetupMessage

InitTlv

common

sealed class InitTlv : Tlv

Tlv types used inside Init messages.

InvalidOnionHmac

common

data class InvalidOnionHmac(onionHash: ByteVector32) : FailureMessage, BadOnion, Perm

InvalidOnionKey

common

data class InvalidOnionKey(onionHash: ByteVector32) : FailureMessage, BadOnion, Perm

InvalidOnionPayload

common

data class InvalidOnionPayload(tag: ULong, offset: Int) : FailureMessage, Perm

InvalidOnionVersion

common

data class InvalidOnionVersion(onionHash: ByteVector32) : FailureMessage, BadOnion, Perm

InvalidRealm

common

object InvalidRealm : FailureMessage, Perm

LightningCodecs

common

@ExperimentalStdlibApi

object LightningCodecs

LightningMessage

common

interface LightningMessage

LightningMessageReader

common

interface LightningMessageReader<T : LightningMessage>

Node

common

interface Node

OnionPaymentPayloadTlv

common

sealed class OnionPaymentPayloadTlv : Tlv

OnionRoutingPacket

common

data class OnionRoutingPacket(version: Int, publicKey: ByteVector, payload: ByteVector, hmac: ByteVector32)

OnionRoutingPacketSerializer

common

class OnionRoutingPacketSerializer(payloadLength: Int)

OpenChannel

common

data class OpenChannel(chainHash: ByteVector32, temporaryChannelId: ByteVector32, fundingSatoshis: Satoshi, pushMsat: MilliSatoshi, dustLimitSatoshis: Satoshi, maxHtlcValueInFlightMsat: Long, channelReserveSatoshis: Satoshi, htlcMinimumMsat: MilliSatoshi, feeratePerKw: FeeratePerKw, toSelfDelay: CltvExpiryDelta, maxAcceptedHtlcs: Int, fundingPubkey: PublicKey, revocationBasepoint: PublicKey, paymentBasepoint: PublicKey, delayedPaymentBasepoint: PublicKey, htlcBasepoint: PublicKey, firstPerCommitmentPoint: PublicKey, channelFlags: Byte, tlvStream: TlvStream<ChannelTlv>) : ChannelMessage, HasTemporaryChannelId, HasChainHash

PaymentOnion

common

object PaymentOnion

PaymentTimeout

common

object PaymentTimeout : FailureMessage

PayToOpenRequest

common

data class PayToOpenRequest(chainHash: ByteVector32, fundingSatoshis: Satoshi, amountMsat: MilliSatoshi, payToOpenMinAmountMsat: MilliSatoshi, payToOpenFeeSatoshis: Satoshi, paymentHash: ByteVector32, expireAt: Long, finalPacket: OnionRoutingPacket) : LightningMessage, HasChainHash

When we don't have enough incoming liquidity to receive a payment, our peer may open a channel to us on-the-fly to carry that payment. This message contains details that allow us to recalculate the fee that our peer will take in exchange for the new channel. This allows us to combine multiple requests for the same payment and figure out the final fee that will be applied.

PayToOpenResponse

common

data class PayToOpenResponse(chainHash: ByteVector32, paymentHash: ByteVector32, result: PayToOpenResponse.Result) : LightningMessage, HasChainHash

Perm

common

interface Perm

PermanentChannelFailure

common

object PermanentChannelFailure : FailureMessage, Perm

PermanentNodeFailure

common

object PermanentNodeFailure : FailureMessage, Perm, Node

PhoenixAndroidLegacyInfo

common

data class PhoenixAndroidLegacyInfo(hasChannels: Boolean) : LightningMessage

PhoenixAndroidLegacyMigrate

common

data class PhoenixAndroidLegacyMigrate(newNodeId: PublicKey) : LightningMessage

Ping

common

data class Ping(pongLength: Int, data: ByteVector) : SetupMessage

Pong

common

data class Pong(data: ByteVector) : SetupMessage

RequiredChannelFeatureMissing

common

object RequiredChannelFeatureMissing : FailureMessage, Perm

RequiredNodeFeatureMissing

common

object RequiredNodeFeatureMissing : FailureMessage, Perm, Node

RevokeAndAck

common

data class RevokeAndAck(channelId: ByteVector32, perCommitmentSecret: PrivateKey, nextPerCommitmentPoint: PublicKey, tlvStream: TlvStream<RevokeAndAckTlv>) : HtlcMessage, HasChannelId, HasEncryptedChannelData

RevokeAndAckTlv

common

sealed class RevokeAndAckTlv : Tlv

RoutingMessage

common

interface RoutingMessage : LightningMessage

SetupMessage

common

interface SetupMessage : LightningMessage

Shutdown

common

data class Shutdown(channelId: ByteVector32, scriptPubKey: ByteVector, tlvStream: TlvStream<ShutdownTlv>) : ChannelMessage, HasChannelId, HasEncryptedChannelData

ShutdownTlv

common

sealed class ShutdownTlv : Tlv

SwapInConfirmed

common

data class SwapInConfirmed(bitcoinAddress: String, amount: MilliSatoshi) : LightningMessage

SwapInPending

common

data class SwapInPending(bitcoinAddress: String, amount: Satoshi) : LightningMessage

SwapInRequest

common

data class SwapInRequest(chainHash: ByteVector32) : LightningMessage, HasChainHash

SwapInResponse

common

data class SwapInResponse(chainHash: ByteVector32, bitcoinAddress: String) : LightningMessage, HasChainHash

TemporaryChannelFailure

common

data class TemporaryChannelFailure(update: ChannelUpdate) : FailureMessage, Update

TemporaryNodeFailure

common

object TemporaryNodeFailure : FailureMessage, Node

Tlv

common

interface Tlv

TlvStream

common

data class TlvStream<T : Tlv>(records: List<T>, unknown: List<GenericTlv>)

A tlv stream is a collection of tlv records. A tlv stream is constrained to a specific tlv namespace that dictates how to parse the tlv records. That namespace is provided by a trait extending the top-level tlv trait.

TlvStreamSerializer

common

class TlvStreamSerializer<T : Tlv>(lengthPrefixed: Boolean, readers: Map<Long, TlvValueReader<T>>)

TlvValueReader

common

interface TlvValueReader<T : Tlv>

TrampolineExpiryTooSoon

common

object TrampolineExpiryTooSoon : FailureMessage, Node

TrampolineFeeInsufficient

common

object TrampolineFeeInsufficient : FailureMessage, Node

UnknownFailureMessage

common

data class UnknownFailureMessage(code: Int) : FailureMessage

We allow remote nodes to send us unknown failure codes (e.g. deprecated failure codes). By reading the PERM and NODE bits of the failure code we can still extract useful information for payment retry even without knowing how to decode the failure payload (but we can't extract a channel update or onion hash).

UnknownNextPeer

common

object UnknownNextPeer : FailureMessage, Perm

UnsetFCMToken

common

object UnsetFCMToken : LightningMessage

Update

common

interface Update

UpdateAddHtlc

common

data class UpdateAddHtlc(channelId: ByteVector32, id: Long, amountMsat: MilliSatoshi, paymentHash: ByteVector32, cltvExpiry: CltvExpiry, onionRoutingPacket: OnionRoutingPacket) : HtlcMessage, UpdateMessage, HasChannelId

UpdateFailHtlc

common

data class UpdateFailHtlc(channelId: ByteVector32, id: Long, reason: ByteVector) : HtlcMessage, HtlcSettlementMessage, HasChannelId

UpdateFailMalformedHtlc

common

data class UpdateFailMalformedHtlc(channelId: ByteVector32, id: Long, onionHash: ByteVector32, failureCode: Int) : HtlcMessage, HtlcSettlementMessage, HasChannelId

UpdateFee

common

data class UpdateFee(channelId: ByteVector32, feeratePerKw: FeeratePerKw) : ChannelMessage, UpdateMessage, HasChannelId

UpdateFulfillHtlc

common

data class UpdateFulfillHtlc(channelId: ByteVector32, id: Long, paymentPreimage: ByteVector32) : HtlcMessage, HtlcSettlementMessage, HasChannelId

UpdateMessage

common

interface UpdateMessage : LightningMessage

Warning

common

data class Warning(channelId: ByteVector32, data: ByteVector) : SetupMessage, HasChannelId