X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmsgs.rs;h=3e0627aac233036361bda62971f704d6ea2718d6;hb=refs%2Fheads%2Fupstream%2Fmain;hp=3b52ff0def9881b0af7626615d19255b11266db1;hpb=bd16a1e409413ed0762d87c166819ad1fa62fa8b;p=rust-lightning diff --git a/lightning/src/ln/msgs.rs b/lightning/src/ln/msgs.rs index 3b52ff0d..e7b43ded 100644 --- a/lightning/src/ln/msgs.rs +++ b/lightning/src/ln/msgs.rs @@ -52,7 +52,7 @@ use core::fmt::Display; use crate::io::{self, Cursor, Read}; use crate::io_extras::read_to_end; -use crate::events::{EventsProvider, MessageSendEventsProvider}; +use crate::events::MessageSendEventsProvider; use crate::crypto::streams::ChaChaPolyReadAdapter; use crate::util::logger; use crate::util::ser::{BigSize, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname, LengthRead, LengthReadable, LengthReadableArgs, Readable, ReadableArgs, TransactionU16LenLimited, WithoutLength, Writeable, Writer}; @@ -410,8 +410,9 @@ pub struct ChannelReady { /// construction. pub type SerialId = u64; -/// An stfu (quiescence) message to be sent by or received from the stfu initiator. -// TODO(splicing): Add spec link for `stfu`; still in draft, using from https://github.com/lightning/bolts/pull/863 +/// An `stfu` (quiescence) message to be sent by or received from the stfu initiator. +/// +// TODO(splicing): Add spec link for `stfu`; still in draft, using from https://github.com/lightning/bolts/pull/1160 #[derive(Clone, Debug, PartialEq, Eq)] pub struct Stfu { /// The channel ID where quiescence is intended @@ -420,48 +421,51 @@ pub struct Stfu { pub initiator: u8, } -/// A splice message to be sent by or received from the stfu initiator (splice initiator). -// TODO(splicing): Add spec link for `splice`; still in draft, using from https://github.com/lightning/bolts/pull/863 +/// A `splice_init` message to be sent by or received from the stfu initiator (splice initiator). +/// +// TODO(splicing): Add spec link for `splice_init`; still in draft, using from https://github.com/lightning/bolts/pull/1160 #[derive(Clone, Debug, PartialEq, Eq)] -pub struct Splice { +pub struct SpliceInit { /// The channel ID where splicing is intended pub channel_id: ChannelId, - /// The genesis hash of the blockchain where the channel is intended to be spliced - pub chain_hash: ChainHash, - /// The intended change in channel capacity: the amount to be added (positive value) - /// or removed (negative value) by the sender (splice initiator) by splicing into/from the channel. - pub relative_satoshis: i64, + /// The amount the splice initiator is intending to add to its channel balance (splice-in) + /// or remove from its channel balance (splice-out). + pub funding_contribution_satoshis: i64, /// The feerate for the new funding transaction, set by the splice initiator pub funding_feerate_perkw: u32, /// The locktime for the new funding transaction pub locktime: u32, /// The key of the sender (splice initiator) controlling the new funding transaction pub funding_pubkey: PublicKey, + /// If set, only confirmed inputs added (by the splice acceptor) will be accepted + pub require_confirmed_inputs: Option<()>, } -/// A splice_ack message to be received by or sent to the splice initiator. +/// A `splice_ack` message to be received by or sent to the splice initiator. /// -// TODO(splicing): Add spec link for `splice_ack`; still in draft, using from https://github.com/lightning/bolts/pull/863 +// TODO(splicing): Add spec link for `splice_ack`; still in draft, using from https://github.com/lightning/bolts/pull/1160 #[derive(Clone, Debug, PartialEq, Eq)] pub struct SpliceAck { /// The channel ID where splicing is intended pub channel_id: ChannelId, - /// The genesis hash of the blockchain where the channel is intended to be spliced - pub chain_hash: ChainHash, - /// The intended change in channel capacity: the amount to be added (positive value) - /// or removed (negative value) by the sender (splice acceptor) by splicing into/from the channel. - pub relative_satoshis: i64, + /// The amount the splice acceptor is intending to add to its channel balance (splice-in) + /// or remove from its channel balance (splice-out). + pub funding_contribution_satoshis: i64, /// The key of the sender (splice acceptor) controlling the new funding transaction pub funding_pubkey: PublicKey, + /// If set, only confirmed inputs added (by the splice initiator) will be accepted + pub require_confirmed_inputs: Option<()>, } -/// A splice_locked message to be sent to or received from a peer. +/// A `splice_locked` message to be sent to or received from a peer. /// -// TODO(splicing): Add spec link for `splice_locked`; still in draft, using from https://github.com/lightning/bolts/pull/863 +// TODO(splicing): Add spec link for `splice_locked`; still in draft, using from https://github.com/lightning/bolts/pull/1160 #[derive(Clone, Debug, PartialEq, Eq)] pub struct SpliceLocked { /// The channel ID pub channel_id: ChannelId, + /// The ID of the new funding transaction that has been locked + pub splice_txid: Txid, } /// A tx_add_input message for adding an input during interactive transaction construction @@ -481,6 +485,8 @@ pub struct TxAddInput { pub prevtx_out: u32, /// The sequence number of this input pub sequence: u32, + /// The ID of the previous funding transaction, when it is being added as an input during splicing + pub shared_input_txid: Option, } /// A tx_add_output message for adding an output during interactive transaction construction. @@ -544,7 +550,7 @@ pub struct TxSignatures { /// The list of witnesses pub witnesses: Vec, /// Optional signature for the shared input -- the previous funding outpoint -- signed by both peers - pub funding_outpoint_sig: Option, + pub shared_input_signature: Option, } /// A tx_init_rbf message which initiates a replacement of the transaction after it's been @@ -708,6 +714,15 @@ pub struct UpdateFailMalformedHTLC { pub failure_code: u16, } +/// Optional batch parameters for `commitment_signed` message. +#[derive(Clone, Debug, Hash, PartialEq, Eq)] +pub struct CommitmentSignedBatch { + /// Batch size N: all N `commitment_signed` messages must be received before being processed + pub batch_size: u16, + /// The funding transaction, to discriminate among multiple pending funding transactions (e.g. in case of splicing) + pub funding_txid: Txid, +} + /// A [`commitment_signed`] message to be sent to or received from a peer. /// /// [`commitment_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#committing-updates-so-far-commitment_signed @@ -719,6 +734,8 @@ pub struct CommitmentSigned { pub signature: Signature, /// Signatures on the HTLC transactions pub htlc_signatures: Vec, + /// Optional batch size and other parameters + pub batch: Option, #[cfg(taproot)] /// The partial Taproot signature on the commitment transaction pub partial_signature_with_nonce: Option, @@ -1227,8 +1244,11 @@ pub struct UnsignedChannelUpdate { pub short_channel_id: u64, /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel pub timestamp: u32, - /// Channel flags - pub flags: u8, + /// Flags pertaining to this message. + pub message_flags: u8, + /// Flags pertaining to the channel, including to which direction in the channel this update + /// applies and whether the direction is currently able to forward HTLCs. + pub channel_flags: u8, /// The number of blocks such that if: /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta` /// then we need to fail the HTLC backwards. When forwarding an HTLC, `cltv_expiry_delta` determines @@ -1461,9 +1481,9 @@ pub trait ChannelMessageHandler : MessageSendEventsProvider { fn handle_stfu(&self, their_node_id: &PublicKey, msg: &Stfu); // Splicing - /// Handle an incoming `splice` message from the given peer. + /// Handle an incoming `splice_init` message from the given peer. #[cfg(splicing)] - fn handle_splice(&self, their_node_id: &PublicKey, msg: &Splice); + fn handle_splice_init(&self, their_node_id: &PublicKey, msg: &SpliceInit); /// Handle an incoming `splice_ack` message from the given peer. #[cfg(splicing)] fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &SpliceAck); @@ -1623,7 +1643,7 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider { } /// A handler for received [`OnionMessage`]s and for providing generated ones to send. -pub trait OnionMessageHandler: EventsProvider { +pub trait OnionMessageHandler { /// Handle an incoming `onion_message` message from the given peer. fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage); @@ -2088,24 +2108,27 @@ impl_writeable_msg!(Stfu, { initiator, }, {}); -impl_writeable_msg!(Splice, { +impl_writeable_msg!(SpliceInit, { channel_id, - chain_hash, - relative_satoshis, + funding_contribution_satoshis, funding_feerate_perkw, locktime, funding_pubkey, -}, {}); +}, { + (2, require_confirmed_inputs, option), // `splice_init_tlvs` +}); impl_writeable_msg!(SpliceAck, { channel_id, - chain_hash, - relative_satoshis, + funding_contribution_satoshis, funding_pubkey, -}, {}); +}, { + (2, require_confirmed_inputs, option), // `splice_ack_tlvs` +}); impl_writeable_msg!(SpliceLocked, { channel_id, + splice_txid, }, {}); impl_writeable_msg!(TxAddInput, { @@ -2114,7 +2137,9 @@ impl_writeable_msg!(TxAddInput, { prevtx, prevtx_out, sequence, -}, {}); +}, { + (0, shared_input_txid, option), // `funding_txid` +}); impl_writeable_msg!(TxAddOutput, { channel_id, @@ -2142,7 +2167,7 @@ impl_writeable_msg!(TxSignatures, { tx_hash, witnesses, }, { - (0, funding_outpoint_sig, option), + (0, shared_input_signature, option), // `signature` }); impl_writeable_msg!(TxInitRbf, { @@ -2191,12 +2216,19 @@ impl_writeable!(ClosingSignedFeeRange, { max_fee_satoshis }); +impl_writeable_msg!(CommitmentSignedBatch, { + batch_size, + funding_txid, +}, {}); + #[cfg(not(taproot))] impl_writeable_msg!(CommitmentSigned, { channel_id, signature, htlc_signatures -}, {}); +}, { + (0, batch, option), +}); #[cfg(taproot)] impl_writeable_msg!(CommitmentSigned, { @@ -2204,7 +2236,8 @@ impl_writeable_msg!(CommitmentSigned, { signature, htlc_signatures }, { - (2, partial_signature_with_nonce, option) + (0, batch, option), + (2, partial_signature_with_nonce, option), }); impl_writeable!(DecodedOnionErrorPacket, { @@ -2866,13 +2899,13 @@ impl_writeable!(ChannelAnnouncement, { impl Writeable for UnsignedChannelUpdate { fn write(&self, w: &mut W) -> Result<(), io::Error> { - // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec. - const MESSAGE_FLAGS: u8 = 1; self.chain_hash.write(w)?; self.short_channel_id.write(w)?; self.timestamp.write(w)?; - let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8); - all_flags.write(w)?; + // The low bit of message_flags used to indicate the presence of `htlc_maximum_msat`, and + // now must be set + (self.message_flags | 1).write(w)?; + self.channel_flags.write(w)?; self.cltv_expiry_delta.write(w)?; self.htlc_minimum_msat.write(w)?; self.fee_base_msat.write(w)?; @@ -2885,22 +2918,26 @@ impl Writeable for UnsignedChannelUpdate { impl Readable for UnsignedChannelUpdate { fn read(r: &mut R) -> Result { - Ok(Self { + let res = Self { chain_hash: Readable::read(r)?, short_channel_id: Readable::read(r)?, timestamp: Readable::read(r)?, - flags: { - let flags: u16 = Readable::read(r)?; - // Note: we ignore the `message_flags` for now, since it was deprecated by the spec. - flags as u8 - }, + message_flags: Readable::read(r)?, + channel_flags: Readable::read(r)?, cltv_expiry_delta: Readable::read(r)?, htlc_minimum_msat: Readable::read(r)?, fee_base_msat: Readable::read(r)?, fee_proportional_millionths: Readable::read(r)?, htlc_maximum_msat: Readable::read(r)?, excess_data: read_to_end(r)?, - }) + }; + if res.message_flags & 1 != 1 { + // The `must_be_one` flag should be set (historically it indicated the presence of the + // `htlc_maximum_msat` field, which is now required). + Err(DecodeError::InvalidValue) + } else { + Ok(res) + } } } @@ -3496,7 +3533,8 @@ mod tests { chain_hash: ChainHash::using_genesis_block(Network::Bitcoin), short_channel_id: 2316138423780173, timestamp: 20190119, - flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 }, + message_flags: 1, // Only must_be_one + channel_flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 }, cltv_expiry_delta: 144, htlc_minimum_msat: 1000000, htlc_maximum_msat: 131355275467161, @@ -3851,19 +3889,19 @@ mod tests { } #[test] - fn encoding_splice() { + fn encoding_splice_init() { let secp_ctx = Secp256k1::new(); let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx); - let splice = msgs::Splice { - chain_hash: ChainHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(), + let splice_init = msgs::SpliceInit { channel_id: ChannelId::from_bytes([2; 32]), - relative_satoshis: 123456, + funding_contribution_satoshis: -123456, funding_feerate_perkw: 2000, locktime: 0, funding_pubkey: pubkey_1, + require_confirmed_inputs: Some(()), }; - let encoded_value = splice.encode(); - assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000000000000001e240000007d000000000031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f"); + let encoded_value = splice_init.encode(); + assert_eq!(encoded_value.as_hex().to_string(), "0202020202020202020202020202020202020202020202020202020202020202fffffffffffe1dc0000007d000000000031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f0200"); } #[test] @@ -3880,23 +3918,24 @@ mod tests { fn encoding_splice_ack() { let secp_ctx = Secp256k1::new(); let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx); - let splice = msgs::SpliceAck { - chain_hash: ChainHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(), + let splice_ack = msgs::SpliceAck { channel_id: ChannelId::from_bytes([2; 32]), - relative_satoshis: 123456, + funding_contribution_satoshis: -123456, funding_pubkey: pubkey_1, + require_confirmed_inputs: Some(()), }; - let encoded_value = splice.encode(); - assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000000000000001e240031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f"); + let encoded_value = splice_ack.encode(); + assert_eq!(encoded_value.as_hex().to_string(), "0202020202020202020202020202020202020202020202020202020202020202fffffffffffe1dc0031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f0200"); } #[test] fn encoding_splice_locked() { - let splice = msgs::SpliceLocked { + let splice_locked = msgs::SpliceLocked { channel_id: ChannelId::from_bytes([2; 32]), + splice_txid: Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(), }; - let encoded_value = splice.encode(); - assert_eq!(encoded_value.as_hex().to_string(), "0202020202020202020202020202020202020202020202020202020202020202"); + let encoded_value = splice_locked.encode(); + assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c2"); } #[test] @@ -3928,10 +3967,11 @@ mod tests { }).unwrap(), prevtx_out: 305419896, sequence: 305419896, + shared_input_txid: Some(Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap()), }; let encoded_value = tx_add_input.encode(); - let target_value = >::from_hex("0202020202020202020202020202020202020202020202020202020202020202000000012345678900de02000000000101779ced6c148293f86b60cb222108553d22c89207326bb7b6b897e23e64ab5b300200000000fdffffff0236dbc1000000000016001417d29e4dd454bac3b1cde50d1926da80cfc5287b9cbd03000000000016001436ec78d514df462da95e6a00c24daa8915362d420247304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701210301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944000000001234567812345678").unwrap(); - assert_eq!(encoded_value, target_value); + let target_value = "0202020202020202020202020202020202020202020202020202020202020202000000012345678900de02000000000101779ced6c148293f86b60cb222108553d22c89207326bb7b6b897e23e64ab5b300200000000fdffffff0236dbc1000000000016001417d29e4dd454bac3b1cde50d1926da80cfc5287b9cbd03000000000016001436ec78d514df462da95e6a00c24daa8915362d420247304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701210301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd694400000000123456781234567800206e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c2"; + assert_eq!(encoded_value.as_hex().to_string(), target_value); } #[test] @@ -3996,7 +4036,7 @@ mod tests { >::from_hex("3045022100ee00dbf4a862463e837d7c08509de814d620e4d9830fa84818713e0fa358f145022021c3c7060c4d53fe84fd165d60208451108a778c13b92ca4c6bad439236126cc01").unwrap(), >::from_hex("028fbbf0b16f5ba5bcb5dd37cd4047ce6f726a21c06682f9ec2f52b057de1dbdb5").unwrap()]), ], - funding_outpoint_sig: Some(sig_1), + shared_input_signature: Some(sig_1), }; let encoded_value = tx_signatures.encode(); let mut target_value = >::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // channel_id @@ -4225,17 +4265,19 @@ mod tests { channel_id: ChannelId::from_bytes([2; 32]), signature: sig_1, htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() }, + batch: Some(msgs::CommitmentSignedBatch { batch_size: 3, funding_txid: Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap() }), #[cfg(taproot)] partial_signature_with_nonce: None, }; let encoded_value = commitment_signed.encode(); - let mut target_value = >::from_hex("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap(); + let mut target_value = "0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a".to_string(); if htlcs { - target_value.append(&mut >::from_hex("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap()); + target_value += "00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd"; } else { - target_value.append(&mut >::from_hex("0000").unwrap()); + target_value += "0000"; } - assert_eq!(encoded_value, target_value); + target_value += "002200036e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c2"; // batch + assert_eq!(encoded_value.as_hex().to_string(), target_value); } #[test]