Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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" + '
Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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('^' + ".*" + ' Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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('^' + ".*" + ' Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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" + ' Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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('^' + ".*" + ' Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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('^' + ".*" + ' Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@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); } })(); })(); Remove std::SystemTime from create_phantom_invoice, ref #1978 by Kurtsley · Pull Request #1985 · lightningdevkit/rust-lightning · GitHub
Skip to content

Remove std::SystemTime from create_phantom_invoice, ref #1978 - #1985

Merged
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice
Jan 30, 2023
Merged

Remove std::SystemTime from create_phantom_invoice, ref #1978#1985
TheBlueMatt merged 1 commit into
lightningdevkit:mainfrom
Kurtsley:chore-no-std-phantom-invoice

Conversation

@Kurtsley

Copy link
Copy Markdown
Contributor

Also added the "can be used in no_std environment" to the comments above the functions.

@jkczyz

Copy link
Copy Markdown
Contributor

@TheBlueMatt Do we still want a version that uses SystemTime?

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

I don't have a super strong opinion. I'm pretty annoyed at how many util methods there are in this file, so I kinda like the idea of not adding new ones (and I expect phantom invoice users can figure out how to get the current time), but of course its also nice to not have to supply something that we can figure out for the user...absent a strong opinion I'm happy to move forward as-is.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

The #[cfg(feature = "std")] bound on the use...PhantomRouteHints needs to be removed.

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Please squash the fixup into the first commit as described at https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits While you're at it, it would be nice to have an explanation of why you're removing the SystemTime from create_phantom_invoice - something about nostd.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e071d35 to e633b2eCompareJanuary 26, 2023 03:45
@codecov-commenter

codecov-commenter commented Jan 26, 2023

Copy link
Copy Markdown

Codecov Report

Base: 90.91% // Head: 90.91% // No change to project coverage 👍

Coverage data is based on head (d4de913) compared to base (d4de913).
Patch has no changes to coverable lines.

❗ Current head d4de913 differs from pull request most recent head afa0480. Consider uploading reports for the commit afa0480 to get more accurate results

📣 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 #1985 +/- ##
=======================================
Coverage 90.91% 90.91% =======================================
Files 99 99 Lines 52505 52505 Branches 52505 52505 =======================================
Hits 47735 47735 Misses 4770 4770 

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 linked an issue Jan 26, 2023 that may be closed by this pull request
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

You need to replace the .current_timestamp call in _create_phantom_invoice as its not available in no-std.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I'm thinking of just adding another function called timestamp_no_std or something and basically copying the current timestamp function over minus SystemTime. I'm obviously having trouble testing this in a no_std environment. My apologies.

@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from e633b2e to 3e905f4CompareJanuary 27, 2023 01:43
Comment threadlightning-invoice/src/lib.rs Outdated
…it#1978
Replace current_timestamp call with no-std duration_from_epoch
@Kurtsley
Kurtsleyforce-pushed the chore-no-std-phantom-invoice branch from 3e905f4 to afa0480CompareJanuary 27, 2023 06:04
Comment on lines +44 to +46
///
/// ['std::time::SystemTime'] has been removed to allow this function to be used in a 'no_std' environment,
/// where [`std::time::SystemTime`] is not available and the current time is supplied by the caller.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can this (and the one below) not just be part of the release notes?

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.

Yea, good point, we shouldn't phrase docs in terms of "changes made", they should describe what the function does now.

@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.

LGTM aside from @dunxen's comment about docs referring to changes. Happy to land as-is if you prefer and we can clean up the docs later, just let me know what you prefer @Kurtsley.

@Kurtsley

Copy link
Copy Markdown
ContributorAuthor

I say merge this and I can open a seperate PR to deal with the docs. Should be able to deal with that tonight.

@TheBlueMatt
TheBlueMatt merged commit 437cc69 into lightningdevkit:mainJan 30, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no-std version of create_phantom_invoice

5 participants

@Kurtsley@jkczyz@TheBlueMatt@codecov-commenter@dunxen