Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Replace `BTreeSet` in `IndexedMap` with sorted `Vec` by alecchendev · Pull Request #2040 · lightningdevkit/rust-lightning · GitHub
Skip to content

Replace BTreeSet in IndexedMap with sorted Vec - #2040

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec
Feb 21, 2023
Merged

Replace BTreeSet in IndexedMap with sorted Vec#2040
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
alecchendev:2023-02-indexed-map-btreeset-to-vec

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#1992.

Summarizing my findings:

I compared two ways of swapping BTreeSet for Vec:

  1. Only sorting on calls to IndexedMap::range
  2. Keeping it strictly sorted on inserts and removes

Both ways seemed to decrease memory usage of reading in a network graph from ~2.5MB to ~1.8MB, as well as very slightly improving the speed of read_network_graph. 2 had a significant regression for bench_reading_full_graph_from_file, so this PR is implementation 1: sorting on range.

@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Two things to note about this current implementation:

  • There are ~200 tests that have asserts comparing a network graph to an expected graph, so I reimplemented PartialEq on IndexedMap to not check for order now that IndexedMap::keys is no longer strictly sorted.
  • range now takes a &mut self which is kinda weird because logically it should be an immutable method. I hear people say cases like this might be a place to use interior mutability, but I didn't know if that would be overkill/mess up other things.

@codecov-commenter

codecov-commenter commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 87.22% // Head: 87.41% // Increases project coverage by +0.19% 🎉

Coverage data is based on head (62a88f9) compared to base (2f36c92).
Patch coverage: 88.08% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2040 +/- ##
==========================================
+ Coverage 87.22% 87.41% +0.19% 
==========================================
Files 100 101 +1 Lines 44051 45633 +1582 Branches 44051 45633 +1582 ==========================================
+ Hits 38424 39891 +1467 - Misses 5627 5742 +115 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs88.43% <0.00%> (-0.07%)⬇️
lightning/src/sync/fairrwlock.rs75.00% <0.00%> (ø)
lightning/src/sync/mod.rs50.00% <50.00%> (ø)
lightning/src/util/indexed_map.rs78.94% <72.22%> (+1.67%)⬆️
lightning/src/ln/outbound_payment.rs83.69% <77.77%> (+3.41%)⬆️
lightning/src/ln/payment_tests.rs95.86% <91.59%> (-0.08%)⬇️
lightning/src/sync/debug_sync.rs80.00% <92.85%> (-0.35%)⬇️
lightning/src/ln/channelmanager.rs87.66% <100.00%> (+1.81%)⬆️
lightning/src/routing/gossip.rs84.04% <100.00%> (+0.01%)⬆️
lightning/src/sync/nostd_sync.rs37.50% <100.00%> (+2.20%)⬆️
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this is great!

Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from eecff3d to 67cea68CompareFebruary 19, 2023 02:43

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, sorry for the runaround on removing range.

Comment threadfuzz/src/indexedmap.rs Outdated
Comment threadlightning/src/util/indexed_map.rs
The `Vec` is sorted not on `IndexedMap::insert`, but on
`IndexedMap::range` to avoid unnecessary work while reading a network
graph.
@alecchendev
alecchendevforce-pushed the 2023-02-indexed-map-btreeset-to-vec branch from 67cea68 to 62a88f9CompareFebruary 20, 2023 04:25
@TheBlueMatt
TheBlueMatt merged commit 068c856 into lightningdevkit:mainFeb 21, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.114 - Mar 3, 2023 - "Faster Async BOLT12 Retries"
API Updates
===========
* `InvoicePayer` has been removed and its features moved directly into
`ChannelManager`. As such it now requires a simplified `Router` and supports
`send_payment_with_retry` (and friends). `ChannelManager::retry_payment` was
removed in favor of the automated retries. Invoice payment utilities in
`lightning-invoice` now call the new code (lightningdevkit#1812, lightningdevkit#1916, lightningdevkit#1929, lightningdevkit#2007, etc).
* `Sign`/`BaseSign` has been renamed `ChannelSigner`, with `EcdsaChannelSigner`
split out in anticipation of future schnorr/taproot support (lightningdevkit#1967).
* The catch-all `KeysInterface` was split into `EntropySource`, `NodeSigner`,
and `SignerProvider`. `KeysManager` implements all three (lightningdevkit#1910, lightningdevkit#1930).
* `KeysInterface::get_node_secret` is now `KeysManager::get_node_secret_key`
and is no longer required for external signers (lightningdevkit#1951, lightningdevkit#2070).
* A `lightning-transaction-sync` crate has been added which implements keeping
LDK in sync with the chain via an esplora server (lightningdevkit#1870). Note that it can
only be used on nodes that *never* ran a previous version of LDK.
* `Score` is updated in `BackgroundProcessor` instead of via `Router` (lightningdevkit#1996).
* `ChainAccess::get_utxo` (now `UtxoAccess`) can now be resolved async (lightningdevkit#1980).
* BOLT12 `Offer`, `InvoiceRequest`, `Invoice` and `Refund` structs as well as
associated builders have been added. Such invoices cannot yet be paid due to
missing support for blinded path payments (lightningdevkit#1927, lightningdevkit#1908, lightningdevkit#1926).
* A `lightning-custom-message` crate has been added to make combining multiple
custom messages into one enum/handler easier (lightningdevkit#1832).
* `Event::PaymentPathFailure` is now generated for failure to send an HTLC
over the first hop on our local channel (lightningdevkit#2014, lightningdevkit#2043).
* `lightning-net-tokio` no longer requires an `Arc` on `PeerManager` (lightningdevkit#1968).
* `ChannelManager::list_recent_payments` was added (lightningdevkit#1873).
* `lightning-background-processor` `std` is now optional in async mode (lightningdevkit#1962).
* `create_phantom_invoice` can now be used in `no-std` (lightningdevkit#1985).
* The required final CLTV delta on inbound payments is now configurable (lightningdevkit#1878)
* bitcoind RPC error code and message are now surfaced in `block-sync` (lightningdevkit#2057).
* Get `historical_estimated_channel_liquidity_probabilities` was added (lightningdevkit#1961).
* `ChannelManager::fail_htlc_backwards_with_reason` was added (lightningdevkit#1948).
* Macros which implement serialization using TLVs or straight writing of struct
fields are now public (lightningdevkit#1823, lightningdevkit#1976, lightningdevkit#1977).
Backwards Compatibility
=======================
* Any inbound payments with a custom final CLTV delta will be rejected by LDK
if you downgrade prior to receipt (lightningdevkit#1878).
* `Event::PaymentPathFailed::network_update` will always be `None` if an
0.0.114-generated event is read by a prior version of LDK (lightningdevkit#2043).
* `Event::PaymentPathFailed::all_paths_removed` will always be false if an
0.0.114-generated event is read by a prior version of LDK. Users who rely on
it to determine payment retries should migrate to `Event::PaymentFailed`, in
a separate release prior to upgrading to LDK 0.0.114 if downgrading is
supported (lightningdevkit#2043).
Performance Improvements
========================
* Channel data is now stored per-peer and channel updates across multiple
peers can be operated on simultaneously (lightningdevkit#1507).
* Routefinding is roughly 1.5x faster (lightningdevkit#1799).
* Deserializing a `NetworkGraph` is roughly 6x faster (lightningdevkit#2016).
* Memory usage for a `NetworkGraph` has been reduced substantially (lightningdevkit#2040).
* `KeysInterface::get_secure_random_bytes` is roughly 200x faster (lightningdevkit#1974).
Bug Fixes
=========
* Fixed a bug where a delay in processing a `PaymentSent` event longer than the
time taken to persist a `ChannelMonitor` update, when occurring immediately
prior to a crash, may result in the `PaymentSent` event being lost (lightningdevkit#2048).
* Fixed spurious rejections of rapid gossip sync data when the graph has been
updated by other means between gossip syncs (lightningdevkit#2046).
* Fixed a panic in `KeysManager` when the high bit of `starting_time_nanos`
is set (lightningdevkit#1935).
* Resolved an issue where the `ChannelManager::get_persistable_update_future`
future would fail to wake until a second notification occurs (lightningdevkit#2064).
* Resolved a memory leak when using `ChannelManager::send_probe` (lightningdevkit#2037).
* Fixed a deadlock on some platforms at least when using async `ChannelMonitor`
updating (lightningdevkit#2006).
* Removed debug-only assertions which were reachable in threaded code (lightningdevkit#1964).
* In some cases when payment sending fails on our local channel retries no
longer take the same path and thus never succeed (lightningdevkit#2014).
* Retries for spontaneous payments have been fixed (lightningdevkit#2002).
* Return an `Err` if `lightning-persister` fails to read the directory listing
rather than panicing (lightningdevkit#1943).
* `peer_disconnected` will now never be called without `peer_connected` (lightningdevkit#2035)
Security
========
0.0.114 fixes several denial-of-service vulnerabilities which are reachable from
untrusted input from channel counterparties or in deployments accepting inbound
connections or channels. It also fixes a denial-of-service vulnerability in rare
cases in the route finding logic.
* The number of pending un-funded channels as well as peers without funded
channels is now limited to avoid denial of service (lightningdevkit#1988).
* A second `channel_ready` message received immediately after the first could
lead to a spurious panic (lightningdevkit#2071). This issue was introduced with 0conf
support in LDK 0.0.107.
* A division-by-zero issue was fixed in the `ProbabilisticScorer` if the amount
being sent (including previous-hop fees) is equal to a channel's capacity
while walking the graph (lightningdevkit#2072). The division-by-zero was introduced with
historical data tracking in LDK 0.0.112.
In total, this release features 130 files changed, 21457 insertions, 10113
deletions in 343 commits from 18 authors, in alphabetical order:
* Alec Chen
* Allan Douglas R. de Oliveira
* Andrei
* Arik Sosman
* Daniel Granhão
* Duncan Dean
* Elias Rohrer
* Jeffrey Czyz
* John Cantrell
* Kurtsley
* Matt Corallo
* Max Fang
* Omer Yacine
* Valentine Wallace
* Viktor Tigerström
* Wilmer Paulino
* benthecarman
* jurvis
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore replacing BTreeSet in IndexedMap with a sorted Vec

4 participants

@alecchendev@codecov-commenter@TheBlueMatt@dunxen