spelling

Author: rustopian

scripts/setup/solana.dic

@@ -64,4 +64,6 @@ RPC
 ed25519
 performant
 syscall/S
-bitmask
+bitmask
+pinocchio
+mainnet

sdk/pinocchio/src/sysvars/slot_hashes/mod.rs

@@ -1,4 +1,4 @@
-//! Efficient, zero-copy access to SlotHashes sysvar data.
+//! Efficient, zero-copy access to `SlotHashes` sysvar data.
 
 pub mod raw;
 #[doc(inline)]
@@ -59,7 +59,7 @@ pub struct SlotHashEntry {
 // Fail compilation if `SlotHashEntry` is not byte-aligned.
 const _: [(); 1] = [(); mem::align_of::<SlotHashEntry>()];
 
-/// SlotHashes provides read-only, zero-copy access to SlotHashes sysvar bytes.
+/// `SlotHashes` provides read-only, zero-copy access to `SlotHashes` sysvar bytes.
 pub struct SlotHashes<T: Deref<Target = [u8]>> {
     data: T,
 }
@@ -93,7 +93,7 @@ pub(crate) unsafe fn read_entry_count_from_bytes_unchecked(data: &[u8]) -> usize
     u64::from_le_bytes(*(data.as_ptr() as *const [u8; NUM_ENTRIES_SIZE])) as usize
 }
 
-/// Validates SlotHashes data format.
+/// Validates `SlotHashes` data format.
 ///
 /// The function checks:
 /// 1. The buffer is large enough to contain the entry count.
@@ -152,7 +152,7 @@ impl<T: Deref<Target = [u8]>> SlotHashes<T> {
     ///
     /// This function is unsafe because it does not validate the data size or format.
     /// The caller must ensure:
-    /// 1. The underlying byte slice in `data` represents valid SlotHashes data
+    /// 1. The underlying byte slice in `data` represents valid `SlotHashes` data
     ///    (length prefix + entries, where entries are sorted in descending order by slot).
     /// 2. The data slice has at least `NUM_ENTRIES_SIZE + (declared_entries * ENTRY_SIZE)` bytes.
     /// 3. The first 8 bytes contain a valid entry count in little-endian format.
@@ -272,7 +272,7 @@ impl<'a> SlotHashes<Ref<'a, [u8]>> {
     /// The returned instance is valid for the lifetime of the borrow.
     ///
     /// # Errors
-    /// - `ProgramError::InvalidArgument` if the account key doesn't match the SlotHashes sysvar ID
+    /// - `ProgramError::InvalidArgument` if the account key doesn't match the `SlotHashes` sysvar ID
     /// - `ProgramError::AccountBorrowFailed` if the account data is already mutably borrowed
     #[inline(always)]
     pub fn from_account_info(account_info: &'a AccountInfo) -> Result<Self, ProgramError> {
@@ -289,7 +289,7 @@ impl<'a> SlotHashes<Ref<'a, [u8]>> {
 
 #[cfg(feature = "std")]
 impl SlotHashes<Box<[u8]>> {
-    /// Fills the provided buffer with the full SlotHashes sysvar data.
+    /// Fills the provided buffer with the full `SlotHashes` sysvar data.
     ///
     /// # Safety
     /// The caller must ensure the buffer pointer is valid for MAX_SIZE bytes.
@@ -321,7 +321,7 @@ impl SlotHashes<Box<[u8]>> {
         Ok(buf.into_boxed_slice())
     }
 
-    /// Fetches the SlotHashes sysvar data directly via syscall. This copies
+    /// Fetches the `SlotHashes` sysvar data directly via syscall. This copies
     /// the full sysvar data (`MAX_SIZE` bytes).
     #[inline(always)]
     pub fn fetch() -> Result<Self, ProgramError> {

sdk/pinocchio/src/sysvars/slot_hashes/raw.rs

@@ -1,14 +1,14 @@
-//! Raw / caller-supplied buffer helpers for the SlotHashes sysvar.
+//! Raw / caller-supplied buffer helpers for the `SlotHashes` sysvar.
 //!
 //! This sub-module exposes lightweight functions that let a program copy
-//! SlotHashes data directly into an arbitrary buffer **without** constructing
+//! `SlotHashes` data directly into an arbitrary buffer **without** constructing
 //! a `SlotHashes<T>` view. Use these when you only need a byte snapshot or
 //! when including the sysvar account is infeasible.
 #![allow(clippy::inline_always)]
 
 use super::*;
 
-/// Validates that a buffer is properly sized for SlotHashes data.
+/// Validates that a buffer is properly sized for `SlotHashes` data.
 ///
 /// Checks that the buffer length is 8 + (N × 40) for some N ≤ 512.
 /// Unlike the `SlotHashes` constructor, this function does not require
@@ -34,9 +34,9 @@ pub(crate) fn validate_buffer_size(buffer_len: usize) -> Result<(), ProgramError
     Ok(())
 }
 
-/// Validates offset parameters for fetching SlotHashes data.
+/// Validates offset parameters for fetching `SlotHashes` data.
 ///
-/// * `offset` – Byte offset within the SlotHashes sysvar data.
+/// * `offset` – Byte offset within the `SlotHashes` sysvar data.
 /// * `buffer_len` – Length of the destination buffer.
 #[inline(always)]
 pub fn validate_fetch_offset(offset: usize, buffer_len: usize) -> Result<(), ProgramError> {
@@ -53,7 +53,7 @@ pub fn validate_fetch_offset(offset: usize, buffer_len: usize) -> Result<(), Pro
     Ok(())
 }
 
-/// Copies SlotHashes sysvar bytes into `buffer`, performing validation.
+/// Copies `SlotHashes` sysvar bytes into `buffer`, performing validation.
 ///
 /// Returns the number of entries present in the sysvar.
 #[inline(always)]
@@ -77,10 +77,10 @@ pub fn fetch_into(buffer: &mut [u8], offset: usize) -> Result<usize, ProgramErro
     Ok(num_entries)
 }
 
-/// Copies SlotHashes sysvar bytes into `buffer` **without** validation.
+/// Copies `SlotHashes` sysvar bytes into `buffer` **without** validation.
 ///
 /// The caller is responsible for ensuring that:
-/// 1. `buffer` is large enough for the requested `offset`+`buffer.len()` range and
+/// 1. `buffer` is large enough for the requested `offset` + `buffer.len()` range and
 ///    properly laid out (see `validate_buffer_size` and `validate_fetch_offset`).
 /// 2. The memory behind `buffer` is writable for its full length.
 ///

sdk/pinocchio/src/sysvars/slot_hashes/test_utils.rs

@@ -1,4 +1,4 @@
-//! Shared helpers for SlotHashes sysvar tests.
+//! Shared helpers for `SlotHashes` sysvar tests.
 //! This module is compiled only when `cfg(test)` is active so `std` can be used
 //! freely while production code remains `#![no_std]`.
 
@@ -84,7 +84,7 @@ pub fn generate_mock_entries(
     entries
 }
 
-/// Build a `Vec<u8>` the size of the *golden* SlotHashes sysvar (20 488 bytes)
+/// Build a `Vec<u8>` the size of the *golden* `SlotHashes` sysvar (20 488 bytes)
 /// containing the supplied `entries` and with the `declared_len` header.
 pub fn build_slot_hashes_bytes(declared_len: u64, entries: &[(u64, Hash)]) -> Vec<u8> {
     let mut data = std::vec![0u8; MAX_SIZE];