Skip to content

Commit 98e5cbc

Browse files
committed
Add funding_txo to ChannelReady event
A ChannelReady event is used for both channel establishment and splicing to indicate that the funding transaction is confirmed to an acceptable depth and thus the channel can be used with the funding. An upcoming SplicePending event will be emitted for each pending splice (i.e., both the initial splice attempt and any RBF attempts). Thus, when a ChannelReady event is emitted, the funding_txo must be included to differentiate between which ChannelPending -- which also contains the funding_txo -- that the event corresponds to.
1 parent 0f528b3 commit 98e5cbc

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

lightning/src/events/mod.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1378,6 +1378,11 @@ pub enum Event {
13781378
user_channel_id: u128,
13791379
/// The `node_id` of the channel counterparty.
13801380
counterparty_node_id: PublicKey,
1381+
/// The outpoint of the channel's funding transaction.
1382+
///
1383+
/// Will be `None` if the channel's funding transaction reached an acceptable depth prior to
1384+
/// version 0.2.
1385+
funding_txo: Option<OutPoint>,
13811386
/// The features that this channel will operate with.
13821387
channel_type: ChannelTypeFeatures,
13831388
},
@@ -1929,11 +1934,13 @@ impl Writeable for Event {
19291934
ref channel_id,
19301935
ref user_channel_id,
19311936
ref counterparty_node_id,
1937+
ref funding_txo,
19321938
ref channel_type,
19331939
} => {
19341940
29u8.write(writer)?;
19351941
write_tlv_fields!(writer, {
19361942
(0, channel_id, required),
1943+
(1, funding_txo, option),
19371944
(2, user_channel_id, required),
19381945
(4, counterparty_node_id, required),
19391946
(6, channel_type, required),
@@ -2440,9 +2447,11 @@ impl MaybeReadable for Event {
24402447
let mut channel_id = ChannelId::new_zero();
24412448
let mut user_channel_id: u128 = 0;
24422449
let mut counterparty_node_id = RequiredWrapper(None);
2450+
let mut funding_txo = None;
24432451
let mut channel_type = RequiredWrapper(None);
24442452
read_tlv_fields!(reader, {
24452453
(0, channel_id, required),
2454+
(1, funding_txo, option),
24462455
(2, user_channel_id, required),
24472456
(4, counterparty_node_id, required),
24482457
(6, channel_type, required),
@@ -2452,6 +2461,7 @@ impl MaybeReadable for Event {
24522461
channel_id,
24532462
user_channel_id,
24542463
counterparty_node_id: counterparty_node_id.0.unwrap(),
2464+
funding_txo,
24552465
channel_type: channel_type.0.unwrap(),
24562466
}))
24572467
};

lightning/src/ln/channelmanager.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3230,6 +3230,7 @@ macro_rules! emit_initial_channel_ready_event {
32303230
channel_id: $channel.context.channel_id(),
32313231
user_channel_id: $channel.context.get_user_id(),
32323232
counterparty_node_id: $channel.context.get_counterparty_node_id(),
3233+
funding_txo: $channel.funding.get_funding_txo().map(|outpoint| outpoint.into_bitcoin_outpoint()),
32333234
channel_type: $channel.funding.get_channel_type().clone(),
32343235
}, None));
32353236
$channel.context.set_initial_channel_ready_event_emitted();
@@ -9676,6 +9677,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
96769677
channel_id: chan.context.channel_id(),
96779678
user_channel_id: chan.context.get_user_id(),
96789679
counterparty_node_id: chan.context.get_counterparty_node_id(),
9680+
funding_txo: chan.funding.get_funding_txo().map(|outpoint| outpoint.into_bitcoin_outpoint()),
96799681
channel_type: chan.funding.get_channel_type().clone(),
96809682
}, None));
96819683
}
@@ -11849,6 +11851,7 @@ where
1184911851
channel_id: funded_channel.context.channel_id(),
1185011852
user_channel_id: funded_channel.context.get_user_id(),
1185111853
counterparty_node_id: funded_channel.context.get_counterparty_node_id(),
11854+
funding_txo: funded_channel.funding.get_funding_txo().map(|outpoint| outpoint.into_bitcoin_outpoint()),
1185211855
channel_type: funded_channel.funding.get_channel_type().clone(),
1185311856
}, None));
1185411857
}

0 commit comments

Comments
 (0)