projects
/
rust-lightning
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add a few notes about deserializing stale ChannelManagers
[rust-lightning]
/
lightning
/
src
/
ln
/
msgs.rs
diff --git
a/lightning/src/ln/msgs.rs
b/lightning/src/ln/msgs.rs
index 712158a97bc604a39ba173e714e8bbeafbfcd399..3042b4d32e0a344e185ef9756654aefa759606aa 100644
(file)
--- a/
lightning/src/ln/msgs.rs
+++ b/
lightning/src/ln/msgs.rs
@@
-61,20
+61,19
@@
pub enum DecodeError {
/// A length descriptor in the packet didn't describe the later data correctly
BadLengthDescriptor,
/// Error from std::io
/// A length descriptor in the packet didn't describe the later data correctly
BadLengthDescriptor,
/// Error from std::io
- Io(::std::io::ErrorKind),
+ Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
+ ::std::io::ErrorKind),
}
/// An init message to be sent or received from a peer
}
/// An init message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct Init {
pub struct Init {
- #[cfg(not(feature = "fuzztarget"))]
- pub(crate) features: InitFeatures,
- #[cfg(feature = "fuzztarget")]
+ /// The relevant features which the sender supports
pub features: InitFeatures,
}
/// An error message to be sent or received from a peer
pub features: InitFeatures,
}
/// An error message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct ErrorMessage {
/// The channel ID involved in the error
pub channel_id: [u8; 32],
pub struct ErrorMessage {
/// The channel ID involved in the error
pub channel_id: [u8; 32],
@@
-86,7
+85,7
@@
pub struct ErrorMessage {
}
/// A ping message to be sent or received from a peer
}
/// A ping message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct Ping {
/// The desired response length
pub ponglen: u16,
pub struct Ping {
/// The desired response length
pub ponglen: u16,
@@
-96,7
+95,7
@@
pub struct Ping {
}
/// A pong message to be sent or received from a peer
}
/// A pong message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct Pong {
/// The pong packet size.
/// This field is not sent on the wire. byteslen zeros are sent.
pub struct Pong {
/// The pong packet size.
/// This field is not sent on the wire. byteslen zeros are sent.
@@
-104,7
+103,7
@@
pub struct Pong {
}
/// An open_channel message to be sent or received from a peer
}
/// An open_channel message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct OpenChannel {
/// The genesis hash of the blockchain where the channel is to be opened
pub chain_hash: BlockHash,
pub struct OpenChannel {
/// The genesis hash of the blockchain where the channel is to be opened
pub chain_hash: BlockHash,
@@
-147,7
+146,7
@@
pub struct OpenChannel {
}
/// An accept_channel message to be sent or received from a peer
}
/// An accept_channel message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct AcceptChannel {
/// A temporary channel ID, until the funding outpoint is announced
pub temporary_channel_id: [u8; 32],
pub struct AcceptChannel {
/// A temporary channel ID, until the funding outpoint is announced
pub temporary_channel_id: [u8; 32],
@@
-182,7
+181,7
@@
pub struct AcceptChannel {
}
/// A funding_created message to be sent or received from a peer
}
/// A funding_created message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct FundingCreated {
/// A temporary channel ID, until the funding is established
pub temporary_channel_id: [u8; 32],
pub struct FundingCreated {
/// A temporary channel ID, until the funding is established
pub temporary_channel_id: [u8; 32],
@@
-195,7
+194,7
@@
pub struct FundingCreated {
}
/// A funding_signed message to be sent or received from a peer
}
/// A funding_signed message to be sent or received from a peer
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub struct FundingSigned {
/// The channel ID
pub channel_id: [u8; 32],
pub struct FundingSigned {
/// The channel ID
pub channel_id: [u8; 32],
@@
-204,7
+203,7
@@
pub struct FundingSigned {
}
/// A funding_locked message to be sent or received from a peer
}
/// A funding_locked message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct FundingLocked {
/// The channel ID
pub channel_id: [u8; 32],
pub struct FundingLocked {
/// The channel ID
pub channel_id: [u8; 32],
@@
-213,7
+212,7
@@
pub struct FundingLocked {
}
/// A shutdown message to be sent or received from a peer
}
/// A shutdown message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct Shutdown {
/// The channel ID
pub channel_id: [u8; 32],
pub struct Shutdown {
/// The channel ID
pub channel_id: [u8; 32],
@@
-223,7
+222,7
@@
pub struct Shutdown {
}
/// A closing_signed message to be sent or received from a peer
}
/// A closing_signed message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct ClosingSigned {
/// The channel ID
pub channel_id: [u8; 32],
pub struct ClosingSigned {
/// The channel ID
pub channel_id: [u8; 32],
@@
-234,7
+233,7
@@
pub struct ClosingSigned {
}
/// An update_add_htlc message to be sent or received from a peer
}
/// An update_add_htlc message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct UpdateAddHTLC {
/// The channel ID
pub channel_id: [u8; 32],
pub struct UpdateAddHTLC {
/// The channel ID
pub channel_id: [u8; 32],
@@
-250,7
+249,7
@@
pub struct UpdateAddHTLC {
}
/// An update_fulfill_htlc message to be sent or received from a peer
}
/// An update_fulfill_htlc message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct UpdateFulfillHTLC {
/// The channel ID
pub channel_id: [u8; 32],
pub struct UpdateFulfillHTLC {
/// The channel ID
pub channel_id: [u8; 32],
@@
-261,7
+260,7
@@
pub struct UpdateFulfillHTLC {
}
/// An update_fail_htlc message to be sent or received from a peer
}
/// An update_fail_htlc message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct UpdateFailHTLC {
/// The channel ID
pub channel_id: [u8; 32],
pub struct UpdateFailHTLC {
/// The channel ID
pub channel_id: [u8; 32],
@@
-271,7
+270,7
@@
pub struct UpdateFailHTLC {
}
/// An update_fail_malformed_htlc message to be sent or received from a peer
}
/// An update_fail_malformed_htlc message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct UpdateFailMalformedHTLC {
/// The channel ID
pub channel_id: [u8; 32],
pub struct UpdateFailMalformedHTLC {
/// The channel ID
pub channel_id: [u8; 32],
@@
-283,7
+282,7
@@
pub struct UpdateFailMalformedHTLC {
}
/// A commitment_signed message to be sent or received from a peer
}
/// A commitment_signed message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct CommitmentSigned {
/// The channel ID
pub channel_id: [u8; 32],
pub struct CommitmentSigned {
/// The channel ID
pub channel_id: [u8; 32],
@@
-294,7
+293,7
@@
pub struct CommitmentSigned {
}
/// A revoke_and_ack message to be sent or received from a peer
}
/// A revoke_and_ack message to be sent or received from a peer
-#[derive(Clone, PartialEq)]
+#[derive(Clone,
Debug,
PartialEq)]
pub struct RevokeAndACK {
/// The channel ID
pub channel_id: [u8; 32],
pub struct RevokeAndACK {
/// The channel ID
pub channel_id: [u8; 32],
@@
-305,7
+304,7
@@
pub struct RevokeAndACK {
}
/// An update_fee message to be sent or received from a peer
}
/// An update_fee message to be sent or received from a peer
-#[derive(
PartialEq, Clone
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct UpdateFee {
/// The channel ID
pub channel_id: [u8; 32],
pub struct UpdateFee {
/// The channel ID
pub channel_id: [u8; 32],
@@
-313,7
+312,7
@@
pub struct UpdateFee {
pub feerate_per_kw: u32,
}
pub feerate_per_kw: u32,
}
-#[derive(
PartialEq, Clone
)]
+#[derive(
Clone, Debug, PartialEq
)]
/// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
/// This is used to convince the recipient that the channel is at a certain commitment
/// number even if they lost that data due to a local failure. Of course, the peer may lie
/// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
/// This is used to convince the recipient that the channel is at a certain commitment
/// number even if they lost that data due to a local failure. Of course, the peer may lie
@@
-327,7
+326,7
@@
pub struct DataLossProtect {
}
/// A channel_reestablish message to be sent or received from a peer
}
/// A channel_reestablish message to be sent or received from a peer
-#[derive(
PartialEq, Clone
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct ChannelReestablish {
/// The channel ID
pub channel_id: [u8; 32],
pub struct ChannelReestablish {
/// The channel ID
pub channel_id: [u8; 32],
@@
-340,7
+339,7
@@
pub struct ChannelReestablish {
}
/// An announcement_signatures message to be sent or received from a peer
}
/// An announcement_signatures message to be sent or received from a peer
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct AnnouncementSignatures {
/// The channel ID
pub channel_id: [u8; 32],
pub struct AnnouncementSignatures {
/// The channel ID
pub channel_id: [u8; 32],
@@
-353,7
+352,7
@@
pub struct AnnouncementSignatures {
}
/// An address which can be used to connect to a remote peer
}
/// An address which can be used to connect to a remote peer
-#[derive(Clone,
PartialEq, Debug
)]
+#[derive(Clone,
Debug, PartialEq
)]
pub enum NetAddress {
/// An IPv4 address/port on which the peer is listening.
IPv4 {
pub enum NetAddress {
/// An IPv4 address/port on which the peer is listening.
IPv4 {
@@
-471,7
+470,7
@@
impl Readable for Result<NetAddress, u8> {
}
/// The unsigned part of a node_announcement
}
/// The unsigned part of a node_announcement
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct UnsignedNodeAnnouncement {
/// The advertised features
pub features: NodeFeatures,
pub struct UnsignedNodeAnnouncement {
/// The advertised features
pub features: NodeFeatures,
@@
-490,7
+489,7
@@
pub struct UnsignedNodeAnnouncement {
pub(crate) excess_address_data: Vec<u8>,
pub(crate) excess_data: Vec<u8>,
}
pub(crate) excess_address_data: Vec<u8>,
pub(crate) excess_data: Vec<u8>,
}
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
/// A node_announcement message to be sent or received from a peer
pub struct NodeAnnouncement {
/// The signature by the node key
/// A node_announcement message to be sent or received from a peer
pub struct NodeAnnouncement {
/// The signature by the node key
@@
-500,7
+499,7
@@
pub struct NodeAnnouncement {
}
/// The unsigned part of a channel_announcement
}
/// The unsigned part of a channel_announcement
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct UnsignedChannelAnnouncement {
/// The advertised channel features
pub features: ChannelFeatures,
pub struct UnsignedChannelAnnouncement {
/// The advertised channel features
pub features: ChannelFeatures,
@@
-519,7
+518,7
@@
pub struct UnsignedChannelAnnouncement {
pub(crate) excess_data: Vec<u8>,
}
/// A channel_announcement message to be sent or received from a peer
pub(crate) excess_data: Vec<u8>,
}
/// A channel_announcement message to be sent or received from a peer
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct ChannelAnnouncement {
/// Authentication of the announcement by the first public node
pub node_signature_1: Signature,
pub struct ChannelAnnouncement {
/// Authentication of the announcement by the first public node
pub node_signature_1: Signature,
@@
-534,7
+533,7
@@
pub struct ChannelAnnouncement {
}
/// The unsigned part of a channel_update
}
/// The unsigned part of a channel_update
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct UnsignedChannelUpdate {
/// The genesis hash of the blockchain where the channel is to be opened
pub chain_hash: BlockHash,
pub struct UnsignedChannelUpdate {
/// The genesis hash of the blockchain where the channel is to be opened
pub chain_hash: BlockHash,
@@
-557,7
+556,7
@@
pub struct UnsignedChannelUpdate {
pub(crate) excess_data: Vec<u8>,
}
/// A channel_update message to be sent or received from a peer
pub(crate) excess_data: Vec<u8>,
}
/// A channel_update message to be sent or received from a peer
-#[derive(
PartialEq, Clone, Debug
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct ChannelUpdate {
/// A signature of the channel update
pub signature: Signature,
pub struct ChannelUpdate {
/// A signature of the channel update
pub signature: Signature,
@@
-569,7
+568,7
@@
pub struct ChannelUpdate {
/// UTXOs in a range of blocks. The recipient of a query makes a best
/// effort to reply to the query using one or more reply_channel_range
/// messages.
/// UTXOs in a range of blocks. The recipient of a query makes a best
/// effort to reply to the query using one or more reply_channel_range
/// messages.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug
, PartialEq
)]
pub struct QueryChannelRange {
/// The genesis hash of the blockchain being queried
pub chain_hash: BlockHash,
pub struct QueryChannelRange {
/// The genesis hash of the blockchain being queried
pub chain_hash: BlockHash,
@@
-586,7
+585,7
@@
pub struct QueryChannelRange {
/// not be a perfect view of the network. The short_channel_ids in the
/// reply are encoded. We only support encoding_type=0 uncompressed
/// serialization and do not support encoding_type=1 zlib serialization.
/// not be a perfect view of the network. The short_channel_ids in the
/// reply are encoded. We only support encoding_type=0 uncompressed
/// serialization and do not support encoding_type=1 zlib serialization.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug
, PartialEq
)]
pub struct ReplyChannelRange {
/// The genesis hash of the blockchain being queried
pub chain_hash: BlockHash,
pub struct ReplyChannelRange {
/// The genesis hash of the blockchain being queried
pub chain_hash: BlockHash,
@@
-608,7
+607,7
@@
pub struct ReplyChannelRange {
/// reply_short_channel_ids_end message. The short_channel_ids sent in
/// this query are encoded. We only support encoding_type=0 uncompressed
/// serialization and do not support encoding_type=1 zlib serialization.
/// reply_short_channel_ids_end message. The short_channel_ids sent in
/// this query are encoded. We only support encoding_type=0 uncompressed
/// serialization and do not support encoding_type=1 zlib serialization.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug
, PartialEq
)]
pub struct QueryShortChannelIds {
/// The genesis hash of the blockchain being queried
pub chain_hash: BlockHash,
pub struct QueryShortChannelIds {
/// The genesis hash of the blockchain being queried
pub chain_hash: BlockHash,
@@
-620,7
+619,7
@@
pub struct QueryShortChannelIds {
/// query_short_channel_ids message. The query recipient makes a best
/// effort to respond based on their local network view which may not be
/// a perfect view of the network.
/// query_short_channel_ids message. The query recipient makes a best
/// effort to respond based on their local network view which may not be
/// a perfect view of the network.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug
, PartialEq
)]
pub struct ReplyShortChannelIdsEnd {
/// The genesis hash of the blockchain that was queried
pub chain_hash: BlockHash,
pub struct ReplyShortChannelIdsEnd {
/// The genesis hash of the blockchain that was queried
pub chain_hash: BlockHash,
@@
-632,7
+631,7
@@
pub struct ReplyShortChannelIdsEnd {
/// A gossip_timestamp_filter message is used by a node to request
/// gossip relay for messages in the requested time range when the
/// gossip_queries feature has been negotiated.
/// A gossip_timestamp_filter message is used by a node to request
/// gossip relay for messages in the requested time range when the
/// gossip_queries feature has been negotiated.
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug
, PartialEq
)]
pub struct GossipTimestampFilter {
/// The genesis hash of the blockchain for channel and node information
pub chain_hash: BlockHash,
pub struct GossipTimestampFilter {
/// The genesis hash of the blockchain for channel and node information
pub chain_hash: BlockHash,
@@
-649,7
+648,7
@@
enum EncodingType {
}
/// Used to put an error message in a LightningError
}
/// Used to put an error message in a LightningError
-#[derive(Clone)]
+#[derive(Clone
, Debug
)]
pub enum ErrorAction {
/// The peer took some action which made us think they were useless. Disconnect them.
DisconnectPeer {
pub enum ErrorAction {
/// The peer took some action which made us think they were useless. Disconnect them.
DisconnectPeer {
@@
-666,7
+665,7
@@
pub enum ErrorAction {
}
/// An Err type for failure to process messages.
}
/// An Err type for failure to process messages.
-#[derive(Clone)]
+#[derive(Clone
, Debug
)]
pub struct LightningError {
/// A human-readable message describing the error
pub err: String,
pub struct LightningError {
/// A human-readable message describing the error
pub err: String,
@@
-676,7
+675,7
@@
pub struct LightningError {
/// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
/// transaction updates if they were pending.
/// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
/// transaction updates if they were pending.
-#[derive(
PartialEq, Clone
)]
+#[derive(
Clone, Debug, PartialEq
)]
pub struct CommitmentUpdate {
/// update_add_htlc messages which should be sent
pub update_add_htlcs: Vec<UpdateAddHTLC>,
pub struct CommitmentUpdate {
/// update_add_htlc messages which should be sent
pub update_add_htlcs: Vec<UpdateAddHTLC>,
@@
-695,7
+694,7
@@
pub struct CommitmentUpdate {
/// The information we received from a peer along the route of a payment we originated. This is
/// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
/// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
/// The information we received from a peer along the route of a payment we originated. This is
/// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
/// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
-#[derive(Clone)]
+#[derive(Clone
, Debug, PartialEq
)]
pub enum HTLCFailChannelUpdate {
/// We received an error which included a full ChannelUpdate message.
ChannelUpdateMessage {
pub enum HTLCFailChannelUpdate {
/// We received an error which included a full ChannelUpdate message.
ChannelUpdateMessage {
@@
-726,7
+725,7
@@
pub enum HTLCFailChannelUpdate {
/// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
/// separate enum type for them.
/// (C-not exported) due to a free generic in T
/// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
/// separate enum type for them.
/// (C-not exported) due to a free generic in T
-#[derive(Clone,
PartialEq, Debug
)]
+#[derive(Clone,
Debug, PartialEq
)]
pub enum OptionalField<T> {
/// Optional field is included in message
Present(T),
pub enum OptionalField<T> {
/// Optional field is included in message
Present(T),
@@
-753,7
+752,7
@@
pub trait ChannelMessageHandler : MessageSendEventsProvider + Send + Sync {
// Channl close:
/// Handle an incoming shutdown message from the given peer.
// Channl close:
/// Handle an incoming shutdown message from the given peer.
- fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
+ fn handle_shutdown(&self, their_node_id: &PublicKey,
their_features: &InitFeatures,
msg: &Shutdown);
/// Handle an incoming closing_signed message from the given peer.
fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
/// Handle an incoming closing_signed message from the given peer.
fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
@@
-911,7
+910,13
@@
impl PartialEq for OnionPacket {
}
}
}
}
-#[derive(Clone, PartialEq)]
+impl fmt::Debug for OnionPacket {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
+ }
+}
+
+#[derive(Clone, Debug, PartialEq)]
pub(crate) struct OnionErrorPacket {
// This really should be a constant size slice, but the spec lets these things be up to 128KB?
// (TODO) We limit it in decode to much lower...
pub(crate) struct OnionErrorPacket {
// This really should be a constant size slice, but the spec lets these things be up to 128KB?
// (TODO) We limit it in decode to much lower...
@@
-931,12
+936,6
@@
impl fmt::Display for DecodeError {
}
}
}
}
-impl fmt::Debug for LightningError {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- f.write_str(self.err.as_str())
- }
-}
-
impl From<::std::io::Error> for DecodeError {
fn from(e: ::std::io::Error) -> Self {
if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
impl From<::std::io::Error> for DecodeError {
fn from(e: ::std::io::Error) -> Self {
if e.kind() == ::std::io::ErrorKind::UnexpectedEof {