X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CHANGELOG.md;h=a23f9d76a957b61fe5be5cb28f23f542b317286e;hb=refs%2Fheads%2F2021-07-check-dust;hp=2931466aed9d5be571b1fab9440a5ab9aa4fce47;hpb=e75d41be7a22e4d9477c52842b8adff8983eeafb;p=rust-lightning diff --git a/CHANGELOG.md b/CHANGELOG.md index 2931466a..a23f9d76 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,158 @@ -# 0.0.99 - WIP +# 0.0.100 - 2021-08-17 + +## API Updates + * The `lightning` crate can now be built in no_std mode, making it easy to + target embedded hardware for rust users. Note that mutexes are replaced with + no-ops for such builds (#1008, #1028). + * LDK now supports sending and receiving "keysend" payments. This includes + modifications to `lightning::util::events::Event::PaymentReceived` to + indicate the type of payment (#967). + * A new variant, `lightning::util::events::Event::PaymentForwarded` has been + added which indicates a forwarded payment has been successfully claimed and + we've received a forwarding fee (#1004). + * `lightning::chain::keysinterface::KeysInterface::get_shutdown_pubkey` has + been renamed to `get_shutdown_scriptpubkey`, returns a script, and is now + called on channel open only if + `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is + set (#1019). + * Closing-signed negotiation is now more configurable, with an explicit + `lightning::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis` + field allowing you to select the maximum amount you are willing to pay to + avoid a force-closure. Further, we are now less restrictive on the fee + placed on the closing transaction when we are not the party paying it. To + control the feerate paid on a channel at close-time, use + `ChannelManager::close_channel_with_target_feerate` instead of + `close_channel` (#1011). + * `lightning_background_processor::BackgroundProcessor` now stops the + background thread when dropped (#1007). It is marked `#[must_use]` so that + Rust users will receive a compile-time warning when it is immediately + dropped after construction (#1029). + * Total potential funds burn on force-close due to dust outputs is now limited + to `lightning::util::config::ChannelConfig::max_dust_htlc_exposure_msat` per + channel (#1009). + * The interval on which + `lightning::ln::peer_handler::PeerManager::timer_tick_occurred` should be + called has been reduced to once every five seconds (#1035) and + `lightning::ln::channelmanager::ChannelManager::timer_tick_occurred` should + now be called on startup in addition to once per minute (#985). + * The rust-bitcoin and bech32 dependencies have been updated to their + respective latest versions (0.27 and 0.8, #1012). + +## Bug Fixes + * Fix panic when reading invoices generated by some versions of c-lightning + (#1002 and #1003). + * Fix panic when attempting to validate a signed message of incorrect length + (#1010). + * Do not ignore the route hints in invoices when the invoice is over 250k + sats (#986). + * Fees are automatically updated on outbound channels to ensure commitment + transactions are always broadcastable (#985). + * Fixes a rare case where a `lightning::util::events::Event::SpendableOutputs` + event is not generated after a counterparty commitment transaction is + confirmed in a reorg when a conflicting local commitment transaction is + removed in the same reorg (#1022). + * Fixes a remotely-triggerable force-closure of an origin channel after an + HTLC was forwarded over a next-hop channel and the next-hop channel was + force-closed by our counterparty (#1025). + * Fixes a rare force-closure case when sending a payment as a channel fundee + when overdrawing our remaining balance. Instead the send will fail (#998). + * Fixes a rare force-closure case when a payment was claimed prior to a + peer disconnection or restart, and later failed (#977). + +## Serialization Compatibility + * Pending inbound keysend payments which have neither been failed nor claimed + when serialized will result in a `ChannelManager` which is not readable on + pre-0.0.100 clients (#967). + * Because + `lightning::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey` + has been updated to return a script instead of only a `PublicKey`, + `ChannelManager`s constructed with custom `KeysInterface` implementations on + 0.0.100 and later versions will not be readable on previous versions. + `ChannelManager`s created with 0.0.99 and prior versions will remain readable + even after the a serialization roundtrip on 0.0.100, as long as no new + channels are opened. Further, users using a + `lightning::chain::keysinterface::KeysManager` as their `KeysInterface` will + have `ChannelManager`s which are readable on prior versions as well (#1019). + * `ChannelMonitorUpdate`s created by 0.0.100 and later for channels when + `lightning::util::config::ChannelConfig::commit_upfront_shutdown_pubkey` is + not set may not be readable by versions prior to 0.0.100 (#1019). + * HTLCs which were in the process of being claimed on-chain when a pre-0.0.100 + `ChannelMonitor` was serialized may generate `PaymentForwarded` events with + spurious `fee_earned_msat` values. This only applies to payments which were + unresolved at the time of the upgrade (#1004). + * 0.0.100 clients with pending `Event::PaymentForwarded` events at + serialization-time will generate serialized `ChannelManager` objects which + 0.0.99 and earlier clients cannot read. The likelihood of this can be reduced + by ensuring you process all pending events immediately before serialization + (as is done by the `lightning-background-processor` crate, #1004). + + +In total, this release features 59 files changed, 5861 insertions, and 2082 +deletions in 95 commits from 6 authors. + + +# 0.0.99 - 2021-07-09 + +## API Updates + + * `lightning_block_sync::poll::Validate` is now public, allowing you to + implement the `lightning_block_sync::poll::Poll` trait without + `lightning_block_sync::poll::ChainPoller` (#956). + * `lightning::ln::peer_handler::PeerManager` no longer requires that no calls + are made to referencing the same `SocketDescriptor` after + `disconnect_socket` returns. This makes the API significantly less + deadlock-prone and simplifies `SocketDescriptor` implementations + significantly. The relevant changes have been made to `lightning_net_tokio` + and `PeerManager` documentation has been substantially rewritten (#957). + * `lightning::util::message_signing`'s `sign` and `verify` methods now take + secret and public keys by reference instead of value (#974). + * Substantially more information is now exposed about channels in + `ChannelDetails`. See documentation for more info (#984 and #988). + * The latest best block seen is now exposed in + `ChannelManager::current_best_block` and + `ChannelMonitor::current_best_block` (#984). + * Feerates charged when forwarding payments over channels is now set in + `ChannelConfig::fee_base_msat` when the channel is opened. For existing + channels, the value is set to the value provided in + `ChannelManagerReadArgs::default_config::channel_options` the first time the + `ChannelManager` is loaded in 0.0.99 (#975). + * We now reject HTLCs which are received to be forwarded over private channels + unless `UserConfig::accept_forwards_to_priv_channels` is set. Note that + `UserConfig` is never serialized and must be provided via + `ChannelManagerReadArgs::default_config` at each start (#975). + +## Bug Fixes + + * We now forward gossip messages to peers instead of only relaying + locally-generated gossip or sending gossip messages during initial sync + (#948). + * Correctly send `channel_update` messages to direct peers on private channels + (#949). Without this, a private node connected to an LDK node over a private + channel cannot receive funds as it does not know which fees the LDK node + will charge. + * `lightning::ln::channelmanager::ChannelManager` no longer expects to be + persisted spuriously after we receive a `channel_update` message about any + channel in the routing gossip (#972). + * Asynchronous `ChannelMonitor` updates (using the + `ChannelMonitorUpdateErr::TemporaryFailure` return variant) no longer cause + spurious HTLC forwarding failures (#954). + * Transaction provided via `ChannelMonitor::transactions_confirmed` + after `ChannelMonitor::best_block_updated` was called for a much later + block now trigger all relevant actions as of the later block. Previously + some transaction broadcasts or other responses required an additional + block be provided via `ChannelMonitor::best_block_updated` (#970). + * We no longer panic in rare cases when an invoice contained last-hop route + hints which were unusable (#958). + +## Node Compatibility + + * We now accept spurious `funding_locked` messages sent prior to + `channel_reestablish` messages after reconnect. This is a + [known, long-standing bug in lnd](https://github.com/lightningnetwork/lnd/issues/4006) + (#966). + * We now set the `first_blocknum` and `number_of_blocks` fields in + `reply_channel_range` messages to values which c-lightning versions prior to + 0.10 accepted. This avoids spurious force-closes from such nodes (#961). ## Serialization Compatibility @@ -6,7 +160,7 @@ version 0.0.98 while an `Event::PaymentSent` is pending processing, the `ChannelManager` will fail to deserialize both on version 0.0.98 and later versions. If you have such a `ChannelManager` available, a simple patch will - allow it to deserialize, please file an issue if you need assistance. + allow it to deserialize. Please file an issue if you need assistance (#973). # 0.0.98 - 2021-06-11