Fixup code comments and variable names

Author: joncinque

stake-pool/cli/src/main.rs

@@ -520,7 +520,7 @@ fn command_vsa_remove(
             stake_pool_address,
             vote_account,
             validator_seed,
-            validator_stake_info.transient_seed_suffix_start,
+            validator_stake_info.transient_seed_suffix,
         ),
     ];
     unique_signers!(signers);
@@ -559,7 +559,7 @@ fn command_increase_validator_stake(
                 vote_account,
                 lamports,
                 validator_seed,
-                validator_stake_info.transient_seed_suffix_start,
+                validator_stake_info.transient_seed_suffix,
             ),
         ],
         &signers,
@@ -598,7 +598,7 @@ fn command_decrease_validator_stake(
                 vote_account,
                 lamports,
                 validator_seed,
-                validator_stake_info.transient_seed_suffix_start,
+                validator_stake_info.transient_seed_suffix,
             ),
         ],
         &signers,
@@ -1095,7 +1095,7 @@ fn command_list(config: &Config, stake_pool_address: &Pubkey) -> CommandResult {
                 &spl_stake_pool::id(),
                 &validator.vote_account_address,
                 stake_pool_address,
-                validator.transient_seed_suffix_start,
+                validator.transient_seed_suffix,
             );
             let update_required = validator.last_update_epoch != epoch_info.epoch;
             CliStakePoolStakeAccountInfo {
@@ -1279,7 +1279,7 @@ fn prepare_withdraw_accounts(
                 &spl_stake_pool::id(),
                 &validator.vote_account_address,
                 stake_pool_address,
-                validator.transient_seed_suffix_start,
+                validator.transient_seed_suffix,
             );
 
             (

stake-pool/cli/src/output.rs

@@ -362,8 +362,8 @@ pub(crate) struct CliStakePoolValidator {
     pub active_stake_lamports: u64,
     pub transient_stake_lamports: u64,
     pub last_update_epoch: u64,
-    pub transient_seed_suffix_start: u64,
-    pub transient_seed_suffix_end: u32,
+    pub transient_seed_suffix: u64,
+    pub unused: u32,
     pub validator_seed_suffix: u32,
     pub status: CliStakePoolValidatorStakeStatus,
     pub vote_account_address: String,
@@ -375,8 +375,8 @@ impl From<ValidatorStakeInfo> for CliStakePoolValidator {
             active_stake_lamports: v.active_stake_lamports,
             transient_stake_lamports: v.transient_stake_lamports,
             last_update_epoch: v.last_update_epoch,
-            transient_seed_suffix_start: v.transient_seed_suffix_start,
-            transient_seed_suffix_end: v.transient_seed_suffix_end,
+            transient_seed_suffix: v.transient_seed_suffix,
+            unused: v.unused,
             validator_seed_suffix: v.validator_seed_suffix,
             status: CliStakePoolValidatorStakeStatus::from(v.status),
             vote_account_address: v.vote_account_address.to_string(),

stake-pool/program/src/instruction.rs

@@ -819,7 +819,7 @@ pub fn update_validator_list_balance(
                         program_id,
                         vote_account_address,
                         stake_pool,
-                        validator_stake_info.transient_seed_suffix_start,
+                        validator_stake_info.transient_seed_suffix,
                     );
                     vec![
                         AccountMeta::new(validator_stake_account, false),

stake-pool/program/src/processor.rs

@@ -933,8 +933,8 @@ impl Processor {
             active_stake_lamports: required_lamports,
             transient_stake_lamports: 0,
             last_update_epoch: clock.epoch,
-            transient_seed_suffix_start: 0,
-            transient_seed_suffix_end: 0,
+            transient_seed_suffix: 0,
+            unused: 0,
             validator_seed_suffix: raw_validator_seed,
         })?;
 
@@ -1047,7 +1047,7 @@ impl Processor {
                 stake_pool_info.key,
                 transient_stake_account_info.key,
                 &vote_account_address,
-                validator_stake_info.transient_seed_suffix_start,
+                validator_stake_info.transient_seed_suffix,
             )?;
 
             match get_stake_state(transient_stake_account_info) {
@@ -1251,7 +1251,7 @@ impl Processor {
             .checked_sub(lamports)
             .ok_or(StakePoolError::CalculationFailure)?;
         validator_stake_info.transient_stake_lamports = lamports;
-        validator_stake_info.transient_seed_suffix_start = transient_stake_seed;
+        validator_stake_info.transient_seed_suffix = transient_stake_seed;
 
         Ok(())
     }
@@ -1443,7 +1443,7 @@ impl Processor {
         )?;
 
         validator_stake_info.transient_stake_lamports = total_lamports;
-        validator_stake_info.transient_seed_suffix_start = transient_stake_seed;
+        validator_stake_info.transient_seed_suffix = transient_stake_seed;
 
         Ok(())
     }
@@ -1590,7 +1590,7 @@ impl Processor {
                 stake_pool_info.key,
                 transient_stake_info.key,
                 &validator_stake_record.vote_account_address,
-                validator_stake_record.transient_seed_suffix_start,
+                validator_stake_record.transient_seed_suffix,
             )
             .is_err()
             {
@@ -2000,6 +2000,9 @@ impl Processor {
         if stake_pool.manager_fee_account != *manager_fee_info.key {
             return Err(StakePoolError::InvalidFeeAccount.into());
         }
+        // There is no bypass if the manager fee account is invalid. Deposits
+        // don't hold user funds hostage, so if the fee account is invalid, users
+        // cannot deposit in the pool.  Let it fail here!
 
         if stake_pool.last_update_epoch < clock.epoch {
             return Err(StakePoolError::StakeListAndPoolOutOfDate.into());
@@ -2256,6 +2259,9 @@ impl Processor {
         if stake_pool.manager_fee_account != *manager_fee_info.key {
             return Err(StakePoolError::InvalidFeeAccount.into());
         }
+        // There is no bypass if the manager fee account is invalid. Deposits
+        // don't hold user funds hostage, so if the fee account is invalid, users
+        // cannot deposit in the pool.  Let it fail here!
 
         // We want this to hold to ensure that deposit_sol mints pool tokens
         // at the right price
@@ -2511,7 +2517,7 @@ impl Processor {
                     stake_pool_info.key,
                     stake_split_from.key,
                     &vote_account_address,
-                    validator_stake_info.transient_seed_suffix_start,
+                    validator_stake_info.transient_seed_suffix,
                 )?;
                 StakeWithdrawSource::Transient
             } else {

stake-pool/program/src/state.rs

@@ -619,9 +619,7 @@ pub(crate) enum StakeWithdrawSource {
 #[repr(C)]
 #[derive(Clone, Copy, Debug, Default, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
 pub struct ValidatorStakeInfo {
-    /// Amount of active stake delegated to this validator, minus the minimum
-    /// required stake amount of rent-exemption +
-    /// `max(crate::MINIMUM_ACTIVE_STAKE, solana_program::stake::tools::get_minimum_delegation())`.
+    /// Amount of lamports on the validator stake account, including rent
     ///
     /// Note that if `last_update_epoch` does not match the current epoch then
     /// this field may not be accurate
@@ -636,11 +634,11 @@ pub struct ValidatorStakeInfo {
     /// Last epoch the active and transient stake lamports fields were updated
     pub last_update_epoch: u64,
 
-    /// Start of the validator transient account seed suffixess
-    pub transient_seed_suffix_start: u64,
+    /// Transient account seed suffix, used to derive the transient stake account address
+    pub transient_seed_suffix: u64,
 
-    /// Offset of the end the validator transient account seed suffixes
-    pub transient_seed_suffix_end: u32,
+    /// Unused space, initially meant to specify the end of seed suffixes
+    pub unused: u32,
 
     /// Validator account seed suffix
     pub validator_seed_suffix: u32, // really `Option<NonZeroU32>` so 0 is `None`
@@ -942,8 +940,8 @@ mod test {
                     active_stake_lamports: u64::from_le_bytes([255; 8]),
                     transient_stake_lamports: u64::from_le_bytes([128; 8]),
                     last_update_epoch: u64::from_le_bytes([64; 8]),
-                    transient_seed_suffix_start: 0,
-                    transient_seed_suffix_end: 0,
+                    transient_seed_suffix: 0,
+                    unused: 0,
                     validator_seed_suffix: 0,
                 },
                 ValidatorStakeInfo {
@@ -952,8 +950,8 @@ mod test {
                     active_stake_lamports: 998877665544,
                     transient_stake_lamports: 222222222,
                     last_update_epoch: 11223445566,
-                    transient_seed_suffix_start: 0,
-                    transient_seed_suffix_end: 0,
+                    transient_seed_suffix: 0,
+                    unused: 0,
                     validator_seed_suffix: 0,
                 },
                 ValidatorStakeInfo {
@@ -962,8 +960,8 @@ mod test {
                     active_stake_lamports: 0,
                     transient_stake_lamports: 0,
                     last_update_epoch: 999999999999999,
-                    transient_seed_suffix_start: 0,
-                    transient_seed_suffix_end: 0,
+                    transient_seed_suffix: 0,
+                    unused: 0,
                     validator_seed_suffix: 0,
                 },
             ],

stake-pool/program/tests/force_destake.rs

@@ -68,8 +68,8 @@ async fn setup() -> (
         active_stake_lamports,
         transient_stake_lamports: 0,
         last_update_epoch: 0,
-        transient_seed_suffix_start: 0,
-        transient_seed_suffix_end: 0,
+        transient_seed_suffix: 0,
+        unused: 0,
         validator_seed_suffix: raw_validator_seed,
     });
 

stake-pool/program/tests/helpers/mod.rs

@@ -1977,8 +1977,8 @@ pub fn add_validator_stake_account(
         active_stake_lamports,
         transient_stake_lamports: 0,
         last_update_epoch: FIRST_NORMAL_EPOCH,
-        transient_seed_suffix_start: 0,
-        transient_seed_suffix_end: 0,
+        transient_seed_suffix: 0,
+        unused: 0,
         validator_seed_suffix: raw_suffix,
     });
 

stake-pool/program/tests/vsa_add.rs

@@ -115,8 +115,8 @@ async fn success() {
                 last_update_epoch: 0,
                 active_stake_lamports: stake_rent + current_minimum_delegation,
                 transient_stake_lamports: 0,
-                transient_seed_suffix_start: 0,
-                transient_seed_suffix_end: 0,
+                transient_seed_suffix: 0,
+                unused: 0,
                 validator_seed_suffix: validator_stake
                     .validator_stake_seed
                     .map(|s| s.get())

stake-pool/program/tests/vsa_remove.rs

@@ -549,8 +549,8 @@ async fn success_with_deactivating_transient_stake() {
             last_update_epoch: 0,
             active_stake_lamports: stake_rent + current_minimum_delegation,
             transient_stake_lamports: TEST_STAKE_AMOUNT + stake_rent,
-            transient_seed_suffix_start: validator_stake.transient_stake_seed,
-            transient_seed_suffix_end: 0,
+            transient_seed_suffix: validator_stake.transient_stake_seed,
+            unused: 0,
             validator_seed_suffix: validator_stake
                 .validator_stake_seed
                 .map(|s| s.get())

stake-pool/py/stake_pool/actions.py

@@ -164,7 +164,7 @@ async def remove_validator_from_pool(
             stake_pool.validator_list,
             validator,
             validator_info.validator_seed_suffix or None,
-            validator_info.transient_seed_suffix_start,
+            validator_info.transient_seed_suffix,
         )
     )
     await client.send_transaction(
@@ -417,7 +417,7 @@ async def update_stake_pool(client: AsyncClient, payer: Keypair, stake_pool_addr
                 STAKE_POOL_PROGRAM_ID,
                 validator.vote_account_address,
                 stake_pool_address,
-                validator.transient_seed_suffix_start,
+                validator.transient_seed_suffix,
             )
             validator_and_transient_stake_pairs.append(transient_stake_address)
         update_list_instructions.append(
@@ -491,7 +491,7 @@ async def increase_validator_stake(
     (withdraw_authority, seed) = find_withdraw_authority_program_address(STAKE_POOL_PROGRAM_ID, stake_pool_address)
 
     validator_info = next(x for x in validator_list.validators if x.vote_account_address == validator_vote)
-    transient_stake_seed = validator_info.transient_seed_suffix_start + 1  # bump up by one to avoid reuse
+    transient_stake_seed = validator_info.transient_seed_suffix + 1  # bump up by one to avoid reuse
     validator_stake_seed = validator_info.validator_seed_suffix or None
     (transient_stake, _) = find_transient_stake_program_address(
         STAKE_POOL_PROGRAM_ID,
@@ -557,7 +557,7 @@ async def decrease_validator_stake(
         stake_pool_address,
         validator_stake_seed,
     )
-    transient_stake_seed = validator_info.transient_seed_suffix_start + 1  # bump up by one to avoid reuse
+    transient_stake_seed = validator_info.transient_seed_suffix + 1  # bump up by one to avoid reuse
     (transient_stake, _) = find_transient_stake_program_address(
         STAKE_POOL_PROGRAM_ID,
         validator_info.vote_account_address,

stake-pool/py/stake_pool/state.py

@@ -132,11 +132,11 @@ class ValidatorStakeInfo(NamedTuple):
     last_update_epoch: int
     """Last epoch the active and transient stake lamports fields were updated."""
 
-    transient_seed_suffix_start: int
-    """Start of the validator transient account seed suffixes."""
+    transient_seed_suffix: int
+    """Transient account seed suffix."""
 
-    transient_seed_suffix_end: int
-    """End of the validator transient account seed suffixes."""
+    unused: int
+    """Unused space, initially meant to specify the range of transient stake account suffixes."""
 
     validator_seed_suffix: int
     """Validator account seed suffix."""
@@ -153,8 +153,8 @@ def decode_container(cls, container: Container):
             active_stake_lamports=container['active_stake_lamports'],
             transient_stake_lamports=container['transient_stake_lamports'],
             last_update_epoch=container['last_update_epoch'],
-            transient_seed_suffix_start=container['transient_seed_suffix_start'],
-            transient_seed_suffix_end=container['transient_seed_suffix_end'],
+            transient_seed_suffix=container['transient_seed_suffix'],
+            unused=container['unused'],
             validator_seed_suffix=container['validator_seed_suffix'],
             status=container['status'],
             vote_account_address=PublicKey(container['vote_account_address']),
@@ -310,8 +310,8 @@ def decode(cls, data: str, encoding: str):
     "active_stake_lamports" / Int64ul,
     "transient_stake_lamports" / Int64ul,
     "last_update_epoch" / Int64ul,
-    "transient_seed_suffix_start" / Int64ul,
-    "transient_seed_suffix_end" / Int32ul,
+    "transient_seed_suffix" / Int64ul,
+    "unused" / Int32ul,
     "validator_seed_suffix" / Int32ul,
     "status" / Int8ul,
     "vote_account_address" / PUBLIC_KEY_LAYOUT,