Skip to content

Commit 9d44544

Browse files
committed
Remove redundant 'outbound' wording from methods
1 parent ff38ab6 commit 9d44544

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
@@ -995,7 +995,7 @@ impl<Signer: ChannelSigner> ChannelContext<Signer> {
995995
}
996996

997997
/// Returns the funding_txo we either got from our peer, or were given by
998-
/// get_outbound_funding_created.
998+
/// get_funding_created.
999999
pub fn get_funding_txo(&self) -> Option<OutPoint> {
10001000
self.channel_transaction_parameters.funding_outpoint
10011001
}
@@ -1440,7 +1440,7 @@ impl<Signer: ChannelSigner> ChannelContext<Signer> {
14401440
#[inline]
14411441
/// Creates a set of keys for build_commitment_transaction to generate a transaction which we
14421442
/// will sign and send to our counterparty.
1443-
/// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1443+
/// If an Err is returned, it is a ChannelError::Close (for get_funding_created)
14441444
fn build_remote_transaction_keys(&self) -> TxCreationKeys {
14451445
//TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
14461446
//may see payments to it!
@@ -2026,7 +2026,7 @@ fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, channel_type_featur
20262026

20272027
// TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
20282028
// has been completed, and then turn into a Channel to get compiler-time enforcement of things like
2029-
// calling channel_id() before we're set up or things like get_outbound_funding_signed on an
2029+
// calling channel_id() before we're set up or things like get_funding_signed on an
20302030
// inbound channel.
20312031
//
20322032
// Holder designates channel data owned for the benefit of the user client.
@@ -5662,8 +5662,8 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
56625662
})
56635663
}
56645664

5665-
/// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
5666-
fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
5665+
/// If an Err is returned, it is a ChannelError::Close (for get_funding_created)
5666+
fn get_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
56675667
let counterparty_keys = self.context.build_remote_transaction_keys();
56685668
let counterparty_initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
56695669
Ok(self.context.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), &self.context.secp_ctx)
@@ -5677,7 +5677,7 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
56775677
/// Note that channel_id changes during this call!
56785678
/// Do NOT broadcast the funding transaction until after a successful funding_signed call!
56795679
/// If an Err is returned, it is a ChannelError::Close.
5680-
pub fn get_outbound_funding_created<L: Deref>(mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L)
5680+
pub fn get_funding_created<L: Deref>(mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L)
56815681
-> Result<(Channel<Signer>, msgs::FundingCreated), (Self, ChannelError)> where L::Target: Logger {
56825682
if !self.context.is_outbound() {
56835683
panic!("Tried to create outbound funding_created message on an inbound channel!");
@@ -5694,7 +5694,7 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
56945694
self.context.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
56955695
self.context.holder_signer.provide_channel_parameters(&self.context.channel_transaction_parameters);
56965696

5697-
let signature = match self.get_outbound_funding_created_signature(logger) {
5697+
let signature = match self.get_funding_created_signature(logger) {
56985698
Ok(res) => res,
56995699
Err(e) => {
57005700
log_error!(logger, "Got bad signatures: {:?}!", e);
@@ -7571,7 +7571,7 @@ mod tests {
75717571
value: 10000000, script_pubkey: output_script.clone(),
75727572
}]};
75737573
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7574-
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
7574+
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
75757575
let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
75767576

75777577
// Node B --> Node A: funding signed
@@ -7698,7 +7698,7 @@ mod tests {
76987698
value: 10000000, script_pubkey: output_script.clone(),
76997699
}]};
77007700
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7701-
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
7701+
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
77027702
let (mut node_b_chan, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
77037703

77047704
// Node B --> Node A: funding signed
@@ -7886,7 +7886,7 @@ mod tests {
78867886
value: 10000000, script_pubkey: output_script.clone(),
78877887
}]};
78887888
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7889-
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
7889+
let (mut node_a_chan, funding_created_msg) = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, &&logger).map_err(|_| ()).unwrap();
78907890
let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
78917891

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

lightning/src/ln/channelmanager.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3375,7 +3375,7 @@ where
33753375
Some(chan) => {
33763376
let funding_txo = find_funding_output(&chan, &funding_transaction)?;
33773377

3378-
let funding_res = chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
3378+
let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
33793379
.map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
33803380
let channel_id = chan.context.channel_id();
33813381
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)