Merge branch 'brent/aesthetic-edits' (#2894)

Author: brentstone

.changelog/unreleased/improvements/2894-aesthetic-edits.md

@@ -0,0 +1,2 @@
+- Some edits to logging and strings
+  ([\#2894](https://github.com/anoma/namada/pull/2894))

crates/proof_of_stake/src/rewards.rs

@@ -360,6 +360,7 @@ where
         num_blocks_in_last_epoch,
         inflation,
         &staking_token,
+        total_tokens,
     )?;
 
     // Write new rewards parameters that will be used for the inflation of
@@ -388,6 +389,7 @@ pub fn update_rewards_products_and_mint_inflation<S>(
     num_blocks_in_last_epoch: u64,
     inflation: token::Amount,
     staking_token: &Address,
+    total_native_tokens: token::Amount,
 ) -> namada_storage::Result<()>
 where
     S: StorageRead + StorageWrite,
@@ -455,11 +457,12 @@ where
     let pos_reward_tokens = inflation - reward_tokens_remaining;
     tracing::info!(
         "Minting tokens for PoS rewards distribution into the PoS account. \
-         Amount: {}. Total inflation: {}, number of blocks in the last epoch: \
-         {num_blocks_in_last_epoch}, reward accumulators sum: \
-         {accumulators_sum}.",
+         Amount: {}. Total inflation: {}. Total native supply: {}. Number of \
+         blocks in the last epoch: {num_blocks_in_last_epoch}. Reward \
+         accumulators sum: {accumulators_sum}.",
         pos_reward_tokens.to_string_native(),
         inflation.to_string_native(),
+        total_native_tokens.to_string_native(),
     );
     credit_tokens(storage, staking_token, &address::POS, pos_reward_tokens)?;
 

crates/proof_of_stake/src/tests/test_pos.rs

@@ -17,6 +17,7 @@ use proptest::test_runner::Config;
 // Use `RUST_LOG=info` (or another tracing level) and `--nocapture` to see
 // `tracing` logs from tests
 use test_log::test;
+use token::storage_key::minted_balance_key;
 
 use crate::parameters::testing::arb_pos_params;
 use crate::parameters::OwnedPosParams;
@@ -1414,6 +1415,11 @@ fn test_update_rewards_products_aux(validators: Vec<GenesisValidator>) {
             .unwrap();
     }
 
+    let total_native_tokens: token::Amount = s
+        .read(&minted_balance_key(&staking_token))
+        .unwrap()
+        .expect("Total NAM balance should exist in storage");
+
     // Distribute inflation into rewards
     let last_epoch = current_epoch.prev();
     let inflation = token::Amount::native_whole(10_000_000);
@@ -1424,6 +1430,7 @@ fn test_update_rewards_products_aux(validators: Vec<GenesisValidator>) {
         num_blocks_in_last_epoch,
         inflation,
         &staking_token,
+        total_native_tokens,
     )
     .unwrap();
 

crates/shielded_token/src/storage_key.rs

@@ -23,15 +23,15 @@ pub const MASP_TOKEN_MAP_KEY: &str = "tokens";
 pub const MASP_ASSETS_HASH_KEY: &str = "assets_hash";
 /// Last calculated inflation value handed out
 pub const MASP_LAST_INFLATION_KEY: &str = "last_inflation";
-/// The last locked ratio
-pub const MASP_LAST_LOCKED_AMOUNT_KEY: &str = "last_locked_ratio";
+/// The last locked amount
+pub const MASP_LAST_LOCKED_AMOUNT_KEY: &str = "last_locked_amount";
 /// The key for the nominal proportional gain of a shielded pool for a given
 /// asset
 pub const MASP_KP_GAIN_KEY: &str = "proportional_gain";
 /// The key for the nominal derivative gain of a shielded pool for a given asset
 pub const MASP_KD_GAIN_KEY: &str = "derivative_gain";
-/// The key for the locked ratio target for a given asset
-pub const MASP_LOCKED_AMOUNT_TARGET_KEY: &str = "locked_ratio_target";
+/// The key for the locked amount target for a given asset
+pub const MASP_LOCKED_AMOUNT_TARGET_KEY: &str = "locked_amount_target";
 /// The key for the max reward rate for a given asset
 pub const MASP_MAX_REWARD_RATE_KEY: &str = "max_reward_rate";
 
@@ -51,13 +51,13 @@ pub fn masp_max_reward_rate_key(token_addr: &Address) -> storage::Key {
         .with_segment(MASP_MAX_REWARD_RATE_KEY.to_owned())
 }
 
-/// Obtain the locked target ratio key for the given token
+/// Obtain the locked target amount key for the given token
 pub fn masp_locked_amount_target_key(token_addr: &Address) -> storage::Key {
     parameter_prefix(token_addr)
         .with_segment(MASP_LOCKED_AMOUNT_TARGET_KEY.to_owned())
 }
 
-/// Obtain the storage key for the last locked ratio of a token
+/// Obtain the storage key for the last locked amount of a token
 pub fn masp_last_locked_amount_key(token_address: &Address) -> storage::Key {
     parameter_prefix(token_address)
         .with_segment(MASP_LAST_LOCKED_AMOUNT_KEY.to_owned())