chore: Format and lint existing source - add lint step to CI (#23)

* Enforce fmt, clippy, cargo test
* CI uses 1.85.0, squash deadcode and expect err warnings

Author: gzalz

.github/workflows/build.yml

@@ -10,6 +10,25 @@ on:
       - master
 
 jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          components: rustfmt, clippy
+          toolchain: "1.85.0"
+      - name: Install cargo-sort from crates.io
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: cargo-sort
+      - run: sudo apt-get install protobuf-compiler -y
+      - run: cargo sort --workspace --check
+      - run: cargo fmt --all --check
+      - run: cargo clippy --all-features --all-targets --tests -- -D warnings
   verified_build:
     name: verified_build
     runs-on: ubuntu-latest
@@ -19,7 +38,7 @@ jobs:
           submodules: recursive
       - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          toolchain: "1.75.0"
+          toolchain: "1.85.0"
       - name: Install solana-verify from crates.io
         uses: baptiste0928/cargo-install@v3
         with:
@@ -35,4 +54,3 @@ jobs:
         with:
           name: program.so
           path: target/deploy/*.so
-

api/src/error.rs

@@ -9,6 +9,7 @@ use solana_sdk::pubkey::Pubkey;
 use thiserror::Error;
 use tracing::error;
 
+#[allow(clippy::large_enum_variant)]
 #[derive(Error, Debug)]
 pub enum ApiError {
     #[error("Rpc Error")]
@@ -41,7 +42,10 @@ impl IntoResponse for ApiError {
             }
             ApiError::ParseStakeDepositAuthorityError(e) => {
                 error!("Parse StakePoolDepositStakeAuthority error: {e}");
-                (StatusCode::INTERNAL_SERVER_ERROR, "Pubkey StakePoolDepositStakeAuthority error")
+                (
+                    StatusCode::INTERNAL_SERVER_ERROR,
+                    "Pubkey StakePoolDepositStakeAuthority error",
+                )
             }
             ApiError::ParseStakePoolError(e) => {
                 error!("Parse StakePool error: {e}");
@@ -53,9 +57,15 @@ impl IntoResponse for ApiError {
             }
             ApiError::ParseValidatorListError(e) => {
                 error!("Parse ValidatorList error: {e}");
-                (StatusCode::INTERNAL_SERVER_ERROR, "Pubkey ValidatorList error")
+                (
+                    StatusCode::INTERNAL_SERVER_ERROR,
+                    "Pubkey ValidatorList error",
+                )
             }
-            ApiError::InvalidStakeVoteAccount => (StatusCode::BAD_REQUEST, "Stake voter_pubkey is invalid or missing"),
+            ApiError::InvalidStakeVoteAccount => (
+                StatusCode::BAD_REQUEST,
+                "Stake voter_pubkey is invalid or missing",
+            ),
             ApiError::InternalError => (StatusCode::INTERNAL_SERVER_ERROR, "Internal Server Error"),
         };
         (

api/src/router/get_deposit_stake_instructions.rs

@@ -18,7 +18,10 @@ use stake_deposit_interceptor::{
     instruction::create_deposit_stake_instruction, state::StakePoolDepositStakeAuthority,
 };
 
-use crate::{error::ApiError, utils::{pubkey_from_str, Instruction}};
+use crate::{
+    error::ApiError,
+    utils::{pubkey_from_str, Instruction},
+};
 
 use super::RouterState;
 
@@ -50,7 +53,7 @@ struct GetDepositStakeResponse {
 }
 
 /// Constructs the instructions necessary to `DepositStake` via the stake-pool-interceptor program.
-/// 
+///
 pub(crate) async fn get_deposit_stake_instructions(
     State(state): State<Arc<RouterState>>,
     Query(query): Query<GetDepositStakeQuery>,

api/src/utils.rs

@@ -39,13 +39,17 @@ impl Serialize for Instruction {
 
         state.serialize_field("programId", &self.program_id.to_string())?;
 
-        let accounts_as_objects: Vec<_> = self.accounts.iter().map(|a| {
-            serde_json::json!({
-                "pubkey": a.pubkey.to_string(),
-                "isSigner": a.is_signer,
-                "isWritable": a.is_writable
+        let accounts_as_objects: Vec<_> = self
+            .accounts
+            .iter()
+            .map(|a| {
+                serde_json::json!({
+                    "pubkey": a.pubkey.to_string(),
+                    "isSigner": a.is_signer,
+                    "isWritable": a.is_writable
+                })
             })
-        }).collect();
+            .collect();
         state.serialize_field("accounts", &accounts_as_objects)?;
 
         state.serialize_field(
@@ -55,4 +59,4 @@ impl Serialize for Instruction {
 
         state.end()
     }
-}
+}

stake_deposit_interceptor/build.rs

@@ -1,13 +1,13 @@
 fn main() {
-  println!("cargo:rerun-if-env-changed=GIT_SHA");
-  println!(
-      "cargo:rustc-env=GIT_SHA={}",
-      option_env!("GIT_SHA").unwrap_or("GIT_SHA_MISSING")
-  );
+    println!("cargo:rerun-if-env-changed=GIT_SHA");
+    println!(
+        "cargo:rustc-env=GIT_SHA={}",
+        option_env!("GIT_SHA").unwrap_or("GIT_SHA_MISSING")
+    );
 
-  println!("cargo:rerun-if-env-changed=GIT_REF_NAME");
-  println!(
-      "cargo:rustc-env=GIT_REF_NAME={}",
-      option_env!("GIT_REF_NAME").unwrap_or("GIT_REF_NAME_MISSING")
-  );
+    println!("cargo:rerun-if-env-changed=GIT_REF_NAME");
+    println!(
+        "cargo:rustc-env=GIT_REF_NAME={}",
+        option_env!("GIT_REF_NAME").unwrap_or("GIT_REF_NAME_MISSING")
+    );
 }