Module vls_protocol::msgs

Structs

• AddBlock
• AddBlockReply
• BlockChunk
  Start or continue streaming a full block. Used when the compact proof has a false positive. The hash and the offset are provided to fail fast if there is a communication error. The stream of messages is always followed by an AddBlock with a proof type ExternalBlock.
• BlockChunkReply
• CheckFutureSecret
  CheckFutureSecret
• CheckFutureSecretReply
• CheckOutpoint
• CheckOutpointReply
• CheckPubKey
  CheckPubKey
• CheckPubKeyReply
• ClientHsmFd
  Connect a new client CLN only
• ClientHsmFdReply
• DebugTxoProof
  A debug wrapper around a TxoProof
• DeriveSecret
  DeriveSecret
• DeriveSecretReply
• Ecdh
• EcdhReply
• ForgetChannel
• ForgetChannelReply
• ForwardWatches
• ForwardWatchesReply
• GetChannelBasepoints
• GetChannelBasepointsReply
• GetHeartbeat
  Get a serialized signed heartbeat
• GetHeartbeatReply
  A serialized signed heartbeat
• GetPerCommitmentPoint
  Get per-commitment point n and optionally revoke a point n-2 by releasing the secret
• GetPerCommitmentPoint2
  Get per-commitment point LDK only
• GetPerCommitmentPoint2Reply
• GetPerCommitmentPointReply
• HsmdDevPreinit
  Developer setup for testing Must preceed HsmdInit{,2} message NOT FOR PRODUCTION USE
• HsmdDevPreinitReply
• HsmdInit
  hsmd Init CLN only
• HsmdInit2
  Signer Init for LDK LDK only
• HsmdInit2Reply
• HsmdInitReplyV2
  deprecated after CLN v23.05
• HsmdInitReplyV4
• LockOutpoint
• LockOutpointReply
• Memleak
  Memleak CLN only
• MemleakReply
• NewChannel
• NewChannelReply
• NodeInfo
  Get node public keys. Used by the frontend
• NodeInfoReply
• Ping
  Ping request LDK only
• Pong
  Ping reply LDK only
• PreapproveInvoice
  PreapproveInvoice {
• PreapproveInvoiceReply
• PreapproveKeysend
  PreapproveKeysend {
• PreapproveKeysendReply
• RemoveBlock
• RemoveBlockReply
• ReverseWatches
• ReverseWatchesReply
• RevokeCommitmentTx
  CLN only
• RevokeCommitmentTxReply
• SerialRequestHeader
  A serial request header
• SetupChannel
• SetupChannelReply
• SignAnchorspend
• SignAnchorspendReply
• SignAnyChannelAnnouncement
  CLN only Same as SignChannelAnnouncement but called from lightningd
• SignAnyChannelAnnouncementReply
• SignAnyDelayedPaymentToUs
  CLN only Same as SignDelayedPaymentToUs but called from lightningd
• SignAnyLocalHtlcTx
  CLN only Same as SignLocalHtlcTx but called from lightningd
• SignAnyPenaltyToUs
  Same as SignPenaltyToUs but called from lightningd
• SignAnyRemoteHtlcToUs
  CLN only Same as SignRemoteHtlcToUs but called from lightningd
• SignBolt12
  SignBolt12
• SignBolt12Reply
• SignChannelAnnouncement
• SignChannelAnnouncementReply
• SignChannelUpdate
  Sign channel update
• SignChannelUpdateReply
• SignCommitmentTx
  CLN only
• SignCommitmentTxReply
• SignCommitmentTxWithHtlcsReply
• SignDelayedPaymentToUs
  CLN only
• SignGossipMessage
• SignGossipMessageReply
• SignHtlcTxMingle
  CLN only
• SignHtlcTxMingleReply
• SignInvoice
  Sign invoice
• SignInvoiceReply
• SignLocalCommitmentTx2
  LDK only
• SignLocalHtlcTx
• SignMessage
  SignMessage
• SignMessageReply
• SignMutualCloseTx
  CLN only
• SignMutualCloseTx2
  LDK only
• SignNodeAnnouncement
• SignNodeAnnouncementReply
• SignPenaltyToUs
• SignRemoteCommitmentTx
  CLN only
• SignRemoteCommitmentTx2
  LDK only
• SignRemoteHtlcToUs
  CLN only
• SignRemoteHtlcTx
• SignSpliceTx
  CLN only
• SignTxReply
• SignWithdrawal
• SignWithdrawalReply
• SignerError
• TipInfo
• TipInfoReply
• Unknown
  An unknown message
• UnknownPlaceholder
• ValidateCommitmentTx
  CLN only
• ValidateCommitmentTx2
  LDK only
• ValidateCommitmentTxReply
• ValidateRevocation
• ValidateRevocationReply

Enums

• Message
  An enum representing all messages we can read and write

Constants

• CODE_ORPHAN_BLOCK
• DEFAULT_MAX_PROTOCOL_VERSION
  Our default protcol version (see also HsmdInit::hsm_wire_min_version, etc.)
• MIN_PROTOCOL_VERSION
  Our minimum protcol version
• PROTOCOL_VERSION_REVOKE
• UNKNOWN_PLACEHOLDER

Traits

• DeBolt
• SerBolt
  Serialize a message with a type prefix, in BOLT style

Functions

• from_reader
  Read a BOLT message from a reader:
• from_vec
  Read a BOLT message from a vector:
• read
  Read a length framed BOLT message of any type:
• read_message
  Read a specific message type from a length framed BOLT message:
• read_raw
  Read a raw message from a length framed BOLT message:
• read_serial_request_header
  Read and return the serial request header Returns BadFraming if the magic is wrong.
• read_serial_response_header
  Read the serial response header and match the expected sequence number Returns BadFraming if the magic or sequence are wrong.
• write
• write_serial_request_header
  Write a serial request header prefixed by two magic bytes
• write_serial_response_header
  Write a serial response header that includes two magic bytes and two sequence bytes
• write_vec