@@ -92,8 +92,6 @@ impl Default for LSPS5ServiceConfig {
92
92
/// - `lsps5.remove_webhook` -> delete a named webhook or return [`app_name_not_found`] error.
93
93
/// - Prune stale webhooks after a client has no open channels and no activity for at least
94
94
/// [`MIN_WEBHOOK_RETENTION_DAYS`].
95
- /// - Rate-limit repeat notifications of the same method to a client by
96
- /// [`notification_cooldown_hours`].
97
95
/// - Sign and enqueue outgoing webhook notifications:
98
96
/// - Construct JSON-RPC 2.0 Notification objects [`WebhookNotification`],
99
97
/// - Timestamp and LN-style zbase32-sign each payload,
@@ -108,7 +106,6 @@ impl Default for LSPS5ServiceConfig {
108
106
/// [`bLIP-55 / LSPS5`]: https://github.com/lightning/blips/pull/55/files
109
107
/// [`max_webhooks_per_client`]: super::service::LSPS5ServiceConfig::max_webhooks_per_client
110
108
/// [`app_name_not_found`]: super::msgs::LSPS5ProtocolError::AppNameNotFound
111
- /// [`notification_cooldown_hours`]: super::service::LSPS5ServiceConfig::notification_cooldown_hours
112
109
/// [`WebhookNotification`]: super::msgs::WebhookNotification
113
110
/// [`LSPS5ServiceEvent::SendWebhookNotification`]: super::event::LSPS5ServiceEvent::SendWebhookNotification
114
111
/// [`app_name`]: super::msgs::LSPS5AppName
@@ -332,10 +329,14 @@ where
332
329
/// This builds a [`WebhookNotificationMethod::LSPS5PaymentIncoming`] webhook notification, signs it with your
333
330
/// node key, and enqueues HTTP POSTs to all registered webhook URLs for that client.
334
331
///
332
+ /// This may fail if a similar notification was sent too recently,
333
+ /// violating the notification cooldown period defined in [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`].
334
+ ///
335
335
/// # Parameters
336
336
/// - `client_id`: the client's node-ID whose webhooks should be invoked.
337
337
///
338
338
/// [`WebhookNotificationMethod::LSPS5PaymentIncoming`]: super::msgs::WebhookNotificationMethod::LSPS5PaymentIncoming
339
+ /// [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`]: super::service::DEFAULT_NOTIFICATION_COOLDOWN_HOURS
339
340
pub fn notify_payment_incoming ( & self , client_id : PublicKey ) -> Result < ( ) , LSPS5ProtocolError > {
340
341
let notification = WebhookNotification :: payment_incoming ( ) ;
341
342
self . send_notifications_to_client_webhooks ( client_id, notification)
@@ -349,11 +350,15 @@ where
349
350
/// the `timeout` block height, signs it, and enqueues HTTP POSTs to the client's
350
351
/// registered webhooks.
351
352
///
353
+ /// This may fail if a similar notification was sent too recently,
354
+ /// violating the notification cooldown period defined in [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`].
355
+ ///
352
356
/// # Parameters
353
357
/// - `client_id`: the client's node-ID whose webhooks should be invoked.
354
358
/// - `timeout`: the block height at which the channel contract will expire.
355
359
///
356
360
/// [`WebhookNotificationMethod::LSPS5ExpirySoon`]: super::msgs::WebhookNotificationMethod::LSPS5ExpirySoon
361
+ /// [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`]: super::service::DEFAULT_NOTIFICATION_COOLDOWN_HOURS
357
362
pub fn notify_expiry_soon (
358
363
& self , client_id : PublicKey , timeout : u32 ,
359
364
) -> Result < ( ) , LSPS5ProtocolError > {
@@ -367,10 +372,14 @@ where
367
372
/// liquidity for `client_id`. Builds a [`WebhookNotificationMethod::LSPS5LiquidityManagementRequest`] notification,
368
373
/// signs it, and sends it to all of the client's registered webhook URLs.
369
374
///
375
+ /// This may fail if a similar notification was sent too recently,
376
+ /// violating the notification cooldown period defined in [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`].
377
+ ///
370
378
/// # Parameters
371
379
/// - `client_id`: the client's node-ID whose webhooks should be invoked.
372
380
///
373
381
/// [`WebhookNotificationMethod::LSPS5LiquidityManagementRequest`]: super::msgs::WebhookNotificationMethod::LSPS5LiquidityManagementRequest
382
+ /// [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`]: super::service::DEFAULT_NOTIFICATION_COOLDOWN_HOURS
374
383
pub fn notify_liquidity_management_request (
375
384
& self , client_id : PublicKey ,
376
385
) -> Result < ( ) , LSPS5ProtocolError > {
@@ -384,10 +393,14 @@ where
384
393
/// for `client_id` while the client is offline. Builds a [`WebhookNotificationMethod::LSPS5OnionMessageIncoming`]
385
394
/// notification, signs it, and enqueues HTTP POSTs to each registered webhook.
386
395
///
396
+ /// This may fail if a similar notification was sent too recently,
397
+ /// violating the notification cooldown period defined in [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`].
398
+ ///
387
399
/// # Parameters
388
400
/// - `client_id`: the client's node-ID whose webhooks should be invoked.
389
401
///
390
402
/// [`WebhookNotificationMethod::LSPS5OnionMessageIncoming`]: super::msgs::WebhookNotificationMethod::LSPS5OnionMessageIncoming
403
+ /// [`DEFAULT_NOTIFICATION_COOLDOWN_HOURS`]: super::service::DEFAULT_NOTIFICATION_COOLDOWN_HOURS
391
404
pub fn notify_onion_message_incoming (
392
405
& self , client_id : PublicKey ,
393
406
) -> Result < ( ) , LSPS5ProtocolError > {
@@ -408,24 +421,34 @@ where
408
421
let now =
409
422
LSPSDateTime :: new_from_duration_since_epoch ( self . time_provider . duration_since_epoch ( ) ) ;
410
423
411
- for ( app_name, webhook) in client_webhooks. iter_mut ( ) {
412
- if webhook
413
- . last_notification_sent
414
- . get ( & notification. method )
415
- . map ( |last_sent| now. clone ( ) . abs_diff ( & last_sent) )
416
- . map_or ( true , |last_sent| {
417
- last_sent >= self . config . notification_cooldown_hours . as_secs ( )
418
- } ) {
419
- webhook. last_notification_sent . insert ( notification. method . clone ( ) , now. clone ( ) ) ;
420
- webhook. last_used = now. clone ( ) ;
421
- self . send_notification (
422
- client_id,
423
- app_name. clone ( ) ,
424
- webhook. url . clone ( ) ,
425
- notification. clone ( ) ,
426
- ) ?;
424
+ // We must avoid sending multiple notifications of the same method
425
+ // (other than lsps5.webhook_registered) close in time.
426
+ if notification. method != WebhookNotificationMethod :: LSPS5WebhookRegistered {
427
+ let rate_limit_applies = client_webhooks. iter ( ) . any ( |( _, webhook) | {
428
+ webhook
429
+ . last_notification_sent
430
+ . get ( & notification. method )
431
+ . map ( |last_sent| now. abs_diff ( & last_sent) )
432
+ . map_or ( false , |duration| {
433
+ duration < DEFAULT_NOTIFICATION_COOLDOWN_HOURS . as_secs ( )
434
+ } )
435
+ } ) ;
436
+
437
+ if rate_limit_applies {
438
+ return Err ( LSPS5ProtocolError :: SlowDownError ) ;
427
439
}
428
440
}
441
+
442
+ for ( app_name, webhook) in client_webhooks. iter_mut ( ) {
443
+ webhook. last_notification_sent . insert ( notification. method . clone ( ) , now. clone ( ) ) ;
444
+ webhook. last_used = now. clone ( ) ;
445
+ self . send_notification (
446
+ client_id,
447
+ app_name. clone ( ) ,
448
+ webhook. url . clone ( ) ,
449
+ notification. clone ( ) ,
450
+ ) ?;
451
+ }
429
452
Ok ( ( ) )
430
453
}
431
454
0 commit comments