rust-lightning/pending_changelog/matt-abandon-restart.txt
Matt Corallo 1969b48b7a Note that abandon_payment does not persist the state update in docs
If a user calls `abandon_payment`, then restarts without freshly
persisting the `ChannelManager`, the payment will still be pending
on restart. This was unclear from the docs (and the docs seemed to
imply otherwise). Because this doesn't materially impact the
usability of `abandon_payment` (users shouldn't be called
`retry_payment` on an abandoned one anyway), we simply document it.

Fixes #1804.
2022-12-12 19:59:19 +00:00

4 lines
237 B
Text

## API Updates
- `ChannelManager::abandon_payment` docs have been updated to note that the
payment may return to pending after a restart if no persistence occurs. This
is not a change in behavior - ensure your existing code is safe.