Skip to content

Make skimmed_fee_msat optional in LSPS2's payment_forwarded API #4162

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Make skimmed_fee_msat optional in LSPS2's payment_forwarded API #4162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions lightning-liquidity/src/lsps2/service.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,15 +434,15 @@ impl OutboundJITChannelState {
}

fn payment_forwarded(
&mut self, skimmed_fee_msat: u64,
&mut self, skimmed_fee_msat: Option<u64>,
) -> Result<Option<ForwardHTLCsAction>, ChannelStateError> {
match self {
OutboundJITChannelState::PendingPaymentForward {
payment_queue,
channel_id,
opening_fee_msat,
} => {
if skimmed_fee_msat >= *opening_fee_msat {
if skimmed_fee_msat >= Some(*opening_fee_msat) {
let mut pq = core::mem::take(payment_queue);
let forward_htlcs = ForwardHTLCsAction(*channel_id, pq.clear());
*self = OutboundJITChannelState::PaymentForwarded { channel_id: *channel_id };
Expand Down Expand Up @@ -542,7 +542,7 @@ impl OutboundJITChannel {
}

fn payment_forwarded(
&mut self, skimmed_fee_msat: u64,
&mut self, skimmed_fee_msat: Option<u64>,
) -> Result<Option<ForwardHTLCsAction>, LightningError> {
let action = self.state.payment_forwarded(skimmed_fee_msat)?;
Ok(action)
Expand Down Expand Up @@ -1179,7 +1179,7 @@ where
///
/// [`Event::PaymentForwarded`]: lightning::events::Event::PaymentForwarded
pub async fn payment_forwarded(
&self, next_channel_id: ChannelId, skimmed_fee_msat: u64,
&self, next_channel_id: ChannelId, skimmed_fee_msat: Option<u64>,
) -> Result<(), APIError> {
let mut should_persist = None;
if let Some(counterparty_node_id) =
Expand Down Expand Up @@ -2239,7 +2239,7 @@ where
///
/// [`Event::PaymentForwarded`]: lightning::events::Event::PaymentForwarded
pub fn payment_forwarded(
&self, next_channel_id: ChannelId, skimmed_fee_msat: u64,
&self, next_channel_id: ChannelId, skimmed_fee_msat: Option<u64>,
) -> Result<(), APIError> {
let mut fut = Box::pin(self.inner.payment_forwarded(next_channel_id, skimmed_fee_msat));

Expand Down Expand Up @@ -2583,7 +2583,7 @@ mod tests {
}
// Payment completes, queued payments get forwarded.
{
let action = state.payment_forwarded(100000000000).unwrap();
let action = state.payment_forwarded(Some(100000000000)).unwrap();
assert!(matches!(state, OutboundJITChannelState::PaymentForwarded { .. }));
match action {
Some(ForwardHTLCsAction(channel_id, htlcs)) => {
Expand Down Expand Up @@ -2718,7 +2718,7 @@ mod tests {
}
// Payment completes, queued payments get forwarded.
{
let action = state.payment_forwarded(10000000000).unwrap();
let action = state.payment_forwarded(Some(10000000000)).unwrap();
assert!(matches!(state, OutboundJITChannelState::PaymentForwarded { .. }));
match action {
Some(ForwardHTLCsAction(channel_id, htlcs)) => {
Expand Down Expand Up @@ -2839,14 +2839,14 @@ mod tests {
);

// Forward a payment that is not enough to cover the fees
let _ = jit_channel.payment_forwarded(min_fee_msat - 1).unwrap();
let _ = jit_channel.payment_forwarded(Some(min_fee_msat - 1)).unwrap();

assert!(
!jit_channel.should_broadcast_funding_transaction(),
"Should not broadcast before all the fees are collected"
);

let _ = jit_channel.payment_forwarded(min_fee_msat).unwrap();
let _ = jit_channel.payment_forwarded(Some(min_fee_msat)).unwrap();

let broadcast_allowed = jit_channel.should_broadcast_funding_transaction();

Expand Down
6 changes: 3 additions & 3 deletions lightning-liquidity/tests/lsps2_integration_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@ fn client_trusts_lsp_end_to_end_test() {
} => {
assert_eq!(prev_node_id, Some(payer_node_id));
assert_eq!(next_node_id, Some(client_node_id));
service_handler.payment_forwarded(channel_id, skimmed_fee_msat.unwrap_or(0)).unwrap();
service_handler.payment_forwarded(channel_id, skimmed_fee_msat).unwrap();
Some(total_fee_earned_msat.unwrap() - skimmed_fee_msat.unwrap())
},
_ => panic!("Expected PaymentForwarded event, got: {:?}", service_events[0]),
Expand Down Expand Up @@ -1782,7 +1782,7 @@ fn late_payment_forwarded_and_safe_after_force_close_does_not_broadcast() {
Event::PaymentForwarded { skimmed_fee_msat, .. } => skimmed_fee_msat.unwrap_or(0),
other => panic!("Expected PaymentForwarded, got {:?}", other),
};
service_handler.payment_forwarded(channel_id, skimmed).unwrap();
service_handler.payment_forwarded(channel_id, Some(skimmed)).unwrap();

// Force-close the service->client channel
service_node
Expand Down Expand Up @@ -2325,7 +2325,7 @@ fn client_trusts_lsp_partial_fee_does_not_trigger_broadcast() {
assert!(service_node.liquidity_manager.get_and_clear_pending_events().is_empty());

let partial_skim_msat = fee_base_msat - 1; // less than promised fee
service_handler.payment_forwarded(channel_id, partial_skim_msat).unwrap();
service_handler.payment_forwarded(channel_id, Some(partial_skim_msat)).unwrap();

let broadcasted = service_node.inner.tx_broadcaster.txn_broadcasted.lock().unwrap();
assert!(broadcasted.is_empty(), "There should be no broadcasted txs yet");
Expand Down