]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Add pending changelog for Event::PaymentFailed
authorJeffrey Czyz <jkczyz@gmail.com>
Wed, 7 Aug 2024 21:15:35 +0000 (16:15 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Wed, 14 Aug 2024 15:55:59 +0000 (10:55 -0500)
pending_changelog/3192-invoice-request-failed-event.txt [new file with mode: 0644]

diff --git a/pending_changelog/3192-invoice-request-failed-event.txt b/pending_changelog/3192-invoice-request-failed-event.txt
new file mode 100644 (file)
index 0000000..f1ab8df
--- /dev/null
@@ -0,0 +1,12 @@
+## API Updates
+ * `Event::PaymentFailed` now uses an `Option` for its payment hash, which will
+   be `None` if the invoice hasn't been received yet for a BOLT12 payment
+   (#3192).
+ * `Event::PaymentFailed` is now generated instead `Event::InvoiceRequestFailed`,
+   which has been removed. When deserialized the latter will be converted to the
+   former with `None` for the payment hash (#3192).
+
+## Backwards Compatibility
+ * Any `Event::PaymentFailed` generated without a payment hash will deserialize
+   with `PaymentHash([0; 32])` when downgrading. This can be treated like an
+   `Event::InvoiceRequestFailed` (#3192).