Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump MSRV to 1.48 and replace most of CI with a bash script #2107

Merged
merged 6 commits into from
Mar 17, 2023

Conversation

TheBlueMatt
Copy link
Collaborator

No description provided.

1.48.0 was released at the end of 2020, nearly 2.5 years ago. It
has been the rustc available on Debian stable since bullseye,
released in 2021. supporting Debian oldstable for more than a year
seems more than sufficient time to give Debian folks to upgrade,
and bullseye is set to become `oldstable` later this year with the
release of `bookworm`, likely this summer.

This also allows us to clean up our MSRV substantially, having a
single MSRV across our crates rather than a number of separate
ones. Sadly, windows already requires 1.49.
@codecov-commenter
Copy link

codecov-commenter commented Mar 15, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.49 🎉

Comparison is base (2d213a4) 91.15% compared to head (6558b51) 91.65%.

📣 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    #2107      +/-   ##
==========================================
+ Coverage   91.15%   91.65%   +0.49%     
==========================================
  Files         101      101              
  Lines       48866    50766    +1900     
  Branches    48866    50766    +1900     
==========================================
+ Hits        44544    46529    +1985     
+ Misses       4322     4237      -85     
Impacted Files Coverage Δ
lightning/src/onion_message/functional_tests.rs 94.92% <100.00%> (-0.04%) ⬇️

... and 36 files with indirect coverage changes

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 in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt TheBlueMatt force-pushed the 2023-04-msrv-cleanup branch from 4a16151 to 0eec9b4 Compare March 15, 2023 22:09
Copy link
Contributor

@tnull tnull left a comment

Choose a reason for hiding this comment

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

Nice! Will see if we can eventually get testing MSRV of lightning-transaction-sync also down to 1.48.

I ran shellcheck on the bash script and it yielded some errors and warnings. The following diff fixes them for me:

diff --git a/ci/ci-tests.sh b/ci/ci-tests.sh
index 03750dd6..3b686e38 100755
--- a/ci/ci-tests.sh
+++ b/ci/ci-tests.sh
@@ -5,7 +5,7 @@ RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
 HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"

 # Tokio MSRV on versions newer than 1.14 is rustc 1.49
-[ $RUSTC_MINOR_VERSION -lt 49 ] && cargo update -p tokio --precise "1.14.0" --verbose
+[ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.0" --verbose
 [ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"

 export RUST_BACKTRACE=1
@@ -16,12 +16,14 @@ cargo test --verbose --color always

 echo -e "\n\nBuilding with all Log-Limiting features"
 pushd lightning
-for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
-       cargo build --verbose --color always --features $FEATURE
+
+grep '^max_level_' < Cargo.toml | awk '{ print $1 }' | while IFS= read -r FEATURE
+do
+       cargo build --verbose --color always --features "$FEATURE"
 done
 popd

-if [ $RUSTC_MINOR_VERSION -gt 51 ]; then # Current `object` MSRV, subject to change
+if [ "$RUSTC_MINOR_VERSION" -gt 51 ]; then # Current `object` MSRV, subject to change
        echo -e "\n\nTest backtrace-debug builds"
        pushd lightning
        cargo test --verbose --color always --features backtrace
@@ -66,7 +68,7 @@ cargo build --verbose --color always --features rpc-client,rest-client,tokio
 cargo test --verbose --color always --features rpc-client,rest-client,tokio
 popd

-if [ $RUSTC_MINOR_VERSION -gt 67 -a [[ "$HOST_PLATFORM" != *windows* ]] ]; then
+if [[ ( "$RUSTC_MINOR_VERSION" -gt 67 ) && ( "$HOST_PLATFORM" != *windows* ) ]]; then
        echo -e "\n\nBuilding and testing Transaction Sync Clients with features"
        pushd lightning-transaction-sync
        cargo build --verbose --color always --features esplora-blocking
@@ -83,7 +85,7 @@ pushd lightning-background-processor
 cargo test --verbose --color always --no-default-features --features futures
 popd

-if [ $RUSTC_MINOR_VERSION -gt 55 ]; then
+if [ "$RUSTC_MINOR_VERSION" -gt 55 ]; then
        echo -e "\n\nTest Custom Message Macros"
        pushd lightning-custom-message
        cargo test --verbose --color always

@TheBlueMatt TheBlueMatt force-pushed the 2023-04-msrv-cleanup branch from 0eec9b4 to e2ad436 Compare March 16, 2023 16:59
@TheBlueMatt
Copy link
Collaborator Author

Fixed the shellcheck warnings, it gets a bit excited with useless warnings, but better than not, so added that to CI as well.

Copy link
Contributor

@tnull tnull left a comment

Choose a reason for hiding this comment

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

CI is unhappy due to sudo not being available on Windows and no apt on macos. LGTM otherwise though.

@TheBlueMatt
Copy link
Collaborator Author

Oops, lol, duh.

@TheBlueMatt TheBlueMatt force-pushed the 2023-04-msrv-cleanup branch from e2ad436 to 6558b51 Compare March 16, 2023 19:15
@wpaulino
Copy link
Contributor

Somehow CI is still showing some previous build checks as pending...

@TheBlueMatt
Copy link
Collaborator Author

Yea, the "pending" jobs were just old jobs we were requiring, I've removed them.

@TheBlueMatt TheBlueMatt merged commit 217c3e0 into lightningdevkit:main Mar 17, 2023
k0k0ne pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"

API Updates
===========

 * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
 * Attempting to claim an un-expired payment on a channel which has closed no
   longer fails. The expiry time of payments is exposed via
   `PaymentClaimable::claim_deadline` (lightningdevkit#2148).
 * `payment_metadata` is now supported in `Invoice` deserialization, sending,
   and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
 * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
 * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
 * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
 * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
 * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
 * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
 * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
 * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
 * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
 * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
 * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).

Backwards Compatibility
=======================

 * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
   longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
 * `Event::PaymentPathFailed::retry` was removed and will always be `None` for
    payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
 * `Route`s and `PaymentParameters` with blinded path information will not be
   readable on prior versions of LDK. Such objects are not currently constructed
   by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
 * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
   `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
   in general unsupported, and included here only for completeness.

Bug Fixes
=========

 * Fixed a case where `process_events_async` may `poll` a `Future` which has
   already completed (lightningdevkit#2081).
 * Fixed deserialization of `u16` arrays. This bug may have previously corrupted
   the historical buckets in a `ProbabilisticScorer`. Users relying on the
   historical buckets may wish to wipe their scorer on upgrade to remove corrupt
   data rather than waiting on it to decay (lightningdevkit#2191).
 * The `process_events_async` task is now `Send` and can thus be polled on a
   multi-threaded runtime (lightningdevkit#2199).
 * Fixed a missing macro export causing
   `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
 * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
 * Fix an issue where the `background-processor` would not wake when a
   `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
 * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
 * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
   than `find_route`, as was intended and described in the API (lightningdevkit#2092).
 * Ensure `process_events_async` always exits if any sleep future returns true,
   not just if all sleep futures repeatedly return true (lightningdevkit#2145).
 * `channel_update` messages no longer set the disable bit unless the peer has
   been disconnected for some time. This should resolve cases where channels are
   disabled for extended periods of time (lightningdevkit#2198).
 * We no longer remove CLN nodes from the network graph for violating the BOLT
   spec in some cases after failing to pay through them (lightningdevkit#2220).
 * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
 * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
 * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).

Security
========

 * Transaction re-broadcasting is now substantially more aggressive, including a
   new regular rebroadcast feature called on a timer from the
   `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
   This should substantially increase transaction confirmation reliability
   without relying on downstream `TransactionBroadcaster` implementations for
   rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
 * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
   privacy vulnerability which allows an intermediate node on the path to
   discover the final destination for a payment (lightningdevkit#2062).

In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
 * Advait
 * Alan Cohen
 * Alec Chen
 * Allan Douglas R. de Oliveira
 * Arik Sosman
 * Elias Rohrer
 * Evan Feenstra
 * Jeffrey Czyz
 * John Cantrell
 * Lucas Soriano del Pino
 * Marc Tyndel
 * Matt Corallo
 * Paul Miller
 * Steven
 * Steven Williamson
 * Steven Zhao
 * Tony Giorgio
 * Valentine Wallace
 * Wilmer Paulino
 * benthecarman
 * munjesi
Sign up for free to 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.

5 participants