//! Wire messages, traits representing wire message handlers, and a few error types live here. //! //! For a normal node you probably don't need to use anything here, however, if you wish to split a //! node into an internet-facing route/message socket handling daemon and a separate daemon (or //! server entirely) which handles only channel-related messages you may wish to implement //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across //! daemons/servers. //! //! Note that if you go with such an architecture (instead of passing raw socket events to a //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the //! source node_id of the mssage, however this does allow you to significantly reduce bandwidth //! between the systems as routing messages can represent a significant chunk of bandwidth usage //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send //! raw socket events into your non-internet-facing system and then send routing events back to //! track the network on the less-secure system. use secp256k1::key::PublicKey; use secp256k1::{Secp256k1, Signature}; use secp256k1; use bitcoin::util::hash::Sha256dHash; use bitcoin::blockdata::script::Script; use std::error::Error; use std::{cmp, fmt}; use std::io::Read; use std::result::Result; use util::{byte_utils, events}; use util::ser::{Readable, Writeable, Writer}; /// An error in decoding a message or struct. #[derive(Debug)] pub enum DecodeError { /// A version byte specified something we don't know how to handle. /// Includes unknown realm byte in an OnionHopData packet UnknownVersion, /// Unknown feature mandating we fail to parse message UnknownRequiredFeature, /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, etc InvalidValue, /// Buffer too short ShortRead, /// node_announcement included more than one address of a given type! ExtraAddressesPerType, /// A length descriptor in the packet didn't describe the later data correctly /// (currently only generated in node_announcement) BadLengthDescriptor, /// Error from std::io Io(::std::io::Error), } /// Tracks localfeatures which are only in init messages #[derive(Clone, PartialEq)] pub struct LocalFeatures { flags: Vec, } impl LocalFeatures { pub(crate) fn new() -> LocalFeatures { LocalFeatures { flags: Vec::new(), } } pub(crate) fn supports_data_loss_protect(&self) -> bool { self.flags.len() > 0 && (self.flags[0] & 3) != 0 } pub(crate) fn requires_data_loss_protect(&self) -> bool { self.flags.len() > 0 && (self.flags[0] & 1) != 0 } pub(crate) fn initial_routing_sync(&self) -> bool { self.flags.len() > 0 && (self.flags[0] & (1 << 3)) != 0 } pub(crate) fn set_initial_routing_sync(&mut self) { if self.flags.len() == 0 { self.flags.resize(1, 1 << 3); } else { self.flags[0] |= 1 << 3; } } pub(crate) fn supports_upfront_shutdown_script(&self) -> bool { self.flags.len() > 0 && (self.flags[0] & (3 << 4)) != 0 } pub(crate) fn requires_upfront_shutdown_script(&self) -> bool { self.flags.len() > 0 && (self.flags[0] & (1 << 4)) != 0 } pub(crate) fn requires_unknown_bits(&self) -> bool { for (idx, &byte) in self.flags.iter().enumerate() { if idx != 0 && (byte & 0x55) != 0 { return true; } else if idx == 0 && (byte & 0x14) != 0 { return true; } } return false; } pub(crate) fn supports_unknown_bits(&self) -> bool { for (idx, &byte) in self.flags.iter().enumerate() { if idx != 0 && byte != 0 { return true; } else if idx == 0 && (byte & 0xc4) != 0 { return true; } } return false; } } /// Tracks globalfeatures which are in init messages and routing announcements #[derive(Clone, PartialEq)] pub struct GlobalFeatures { flags: Vec, } impl GlobalFeatures { pub(crate) fn new() -> GlobalFeatures { GlobalFeatures { flags: Vec::new(), } } pub(crate) fn requires_unknown_bits(&self) -> bool { for &byte in self.flags.iter() { if (byte & 0x55) != 0 { return true; } } return false; } pub(crate) fn supports_unknown_bits(&self) -> bool { for &byte in self.flags.iter() { if byte != 0 { return true; } } return false; } } /// An init message to be sent or received from a peer pub struct Init { pub(crate) global_features: GlobalFeatures, pub(crate) local_features: LocalFeatures, } /// An error message to be sent or received from a peer pub struct ErrorMessage { pub(crate) channel_id: [u8; 32], pub(crate) data: String, } /// A ping message to be sent or received from a peer pub struct Ping { pub(crate) ponglen: u16, pub(crate) byteslen: u16, } /// A pong message to be sent or received from a peer pub struct Pong { pub(crate) byteslen: u16, } /// An open_channel message to be sent or received from a peer pub struct OpenChannel { pub(crate) chain_hash: Sha256dHash, pub(crate) temporary_channel_id: [u8; 32], pub(crate) funding_satoshis: u64, pub(crate) push_msat: u64, pub(crate) dust_limit_satoshis: u64, pub(crate) max_htlc_value_in_flight_msat: u64, pub(crate) channel_reserve_satoshis: u64, pub(crate) htlc_minimum_msat: u64, pub(crate) feerate_per_kw: u32, pub(crate) to_self_delay: u16, pub(crate) max_accepted_htlcs: u16, pub(crate) funding_pubkey: PublicKey, pub(crate) revocation_basepoint: PublicKey, pub(crate) payment_basepoint: PublicKey, pub(crate) delayed_payment_basepoint: PublicKey, pub(crate) htlc_basepoint: PublicKey, pub(crate) first_per_commitment_point: PublicKey, pub(crate) channel_flags: u8, pub(crate) shutdown_scriptpubkey: Option