Skip to content

Commit f65cfd2

Browse files
committed
Remove redundant 'outbound' wording from methods
1 parent b330f78 commit f65cfd2

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

lightning/src/chain/onchaintx.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1104,7 +1104,7 @@ impl<ChannelSigner: WriteableEcdsaChannelSigner> OnchainTxHandler<ChannelSigner>
11041104
}
11051105

11061106
//TODO: getting lastest holder transactions should be infallible and result in us "force-closing the channel", but we may
1107-
// have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after Channel::get_outbound_funding_created,
1107+
// have empty holder commitment transaction if a ChannelMonitor is asked to force-close just after OutboundV1Channel::get_funding_created,
11081108
// before providing a initial commitment transaction. For outbound channel, init ChannelMonitor at Channel::funding_signed, there is nothing
11091109
// to monitor before.
11101110
pub(crate) fn get_fully_signed_holder_tx(&mut self, funding_redeemscript: &Script) -> Transaction {

lightning/src/ln/channel.rs

+10-10
Original file line numberDiff line numberDiff line change
@@ -963,7 +963,7 @@ impl<Signer: ChannelSigner> ChannelContext<Signer> {
963963
}
964964

965965
/// Returns the funding_txo we either got from our peer, or were given by
966-
/// get_outbound_funding_created.
966+
/// get_funding_created.
967967
pub fn get_funding_txo(&self) -> Option<OutPoint> {
968968
self.channel_transaction_parameters.funding_outpoint
969969
}
@@ -1398,7 +1398,7 @@ impl<Signer: ChannelSigner> ChannelContext<Signer> {
13981398
#[inline]
13991399
/// Creates a set of keys for build_commitment_transaction to generate a transaction which we
14001400
/// will sign and send to our counterparty.
1401-
/// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1401+
/// If an Err is returned, it is a ChannelError::Close (for get_funding_created)
14021402
fn build_remote_transaction_keys(&self) -> TxCreationKeys {
14031403
//TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
14041404
//may see payments to it!
@@ -1980,7 +1980,7 @@ fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, channel_type_featur
19801980

19811981
// TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
19821982
// has been completed, and then turn into a Channel to get compiler-time enforcement of things like
1983-
// calling channel_id() before we're set up or things like get_outbound_funding_signed on an
1983+
// calling channel_id() before we're set up or things like get_funding_signed on an
19841984
// inbound channel.
19851985
//
19861986
// Holder designates channel data owned for the benefit of the user client.
@@ -5587,8 +5587,8 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
55875587
})
55885588
}
55895589

5590-
/// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
5591-
fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
5590+
/// If an Err is returned, it is a ChannelError::Close (for get_funding_created)
5591+
fn get_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
55925592
let counterparty_keys = self.context.build_remote_transaction_keys();
55935593
let counterparty_initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
55945594
Ok(self.context.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), &self.context.secp_ctx)
@@ -5602,7 +5602,7 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
56025602
/// Note that channel_id changes during this call!
56035603
/// Do NOT broadcast the funding transaction until after a successful funding_signed call!
56045604
/// If an Err is returned, it is a ChannelError::Close.
5605-
pub fn get_outbound_funding_created<L: Deref>(mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L)
5605+
pub fn get_funding_created<L: Deref>(mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L)
56065606
-> Result<(Channel<Signer>, msgs::FundingCreated), (Self, ChannelError)> where L::Target: Logger {
56075607
if !self.context.is_outbound() {
56085608
panic!("Tried to create outbound funding_created message on an inbound channel!");
@@ -5619,7 +5619,7 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
56195619
self.context.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
56205620
self.context.holder_signer.provide_channel_parameters(&self.context.channel_transaction_parameters);
56215621

5622-
let signature = match self.get_outbound_funding_created_signature(logger) {
5622+
let signature = match self.get_funding_created_signature(logger) {
56235623
Ok(res) => res,
56245624
Err(e) => {
56255625
log_error!(logger, "Got bad signatures: {:?}!", e);
@@ -7496,7 +7496,7 @@ mod tests {
74967496
value: 10000000, script_pubkey: output_script.clone(),
74977497
}]};
74987498
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7499-
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
7499+
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
75007500
let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
75017501

75027502
// Node B --> Node A: funding signed
@@ -7623,7 +7623,7 @@ mod tests {
76237623
value: 10000000, script_pubkey: output_script.clone(),
76247624
}]};
76257625
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7626-
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
7626+
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
76277627
let (mut node_b_chan, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
76287628

76297629
// Node B --> Node A: funding signed
@@ -7811,7 +7811,7 @@ mod tests {
78117811
value: 10000000, script_pubkey: output_script.clone(),
78127812
}]};
78137813
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7814-
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
7814+
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
78157815
let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
78167816

78177817
// Node B --> Node A: funding signed

lightning/src/ln/channelmanager.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3321,7 +3321,7 @@ where
33213321
Some(chan) => {
33223322
let funding_txo = find_funding_output(&chan, &funding_transaction)?;
33233323

3324-
let funding_res = chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
3324+
let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
33253325
.map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
33263326
let channel_id = chan.context.channel_id();
33273327
let user_id = chan.context.get_user_id();

lightning/src/ln/functional_tests.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8881,13 +8881,13 @@ fn test_duplicate_chan_id() {
88818881
let (_, funding_created) = {
88828882
let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
88838883
let mut a_peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
8884-
// Once we call `get_outbound_funding_created` the channel has a duplicate channel_id as
8884+
// Once we call `get_funding_created` the channel has a duplicate channel_id as
88858885
// another channel in the ChannelManager - an invalid state. Thus, we'd panic later when we
88868886
// try to create another channel. Instead, we drop the channel entirely here (leaving the
88878887
// channelmanager in a possibly nonsense state instead).
88888888
let mut as_chan = a_peer_state.outbound_v1_channel_by_id.remove(&open_chan_2_msg.temporary_channel_id).unwrap();
88898889
let logger = test_utils::TestLogger::new();
8890-
as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap()
8890+
as_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap()
88918891
};
88928892
check_added_monitors!(nodes[0], 0);
88938893
nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);

0 commit comments

Comments
 (0)