Update CHANGELOG for 0.0.107

Author: jkczyz

CHANGELOG.md

@@ -1,3 +1,121 @@
+# 0.0.107 - 2022-XX-XX
+
+## API Updates
+ * The `lightning-block-sync` crate's `BlockSource` trait methods now take
+   `&self` instead of `&mut self` (#1307).
+ * `inbound_payment` module is now public to allow for creating phantom invoices
+   without a `ChannelManager` (#1384).
+ * `lightning-block-sync`'s `init` and `poll` modules support `&dyn BlockSource`
+   which can be determined at runtime (#1423).
+ * `lightning-invoice` crate's `utils` now accept an expiration time (#1422,
+   #1474).
+ * `find_route` now assumes variable-length onions by default (#1414).
+ * `Event::PaymentForwarded` includes `prev_channel_id` and `next_channel_id`
+   (#1419, #1475).
+ * `chain::Watch::release_pending_monitor_events`' return type now associates
+   `MonitorEvent`s with funding `OutPoints` (#1475).
+ * `lightning-background-processor` crate's `Persister` trait has been moved to
+   `lightning` crate's `util::persist` module, which now has a general
+   `KVStorePersister` trait. Blanket implementations of `Persister` and
+   `chainmonitor::Persist` are given for types implementing `KVStorePersister`.
+   ` lightning-persister`'s `FilesystemPersister` implements `KVStorePersister`
+   (#1417).
+ * `ChannelDetails` and `ChannelCounterparty` include fields for HTLC minimum
+   and maximum values (#1378, #1444).
+ * Added a `filtered_block_connected` method to `chain::Listen` and a default
+   implementation of `block_connected` in order to support BIP 157/158 compact
+   block filters (#1453).
+ * `ProabilisticScorer` is parameterized by a `Logger`, which it uses to log
+   channel liquidity updates or lack thereof (#1405).
+ * `ChannelDetails` has a `outbound_htlc_limit_msat` field, which should be used
+   in routing instead of `outbound_capacity_msat` (#1435).
+ * Wumbo channels are now supported and can be enabled for inbound channels
+   using `ChannelHandshakeLimits::max_funding_satoshis` (#1425).
+ * `ProabilisticScorer`'s channel liquidities can be logged via
+   `debug_log_liquidity_stats` (#1460).
+ * `BackgroundProcessor` now takes an optional `WriteableScore` which it will
+   persist using the `Persister` trait's new `persist_scorer` method (#1416).
+ * A `warn` message is now sent when receiving a `channel_reestablish` with an
+   old commitment transaction number (#1430).
+ * Upgraded to `bitcoin` crate version 0.28.1 (#1389).
+ * `ShutdownScript::new_witness_program` now takes a `WitnessVersion` instead of
+   a `NonZeroU8` (#1389).
+ * When a `channel_update` message is included in an onion error's `failuremsg`,
+   its message type is now encoded (#1465).
+ * `Event::ChannelClosed::reason` will only be `ClosureReason::DisconnectedPeer`
+   when a peer is disconnected prior to completing funding. Thus, channels will
+   no longer be automatically force closed when the counterparty is
+   disconnected (#1429).
+ * `Event::FundingGenerationReady` now has a `counterparty_node_id` field, which
+   is used to pass to `ChannelManager` methods for funding, accepting, and
+   closing the channel (#1479, #1485).
+ * `InvoicePayer::new` now takes a `Retry` enum (replacing the `RetryAttempts`
+   struct), which supports both attempt- and timeout-based retrying (#1418).
+ * `Score::channel_penalty_msat` takes a `ChannelUsage` struct, which contains
+   the capacity as an `EffectiveCapacity` enum and any potential in-flight HTLC
+   value, rather than a single `u64`. Used by `ProbabilisticScorer` for more
+   accurate penalties (#1456).
+ * `lightning-rapid-gossip-sync` is a new crate for syncing gossip data from a
+   server, primarily aimed at mobile devices (#1155).
+ * `build_route_from_hops` is a new function useful for constructing a route to
+   probe (#1491).
+ * Support for feature `option_zeroconf`, allowing immediate forwarding of
+   payments. This is configured for outbound channels using
+   `ChannelHandshakeLimits::trust_own_funding_0conf` whereas
+   `ChannelManager::accept_inbound_channel_from_trusted_peer_0conf` is used for
+   accepting inbound channels (#1401, #1505).
+ * `ChannelManager::claim_funds` no longer returns a `bool` to indicate success.
+   Instead, an `Event::PaymentClaimed` is generated if the claim was successful.
+   Likewise, `ChannelManager::fail_htlc_backwards` no longer has a return value
+   (#1434).
+ * `FundingLocked` message has been renamed `ChannelReady`, and related
+   identifiers have been renamed accordingly (#1506).
+ * `core2::io` or `std::io` (depending on feature flags `no-std` or `std`) is
+   exported as a `lightning::io` module (#1504).
+ * The deprecated `Scorer` has been removed in favor or `ProbabilisitcScorer`
+   (#1512).
+ * `RapidGossipSync` can be passed to `BackgroundProcessor` in order to persist
+   the `NetworkGraph` and handle `NetworkUpdate`s during event handling (#1433,
+   #1517).
+ * `NetGraphMsgHandler` has been renamed to `P2PGossipSync`, the `network_graph`
+    module has been renamed to `gossip`, and `NetworkUpdate::ChannelClosed` has
+   been renamed `NetworkUpdate::ChannelFailure` (#1159).
+
+## Performance Improvements
+ * `lightning-persister` crates uses `BufWriter` for improved performance
+   (#1404).
+ * Log gossip query messages at `GOSSIP` instead of `TRACE` to avoid
+   overwhelming default logging (#1421).
+ * `PeerManager` supports processing messages from different peers in parallel
+   (#1023).
+ * `PeerManager` uses a single `Secp256k1` across all peers (#1472).
+
+## Bug Fixes
+ * `ProabilisticScorer` uses more precision when approximating `log10` (#1406).
+ * `BackgroundProcessor` process pending events before processing network
+   messages to reduce lock contention in `ChannelManager`, which can be
+   problematic for extremely slow machines (#1436).
+ * Fixed an integer underflow during channel opening occurring when the channel
+   reserves are greater than the full channel value (#1454, #1463).
+ * `gossip_timestamp_filter` filters are now honored when sending gossip to
+   peers (#1452).
+ * During a reorg, only force-close a channel if its funding transaction is
+   unconfirmed (#1461).
+ * Fixed a panic in `lightning-net-tokio` when fetching a peer's socket address
+   after the connection has been closed (#1449).
+ * `find_route` will no longer return routes that would cause Onion construction
+   to fail (#1476).
+ * Fixed a bug where crashing while persisting a `ChannelMonitorUpdate` for a
+   part of a multi-path payment would cause refusal to claim the funds on
+   restart (#1434).
+
+## Serialization Compatibility
+* `ChannelManager` serialization is no longer compatible with versions prior to
+  0.0.99 (#1401).
+
+TODO: Fill in stats
+
+
 # 0.0.106 - 2022-04-03
 
 ## API Updates