Skip to content

Commit 1e9eece

Browse files
optout21optout21
committed
Send&handle&encode infrastructure for splicing messages
1 parent c6ec620 commit 1e9eece

File tree

8 files changed

+201
-1
lines changed

8 files changed

+201
-1
lines changed

‎lightning-net-tokio/src/lib.rs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -606,6 +606,9 @@ mod tests {
606606
fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &ChannelUpdate) {}
607607
fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, _msg: &OpenChannelV2) {}
608608
fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, _msg: &AcceptChannelV2) {}
609+
fn handle_splice(&self, _their_node_id: &PublicKey, _msg: &Splice) {}
610+
fn handle_splice_ack(&self, _their_node_id: &PublicKey, _msg: &SpliceAck) {}
611+
fn handle_splice_locked(&self, _their_node_id: &PublicKey, _msg: &SpliceLocked) {}
609612
fn handle_tx_add_input(&self, _their_node_id: &PublicKey, _msg: &TxAddInput) {}
610613
fn handle_tx_add_output(&self, _their_node_id: &PublicKey, _msg: &TxAddOutput) {}
611614
fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, _msg: &TxRemoveInput) {}

‎lightning/src/events/mod.rs‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1606,6 +1606,27 @@ pub enum MessageSendEvent {
16061606
/// The message which should be sent.
16071607
msg: msgs::FundingSigned,
16081608
},
1609+
/// Used to indicate that a splice message should be sent to the peer with the given node id.
1610+
SendSplice {
1611+
/// The node_id of the node which should receive this message
1612+
node_id: PublicKey,
1613+
/// The message which should be sent.
1614+
msg: msgs::Splice,
1615+
},
1616+
/// Used to indicate that a splice_ack message should be sent to the peer with the given node id.
1617+
SendSpliceAck {
1618+
/// The node_id of the node which should receive this message
1619+
node_id: PublicKey,
1620+
/// The message which should be sent.
1621+
msg: msgs::SpliceAck,
1622+
},
1623+
/// Used to indicate that a splice_locked message should be sent to the peer with the given node id.
1624+
SendSpliceLocked {
1625+
/// The node_id of the node which should receive this message
1626+
node_id: PublicKey,
1627+
/// The message which should be sent.
1628+
msg: msgs::SpliceLocked,
1629+
},
16091630
/// Used to indicate that a tx_add_input message should be sent to the peer with the given node_id.
16101631
SendTxAddInput {
16111632
/// The node_id of the node which should receive this message

‎lightning/src/ln/channelmanager.rs‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7326,6 +7326,24 @@ where
73267326
let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
73277327
}
73287328

7329+
fn handle_splice(&self, counterparty_node_id: &PublicKey, msg: &msgs::Splice) {
7330+
let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7331+
"Splicing not supported".to_owned(),
7332+
msg.channel_id.clone())), *counterparty_node_id);
7333+
}
7334+
7335+
fn handle_splice_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceAck) {
7336+
let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7337+
"Splicing not supported (splice_ack)".to_owned(),
7338+
msg.channel_id.clone())), *counterparty_node_id);
7339+
}
7340+
7341+
fn handle_splice_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
7342+
let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7343+
"Splicing not supported (splice_locked)".to_owned(),
7344+
msg.channel_id.clone())), *counterparty_node_id);
7345+
}
7346+
73297347
fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
73307348
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
73317349
let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
@@ -7438,6 +7456,10 @@ where
74387456
// Common Channel Establishment
74397457
&events::MessageSendEvent::SendChannelReady { .. } => false,
74407458
&events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7459+
// Splicing
7460+
&events::MessageSendEvent::SendSplice { .. } => false,
7461+
&events::MessageSendEvent::SendSpliceAck { .. } => false,
7462+
&events::MessageSendEvent::SendSpliceLocked { .. } => false,
74417463
// Interactive Transaction Construction
74427464
&events::MessageSendEvent::SendTxAddInput { .. } => false,
74437465
&events::MessageSendEvent::SendTxAddOutput { .. } => false,

‎lightning/src/ln/functional_test_utils.rs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -765,6 +765,15 @@ pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut
765765
MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
766766
node_id == msg_node_id
767767
},
768+
MessageSendEvent::SendSplice { node_id, .. } => {
769+
node_id == msg_node_id
770+
},
771+
MessageSendEvent::SendSpliceAck { node_id, .. } => {
772+
node_id == msg_node_id
773+
},
774+
MessageSendEvent::SendSpliceLocked { node_id, .. } => {
775+
node_id == msg_node_id
776+
},
768777
MessageSendEvent::SendTxAddInput { node_id, .. } => {
769778
node_id == msg_node_id
770779
},

‎lightning/src/ln/msgs.rs‎

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1276,12 +1276,20 @@ pub trait ChannelMessageHandler : MessageSendEventsProvider {
12761276
/// Handle an incoming `channel_ready` message from the given peer.
12771277
fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
12781278

1279-
// Channl close:
1279+
// Channel close:
12801280
/// Handle an incoming `shutdown` message from the given peer.
12811281
fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
12821282
/// Handle an incoming `closing_signed` message from the given peer.
12831283
fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
12841284

1285+
// Splicing
1286+
/// Handle an incoming `splice` message from the given peer.
1287+
fn handle_splice(&self, their_node_id: &PublicKey, msg: &Splice);
1288+
/// Handle an incoming `splice_ack` message from the given peer.
1289+
fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &SpliceAck);
1290+
/// Handle an incoming `splice_locked` message from the given peer.
1291+
fn handle_splice_locked(&self, their_node_id: &PublicKey, msg: &SpliceLocked);
1292+
12851293
// Interactive channel construction
12861294
/// Handle an incoming `tx_add_input message` from the given peer.
12871295
fn handle_tx_add_input(&self, their_node_id: &PublicKey, msg: &TxAddInput);
@@ -1660,6 +1668,26 @@ impl_writeable_msg!(AcceptChannelV2, {
16601668
(2, require_confirmed_inputs, option),
16611669
});
16621670

1671+
impl_writeable_msg!(Splice, {
1672+
channel_id,
1673+
chain_hash,
1674+
relative_satoshis,
1675+
funding_feerate_perkw,
1676+
locktime,
1677+
funding_pubkey,
1678+
}, {});
1679+
1680+
impl_writeable_msg!(SpliceAck, {
1681+
channel_id,
1682+
chain_hash,
1683+
relative_satoshis,
1684+
funding_pubkey,
1685+
}, {});
1686+
1687+
impl_writeable_msg!(SpliceLocked, {
1688+
channel_id,
1689+
}, {});
1690+
16631691
impl_writeable_msg!(TxAddInput, {
16641692
channel_id,
16651693
serial_id,
@@ -3162,6 +3190,45 @@ mod tests {
31623190
assert_eq!(encoded_value, target_value);
31633191
}
31643192

3193+
#[test]
3194+
fn encoding_splice() {
3195+
let secp_ctx = Secp256k1::new();
3196+
let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3197+
let splice = msgs::Splice {
3198+
chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
3199+
channel_id: ChannelId::from_bytes([2; 32]),
3200+
relative_satoshis: 123456,
3201+
funding_feerate_perkw: 2000,
3202+
locktime: 0,
3203+
funding_pubkey: pubkey_1,
3204+
};
3205+
let encoded_value = splice.encode();
3206+
assert_eq!(hex::encode(encoded_value), "0202020202020202020202020202020202020202020202020202020202020202000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f000000000001e240000007d000000000031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f");
3207+
}
3208+
3209+
#[test]
3210+
fn encoding_splice_ack() {
3211+
let secp_ctx = Secp256k1::new();
3212+
let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3213+
let splice = msgs::SpliceAck {
3214+
chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
3215+
channel_id: ChannelId::from_bytes([2; 32]),
3216+
relative_satoshis: 123456,
3217+
funding_pubkey: pubkey_1,
3218+
};
3219+
let encoded_value = splice.encode();
3220+
assert_eq!(hex::encode(encoded_value), "0202020202020202020202020202020202020202020202020202020202020202000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f000000000001e240031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f");
3221+
}
3222+
3223+
#[test]
3224+
fn encoding_splice_locked() {
3225+
let splice = msgs::SpliceLocked {
3226+
channel_id: ChannelId::from_bytes([2; 32]),
3227+
};
3228+
let encoded_value = splice.encode();
3229+
assert_eq!(hex::encode(encoded_value), "0202020202020202020202020202020202020202020202020202020202020202");
3230+
}
3231+
31653232
#[test]
31663233
fn encoding_tx_add_input() {
31673234
let tx_add_input = msgs::TxAddInput {

‎lightning/src/ln/peer_handler.rs‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,15 @@ impl ChannelMessageHandler for ErroringMessageHandler {
227227
fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
228228
ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
229229
}
230+
fn handle_splice(&self, their_node_id: &PublicKey, msg: &msgs::Splice) {
231+
ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
232+
}
233+
fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
234+
ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
235+
}
236+
fn handle_splice_locked(&self, their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
237+
ErroringMessageHandler::push_error(&self, their_node_id, msg.channel_id);
238+
}
230239
fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
231240
ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
232241
}
@@ -1637,6 +1646,17 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
16371646
self.message_handler.chan_handler.handle_channel_ready(&their_node_id, &msg);
16381647
},
16391648

1649+
// Splicing messages:
1650+
wire::Message::Splice(msg) => {
1651+
self.message_handler.chan_handler.handle_splice(&their_node_id, &msg);
1652+
}
1653+
wire::Message::SpliceAck(msg) => {
1654+
self.message_handler.chan_handler.handle_splice_ack(&their_node_id, &msg);
1655+
}
1656+
wire::Message::SpliceLocked(msg) => {
1657+
self.message_handler.chan_handler.handle_splice_locked(&their_node_id, &msg);
1658+
}
1659+
16401660
// Interactive transaction construction messages:
16411661
wire::Message::TxAddInput(msg) => {
16421662
self.message_handler.chan_handler.handle_tx_add_input(&their_node_id, &msg);
@@ -1956,6 +1976,24 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
19561976
&msg.channel_id);
19571977
self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
19581978
},
1979+
MessageSendEvent::SendSplice { ref node_id, ref msg} => {
1980+
log_debug!(self.logger, "Handling SendSplice event in peer_handler for node {} for channel {}",
1981+
log_pubkey!(node_id),
1982+
&msg.channel_id);
1983+
self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1984+
}
1985+
MessageSendEvent::SendSpliceAck { ref node_id, ref msg} => {
1986+
log_debug!(self.logger, "Handling SendSpliceAck event in peer_handler for node {} for channel {}",
1987+
log_pubkey!(node_id),
1988+
&msg.channel_id);
1989+
self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1990+
}
1991+
MessageSendEvent::SendSpliceLocked { ref node_id, ref msg} => {
1992+
log_debug!(self.logger, "Handling SendSpliceLocked event in peer_handler for node {} for channel {}",
1993+
log_pubkey!(node_id),
1994+
&msg.channel_id);
1995+
self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1996+
}
19591997
MessageSendEvent::SendTxAddInput { ref node_id, ref msg } => {
19601998
log_debug!(self.logger, "Handling SendTxAddInput event in peer_handler for node {} for channel {}",
19611999
log_pubkey!(node_id),

‎lightning/src/ln/wire.rs‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ pub(crate) enum Message<T> where T: core::fmt::Debug + Type + TestEq {
5959
AcceptChannelV2(msgs::AcceptChannelV2),
6060
FundingCreated(msgs::FundingCreated),
6161
FundingSigned(msgs::FundingSigned),
62+
Splice(msgs::Splice),
63+
SpliceAck(msgs::SpliceAck),
64+
SpliceLocked(msgs::SpliceLocked),
6265
TxAddInput(msgs::TxAddInput),
6366
TxAddOutput(msgs::TxAddOutput),
6467
TxRemoveInput(msgs::TxRemoveInput),
@@ -110,6 +113,9 @@ impl<T> Writeable for Message<T> where T: core::fmt::Debug + Type + TestEq {
110113
&Message::AcceptChannelV2(ref msg) => msg.write(writer),
111114
&Message::FundingCreated(ref msg) => msg.write(writer),
112115
&Message::FundingSigned(ref msg) => msg.write(writer),
116+
&Message::Splice(ref msg) => msg.write(writer),
117+
&Message::SpliceAck(ref msg) => msg.write(writer),
118+
&Message::SpliceLocked(ref msg) => msg.write(writer),
113119
&Message::TxAddInput(ref msg) => msg.write(writer),
114120
&Message::TxAddOutput(ref msg) => msg.write(writer),
115121
&Message::TxRemoveInput(ref msg) => msg.write(writer),
@@ -161,6 +167,9 @@ impl<T> Type for Message<T> where T: core::fmt::Debug + Type + TestEq {
161167
&Message::AcceptChannelV2(ref msg) => msg.type_id(),
162168
&Message::FundingCreated(ref msg) => msg.type_id(),
163169
&Message::FundingSigned(ref msg) => msg.type_id(),
170+
&Message::Splice(ref msg) => msg.type_id(),
171+
&Message::SpliceAck(ref msg) => msg.type_id(),
172+
&Message::SpliceLocked(ref msg) => msg.type_id(),
164173
&Message::TxAddInput(ref msg) => msg.type_id(),
165174
&Message::TxAddOutput(ref msg) => msg.type_id(),
166175
&Message::TxRemoveInput(ref msg) => msg.type_id(),
@@ -258,6 +267,15 @@ fn do_read<R: io::Read, T, H: core::ops::Deref>(buffer: &mut R, message_type: u1
258267
msgs::FundingSigned::TYPE => {
259268
Ok(Message::FundingSigned(Readable::read(buffer)?))
260269
},
270+
msgs::Splice::TYPE => {
271+
Ok(Message::Splice(Readable::read(buffer)?))
272+
},
273+
msgs::SpliceAck::TYPE => {
274+
Ok(Message::SpliceAck(Readable::read(buffer)?))
275+
},
276+
msgs::SpliceLocked::TYPE => {
277+
Ok(Message::SpliceLocked(Readable::read(buffer)?))
278+
},
261279
msgs::TxAddInput::TYPE => {
262280
Ok(Message::TxAddInput(Readable::read(buffer)?))
263281
},
@@ -464,6 +482,19 @@ impl Encode for msgs::AcceptChannelV2 {
464482
const TYPE: u16 = 65;
465483
}
466484

485+
impl Encode for msgs::Splice {
486+
// TODO(splicing) Double check with spec; spec contains 74, which is probably wrong as it is used by tx_Abort; CLN uses 75
487+
const TYPE: u16 = 75;
488+
}
489+
490+
impl Encode for msgs::SpliceAck {
491+
const TYPE: u16 = 76;
492+
}
493+
494+
impl Encode for msgs::SpliceLocked {
495+
const TYPE: u16 = 77;
496+
}
497+
467498
impl Encode for msgs::TxAddInput {
468499
const TYPE: u16 = 66;
469500
}

‎lightning/src/util/test_utils.rs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,15 @@ impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
542542
fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
543543
self.received_msg(wire::Message::ClosingSigned(msg.clone()));
544544
}
545+
fn handle_splice(&self, _their_node_id: &PublicKey, msg: &msgs::Splice) {
546+
self.received_msg(wire::Message::Splice(msg.clone()));
547+
}
548+
fn handle_splice_ack(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
549+
self.received_msg(wire::Message::SpliceAck(msg.clone()));
550+
}
551+
fn handle_splice_locked(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
552+
self.received_msg(wire::Message::SpliceLocked(msg.clone()));
553+
}
545554
fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
546555
self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
547556
}

0 commit comments

Comments
 (0)