Skip to content

Add ChannelPending event #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 44 additions & 9 deletions src/event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ use lightning::routing::gossip::NodeId;
use lightning::util::errors::APIError;
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};

use bitcoin::secp256k1::Secp256k1;
use bitcoin::secp256k1::{PublicKey, Secp256k1};
use bitcoin::OutPoint;
use rand::{thread_rng, Rng};
use std::collections::VecDeque;
use std::ops::Deref;
Expand Down Expand Up @@ -48,6 +49,19 @@ pub enum Event {
/// The value, in thousandths of a satoshi, that has been received.
amount_msat: u64,
},
/// A channel has been created and is pending confirmation on-chain.
ChannelPending {
/// The `channel_id` of the channel.
channel_id: [u8; 32],
/// The `user_channel_id` of the channel.
user_channel_id: u128,
/// The `temporary_channel_id` this channel used to be known by during channel establishment.
former_temporary_channel_id: [u8; 32],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Would opt to drop former as this seems to be implied by "temporary", FWIW.

Copy link
Collaborator Author

@tnull tnull Apr 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to disagree. The 'former' is there to clearly communicate that it's invalid by now.

/// The `node_id` of the channel counterparty.
counterparty_node_id: PublicKey,
/// The outpoint of the channel's funding transaction.
funding_txo: OutPoint,
},
/// A channel is ready to be used.
ChannelReady {
/// The `channel_id` of the channel.
Expand Down Expand Up @@ -79,7 +93,14 @@ impl_writeable_tlv_based_enum!(Event,
(0, channel_id, required),
(1, user_channel_id, required),
},
(4, ChannelClosed) => {
(4, ChannelPending) => {
(0, channel_id, required),
(1, user_channel_id, required),
(2, former_temporary_channel_id, required),
(3, counterparty_node_id, required),
(4, funding_txo, required),
},
(5, ChannelClosed) => {
(0, channel_id, required),
(1, user_channel_id, required),
};
Expand Down Expand Up @@ -607,20 +628,34 @@ where
}
}
LdkEvent::ChannelPending {
channel_id: _,
user_channel_id: _,
former_temporary_channel_id: _,
counterparty_node_id: _,
funding_txo: _,
channel_id,
user_channel_id,
former_temporary_channel_id,
counterparty_node_id,
funding_txo,
} => {
// TODO!
log_info!(
self.logger,
"New channel {} with counterparty {} has been created and is pending confirmation on chain.",
hex_utils::to_string(&channel_id),
counterparty_node_id,
);
self.event_queue
.add_event(Event::ChannelPending {
channel_id,
user_channel_id,
former_temporary_channel_id: former_temporary_channel_id.unwrap(),
counterparty_node_id,
funding_txo,
})
.expect("Failed to push to event queue");
}
LdkEvent::ChannelReady {
channel_id, user_channel_id, counterparty_node_id, ..
} => {
log_info!(
self.logger,
"Channel {} with {} ready to be used.",
"Channel {} with counterparty {} ready to be used.",
hex_utils::to_string(&channel_id),
counterparty_node_id,
);
Expand Down
18 changes: 10 additions & 8 deletions src/test/functional_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ use crate::{Builder, Error, Event, PaymentDirection, PaymentStatus};

use bitcoin::Amount;

use std::time::Duration;
#[test]
fn channel_full_cycle() {
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
Expand Down Expand Up @@ -36,13 +35,16 @@ fn channel_full_cycle() {
let node_b_addr = format!("{}@{}", node_b.node_id(), node_b.listening_address().unwrap());
node_a.connect_open_channel(&node_b_addr, 50000, true).unwrap();

let funding_txo = loop {
let details = node_a.list_channels();
expect_event!(node_a, ChannelPending);

if details.is_empty() || details[0].funding_txo.is_none() {
std::thread::sleep(Duration::from_secs(1));
} else {
break details[0].funding_txo.unwrap();
let funding_txo = match node_b.next_event() {
ref e @ Event::ChannelPending { funding_txo, .. } => {
println!("{} got event {:?}", std::stringify!(node_b), e);
node_b.event_handled();
funding_txo
}
ref e => {
panic!("{} got unexpected event!: {:?}", std::stringify!(node_b), e);
}
};

Expand Down Expand Up @@ -168,7 +170,7 @@ fn channel_full_cycle() {
expect_event!(node_a, ChannelClosed);
expect_event!(node_b, ChannelClosed);

wait_for_outpoint_spend(&electrsd, funding_txo.into_bitcoin_outpoint());
wait_for_outpoint_spend(&electrsd, funding_txo);

generate_blocks_and_wait(&bitcoind, &electrsd, 1);
node_a.sync_wallets().unwrap();
Expand Down