Module vls_protocol::msgs

Structs

• AddBlock
• AddBlockReply
• CheckFutureSecret
  CheckFutureSecret
• CheckFutureSecretReply
• ClientHsmFd
  Connect a new client CLN only
• ClientHsmFdReply
• DeriveSecret
  DeriveSecret
• DeriveSecretReply
• Ecdh
• EcdhReply
• 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
• HsmdInit
  hsmd Init CLN only
• HsmdInit2
  Signer Init for LDK LDK only
• HsmdInit2Reply
• HsmdInitReplyV1Deprecated
  deprecated in CLN
• HsmdInitReplyV2
• Memleak
  Memleak CLN only
• MemleakReply
• NewChannel
• NewChannelReply
• NodeInfo
  Get node public keys. Used by the frontend
• NodeInfoReply
• Persist
  Store key-value pairs to persistent storage - potentially in the cloud. This message may be sent by the signer in response to a normal API message, before the actual API response. The front end should reply with PersistReply
• PersistReply
  Result of a Persist.
• Ping
  Ping request LDK only
• Pong
  Ping reply LDK only
• PreapproveInvoice
  PreapproveInvoice {
• PreapproveInvoiceReply
• PreapproveKeysend
  PreapproveKeysend {
• PreapproveKeysendReply
• ReadyChannel
• ReadyChannelReply
• RemoveBlock
• RemoveBlockReply
• ReverseWatches
• ReverseWatchesReply
• SerialRequestHeader
  A serial request header
• SignBolt12
  SignBolt12
• SignBolt12Reply
• SignChannelAnnouncement
• SignChannelAnnouncementReply
• SignChannelUpdate
  Sign channel update
• SignChannelUpdateReply
• SignCommitmentTx
  CLN only
• SignCommitmentTxReply
• SignCommitmentTxWithHtlcsReply
• SignDelayedPaymentToUs
  CLN only
• SignGossipMessage
• SignGossipMessageReply
• 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
• SignTxReply
• SignWithdrawal
• SignWithdrawalReply
• TipInfo
• TipInfoReply
• Unknown
  An unknown message
• ValidateCommitmentTx
  CLN only
• ValidateCommitmentTx2
  LDK only
• ValidateCommitmentTxReply
• ValidateRevocation
• ValidateRevocationReply

Enums

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

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