style: enable fmt linting for grouped imports by std external and cra…

…tes (#1603)
ethereum · Dec 8, 2024 · 38b41c2 · 38b41c2
1 parent 5763698
commit 38b41c2
Show file tree

Hide file tree

Showing 168 changed files with 837 additions and 738 deletions.
diff --git a/book/src/developers/contributing/rust/imports.md b/book/src/developers/contributing/rust/imports.md
@@ -1,7 +1,22 @@
 # Imports
 
-- In `*.rs` files, imports should be split into 3 groups [src](https://github.com/rust-dev-tools/fmt-rfcs/issues/131) and separated by a single line. Within a single group, imported items should be sorted alphabetically.
-	- Imports from `'std'`
-	- Imports from external crates
-	- Imports from crates within trin
+- In `*.rs` files, imports should be split into 3 groups [src](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#StdExternalCrate) and separated by a single line. Within a single group, imported items should be sorted alphabetically.
+  1. std, core and alloc,
+  2. external crates,
+  3. self, super and crate imports.
 - Alphabetize imports in `Cargo.toml`
+
+```rust,ignore
+use alloc::alloc::Layout;
+use core::f32;
+use std::sync::Arc;
+
+use broker::database::PooledConnection;
+use chrono::Utc;
+use juniper::{FieldError, FieldResult};
+use uuid::Uuid;
+
+use super::schema::{Context, Payload};
+use super::update::convert_publish_payload;
+use crate::models::Event;
+```
diff --git a/e2store/src/e2store/memory.rs b/e2store/src/e2store/memory.rs
@@ -66,9 +66,10 @@ impl E2StoreMemory {
 
 #[cfg(test)]
 mod test {
-    use super::*;
     use ethportal_api::utils::bytes::{hex_decode, hex_encode};
 
+    use super::*;
+
     // test cases sourced from: https://github.com/ethereum/go-ethereum/pull/26621/
 
     #[test]

diff --git a/e2store/src/e2store/stream.rs b/e2store/src/e2store/stream.rs
@@ -65,9 +65,8 @@ mod tests {
     use rand::Rng;
     use trin_utils::dir::create_temp_test_dir;
 
-    use crate::e2store::types::VersionEntry;
-
     use super::*;
+    use crate::e2store::types::VersionEntry;
 
     #[test]
     fn test_e2store_stream_write_and_read() -> anyhow::Result<()> {

diff --git a/e2store/src/era.rs b/e2store/src/era.rs
@@ -1,15 +1,17 @@
-use crate::e2store::{
-    memory::E2StoreMemory,
-    types::{Entry, Header, VersionEntry},
+use std::{
+    fs,
+    io::{Read, Write},
 };
+
 use anyhow::{anyhow, ensure};
 use ethportal_api::consensus::{
     beacon_block::SignedBeaconBlock, beacon_state::BeaconState, fork::ForkName,
 };
 use ssz::Encode;
-use std::{
-    fs,
-    io::{Read, Write},
+
+use crate::e2store::{
+    memory::E2StoreMemory,
+    types::{Entry, Header, VersionEntry},
 };
 
 pub const SLOTS_PER_HISTORICAL_ROOT: usize = 8192;

diff --git a/e2store/src/era1.rs b/e2store/src/era1.rs
@@ -1,19 +1,21 @@
-use crate::{
-    e2store::{
-        memory::E2StoreMemory,
-        types::{Entry, VersionEntry},
-    },
-    types::HeaderEntry,
+use std::{
+    fs,
+    io::{Read, Write},
 };
+
 use alloy::{
     primitives::{B256, U256},
     rlp::Decodable,
 };
 use anyhow::ensure;
 use ethportal_api::types::execution::{block_body::BlockBody, receipts::Receipts};
-use std::{
-    fs,
-    io::{Read, Write},
+
+use crate::{
+    e2store::{
+        memory::E2StoreMemory,
+        types::{Entry, VersionEntry},
+    },
+    types::HeaderEntry,
 };
 
 // <config-name>-<era-number>-<era-count>-<short-historical-root>.era

diff --git a/e2store/src/era2.rs b/e2store/src/era2.rs
@@ -319,9 +319,8 @@ mod tests {
     use alloy::primitives::{Address, Bloom, B64};
     use trin_utils::dir::create_temp_test_dir;
 
-    use crate::e2store::types::VersionEntry;
-
     use super::*;
+    use crate::e2store::types::VersionEntry;
 
     #[test]
     fn test_era2_stream_write_and_read() -> anyhow::Result<()> {

diff --git a/ethportal-api/src/beacon.rs b/ethportal-api/src/beacon.rs
@@ -1,3 +1,7 @@
+use alloy::primitives::B256;
+use discv5::enr::NodeId;
+use jsonrpsee::{core::RpcResult, proc_macros::rpc};
+
 use crate::{
     consensus::header::BeaconBlockHeader,
     light_client::store::LightClientStore,
@@ -12,9 +16,6 @@ use crate::{
     },
     RawContentValue, RoutingTableInfo,
 };
-use alloy::primitives::B256;
-use discv5::enr::NodeId;
-use jsonrpsee::{core::RpcResult, proc_macros::rpc};
 
 /// Portal Beacon JSON-RPC endpoints
 #[rpc(client, server, namespace = "portal")]

diff --git a/ethportal-api/src/dashboard/grafana.rs b/ethportal-api/src/dashboard/grafana.rs
@@ -1,7 +1,8 @@
+use std::fs;
+
 use base64;
 use nanotemplate::template;
 use serde::Deserialize;
-use std::fs;
 use ureq;
 
 pub const DASHBOARD_TEMPLATES: &[&str] =

diff --git a/ethportal-api/src/discv5.rs b/ethportal-api/src/discv5.rs
@@ -1,9 +1,10 @@
+use discv5::enr::NodeId;
+use jsonrpsee::{core::RpcResult, proc_macros::rpc};
+
 use crate::types::{
     discv5::{NodeInfo, RoutingTableInfo},
     enr::Enr,
 };
-use discv5::enr::NodeId;
-use jsonrpsee::{core::RpcResult, proc_macros::rpc};
 
 /// Discv5 JSON-RPC endpoints
 #[rpc(client, server, namespace = "discv5")]

diff --git a/ethportal-api/src/history.rs b/ethportal-api/src/history.rs
@@ -1,3 +1,6 @@
+use discv5::enr::NodeId;
+use jsonrpsee::{core::RpcResult, proc_macros::rpc};
+
 use crate::{
     types::{
         content_key::history::HistoryContentKey,
@@ -10,8 +13,6 @@ use crate::{
     },
     RawContentValue, RoutingTableInfo,
 };
-use discv5::enr::NodeId;
-use jsonrpsee::{core::RpcResult, proc_macros::rpc};
 
 /// Portal History JSON-RPC endpoints
 #[rpc(client, server, namespace = "portal")]

diff --git a/ethportal-api/src/lib.rs b/ethportal-api/src/lib.rs
@@ -24,9 +24,9 @@ pub use beacon::{BeaconNetworkApiClient, BeaconNetworkApiServer};
 pub use discv5::{Discv5ApiClient, Discv5ApiServer};
 pub use eth::{EthApiClient, EthApiServer};
 pub use history::{HistoryNetworkApiClient, HistoryNetworkApiServer};
+// Re-exports jsonrpsee crate
+pub use jsonrpsee;
 pub use state::{StateNetworkApiClient, StateNetworkApiServer};
-pub use web3::{Web3ApiClient, Web3ApiServer};
-
 pub use types::{
     consensus,
     consensus::light_client,
@@ -47,8 +47,6 @@ pub use types::{
     node_id::*,
     portal::{RawContentKey, RawContentValue},
 };
-
-// Re-exports jsonrpsee crate
-pub use jsonrpsee;
+pub use web3::{Web3ApiClient, Web3ApiServer};
 
 shadow_rs::shadow!(build_info);
diff --git a/ethportal-api/src/state.rs b/ethportal-api/src/state.rs
@@ -1,3 +1,6 @@
+use discv5::enr::NodeId;
+use jsonrpsee::{core::RpcResult, proc_macros::rpc};
+
 use crate::{
     types::{
         content_key::state::StateContentKey,
@@ -10,8 +13,6 @@ use crate::{
     },
     RawContentValue, RoutingTableInfo,
 };
-use discv5::enr::NodeId;
-use jsonrpsee::{core::RpcResult, proc_macros::rpc};
 
 /// Portal State JSON-RPC endpoints
 #[rpc(client, server, namespace = "portal")]

diff --git a/ethportal-api/src/types/bootnodes.rs b/ethportal-api/src/types/bootnodes.rs
@@ -143,9 +143,10 @@ impl FromStr for Bootnodes {
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod test {
+    use rstest::rstest;
+
     use super::*;
     use crate::types::cli::TrinConfig;
-    use rstest::rstest;
 
     #[test_log::test]
     fn test_bootnodes_default_with_default_bootnodes() {

diff --git a/ethportal-api/src/types/cli.rs b/ethportal-api/src/types/cli.rs
@@ -1,11 +1,12 @@
+use std::{env, ffi::OsString, fmt, net::SocketAddr, path::PathBuf, str::FromStr, sync::Arc};
+
 use alloy::primitives::B256;
 use clap::{
     arg,
     builder::ArgPredicate,
     error::{Error, ErrorKind},
     Args, Parser, Subcommand,
 };
-use std::{env, ffi::OsString, fmt, net::SocketAddr, path::PathBuf, str::FromStr, sync::Arc};
 use url::Url;
 
 use crate::{
@@ -24,9 +25,8 @@ pub const DEFAULT_NETWORK: &str = "mainnet";
 pub const DEFAULT_STORAGE_CAPACITY_MB: &str = "1000";
 pub const DEFAULT_WEB3_TRANSPORT: &str = "ipc";
 
-use crate::dashboard::grafana::{GrafanaAPI, DASHBOARD_TEMPLATES};
-
 use super::portal_wire::{NetworkSpec, ANGELFOOD, MAINNET};
+use crate::dashboard::grafana::{GrafanaAPI, DASHBOARD_TEMPLATES};
 
 #[derive(Debug, PartialEq, Clone)]
 pub enum Web3TransportType {
@@ -555,6 +555,7 @@ pub fn create_dashboard(
 #[cfg(test)]
 mod tests {
     use std::net::{IpAddr, Ipv4Addr};
+
     use test_log::test;
 
     use super::*;

diff --git a/ethportal-api/src/types/consensus/beacon_block.rs b/ethportal-api/src/types/consensus/beacon_block.rs
@@ -1,8 +1,3 @@
-use crate::consensus::{
-    body::{BeaconBlockBodyBellatrix, BeaconBlockBodyCapella, BeaconBlockBodyDeneb},
-    fork::ForkName,
-    signature::BlsSignature,
-};
 use alloy::primitives::B256;
 use jsonrpsee::core::Serialize;
 use rs_merkle::{algorithms::Sha256, MerkleTree};
@@ -14,6 +9,12 @@ use superstruct::superstruct;
 use tree_hash::TreeHash;
 use tree_hash_derive::TreeHash;
 
+use crate::consensus::{
+    body::{BeaconBlockBodyBellatrix, BeaconBlockBodyCapella, BeaconBlockBodyDeneb},
+    fork::ForkName,
+    signature::BlsSignature,
+};
+
 /// A block of the `BeaconChain`.
 #[superstruct(
     variants(Bellatrix, Capella, Deneb),
@@ -190,12 +191,14 @@ impl SignedBeaconBlock {
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod test {
-    use super::*;
-    use crate::consensus::fork::ForkName;
+    use std::str::FromStr;
+
     use ::ssz::Encode;
     use rstest::rstest;
     use serde_json::Value;
-    use std::str::FromStr;
+
+    use super::*;
+    use crate::consensus::fork::ForkName;
 
     #[rstest]
     #[case("case_0")]

diff --git a/ethportal-api/src/types/consensus/beacon_state.rs b/ethportal-api/src/types/consensus/beacon_state.rs
@@ -1,15 +1,5 @@
-use crate::consensus::{
-    body::{Checkpoint, Eth1Data},
-    execution_payload::{
-        ExecutionPayloadHeaderBellatrix, ExecutionPayloadHeaderCapella, ExecutionPayloadHeaderDeneb,
-    },
-    fork::ForkName,
-    header::BeaconBlockHeader,
-    historical_summaries::HistoricalSummaries,
-    participation_flags::ParticipationFlags,
-    pubkey::PubKey,
-    sync_committee::SyncCommittee,
-};
+use std::sync::Arc;
+
 use alloy::primitives::B256;
 use discv5::enr::k256::elliptic_curve::consts::{U1099511627776, U2048, U4, U65536, U8192};
 use jsonrpsee::core::Serialize;
@@ -20,11 +10,23 @@ use serde_utils;
 use ssz::{Decode, DecodeError, Encode};
 use ssz_derive::{Decode, Encode};
 use ssz_types::{typenum::U16777216, BitVector, FixedVector, VariableList};
-use std::sync::Arc;
 use superstruct::superstruct;
 use tree_hash::{Hash256, TreeHash};
 use tree_hash_derive::TreeHash;
 
+use crate::consensus::{
+    body::{Checkpoint, Eth1Data},
+    execution_payload::{
+        ExecutionPayloadHeaderBellatrix, ExecutionPayloadHeaderCapella, ExecutionPayloadHeaderDeneb,
+    },
+    fork::ForkName,
+    header::BeaconBlockHeader,
+    historical_summaries::HistoricalSummaries,
+    participation_flags::ParticipationFlags,
+    pubkey::PubKey,
+    sync_committee::SyncCommittee,
+};
+
 type SlotsPerHistoricalRoot = U8192; // uint64(2**13) (= 8,192)
 type HistoricalRootsLimit = U16777216; // uint64(2**24) (= 16,777,216)
 type ValidatorRegistryLimit = U1099511627776;
@@ -342,11 +344,13 @@ impl HistoricalBatch {
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod test {
-    use super::*;
+    use std::str::FromStr;
+
     use ::ssz::Encode;
     use rstest::rstest;
     use serde_json::Value;
-    use std::str::FromStr;
+
+    use super::*;
 
     #[rstest]
     #[case("case_0")]