Add blanket Persist/Persister impls for dyn KVStore + Send + Sync
#2883
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, we only had blanket impls for `KVStore`. However, in order to enable the use of `dyn KVStore + Send + Sync` instead of a `KVStore` generic, we here also add the corresponding blanket implementations for said type signature.
WalkthroughThis update introduces enhancements to the persistence layer of a Rust project, likely aimed at improving the robustness and functionality of data storage. New trait implementations have been added for Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
@coderabbitai pause |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Comment on lines
+635
to
+636
| unsafe impl Sync for TestStore {} | ||
| unsafe impl Send for TestStore {} |
There was a problem hiding this comment.
Unsafe implementations of Sync and Send for TestStore lack justification.
Ensure that the TestStore truly satisfies the requirements for safe concurrent access before marking it as Sync and Send. If it's only for testing purposes and you're sure about thread safety, document the reasoning.
Comment on lines
+190
to
+223
| impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref, S: WriteableScore<'a>> Persister<'a, M, T, ES, NS, SP, F, R, L, S> for dyn KVStore + Send + Sync | ||
| where M::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>, | ||
| T::Target: 'static + BroadcasterInterface, | ||
| ES::Target: 'static + EntropySource, | ||
| NS::Target: 'static + NodeSigner, | ||
| SP::Target: 'static + SignerProvider, | ||
| F::Target: 'static + FeeEstimator, | ||
| R::Target: 'static + Router, | ||
| L::Target: 'static + Logger, | ||
| { | ||
| /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed. | ||
| fn persist_manager(&self, channel_manager: &ChannelManager<M, T, ES, NS, SP, F, R, L>) -> Result<(), io::Error> { | ||
| self.write(CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, | ||
| CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, | ||
| CHANNEL_MANAGER_PERSISTENCE_KEY, | ||
| &channel_manager.encode()) | ||
| } | ||
|
|
||
| /// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed. | ||
| fn persist_graph(&self, network_graph: &NetworkGraph<L>) -> Result<(), io::Error> { | ||
| self.write(NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, | ||
| NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, | ||
| NETWORK_GRAPH_PERSISTENCE_KEY, | ||
| &network_graph.encode()) | ||
| } | ||
|
|
||
| /// Persist the given [`WriteableScore`] to disk, returning an error if persistence failed. | ||
| fn persist_scorer(&self, scorer: &S) -> Result<(), io::Error> { | ||
| self.write(SCORER_PERSISTENCE_PRIMARY_NAMESPACE, | ||
| SCORER_PERSISTENCE_SECONDARY_NAMESPACE, | ||
| SCORER_PERSISTENCE_KEY, | ||
| &scorer.encode()) | ||
| } | ||
| } |
There was a problem hiding this comment.
The implementation of Persister for dyn KVStore + Send + Sync duplicates the logic found in the static implementation for A: KVStore. Consider refactoring to avoid code duplication, which can lead to maintenance issues and inconsistencies in the future.
Comment on lines
+256
to
+284
| impl<ChannelSigner: WriteableEcdsaChannelSigner> Persist<ChannelSigner> for dyn KVStore + Send + Sync { | ||
| // TODO: We really need a way for the persister to inform the user that its time to crash/shut | ||
| // down once these start returning failure. | ||
| // Then we should return InProgress rather than UnrecoverableError, implying we should probably | ||
| // just shut down the node since we're not retrying persistence! | ||
|
|
||
| fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus { | ||
| let key = format!("{}_{}", funding_txo.txid.to_string(), funding_txo.index); | ||
| match self.write( | ||
| CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE, | ||
| CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE, | ||
| &key, &monitor.encode()) | ||
| { | ||
| Ok(()) => chain::ChannelMonitorUpdateStatus::Completed, | ||
| Err(_) => chain::ChannelMonitorUpdateStatus::UnrecoverableError | ||
| } | ||
| } | ||
|
|
||
| fn update_persisted_channel(&self, funding_txo: OutPoint, _update: Option<&ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus { | ||
| let key = format!("{}_{}", funding_txo.txid.to_string(), funding_txo.index); | ||
| match self.write( | ||
| CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE, | ||
| CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE, | ||
| &key, &monitor.encode()) | ||
| { | ||
| Ok(()) => chain::ChannelMonitorUpdateStatus::Completed, | ||
| Err(_) => chain::ChannelMonitorUpdateStatus::UnrecoverableError | ||
| } | ||
| } |
There was a problem hiding this comment.
Similar to the previous comment, the implementation for persisting ChannelMonitor and ChannelMonitorUpdate using dyn KVStore + Send + Sync duplicates logic found in the static implementation. Consider leveraging shared functionality or abstracting common logic to reduce duplication and improve maintainability.
tnull
commented
Feb 7, 2024
| @@ -187,6 +187,41 @@ impl<'a, A: KVStore, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Der | |||
| } | |||
| } | |||
|
|
|||
| impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref, S: WriteableScore<'a>> Persister<'a, M, T, ES, NS, SP, F, R, L, S> for dyn KVStore + Send + Sync | |||
There was a problem hiding this comment.
FWIW, if we also changed the KVStore impl to require Send + Sync (i.e. trait KVStore: Send + Sync), we wouldn't only make its use in ~all cases more ergonomic, but it would also allow us to expose it in the LDK Node bindings interface, i.e., allow users to implement custom KVStores in the target language, which would be nice.
There was a problem hiding this comment.
I know we discussed this offline, but is there a way to have some supertrait NodeKV that is implemented for all KVStore, but is required in LDK Node and expose that to bindings? Its kinda annoying but at least it would let LDK Node require Send+Sync everywhere and support bindings.
There was a problem hiding this comment.
Mh, I'll explore that but currently suspect that it might not be worth the effort. Shlepping around Sync + Send is not that annoying, but it would be nice to find a solution to expose custom KVStores in bindings. In any case I'd make this a follow-up and will just land this PR for the time being.
TheBlueMatt
approved these changes
Feb 14, 2024
k0k0ne
pushed a commit
to bitlightlabs/rust-lightning
that referenced
this pull request
Sep 30, 2024
v0.0.123 - May 08, 2024 - "BOLT12 Dust Sweeping" API Updates =========== * To reduce risk of force-closures and improve HTLC reliability the default dust exposure limit has been increased to `MaxDustHTLCExposure::FeeRateMultiplier(10_000)`. Users with existing channels might want to consider using `ChannelManager::update_channel_config` to apply the new default (lightningdevkit#3045). * `ChainMonitor::archive_fully_resolved_channel_monitors` is now provided to remove from memory `ChannelMonitor`s that have been fully resolved on-chain and are now not needed. It uses the new `Persist::archive_persisted_channel` to inform the storage layer that such a monitor should be archived (lightningdevkit#2964). * An `OutputSweeper` is now provided which will automatically sweep `SpendableOutputDescriptor`s, retrying until the sweep confirms (lightningdevkit#2825). * After initiating an outbound channel, a peer disconnection no longer results in immediate channel closure. Rather, if the peer is reconnected before the channel times out LDK will automatically retry opening it (lightningdevkit#2725). * `PaymentPurpose` now has separate variants for BOLT12 payments, which include fields from the `invoice_request` as well as the `OfferId` (lightningdevkit#2970). * `ChannelDetails` now includes a list of in-flight HTLCs (lightningdevkit#2442). * `Event::PaymentForwarded` now includes `skimmed_fee_msat` (lightningdevkit#2858). * The `hashbrown` dependency has been upgraded and the use of `ahash` as the no-std hash table hash function has been removed. As a consequence, LDK's `Hash{Map,Set}`s no longer feature several constructors when LDK is built with no-std; see the `util::hash_tables` module instead. On platforms that `getrandom` supports, setting the `possiblyrandom/getrandom` feature flag will ensure hash tables are resistant to HashDoS attacks, though the `possiblyrandom` crate should detect most common platforms (lightningdevkit#2810, lightningdevkit#2891). * `ChannelMonitor`-originated requests to the `ChannelSigner` can now fail and be retried using `ChannelMonitor::signer_unblocked` (lightningdevkit#2816). * `SpendableOutputDescriptor::to_psbt_input` now includes the `witness_script` where available as well as new proprietary data which can be used to re-derive some spending keys from the base key (lightningdevkit#2761, lightningdevkit#3004). * `OutPoint::to_channel_id` has been removed in favor of `ChannelId::v1_from_funding_outpoint` in preparation for v2 channels with a different `ChannelId` derivation scheme (lightningdevkit#2797). * `PeerManager::get_peer_node_ids` has been replaced with `list_peers` and `peer_by_node_id`, which provide more details (lightningdevkit#2905). * `Bolt11Invoice::get_payee_pub_key` is now provided (lightningdevkit#2909). * `Default[Message]Router` now take an `entropy_source` argument (lightningdevkit#2847). * `ClosureReason::HTLCsTimedOut` has been separated out from `ClosureReason::HolderForceClosed` as it is the most common case (lightningdevkit#2887). * `ClosureReason::CooperativeClosure` is now split into `{Counterparty,Locally}Initiated` variants (lightningdevkit#2863). * `Event::ChannelPending::channel_type` is now provided (lightningdevkit#2872). * `PaymentForwarded::{prev,next}_user_channel_id` are now provided (lightningdevkit#2924). * Channel init messages have been refactored towards V2 channels (lightningdevkit#2871). * `BumpTransactionEvent` now contains the channel and counterparty (lightningdevkit#2873). * `util::scid_utils` is now public, with some trivial utilities to examine short channel ids (lightningdevkit#2694). * `DirectedChannelInfo::{source,target}` are now public (lightningdevkit#2870). * Bounds in `lightning-background-processor` were simplified by using `AChannelManager` (lightningdevkit#2963). * The `Persist` impl for `KVStore` no longer requires `Sized`, allowing for the use of `dyn KVStore` as `Persist` (lightningdevkit#2883, lightningdevkit#2976). * `From<PaymentPreimage>` is now implemented for `PaymentHash` (lightningdevkit#2918). * `NodeId::from_slice` is now provided (lightningdevkit#2942). * `ChannelManager` deserialization may now fail with `DangerousValue` when LDK's persistence API was violated (lightningdevkit#2974). Bug Fixes ========= * Excess fees on counterparty commitment transactions are now included in the dust exposure calculation. This lines behavior up with some cases where transaction fees can be burnt, making them effectively dust exposure (lightningdevkit#3045). * `Future`s used as an `std::...::Future` could grow in size unbounded if it was never woken. For those not using async persistence and using the async `lightning-background-processor`, this could cause a memory leak in the `ChainMonitor` (lightningdevkit#2894). * Inbound channel requests that fail in `ChannelManager::accept_inbound_channel` would previously have stalled from the peer's perspective as no `error` message was sent (lightningdevkit#2953). * Blinded path construction has been tuned to select paths more likely to succeed, improving BOLT12 payment reliability (lightningdevkit#2911, lightningdevkit#2912). * After a reorg, `lightning-transaction-sync` could have failed to follow a transaction that LDK needed information about (lightningdevkit#2946). * `RecipientOnionFields`' `custom_tlvs` are now propagated to recipients when paying with blinded paths (lightningdevkit#2975). * `Event::ChannelClosed` is now properly generated and peers are properly notified for all channels that as a part of a batch channel open fail to be funded (lightningdevkit#3029). * In cases where user event processing is substantially delayed such that we complete multiple round-trips with our peers before a `PaymentSent` event is handled and then restart without persisting the `ChannelManager` after having persisted a `ChannelMonitor[Update]`, on startup we may have `Err`d trying to deserialize the `ChannelManager` (lightningdevkit#3021). * If a peer has relatively high latency, `PeerManager` may have failed to establish a connection (lightningdevkit#2993). * `ChannelUpdate` messages broadcasted for our own channel closures are now slightly more robust (lightningdevkit#2731). * Deserializing malformed BOLT11 invoices may have resulted in an integer overflow panic in debug builds (lightningdevkit#3032). * In exceedingly rare cases (no cases of this are known), LDK may have created an invalid serialization for a `ChannelManager` (lightningdevkit#2998). * Message processing latency handling BOLT12 payments has been reduced (lightningdevkit#2881). * Latency in processing `Event::SpendableOutputs` may be reduced (lightningdevkit#3033). Node Compatibility ================== * LDK's blinded paths were inconsistent with other implementations in several ways, which have been addressed (lightningdevkit#2856, lightningdevkit#2936, lightningdevkit#2945). * LDK's messaging blinded paths now support the latest features which some nodes may begin relying on soon (lightningdevkit#2961). * LDK's BOLT12 structs have been updated to support some last-minute changes to the spec (lightningdevkit#3017, lightningdevkit#3018). * CLN v24.02 requires the `gossip_queries` feature for all peers, however LDK by default does not set it for those not using a `P2PGossipSync` (e.g. those using RGS). This change was reverted in CLN v24.02.2 however for now LDK always sets the `gossip_queries` feature. This change is expected to be reverted in a future LDK release (lightningdevkit#2959). Security ======== 0.0.123 fixes a denial-of-service vulnerability which we believe to be reachable from untrusted input when parsing invalid BOLT11 invoices containing non-ASCII characters. * BOLT11 invoices with non-ASCII characters in the human-readable-part may cause an out-of-bounds read attempt leading to a panic (lightningdevkit#3054). Note that all BOLT11 invoices containing non-ASCII characters are invalid. In total, this release features 150 files changed, 19307 insertions, 6306 deletions in 360 commits since 0.0.121 from 17 authors, in alphabetical order: * Arik Sosman * Duncan Dean * Elias Rohrer * Evan Feenstra * Jeffrey Czyz * Keyue Bao * Matt Corallo * Orbital * Sergi Delgado Segura * Valentine Wallace * Willem Van Lint * Wilmer Paulino * benthecarman * jbesraa * olegkubrakov * optout * shaavan
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, LDK Node's main object has a generic trait bound on
KVStore, i.e.,Node<K: KVStore + Send + Sync + 'static>. However, this has always been a painful issue as our bindings generator UniFFI doesn't have generic support, so we were required to type-def and expose only a concrete type, i.e.,Node<SqliteStore>, in bindings. This will now become even more painful and borderline infeasible with the introduction of theVssStorealternative.To fix this, we now want to drop the generic trait bound and rather have
Nodetake adyn KVStore + Send + Sync, for which however the necessary blanket implementations ofPersistandPersisterare not implemented currently. Here we add these impls this to LDK, so that we can switch to use dynamic dispatch in LDK Node.