Package fr.acinq.lightning.serialization.v1

Types

Aborted

common

data class Aborted(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates) : ChannelState

AbstractBtcSerializableKSerializer

common

abstract class AbstractBtcSerializableKSerializer<T : BtcSerializable<T>>(name: String, btcSerializer: BtcSerializer<T>) : KSerializer<T>

AbstractStringKSerializer

common

abstract class AbstractStringKSerializer<T>(name: String, toString: (T) -> String, fromString: (String) -> T) : KSerializer<T>

BlockHeaderKSerializer

common

object BlockHeaderKSerializer : AbstractBtcSerializableKSerializer<BlockHeader>

ByteVector32KSerializer

common

object ByteVector32KSerializer : AbstractStringKSerializer<ByteVector32>

ByteVector64KSerializer

common

object ByteVector64KSerializer : AbstractStringKSerializer<ByteVector64>

ByteVectorKSerializer

common

object ByteVectorKSerializer : AbstractStringKSerializer<ByteVector>

ChannelState

common

sealed class ChannelState

ChannelStateWithCommitments

common

sealed class ChannelStateWithCommitments : ChannelState

ChannelVersion

common

data class ChannelVersion(bits: ByteVector)

Closed

common

data class Closed(state: Closing) : ChannelStateWithCommitments

Closing

common

data class Closing(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, fundingTx: Transaction?, waitingSinceBlock: Long, mutualCloseProposed: List<Transactions.TransactionWithInputInfo.ClosingTx>, mutualClosePublished: List<Transactions.TransactionWithInputInfo.ClosingTx>, localCommitPublished: LocalCommitPublished?, remoteCommitPublished: RemoteCommitPublished?, nextRemoteCommitPublished: RemoteCommitPublished?, futureRemoteCommitPublished: RemoteCommitPublished?, revokedCommitPublished: List<RevokedCommitPublished>) : ChannelStateWithCommitments

ClosingTxProposed

common

data class ClosingTxProposed(unsignedTx: Transactions.TransactionWithInputInfo.ClosingTx, localClosingSigned: ClosingSigned)

Commitments

common

data class Commitments(channelVersion: ChannelVersion, 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)

CommitmentSpec

common

data class CommitmentSpec(htlcs: Set<DirectedHtlc>, feerate: FeeratePerKw, toLocal: MilliSatoshi, toRemote: MilliSatoshi)

DirectedHtlc

common

sealed class DirectedHtlc

EitherSerializer

common

class EitherSerializer<A : Any, B : Any>(aSer: KSerializer<A>, bSer: KSerializer<B>) : KSerializer<Either<A, B>>

ErrorInformationLeak

common

data class ErrorInformationLeak(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments) : ChannelStateWithCommitments

ExtendedPrivateKeyKSerializer

common

object ExtendedPrivateKeyKSerializer : KSerializer<DeterministicWallet.ExtendedPrivateKey>

ExtendedPublicKeyKSerializer

common

object ExtendedPublicKeyKSerializer : KSerializer<DeterministicWallet.ExtendedPublicKey>

HtlcTxAndSigs

common

data class HtlcTxAndSigs(txinfo: Transactions.TransactionWithInputInfo.HtlcTx, localSig: ByteVector64, remoteSig: ByteVector64)

IncomingHtlc

common

data class IncomingHtlc(add: UpdateAddHtlc) : DirectedHtlc

InitFunder

common

data class InitFunder(temporaryChannelId: ByteVector32, fundingAmount: Satoshi, pushAmount: MilliSatoshi, initialFeerate: FeeratePerKw, fundingTxFeerate: FeeratePerKw, localParams: LocalParams, remoteInit: Init, channelFlags: Byte, channelVersion: ChannelVersion)

KeyPathKSerializer

common

object KeyPathKSerializer : KSerializer<KeyPath>

LocalChanges

common

data class LocalChanges(proposed: List<UpdateMessage>, signed: List<UpdateMessage>, acked: List<UpdateMessage>)

LocalCommit

common

data class LocalCommit(index: Long, spec: CommitmentSpec, publishableTxs: PublishableTxs)

LocalCommitPublished

common

data class LocalCommitPublished(commitTx: Transaction, claimMainDelayedOutputTx: Transactions.TransactionWithInputInfo.ClaimLocalDelayedOutputTx?, htlcTxs: Map<OutPoint, Transactions.TransactionWithInputInfo.HtlcTx?>, claimHtlcDelayedTxs: List<Transactions.TransactionWithInputInfo.ClaimLocalDelayedOutputTx>, claimAnchorTxs: List<Transactions.TransactionWithInputInfo.ClaimAnchorOutputTx>, irrevocablySpent: Map<OutPoint, Transaction>)

LocalParams

common

data class LocalParams(nodeId: PublicKey, fundingKeyPath: KeyPath, dustLimit: Satoshi, maxHtlcValueInFlightMsat: Long, channelReserve: Satoshi, htlcMinimum: MilliSatoshi, toSelfDelay: CltvExpiryDelta, maxAcceptedHtlcs: Int, isFunder: Boolean, defaultFinalScriptPubKey: ByteVector, features: Features)

README: by design, we do not include channel private keys and secret here, so they won't be included in our backups (local files, encrypted peer backup, ...), so even if these backups were compromised channel private keys would not be leaked unless the main seed was also compromised. This means that they will be recomputed once when we convert serialized data to their "live" counterparts.

Negotiating

common

data class Negotiating(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, localShutdown: Shutdown, remoteShutdown: Shutdown, closingTxProposed: List<List<ClosingTxProposed>>, bestUnpublishedClosingTx: Transactions.TransactionWithInputInfo.ClosingTx?) : ChannelStateWithCommitments

Normal

common

data class Normal(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, shortChannelId: ShortChannelId, buried: Boolean, channelAnnouncement: ChannelAnnouncement?, channelUpdate: ChannelUpdate, remoteChannelUpdate: ChannelUpdate?, localShutdown: Shutdown?, remoteShutdown: Shutdown?) : ChannelStateWithCommitments

Offline

common

data class Offline(state: ChannelStateWithCommitments) : ChannelState

OnChainFeerates

common

data class OnChainFeerates(mutualCloseFeerate: FeeratePerKw, claimMainFeerate: FeeratePerKw, fastFeerate: FeeratePerKw)

OutgoingHtlc

common

data class OutgoingHtlc(add: UpdateAddHtlc) : DirectedHtlc

OutPointKSerializer

common

object OutPointKSerializer : AbstractBtcSerializableKSerializer<OutPoint>

PrivateKeyKSerializer

common

object PrivateKeyKSerializer : AbstractStringKSerializer<PrivateKey>

PublicKeyKSerializer

common

object PublicKeyKSerializer : AbstractStringKSerializer<PublicKey>

PublishableTxs

common

data class PublishableTxs(commitTx: Transactions.TransactionWithInputInfo.CommitTx, htlcTxsAndSigs: List<HtlcTxAndSigs>)

RemoteChanges

common

data class RemoteChanges(proposed: List<UpdateMessage>, acked: List<UpdateMessage>, signed: List<UpdateMessage>)

RemoteCommit

common

data class RemoteCommit(index: Long, spec: CommitmentSpec, txid: ByteVector32, remotePerCommitmentPoint: PublicKey)

RemoteCommitPublished

common

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

RemoteParams

common

data class RemoteParams(nodeId: PublicKey, dustLimit: Satoshi, maxHtlcValueInFlightMsat: Long, channelReserve: Satoshi, htlcMinimum: MilliSatoshi, toSelfDelay: CltvExpiryDelta, maxAcceptedHtlcs: Int, fundingPubKey: PublicKey, revocationBasepoint: PublicKey, paymentBasepoint: PublicKey, delayedPaymentBasepoint: PublicKey, htlcBasepoint: PublicKey, features: Features)

RevokedCommitPublished

common

data class RevokedCommitPublished(commitTx: Transaction, remotePerCommitmentSecret: PrivateKey, claimMainOutputTx: Transactions.TransactionWithInputInfo.ClaimRemoteCommitMainOutputTx?, mainPenaltyTx: Transactions.TransactionWithInputInfo.MainPenaltyTx?, htlcPenaltyTxs: List<Transactions.TransactionWithInputInfo.HtlcPenaltyTx>, claimHtlcDelayedPenaltyTxs: List<Transactions.TransactionWithInputInfo.ClaimHtlcDelayedOutputPenaltyTx>, irrevocablySpent: Map<OutPoint, Transaction>)

SatoshiKSerializer

common

object SatoshiKSerializer : KSerializer<Satoshi>

ScriptWitnessKSerializer

common

object ScriptWitnessKSerializer : AbstractBtcSerializableKSerializer<ScriptWitness>

Serialization

common

object Serialization

ShaChainSerializer

common

object ShaChainSerializer : KSerializer<ShaChain>

ShuttingDown

common

data class ShuttingDown(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, localShutdown: Shutdown, remoteShutdown: Shutdown) : ChannelStateWithCommitments

StaticParams

common

data class StaticParams(chainHash: ByteVector32, remoteNodeId: PublicKey)

Syncing

common

data class Syncing(state: ChannelStateWithCommitments, waitForTheirReestablishMessage: Boolean) : ChannelState

TransactionKSerializer

common

object TransactionKSerializer : AbstractBtcSerializableKSerializer<Transaction>

TxInKSerializer

common

object TxInKSerializer : AbstractBtcSerializableKSerializer<TxIn>

TxOutKSerializer

common

object TxOutKSerializer : AbstractBtcSerializableKSerializer<TxOut>

WaitForAcceptChannel

common

data class WaitForAcceptChannel(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, initFunder: InitFunder, lastSent: OpenChannel) : ChannelState

WaitForFundingConfirmed

common

data class WaitForFundingConfirmed(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, fundingTx: Transaction?, waitingSinceBlock: Long, deferred: FundingLocked?, lastSent: Either<FundingCreated, FundingSigned>) : ChannelStateWithCommitments

WaitForFundingCreated

common

data class WaitForFundingCreated(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, temporaryChannelId: ByteVector32, localParams: LocalParams, remoteParams: RemoteParams, fundingAmount: Satoshi, pushAmount: MilliSatoshi, initialFeerate: FeeratePerKw, remoteFirstPerCommitmentPoint: PublicKey, channelFlags: Byte, channelVersion: ChannelVersion, lastSent: AcceptChannel) : ChannelState

WaitForFundingInternal

common

data class WaitForFundingInternal(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, temporaryChannelId: ByteVector32, localParams: LocalParams, remoteParams: RemoteParams, fundingAmount: Satoshi, pushAmount: MilliSatoshi, initialFeerate: FeeratePerKw, remoteFirstPerCommitmentPoint: PublicKey, channelVersion: ChannelVersion, lastSent: OpenChannel) : ChannelState

WaitForFundingLocked

common

data class WaitForFundingLocked(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, shortChannelId: ShortChannelId, lastSent: FundingLocked) : ChannelStateWithCommitments

WaitForFundingSigned

common

data class WaitForFundingSigned(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, channelId: ByteVector32, localParams: LocalParams, remoteParams: RemoteParams, fundingTx: Transaction, fundingTxFee: Satoshi, localSpec: CommitmentSpec, localCommitTx: Transactions.TransactionWithInputInfo.CommitTx, remoteCommit: RemoteCommit, channelFlags: Byte, channelVersion: ChannelVersion, lastSent: FundingCreated) : ChannelState

WaitForInit

common

data class WaitForInit(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates) : ChannelState

WaitForOpenChannel

common

data class WaitForOpenChannel(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, temporaryChannelId: ByteVector32, localParams: LocalParams, remoteInit: Init) : ChannelState

WaitForRemotePublishFutureCommitment

common

data class WaitForRemotePublishFutureCommitment(staticParams: StaticParams, currentTip: Pair<Int, BlockHeader>, currentOnChainFeerates: OnChainFeerates, commitments: Commitments, remoteChannelReestablish: ChannelReestablish) : ChannelStateWithCommitments

WaitingForRevocation

common

data class WaitingForRevocation(nextRemoteCommit: RemoteCommit, sent: CommitSig, sentAfterLocalCommitIndex: Long, reSignAsap: Boolean)