Skip to content

Commit 48e0518

Browse files
optout21optout21
committed
Rename method, review
1 parent 0e47819 commit 48e0518

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

‎lightning/src/ln/channel.rs‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use crate::ln::types::ChannelId;
3131
use crate::types::payment::{PaymentPreimage, PaymentHash};
3232
use crate::types::features::{ChannelTypeFeatures, InitFeatures};
3333
use crate::ln::interactivetxs::{
34-
get_output_weight, need_to_add_funding_change_output, HandleTxCompleteValue, HandleTxCompleteResult, InteractiveTxConstructor,
34+
get_output_weight, calculate_change_output_value, HandleTxCompleteValue, HandleTxCompleteResult, InteractiveTxConstructor,
3535
InteractiveTxConstructorArgs, InteractiveTxMessageSend, InteractiveTxSigningSession, InteractiveTxMessageSendResult,
3636
OutputOwned, SharedOwnedOutput, TX_COMMON_FIELDS_WEIGHT,
3737
};
@@ -1747,7 +1747,7 @@ pub(super) trait InteractivelyFunded<SP: Deref> where SP::Target: SignerProvider
17471747
};
17481748

17491749
// Optionally add change output
1750-
if let Some(change_value) = need_to_add_funding_change_output(
1750+
if let Some(change_value) = calculate_change_output_value(
17511751
self.is_initiator(), self.dual_funding_context().our_funding_satoshis,
17521752
&funding_inputs_prev_outputs, &funding_outputs,
17531753
self.dual_funding_context().funding_feerate_sat_per_1000_weight,
@@ -1757,8 +1757,8 @@ pub(super) trait InteractivelyFunded<SP: Deref> where SP::Target: SignerProvider
17571757
|err| APIError::APIMisuseError {
17581758
err: format!("Failed to get change script as new destination script, {:?}", err),
17591759
})?;
1760-
let _res = add_funding_change_output(
1761-
change_value, change_script, &mut funding_outputs, self.dual_funding_context().funding_feerate_sat_per_1000_weight);
1760+
add_funding_change_output(change_value, change_script,
1761+
&mut funding_outputs, self.dual_funding_context().funding_feerate_sat_per_1000_weight);
17621762
}
17631763

17641764
let constructor_args = InteractiveTxConstructorArgs {
@@ -4268,7 +4268,7 @@ fn get_v2_channel_reserve_satoshis(channel_value_satoshis: u64, dust_limit_satos
42684268
fn add_funding_change_output(
42694269
change_value: u64, change_script: ScriptBuf,
42704270
funding_outputs: &mut Vec<OutputOwned>, funding_feerate_sat_per_1000_weight: u32,
4271-
) -> TxOut {
4271+
) {
42724272
let mut change_output = TxOut {
42734273
value: Amount::from_sat(change_value),
42744274
script_pubkey: change_script,
@@ -4277,7 +4277,6 @@ fn add_funding_change_output(
42774277
let change_output_fee = fee_for_weight(funding_feerate_sat_per_1000_weight, change_output_weight);
42784278
change_output.value = Amount::from_sat(change_value.saturating_sub(change_output_fee));
42794279
funding_outputs.push(OutputOwned::Single(change_output.clone()));
4280-
change_output
42814280
}
42824281

42834282
pub(super) fn calculate_our_funding_satoshis(

‎lightning/src/ln/interactivetxs.rs‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1665,8 +1665,10 @@ impl InteractiveTxConstructor {
16651665
/// Determine whether a change output should be added or not, and if so, of what size,
16661666
/// considering our given inputs, outputs, and intended contribution.
16671667
/// Computes and takes into account fees.
1668+
/// Return value is the value computed for the change output (in satoshis),
1669+
/// or None if a change is not needed/possible.
16681670
#[allow(dead_code)] // TODO(dual_funding): Remove once begin_interactive_funding_tx_construction() is used
1669-
pub(super) fn need_to_add_funding_change_output(
1671+
pub(super) fn calculate_change_output_value(
16701672
is_initiator: bool, our_contribution: u64, funding_inputs_prev_outputs: &Vec<TxOut>,
16711673
funding_outputs: &Vec<OutputOwned>, funding_feerate_sat_per_1000_weight: u32,
16721674
holder_dust_limit_satoshis: u64,
@@ -1707,7 +1709,7 @@ mod tests {
17071709
use crate::chain::chaininterface::{fee_for_weight, FEERATE_FLOOR_SATS_PER_KW};
17081710
use crate::ln::channel::TOTAL_BITCOIN_SUPPLY_SATOSHIS;
17091711
use crate::ln::interactivetxs::{
1710-
generate_holder_serial_id, need_to_add_funding_change_output, AbortReason,
1712+
generate_holder_serial_id, calculate_change_output_value, AbortReason,
17111713
HandleTxCompleteValue, InteractiveTxConstructor, InteractiveTxConstructorArgs,
17121714
InteractiveTxMessageSend, MAX_INPUTS_OUTPUTS_COUNT, MAX_RECEIVED_TX_ADD_INPUT_COUNT,
17131715
MAX_RECEIVED_TX_ADD_OUTPUT_COUNT,
@@ -2637,7 +2639,7 @@ mod tests {
26372639
}
26382640

26392641
#[test]
2640-
fn test_need_to_add_funding_change_output_open() {
2642+
fn test_calculate_change_output_value_open() {
26412643
let input_prevouts = vec![
26422644
TxOut { value: Amount::from_sat(70_000), script_pubkey: ScriptBuf::new() },
26432645
TxOut { value: Amount::from_sat(60_000), script_pubkey: ScriptBuf::new() },
@@ -2653,7 +2655,7 @@ mod tests {
26532655
let common_fees = 126;
26542656
{
26552657
// There is leftover for change
2656-
let res = need_to_add_funding_change_output(
2658+
let res = calculate_change_output_value(
26572659
true,
26582660
our_contributed,
26592661
&input_prevouts,
@@ -2665,7 +2667,7 @@ mod tests {
26652667
}
26662668
{
26672669
// There is leftover for change, without common fees
2668-
let res = need_to_add_funding_change_output(
2670+
let res = calculate_change_output_value(
26692671
false,
26702672
our_contributed,
26712673
&input_prevouts,
@@ -2677,7 +2679,7 @@ mod tests {
26772679
}
26782680
{
26792681
// Larger fee, smaller change
2680-
let res = need_to_add_funding_change_output(
2682+
let res = calculate_change_output_value(
26812683
true,
26822684
our_contributed,
26832685
&input_prevouts,
@@ -2689,7 +2691,7 @@ mod tests {
26892691
}
26902692
{
26912693
// Insufficient inputs, no leftover
2692-
let res = need_to_add_funding_change_output(
2694+
let res = calculate_change_output_value(
26932695
false,
26942696
130_000,
26952697
&input_prevouts,
@@ -2701,7 +2703,7 @@ mod tests {
27012703
}
27022704
{
27032705
// Very small leftover
2704-
let res = need_to_add_funding_change_output(
2706+
let res = calculate_change_output_value(
27052707
false,
27062708
128_100,
27072709
&input_prevouts,
@@ -2713,7 +2715,7 @@ mod tests {
27132715
}
27142716
{
27152717
// Small leftover, but not dust
2716-
let res = need_to_add_funding_change_output(
2718+
let res = calculate_change_output_value(
27172719
false,
27182720
128_100,
27192721
&input_prevouts,
@@ -2726,7 +2728,7 @@ mod tests {
27262728
}
27272729

27282730
#[test]
2729-
fn test_need_to_add_funding_change_output_splice() {
2731+
fn test_calculate_change_output_value_splice() {
27302732
let input_prevouts = vec![
27312733
TxOut { value: Amount::from_sat(70_000), script_pubkey: ScriptBuf::new() },
27322734
TxOut { value: Amount::from_sat(60_000), script_pubkey: ScriptBuf::new() },
@@ -2742,7 +2744,7 @@ mod tests {
27422744
let common_fees = 126;
27432745
{
27442746
// There is leftover for change
2745-
let res = need_to_add_funding_change_output(
2747+
let res = calculate_change_output_value(
27462748
true,
27472749
our_contributed,
27482750
&input_prevouts,
@@ -2754,7 +2756,7 @@ mod tests {
27542756
}
27552757
{
27562758
// Very small leftover
2757-
let res = need_to_add_funding_change_output(
2759+
let res = calculate_change_output_value(
27582760
false,
27592761
128_100,
27602762
&input_prevouts,
@@ -2766,7 +2768,7 @@ mod tests {
27662768
}
27672769
{
27682770
// Small leftover, but not dust
2769-
let res = need_to_add_funding_change_output(
2771+
let res = calculate_change_output_value(
27702772
false,
27712773
128_100,
27722774
&input_prevouts,

0 commit comments

Comments
 (0)