CRC: fix some comments

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jferrant

stacks-common/src/deps_common/bitcoin/blockdata/script.rs

@@ -840,7 +840,10 @@ mod test {
 
         let original = hex_script!("827651a0698faaa9a8a7a687");
         let json_value = serde_json::to_value(&original).unwrap();
-        assert_eq!(serde_json::to_vec(&json_value).unwrap(), b"\"827651a0698faaa9a8a7a687\"");
+        assert_eq!(
+            serde_json::to_vec(&json_value).unwrap(),
+            b"\"827651a0698faaa9a8a7a687\""
+        );
         assert_eq!(json_value.to_string(), "\"827651a0698faaa9a8a7a687\"");
         let des = serde_json::from_value(json_value).unwrap();
         assert_eq!(original, des);

stacks-common/src/deps_common/bitcoin/network/message_network.rs

@@ -22,7 +22,8 @@ use crate::deps_common::bitcoin::network::address::Address;
 use crate::deps_common::bitcoin::network::constants;
 use crate::util;
 
-/// Some simple messages
+// Some simple messages
+
 /// The `version` message
 #[derive(PartialEq, Eq, Clone, Debug)]
 pub struct VersionMessage {

stacks-common/src/types/mod.rs

@@ -122,22 +122,21 @@ pub struct CoinbaseInterval {
     pub effective_start_height: u64,
 }
 
-/// From SIP-029:
-///
-/// | Coinbase Interval  | Bitcoin Height | Offset Height       | Approx. Supply   | STX Reward | Annual Inflation |
-/// |--------------------|----------------|---------------------|------------------|------------|------------------|
-/// | Current            | -              | -                   | 1,552,452,847    | 1000       | -                |
-/// | 1st                |   945,000      |   278,950           | 1,627,352,847    | 500 (50%)  | 3.23%            |
-/// | 2nd                | 1,050,000      |   383,950           | 1,679,852,847    | 250 (50%)  | 1.57%            |
-/// | 3rd                | 1,260,000      |   593,950           | 1,732,352,847    | 125 (50%)  | 0.76%            |
-/// | 4th                | 1,470,000      |   803,950           | 1,758,602,847    | 62.5 (50%) | 0.37%            |
-/// | -                  | 2,197,560      | 1,531,510           | 1,804,075,347    | 62.5 (0%)  | 0.18%            |
-///
-/// The above is for mainnet, which has a burnchain year of 52596 blocks and starts at burnchain height 666050.
-/// The `Offset Height` column is simply the difference between `Bitcoin Height` and 666050.
-/// 
+// From SIP-029:
+//
+// | Coinbase Interval  | Bitcoin Height | Offset Height       | Approx. Supply   | STX Reward | Annual Inflation |
+// |--------------------|----------------|---------------------|------------------|------------|------------------|
+// | Current            | -              | -                   | 1,552,452,847    | 1000       | -                |
+// | 1st                |   945,000      |   278,950           | 1,627,352,847    | 500 (50%)  | 3.23%            |
+// | 2nd                | 1,050,000      |   383,950           | 1,679,852,847    | 250 (50%)  | 1.57%            |
+// | 3rd                | 1,260,000      |   593,950           | 1,732,352,847    | 125 (50%)  | 0.76%            |
+// | 4th                | 1,470,000      |   803,950           | 1,758,602,847    | 62.5 (50%) | 0.37%            |
+// | -                  | 2,197,560      | 1,531,510           | 1,804,075,347    | 62.5 (0%)  | 0.18%            |
+//
+// The above is for mainnet, which has a burnchain year of 52596 blocks and starts at burnchain height 666050.
+
 /// Mainnet coinbase intervals, as of SIP-029
-// This static value is lazily initialized using `OnceLock` to avoid unnecessary 
+// This static value is lazily initialized using `OnceLock` to avoid unnecessary
 // computation at program startup while ensuring thread safety and one-time initialization.
 // The intervals define the emission schedule for mainnet and are validated at runtime.
 pub static COINBASE_INTERVALS_MAINNET: OnceLock<[CoinbaseInterval; 5]> = OnceLock::new();
@@ -173,7 +172,7 @@ pub fn get_coinbase_intervals_mainnet() -> &'static [CoinbaseInterval; 5] {
 
 /// Testnet coinbase intervals as defined by SIP-029.
 ///
-/// This static value is lazily initialized using `OnceLock` to avoid unnecessary 
+/// This static value is lazily initialized using `OnceLock` to avoid unnecessary
 /// computation at program startup while ensuring thread safety and one-time initialization.
 /// The intervals define the emission schedule for testnet and are validated at runtime.
 pub static COINBASE_INTERVALS_TESTNET: OnceLock<[CoinbaseInterval; 5]> = OnceLock::new();
@@ -261,7 +260,7 @@ impl CoinbaseInterval {
         }
 
         let mut ht = intervals[0].effective_start_height;
-        for interval in intervals  {
+        for interval in intervals {
             if interval.effective_start_height < ht {
                 return false;
             }
@@ -553,13 +552,11 @@ impl StacksEpochId {
             | StacksEpochId::Epoch30 => {
                 self.coinbase_reward_pre_sip029(first_burnchain_height, current_burnchain_height)
             }
-            StacksEpochId::Epoch31 => {
-                self.coinbase_reward_sip029(
-                    mainnet,
-                    first_burnchain_height,
-                    current_burnchain_height,
-                )
-            }
+            StacksEpochId::Epoch31 => self.coinbase_reward_sip029(
+                mainnet,
+                first_burnchain_height,
+                current_burnchain_height,
+            ),
         }
     }
 }

stacks-common/src/types/tests.rs

@@ -14,12 +14,11 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-use crate::types::{get_coinbase_intervals_mainnet, get_coinbase_intervals_testnet};
-
 use super::{
     set_test_coinbase_schedule, CoinbaseInterval, StacksEpochId, COINBASE_INTERVALS_MAINNET,
     COINBASE_INTERVALS_TESTNET,
 };
+use crate::types::{get_coinbase_intervals_mainnet, get_coinbase_intervals_testnet};
 
 #[test]
 fn test_mainnet_coinbase_emissions() {

stacks-common/src/util/hash.rs

@@ -382,10 +382,10 @@ pub struct MerklePathPoint<H: MerkleHashFunc> {
 pub type MerklePath<H> = Vec<MerklePathPoint<H>>;
 
 /// Merkle tree implementation with tagged nodes:
-/// 
+///
 /// * A leaf hash is `H(0x00 + data)`
 /// * A node hash is `H(0x01 + left.hash + right.hash)`
-/// 
+///
 /// An empty tree has a root hash of `0x00000...00000`.
 ///
 /// NOTE: This is consensus-critical code, because it is used to generate the transaction Merkle