Upgrade rust edition to 2024

[brooksprumo]

Rust 2024 (full guide) is out, but the monorepo still uses Rust 2021.

I ran cargo fix --edition and there's quite a lot of changes that need to be inspected/reviewed. I don't think we can/should upgrade the edition until then.

To get a sense of the changes, here's logs of running cargo fix --edition on stable and then nightly.

• stable
• nightly

I'm creating this issue so we can track progress, and also to have a place with the logs to point at.

Maybe we incrementally upgrade crates one at a time, done by their owners, instead of trying to do the whole monorepo at once?

[vadorovsky]

I tried upgrading solana-perf to edition 2024 and the first obstacle was that Rng::gen conflicts with the new Rust keyword gen, so cargo fix slapped a lot of changes like

diff --git a/perf/benches/dedup.rs b/perf/benches/dedup.rs
index 4fbdbd4dfd..ee61c6c123 100644
--- a/perf/benches/dedup.rs
+++ b/perf/benches/dedup.rs
@@ -18,7 +18,7 @@ const NUM: usize = 4096;
 fn test_packet_with_size(size: usize, rng: &mut ThreadRng) -> Vec<u8> {
     // subtract 8 bytes because the length will get serialized as well
     (0..size.checked_sub(8).unwrap())
-        .map(|_| rng.gen())
+        .map(|_| rng.r#gen())
         .collect()
 }

I figured that it was fixed upstream by renaming Rng::gen to Rng::random rust-random/rand#1438, but after trying to upgrade it, the curve-dalek crates are not happy:

error[E0277]: the trait bound `rand::rngs::OsRng: CryptoRngCore` is not satisfied
   --> zk-sdk/src/sigma_proofs/zero_ciphertext.rs:80:36
    |
80  |         let mut y = Scalar::random(&mut OsRng);
    |                     -------------- ^^^^^^^^^^ the trait `aes_gcm_siv::aead::rand_core::RngCore` is not implemented for `rand::rngs::OsRng`
    |                     |
    |                     required by a bound introduced by this call
    |
note: there are multiple different versions of crate `rand_core` in the dependency graph
   --> /root/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rand_core-0.6.4/src/lib.rs:142:1
    |
142 | pub trait RngCore {
    | ^^^^^^^^^^^^^^^^^ this is the required trait
    |
   ::: zk-sdk/src/encryption/auth_encryption.rs:12:5
    |
12  |     aes_gcm_siv::{
    |     ----------- one version of crate `rand_core` used here, as a dependency of crate `crypto_common`
...
17  |     rand::{rngs::OsRng, Rng},
    |     ---- one version of crate `rand_core` used here, as a dependency of crate `rand`

There is a huge chance that's not the only crate suffering from this problem. I think we need to check whether all the crates we depend on, and depend on rand as well, did an upgrade. If not, we need to propose it.

[puhtaytow]

I have looked at crate bloom and its affected by the gen conflict, which seem to not be present in rand v0.9

Not sure whats the best solution here, but i have something like this.. wdyt?

https://github.com/anza-xyz/agave/compare/master...puhtaytow:agave:feat/bloom-to-2024-1?expand=1

[steviez]

@puhtaytow - I see you have created a handful of PR's to work on this. Thank you for jumping in and I think the approach of doing it crate by crate that Brooks recommended and that you've been doing makes sense.

One thing that I think would be beneficial for potential reviewers would be including the cargo logs that point out the issues you addressed. Ie, within a given crate directory, run cargo fix --edition > edition_upgrade.log and post that with your PR

[steviez]

I also see that #6776 shipped, but didn't adjust the edition for the actual crate. Thus, it is possible that subsequent changes would come in and reintroduce changes that are ok with 2021 edition but not 2024.

I'm wondering if it makes sense to adjust the edition on each crate to ensure no 2024-incompatible changes sneak in. Ie, change this:

agave/gossip/Cargo.toml

Line 10 in 2361c7d

edition = { workspace = true }

This would ideally be a temporary change, and we'd hopefully get all the crates in the workspace done, bump the worksapce version to 2024 (below) and then revert all the individual crates to again inherit workspace edition.

agave/Cargo.toml

Line 158 in 2361c7d

edition = "2021"

What do you think @brooksprumo ?

[puhtaytow]

@puhtaytow - I see you have created a handful of PR's to work on this. Thank you for jumping in and I think the approach of doing it crate by crate that Brooks recommended and that you've been doing makes sense.

One thing that I think would be beneficial for potential reviewers would be including the cargo logs that point out the issues you addressed. Ie, within a given crate directory, run cargo fix --edition > edition_upgrade.log and post that with your PR

Absolutely. Thank you for the suggestion 🙏