Add a pending changelog entry for the past few commits 2022-10-user-idempotency-token
authorMatt Corallo <git@bluematt.me>
Sat, 8 Oct 2022 21:25:44 +0000 (21:25 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 2 Nov 2022 01:09:07 +0000 (01:09 +0000)
pending_changelog/matt-idempotent-payments.txt [new file with mode: 0644]

diff --git a/pending_changelog/matt-idempotent-payments.txt b/pending_changelog/matt-idempotent-payments.txt
new file mode 100644 (file)
index 0000000..e837594
--- /dev/null
@@ -0,0 +1,16 @@
+API Changes
+===========
+
+ * Payment sending methods now take an explicit `PaymentId`, which acts as an
+   idempotency token. You may use the PaymentHash for this, which existing
+   `InvoicePayer` send methods do, new `_with_id` variants were added (#XXXX).
+ * Pending outbound payments are no longer automatically timed-out a few blocks
+   after failure. Thus, in order to avoid leaking memory, you MUST call
+   `ChannelManager::abandon_payment` when you no longer wish to retry (#XXXX).
+
+Serialization Compatibility
+===========================
+
+ * When downgrading to a version of LDK prior to THIS_VERSION_XXX when there are
+   resolved payments waiting for a small timeout, the payments may not be
+   removed, preventing payments with the same `PaymentId`.