Merge pull request #283 from benthecarman/migrate-forwarded-payments-ldk-node

Use ldk-node for forwarded payment history

Author: tnull

Cargo.lock

@@ -10,6 +10,11 @@ alias = "ldk_server"                          # Lightning node alias
 #async_payments_role = "client"               # Optional async payments role: "client" or "server"
 #enable_zero_fee_commitments = false          # Enable zero-fee commitment channels (default: false)
 
+# Forwarding history: "detailed" retains individual records for the current and previous hour,
+# then aggregates them into hourly channel-pair statistics and removes the individual records.
+# "stats" updates per-channel totals directly without storing individual forwards.
+#forwarded_payment_tracking_mode = "stats"    # Default: "stats"
+
 # Background probing service (optional)
 # CAUTION: Probes send real HTLCs and can lock outbound liquidity until they time out.
 # See docs/configuration.md for complete field descriptions.

contrib/ldk-server-config.toml

@@ -161,7 +161,12 @@ a channel just-in-time when the invoice is paid.
 |-------------------------|------------------------------------------------|
 | `GetPaymentDetails`     | Get details for a specific payment by ID       |
 | `ListPayments`          | List all payments (paginated)                  |
-| `ListForwardedPayments` | List all forwarded/routed payments (paginated) |
+| `GetForwardedPaymentDetails` | Get a stored forwarded payment by its ID |
+| `GetForwardedPaymentTrackingMode` | Get the configured forwarding history tracking mode |
+| `GetChannelForwardingStats` | Get forwarding statistics for a channel |
+| `ListChannelForwardingStats` | List channel forwarding statistics (paginated) |
+| `ListChannelPairForwardingStats` | List channel-pair forwarding statistics (paginated) |
+| `ListForwardedPayments` | List forwarded payments (paginated) |
 
 See [Pagination](#pagination) below for how to page through results.
 
@@ -286,7 +291,8 @@ errors before accepting further payments.
 
 ## Pagination
 
-`ListPayments` and `ListForwardedPayments` support cursor-based pagination:
+`ListPayments`, `ListForwardedPayments`, `ListChannelForwardingStats`, and
+`ListChannelPairForwardingStats` support cursor-based pagination:
 
 1. Make the first request without a `page_token`. The server controls the page size.
 2. If the response includes a `next_page_token`, pass it as `page_token` in the next request.

docs/api-guide.md

@@ -64,6 +64,14 @@ falling back to other channel types supported by the peer. Enabling this setting
 source that supports Bitcoin Core's `submitpackage` RPC, and relays TRUC, P2A, and ephemeral
 dust. The default is `false`.
 
+Set `forwarded_payment_tracking_mode = "detailed"` to store individual
+forwards. LDK Node retains these records for the current and previous one-hour buckets, then
+aggregates them into hourly channel-pair statistics and removes the individual records.
+Set it to `"stats"` (the default, matching LDK Node) to update per-channel totals directly without
+storing individual forwards. Values are case-insensitive.
+The same setting is available as `--node-forwarded-payment-tracking-mode` or
+`LDK_SERVER_NODE_FORWARDED_PAYMENT_TRACKING_MODE`.
+
 ### `[probing]`
 
 Enables LDK Node's background probing service to train the payment scorer with current
@@ -220,8 +228,7 @@ Two resolution methods are supported via the `mode` field:
   <network>/                # e.g., bitcoin/, regtest/, signet/
     api_key                # API key
     ldk-server.log         # Log file
-    ldk_node_data.sqlite   # LDK Node state (channels, wallet, payments)
-    ldk_server_data.sqlite # Forwarded-payment history
+    ldk_node_data.sqlite   # LDK Node state, payments, and forwarding history
 ```
 
 The mnemonic is the node's master secret, required to recover on-chain funds. On first start,

docs/configuration.md

@@ -53,8 +53,7 @@ the following config to `/etc/logrotate.d/ldk-server` (adjust the log path to ma
 | File                                   | Priority     | Description                                                                |
 | -------------------------------------- | ------------ | -------------------------------------------------------------------------- |
 | `<storage_dir>/keys_mnemonic`          | **Critical** | BIP39 mnemonic. Required to recover on-chain funds. Default for new installs. |
-| `<network_dir>/ldk_node_data.sqlite`   | **Critical** | Channel state, on-chain wallet data, and payment history. Required to recover channel funds. |
-| `<network_dir>/ldk_server_data.sqlite` | Nice-to-have | Forwarded-payment history                                                  |
+| `<network_dir>/ldk_node_data.sqlite`   | **Critical** | Channel state, on-chain wallet data, payment and forwarding history. Required to recover channel funds. |
 
 ### What is Reconstructable