Enable spellcheck in CI/CD (#100)

Enable spellcheck

Author: grod220

Cargo.toml

@@ -28,3 +28,6 @@ build = "1.86.0"
 format = "nightly-2025-02-16"
 lint = "nightly-2025-02-16"
 test = "nightly-2025-02-16"
+
+[workspace.metadata.spellcheck]
+config = "scripts/spellcheck.toml"

Makefile

@@ -27,7 +27,7 @@ audit:
 		--ignore RUSTSEC-2024-0344 $(ARGS)
 
 spellcheck:
-	@echo "TODO: Implement cargo spellcheck and make fixes"
+	cargo spellcheck --code 1 $(ARGS)
 
 clippy-%:
 	cargo $(nightly) clippy --manifest-path $(call make-path,$*)/Cargo.toml \

interface/src/config.rs

@@ -24,7 +24,7 @@ declare_deprecated_id!("StakeConfig11111111111111111111111111111111");
 pub struct Config {
     /// how much stake we can activate/deactivate per-epoch as a fraction of currently effective stake
     pub warmup_cooldown_rate: f64,
-    /// percentage of stake lost when slash, expressed as a portion of u8::MAX
+    /// percentage of stake lost when slash, expressed as a portion of `u8::MAX`
     pub slash_penalty: u8,
 }
 

interface/src/instruction.rs

@@ -52,7 +52,7 @@ pub enum StakeInstruction {
     ///   0. `[WRITE]` Stake account to be updated
     ///   1. `[]` Clock sysvar
     ///   2. `[SIGNER]` The stake or withdraw authority
-    ///   3. Optional: `[SIGNER]` Lockup authority, if updating StakeAuthorize::Withdrawer before
+    ///   3. Optional: `[SIGNER]` Lockup authority, if updating `StakeAuthorize::Withdrawer` before
     ///      lockup expiration
     Authorize(Pubkey, StakeAuthorize),
 
@@ -205,7 +205,7 @@ pub enum StakeInstruction {
     /// # Account references
     ///   None
     ///
-    /// Returns the minimum delegation as a little-endian encoded u64 value.
+    /// Returns the minimum delegation as a little-endian encoded `u64` value.
     /// Programs can use the [`get_minimum_delegation()`] helper function to invoke and
     /// retrieve the return value for this instruction.
     ///

interface/src/state.rs

@@ -282,7 +282,7 @@ pub enum StakeAuthorize {
 )]
 #[derive(Default, Debug, PartialEq, Eq, Clone, Copy)]
 pub struct Lockup {
-    /// UnixTimestamp at which this stake will allow withdrawal, unless the
+    /// `UnixTimestamp` at which this stake will allow withdrawal, unless the
     ///   transaction is signed by the custodian
     pub unix_timestamp: UnixTimestamp,
     /// epoch height at which this stake will allow withdrawal, unless the

program/src/helpers/merge.rs

@@ -181,10 +181,11 @@ pub(crate) fn merge_delegation_stake_and_credits_observed(
 /// observed of the merged stake is the weighted average of the two stakes'
 /// credits observed.
 ///
-/// This is because we can derive the effective credits_observed by reversing
+/// This is because we can derive the effective `credits_observed` by reversing
 /// the staking rewards equation, _while keeping the rewards unchanged after
 /// merge (i.e. strong requirement)_, like below:
 ///
+/// ```text
 /// a(N) => account, r => rewards, s => stake, c => credits:
 /// assume:
 ///   a3 = merge(a1, a2)
@@ -197,9 +198,10 @@ pub(crate) fn merge_delegation_stake_and_credits_observed(
 ///        a3.r = a1.r + a2.r
 /// a3.c * a3.s = a1.c * a1.s + a2.c * a2.s
 ///        a3.c = (a1.c * a1.s + a2.c * a2.s) / (a1.s + a2.s)     // QED
+/// ```
 ///
 /// (For this discussion, we omitted irrelevant variables, including distance
-///  calculation against vote_account and point indirection.)
+///  calculation against `vote_account` and point indirection.)
 pub(crate) fn stake_weighted_credits_observed(
     stake: &Stake,
     absorbed_lamports: u64,

scripts/solana.dic

@@ -0,0 +1,27 @@
+1000
+activations
+autogenerated
+codama
+config
+cooldown
+deallocated
+entrypoint
+fn
+lamports
+mergeable
+pubkey
+pubkeys
+redelegate
+redelegated
+redelegation
+rpc
+staker
+struct
+sysvar
+sysvars
+undelegate
+undelegated
+unstake
+unstaked
+warmup
+withdrawer

scripts/spellcheck.toml

@@ -0,0 +1,5 @@
+[Hunspell]
+use_builtin = true
+skip_os_lookups = false
+search_dirs = ["."]
+extra_dictionaries = ["solana.dic"]