chore: create root workspace and add lints

Author: Riateche

Cargo.lock

@@ -0,0 +1,108 @@
+[workspace]
+resolver = "2"
+
+members = [
+    "apps/argus",
+    "apps/fortuna",
+    "apps/pyth-lazer-agent",
+    "apps/quorum",
+    "lazer/publisher_sdk/rust",
+    "lazer/sdk/rust/client",
+    "lazer/sdk/rust/protocol",
+    "pythnet/pythnet_sdk",
+    "target_chains/starknet/tools/test_vaas",
+]
+
+exclude = [
+    # Depends on pinned Solana version
+    "apps/hermes/server",
+    # Solana contract
+    "governance/remote_executor",
+    "governance/remote_executor/cli",
+    "governance/remote_executor/programs/remote-executor",
+    # Solana contract
+    "lazer/contracts/solana",
+    "lazer/contracts/solana/programs/pyth-lazer-solana-contract",
+    # Solana contract
+    "pythnet/message_buffer",
+    "pythnet/message_buffer/programs/message_buffer",
+    "pythnet/message_buffer/programs/mock-cpi-caller",
+    # Solana contract
+    "pythnet/stake_caps_parameters",
+    "pythnet/stake_caps_parameters/cli",
+    "pythnet/stake_caps_parameters/programs/stake_caps_parameters",
+    # CosmWasm contract
+    "target_chains/cosmwasm",
+    "target_chains/cosmwasm/contracts/pyth",
+    "target_chains/cosmwasm/examples/cw-contract",
+    "target_chains/cosmwasm/sdk/rust",
+    # Stylus contract
+    "target_chains/ethereum/sdk/stylus",
+    "target_chains/ethereum/sdk/stylus/benches",
+    "target_chains/ethereum/sdk/stylus/contracts",
+    "target_chains/ethereum/sdk/stylus/examples/extend-pyth-example",
+    "target_chains/ethereum/sdk/stylus/examples/function-example",
+    "target_chains/ethereum/sdk/stylus/examples/pyth-example",
+    # Fuel contract
+    "target_chains/fuel/contracts",
+    # Near contract
+    "target_chains/near/example",
+    "target_chains/near/receiver",
+    "target_chains/near/wormhole-stub",
+    # Solana contracts
+    "target_chains/solana",
+    "target_chains/solana/cli",
+    "target_chains/solana/common_test_utils",
+    "target_chains/solana/program_simulator",
+    "target_chains/solana/programs/pyth-price-store",
+    "target_chains/solana/programs/pyth-price-store/target/package/pyth-price-publisher-0.1.0",
+    "target_chains/solana/programs/pyth-push-oracle",
+    "target_chains/solana/programs/pyth-solana-receiver",
+    "target_chains/solana/pyth_solana_receiver_sdk",
+    # Stylus contract
+    "target_chains/stylus",
+    "target_chains/stylus/contracts/pyth-receiver",
+    "target_chains/stylus/contracts/wormhole",
+]
+
+[workspace.lints.rust]
+unsafe_code = "deny"
+
+[workspace.lints.clippy]
+# See https://github.com/pyth-network/pyth-crosschain/blob/main/doc/rust-code-guidelines.md
+
+wildcard_dependencies = "deny"
+
+collapsible_if = "allow"
+collapsible_else_if = "allow"
+
+allow_attributes_without_reason = "warn"
+
+# Panics
+expect_used = "warn"
+fallible_impl_from = "warn"
+indexing_slicing = "warn"
+panic = "warn"
+panic_in_result_fn = "warn"
+string_slice = "warn"
+todo = "warn"
+unchecked_duration_subtraction = "warn"
+unreachable = "warn"
+unwrap_in_result = "warn"
+unwrap_used = "warn"
+
+# Correctness
+cast_lossless = "warn"
+cast_possible_truncation = "warn"
+cast_possible_wrap = "warn"
+cast_sign_loss = "warn"
+collection_is_never_read = "warn"
+match_wild_err_arm = "warn"
+path_buf_push_overwrite = "warn"
+read_zero_byte_vec = "warn"
+same_name_method = "warn"
+suspicious_operation_groupings = "warn"
+suspicious_xor_used_as_pow = "warn"
+unused_self = "warn"
+used_underscore_binding = "warn"
+while_float = "warn"

Cargo.toml

@@ -13,7 +13,7 @@ ethers = { version = "2.0.14", features = ["ws"] }
 fortuna = { path = "../fortuna" }
 futures = { version = "0.3.28" }
 hex = "0.4.3"
-prometheus-client = { version = "0.21.2" }
+prometheus-client = { version = "0.23.1" }
 pythnet-sdk = { path = "../../pythnet/pythnet_sdk", features = ["strum"] }
 rand = "0.8.5"
 reqwest = { version = "0.11.22", features = ["json", "blocking"] }
@@ -42,6 +42,8 @@ dashmap = "6.1.0"
 pyth-sdk = "0.8.0"
 humantime-serde = "1.1.1"
 
-
 [dev-dependencies]
 mockall = "0.13.1"
+
+[lints]
+workspace = true

apps/argus/Cargo.toml

@@ -1,3 +1,5 @@
+#![allow(clippy::same_name_method, reason = "generated code")]
+
 use {
     crate::config::EthereumConfig,
     crate::state::ChainName,
@@ -21,10 +23,7 @@ use {
 
 // FIXME: When public scheduler interface is extracted out to an SDK,
 // get the ABI from the SDK package.
-abigen!(
-    PythPulse,
-    "../../target_chains/ethereum/contracts/out/IScheduler.sol/IScheduler.abi.json"
-);
+abigen!(PythPulse, "abi/IScheduler.abi.json");
 
 pub type MiddlewaresWrapper<T> = LegacyTxMiddleware<
     GasOracleMiddleware<

apps/argus/src/adapters/ethereum.rs

@@ -9,9 +9,11 @@ pub async fn metrics(State(state): State<crate::api::ApiState>) -> impl IntoResp
     let registry = state.metrics_registry.read().await;
     let mut buffer = String::new();
 
-    // Should not fail if the metrics are valid and there is memory available
-    // to write to the buffer.
-    encode(&mut buffer, &registry).unwrap();
+    #[allow(
+        clippy::expect_used,
+        reason = "should not fail if the metrics are valid and there is memory available to write to the buffer"
+    )]
+    encode(&mut buffer, &registry).expect("metric encoding failed");
 
     buffer
 }

apps/argus/src/api/metrics.rs

@@ -12,7 +12,7 @@ use {
         },
         state::ArgusState,
     },
-    anyhow::{anyhow, Error, Result},
+    anyhow::{anyhow, Context as _, Result},
     backoff::ExponentialBackoff,
     ethers::signers::Signer,
     fortuna::eth_utils::traced_client::RpcMetrics,
@@ -35,7 +35,7 @@ pub async fn run(opts: &RunOptions) -> Result<()> {
         .keeper
         .private_key
         .load()?
-        .expect("Keeper private key not found in config");
+        .context("Keeper private key not found in config")?;
 
     let chain_labels: Vec<String> = config.chains.keys().cloned().collect();
     let keeper_metrics = Arc::new(KeeperMetrics::new(metrics_registry.clone(), chain_labels).await);
@@ -47,27 +47,30 @@ pub async fn run(opts: &RunOptions) -> Result<()> {
     // Spawn a task to listen for Ctrl+C so we can trigger a graceful shutdown
     spawn(async move {
         tracing::info!("Registered shutdown signal handler");
-        tokio::signal::ctrl_c().await.unwrap();
-        tracing::info!("Shutdown signal received, waiting for tasks to exit");
-        // No need to handle error here, as this can only error if all of the
-        // receivers have been dropped, which is what we want to do
-        exit_tx.send(true)?;
-
-        Ok::<(), Error>(())
+        match tokio::signal::ctrl_c().await {
+            Ok(()) => {
+                tracing::info!("Shutdown signal received, waiting for tasks to exit");
+                // No need to handle error here, as this can only error if all of the
+                // receivers have been dropped, which is what we want to do
+                let _ = exit_tx.send(true);
+            }
+            Err(err) => {
+                tracing::error!(?err, "Couldn't register shutdown signal handler");
+            }
+        }
     });
 
     // Run keeper services for all chains
-    let mut handles = Vec::new();
     for (chain_name, chain_config) in &config.chains {
-        handles.push(spawn(run_keeper_for_chain(
+        spawn(run_keeper_for_chain(
             keeper_private_key.clone(),
             chain_config.clone(),
             chain_name.clone(),
             keeper_metrics.clone(),
             rpc_metrics.clone(),
             exit_rx.clone(),
             config.clone(),
-        )));
+        ));
     }
 
     // Run API server for metrics and health checks
@@ -98,10 +101,11 @@ pub async fn run_keeper_for_chain(
             rpc_metrics.clone(),
         )
         .await
-        .expect(&format!(
-            "Failed to create InstrumentedSignablePythContract from config for chain {}",
-            chain_name
-        )),
+        .with_context(|| {
+            format!(
+                "Failed to create InstrumentedSignablePythContract from config for chain {chain_name}"
+            )
+        })?,
     );
 
     let keeper_address = contract.wallet().address();

apps/argus/src/command/run.rs

@@ -20,7 +20,6 @@ const DEFAULT_RPC_ADDR: &str = "127.0.0.1:7777";
 #[command(author = crate_authors!())]
 #[command(about = crate_description!())]
 #[command(version = crate_version!())]
-#[allow(clippy::large_enum_variant)]
 pub enum Options {
     /// Run the Argus keeper service.
     Run(RunOptions),

apps/argus/src/config.rs

@@ -1,4 +1,3 @@
-#![allow(clippy::just_underscores_and_digits)]
 pub mod adapters;
 pub mod api;
 pub mod command;

apps/argus/src/main.rs

@@ -68,13 +68,9 @@ impl Default for KeeperMetrics {
             gas_price_estimate: Family::default(),
             keeper_wallet_balance: Family::default(),
             price_update_latency_ms: Family::new_with_constructor(|| {
-                Histogram::new(
-                    vec![
-                        100.0, 250.0, 500.0, 1000.0, 2500.0, 5000.0, 10000.0, 20000.0, 30000.0,
-                        60000.0,
-                    ]
-                    .into_iter(),
-                )
+                Histogram::new(vec![
+                    100.0, 250.0, 500.0, 1000.0, 2500.0, 5000.0, 10000.0, 20000.0, 30000.0, 60000.0,
+                ])
             }),
         }
     }

apps/argus/src/metrics.rs

@@ -19,8 +19,10 @@ use crate::state::ChainName;
 use crate::state::ChainPriceState;
 
 pub struct ChainPriceService {
+    #[allow(dead_code, reason = "unknown")]
     chain_name: ChainName,
     name: String,
+    #[allow(dead_code, reason = "unknown")]
     contract: Arc<dyn GetChainPrices + Send + Sync>,
     poll_interval: Duration,
     chain_price_state: Arc<ChainPriceState>,
@@ -35,7 +37,7 @@ impl ChainPriceService {
     ) -> Self {
         Self {
             chain_name: chain_name.clone(),
-            name: format!("ChainPriceService-{}", chain_name),
+            name: format!("ChainPriceService-{chain_name}"),
             contract,
             poll_interval,
             chain_price_state,