fix: further comment nits (#773)

Author: chrismaree

.github/workflows/pr.yml

@@ -28,11 +28,11 @@ jobs:
       - name: Install Cargo toolchain
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+          toolchain: nightly
           profile: minimal
           components: rustc
       - name: Install packages
-        run: yarn install --frozen-lockfile
+        run: yarn install --frozen-lockfile && rustup component add --toolchain nightly-x86_64-unknown-linux-gnu rustfmt
       - name: Lint js
         shell: bash
         run: yarn lint-js

.rustfmt.toml

@@ -1,2 +1,5 @@
 edition = "2021"
 max_width = 120
+fn_call_width = 120
+struct_lit_width = 120
+normalize_comments = false

package.json

@@ -22,8 +22,8 @@
     "lint": "yarn lint-solidity && yarn lint-js && yarn lint-rust",
     "lint-solidity": "yarn solhint ./contracts/**/*.sol",
     "lint-js": "yarn prettier --list-different **/*.js **/*.ts",
-    "lint-rust": "cargo fmt --all -- --check && cargo clippy",
-    "lint-fix": "yarn prettier --write **/*.js **/*.ts ./programs/**/*.rs ./contracts**/*.sol && cargo fmt --all",
+    "lint-rust": "cargo +nightly fmt --all -- --check && cargo clippy",
+    "lint-fix": "yarn prettier --write **/*.js **/*.ts ./programs/**/*.rs ./contracts**/*.sol && cargo +nightly fmt  --all && cargo clippy",
     "clean-fast": "for dir in node_modules cache cache-zk artifacts artifacts-zk dist typechain; do mv \"${dir}\" \"_${dir}\"; rm -rf \"_${dir}\" &; done",
     "clean": "rm -rf node_modules cache cache-zk artifacts artifacts-zk dist typechain",
     "build-evm": "hardhat compile",

programs/multicall-handler/src/lib.rs

@@ -46,11 +46,7 @@ pub mod multicall_handler {
                 account_infos.push(account_info.to_owned());
             }
 
-            let cpi_instruction = Instruction {
-                program_id: target_program.key(),
-                accounts,
-                data: compiled_ix.data,
-            };
+            let cpi_instruction = Instruction { program_id: target_program.key(), accounts, data: compiled_ix.data };
 
             match use_handler_signer {
                 true => invoke_signed(&cpi_instruction, &account_infos, &[&[b"handler_signer", &[bump]]])?,

programs/svm-spoke/src/error.rs

@@ -78,7 +78,7 @@ pub enum SvmError {
     InvalidATACreationAccounts,
 }
 
-// Errors to handle the CCTP interactions.
+// CCTP specific errors.
 #[error_code]
 pub enum CallDataError {
     #[msg("Invalid solidity selector")]
@@ -99,7 +99,7 @@ pub enum CallDataError {
     UnsupportedSelector,
 }
 
-// Errors to handle Across+ message calls.
+// Across+ specific errors.
 #[error_code]
 pub enum AcrossPlusError {
     #[msg("Message did not deserialize")]

programs/svm-spoke/src/event.rs

@@ -30,6 +30,11 @@ pub struct RelayedRootBundle {
     pub slow_relay_root: [u8; 32],
 }
 
+#[event]
+pub struct EmergencyDeletedRootBundle {
+    pub root_bundle_id: u32,
+}
+
 // Deposit events
 #[event]
 pub struct V3FundsDeposited {
@@ -101,7 +106,7 @@ pub struct RequestedV3SlowFill {
     pub message_hash: [u8; 32],
 }
 
-// Relayer refund events
+// Bundle refund events
 #[event]
 pub struct ExecutedRelayerRefundRoot {
     pub amount_to_return: u64,
@@ -122,11 +127,6 @@ pub struct ClaimedRelayerRefund {
     pub refund_address: Pubkey,
 }
 
-#[event]
-pub struct EmergencyDeletedRootBundle {
-    pub root_bundle_id: u32,
-}
-
 #[event]
 pub struct BridgedToHubPool {
     pub amount: u64,

programs/svm-spoke/src/instructions/admin.rs

@@ -110,6 +110,7 @@ pub struct TransferOwnership<'info> {
 pub fn transfer_ownership(ctx: Context<TransferOwnership>, new_owner: Pubkey) -> Result<()> {
     let state = &mut ctx.accounts.state;
     state.owner = new_owner;
+
     Ok(())
 }
 
@@ -127,9 +128,7 @@ pub fn set_cross_domain_admin(ctx: Context<SetCrossDomainAdmin>, cross_domain_ad
     let state = &mut ctx.accounts.state;
     state.cross_domain_admin = cross_domain_admin;
 
-    emit_cpi!(SetXDomainAdmin {
-        new_admin: cross_domain_admin,
-    });
+    emit_cpi!(SetXDomainAdmin { new_admin: cross_domain_admin });
 
     Ok(())
 }
@@ -190,11 +189,7 @@ pub fn set_enable_route(
 ) -> Result<()> {
     ctx.accounts.route.enabled = enabled;
 
-    emit_cpi!(EnabledDepositRoute {
-        origin_token,
-        destination_chain_id,
-        enabled,
-    });
+    emit_cpi!(EnabledDepositRoute { origin_token, destination_chain_id, enabled });
 
     Ok(())
 }
@@ -233,13 +228,10 @@ pub fn relay_root_bundle(
     root_bundle.relayer_refund_root = relayer_refund_root;
     root_bundle.slow_relay_root = slow_relay_root;
 
-    emit_cpi!(RelayedRootBundle {
-        root_bundle_id: state.root_bundle_id,
-        relayer_refund_root,
-        slow_relay_root,
-    });
+    emit_cpi!(RelayedRootBundle { root_bundle_id: state.root_bundle_id, relayer_refund_root, slow_relay_root });
 
     state.root_bundle_id += 1;
+
     Ok(())
 }
 

programs/svm-spoke/src/instructions/bundle.rs

@@ -95,6 +95,7 @@ impl RelayerRefundLeaf {
 
     pub fn to_keccak_hash(&self) -> Result<[u8; 32]> {
         let input = self.to_bytes()?;
+
         Ok(keccak::hash(&input).to_bytes())
     }
 }
@@ -126,10 +127,7 @@ where
         return err!(CommonError::ClaimedMerkleLeaf);
     }
 
-    set_claimed(
-        &mut ctx.accounts.root_bundle.claimed_bitmap,
-        relayer_refund_leaf.leaf_id,
-    );
+    set_claimed(&mut ctx.accounts.root_bundle.claimed_bitmap, relayer_refund_leaf.leaf_id);
 
     if relayer_refund_leaf.refund_addresses.len() != relayer_refund_leaf.refund_amounts.len() {
         return err!(CommonError::InvalidMerkleLeaf);
@@ -202,11 +200,8 @@ fn distribute_relayer_refunds<'info>(
             to: refund_token_account.to_account_info(),
             authority: ctx.accounts.state.to_account_info(),
         };
-        let cpi_context = CpiContext::new_with_signer(
-            ctx.accounts.token_program.to_account_info(),
-            transfer_accounts,
-            signer_seeds,
-        );
+        let cpi_context =
+            CpiContext::new_with_signer(ctx.accounts.token_program.to_account_info(), transfer_accounts, signer_seeds);
         transfer_checked(cpi_context, amount.to_owned(), ctx.accounts.mint.decimals)?;
     }
 

programs/svm-spoke/src/instructions/fill.rs

@@ -116,12 +116,8 @@ pub fn fill_v3_relay<'info>(
     fill_status_account.status = FillStatus::Filled;
     fill_status_account.relayer = *ctx.accounts.signer.key;
 
-    if relay_data.message.len() > 0 {
-        invoke_handler(
-            ctx.accounts.signer.as_ref(),
-            ctx.remaining_accounts,
-            &relay_data.message,
-        )?;
+    if !relay_data.message.is_empty() {
+        invoke_handler(ctx.accounts.signer.as_ref(), ctx.remaining_accounts, &relay_data.message)?;
     }
 
     // Empty message is not hashed and emits zeroed bytes32 for easier human observability.

programs/svm-spoke/src/instructions/handle_receive_message.rs

@@ -111,11 +111,7 @@ fn invoke_self<'info>(ctx: &Context<'_, '_, '_, 'info, HandleReceiveMessage<'inf
         }
     }
 
-    let instruction = Instruction {
-        program_id: crate::ID,
-        accounts,
-        data: data.to_owned(),
-    };
+    let instruction = Instruction { program_id: crate::ID, accounts, data: data.to_owned() };
 
     program::invoke_signed(
         &instruction,