Include fees in SpliceContribution docs
What the developer wrote
Authored by Jeffrey Czyz
Include fees in SpliceContribution docs
How fees are paid for in a SpliceContribution depends on whether it is a
SpliceIn or SpliceOut. Include this in its docs for clarification.
What changed, and why it matters
This commit only updates documentation comments for the SpliceContribution type. It clarifies that users must account for transaction fees when providing inputs for a splice-in or outputs for a splice-out. No code behavior changed.
No security action needed. Treat as a normal documentation improvement.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies two Rust doc comments in lightning/src/ln/funding.rs. For SpliceIn, it now states inputs must cover the contributed amount plus fees. For SpliceOut, it now states the removed amount equals the outputs’ total value plus fees. There are no logic, API, or cryptographic changes.
Changed components
lightning/src/ln/funding.rs documentation onlyInspect captured patch +3 / −3
diff --git a/lightning/src/ln/funding.rs b/lightning/src/ln/funding.rs
index 8a51741..e42c338 100644
--- a/lightning/src/ln/funding.rs
+++ b/lightning/src/ln/funding.rs
@@ -24,8 +24,8 @@ pub enum SpliceContribution {
/// The amount to contribute to the splice.
value: Amount,
- /// The inputs included in the splice's funding transaction to meet the contributed amount.
- /// Any excess amount will be sent to a change output.
+ /// The inputs included in the splice's funding transaction to meet the contributed amount
+ /// plus fees. Any excess amount will be sent to a change output.
inputs: Vec<FundingTxInput>,
/// An optional change output script. This will be used if needed or, when not set,
@@ -35,7 +35,7 @@ pub enum SpliceContribution {
/// When funds are removed from a channel.
SpliceOut {
/// The outputs to include in the splice's funding transaction. The total value of all
- /// outputs will be the amount that is removed.
+ /// outputs plus fees will be the amount that is removed.
outputs: Vec<TxOut>,
},
}
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.