docs: fix docs build issues (#297)

Author: xdustinface

dash-spv-ffi/FFI_API.md

@@ -94,7 +94,7 @@ Functions: 3
 
 | Function | Description | Module |
 |----------|-------------|--------|
-| `dash_spv_ffi_client_broadcast_transaction` | No description | broadcast |
+| `dash_spv_ffi_client_broadcast_transaction` | Broadcasts a transaction to the Dash network via connected peers | broadcast |
 | `dash_spv_ffi_unconfirmed_transaction_destroy` | Destroys an FFIUnconfirmedTransaction and all its associated resources  #... | types |
 | `dash_spv_ffi_unconfirmed_transaction_destroy_raw_tx` | Destroys the raw transaction bytes allocated for an FFIUnconfirmedTransaction... | types |
 
@@ -254,7 +254,7 @@ dash_spv_ffi_config_add_peer(config: *mut FFIClientConfig, addr: *const c_char,)
 ```
 
 **Description:**
-Adds a peer address to the configuration  Accepts either a full socket address (e.g., "192.168.1.1:9999" or "[::1]:19999") or an IP-only string (e.g., "127.0.0.1" or "2001:db8::1"). When an IP-only string is given, the default P2P port for the configured network is used.  # Safety - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet - `addr` must be a valid null-terminated C string containing a socket address or IP-only string - The caller must ensure both pointers remain valid for the duration of this call
+Adds a peer address to the configuration  Accepts either a full socket address (e.g., `192.168.1.1:9999` or `[::1]:19999`) or an IP-only string (e.g., "127.0.0.1" or "2001:db8::1"). When an IP-only string is given, the default P2P port for the configured network is used.  # Safety - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet - `addr` must be a valid null-terminated C string containing a socket address or IP-only string - The caller must ensure both pointers remain valid for the duration of this call
 
 **Safety:**
 - `config` must be a valid pointer to an FFIClientConfig created by dash_spv_ffi_config_new/mainnet/testnet - `addr` must be a valid null-terminated C string containing a socket address or IP-only string - The caller must ensure both pointers remain valid for the duration of this call
@@ -785,6 +785,12 @@ Destroys the addresses array allocated for an FFIUnconfirmedTransaction  # Safet
 dash_spv_ffi_client_broadcast_transaction(client: *mut FFIDashSpvClient, tx_hex: *const c_char,) -> i32
 ```
 
+**Description:**
+Broadcasts a transaction to the Dash network via connected peers.  # Safety  - `client` must be a valid, non-null pointer to an initialized FFIDashSpvClient - `tx_hex` must be a valid, non-null pointer to a NUL-terminated C string containing a hex-encoded serialized transaction
+
+**Safety:**
+- `client` must be a valid, non-null pointer to an initialized FFIDashSpvClient - `tx_hex` must be a valid, non-null pointer to a NUL-terminated C string containing a hex-encoded serialized transaction
+
 **Module:** `broadcast`
 
 ---

dash-spv-ffi/include/dash_spv_ffi.h

@@ -609,7 +609,7 @@ int32_t dash_spv_ffi_config_set_max_peers(struct FFIClientConfig *config,
 /**
  * Adds a peer address to the configuration
  *
- * Accepts either a full socket address (e.g., "192.168.1.1:9999" or "[::1]:19999")
+ * Accepts either a full socket address (e.g., `192.168.1.1:9999` or `[::1]:19999`)
  * or an IP-only string (e.g., "127.0.0.1" or "2001:db8::1"). When an IP-only
  * string is given, the default P2P port for the configured network is used.
  *
@@ -992,6 +992,15 @@ int32_t dash_spv_ffi_init_logging(const char *level,
 
  void dash_spv_ffi_enable_test_mode(void) ;
 
+/**
+ * Broadcasts a transaction to the Dash network via connected peers.
+ *
+ * # Safety
+ *
+ * - `client` must be a valid, non-null pointer to an initialized FFIDashSpvClient
+ * - `tx_hex` must be a valid, non-null pointer to a NUL-terminated C string
+ *   containing a hex-encoded serialized transaction
+ */
 
 int32_t dash_spv_ffi_client_broadcast_transaction(struct FFIDashSpvClient *client,
                                                   const char *tx_hex)

dash-spv-ffi/src/broadcast.rs

@@ -2,6 +2,13 @@ use crate::{null_check, set_last_error, FFIDashSpvClient, FFIErrorCode};
 use std::ffi::CStr;
 use std::os::raw::c_char;
 
+/// Broadcasts a transaction to the Dash network via connected peers.
+///
+/// # Safety
+///
+/// - `client` must be a valid, non-null pointer to an initialized FFIDashSpvClient
+/// - `tx_hex` must be a valid, non-null pointer to a NUL-terminated C string
+///   containing a hex-encoded serialized transaction
 #[no_mangle]
 pub unsafe extern "C" fn dash_spv_ffi_client_broadcast_transaction(
     client: *mut FFIDashSpvClient,

dash-spv-ffi/src/config.rs

@@ -125,7 +125,7 @@ pub unsafe extern "C" fn dash_spv_ffi_config_set_max_peers(
 
 /// Adds a peer address to the configuration
 ///
-/// Accepts either a full socket address (e.g., "192.168.1.1:9999" or "[::1]:19999")
+/// Accepts either a full socket address (e.g., `192.168.1.1:9999` or `[::1]:19999`)
 /// or an IP-only string (e.g., "127.0.0.1" or "2001:db8::1"). When an IP-only
 /// string is given, the default P2P port for the configured network is used.
 ///

dash-spv/src/client/core.rs

@@ -109,7 +109,7 @@ pub struct DashSpvClient<W: WalletInterface, N: NetworkManager, S: StorageManage
     ///
     /// # Architectural Design
     ///
-    /// The sync manager is stored as a non-shared field (not wrapped in Arc<Mutex<T>>)
+    /// The sync manager is stored as a non-shared field (not wrapped in `Arc<Mutex<T>>`)
     /// for the following reasons:
     ///
     /// 1. **Single Owner Pattern**: The sync manager is exclusively owned by the client,
@@ -126,7 +126,7 @@ pub struct DashSpvClient<W: WalletInterface, N: NetworkManager, S: StorageManage
     ///
     /// If concurrent access becomes necessary (e.g., for monitoring sync progress from
     /// multiple threads), consider:
-    /// - Using interior mutability patterns (Arc<Mutex<SyncManager>>)
+    /// - Using interior mutability patterns (`Arc<Mutex<SyncManager>>`)
     /// - Extracting read-only state into a separate shared structure
     /// - Implementing a message-passing architecture for sync commands
     ///

dash-spv/src/client/mod.rs

@@ -23,11 +23,11 @@
 //! ## Lock Ordering (CRITICAL - Prevents Deadlocks)
 //!
 //! When acquiring multiple locks, ALWAYS use this order:
-//! 1. running (Arc<RwLock<bool>>)
-//! 2. state (Arc<RwLock<ChainState>>)
-//! 3. stats (Arc<RwLock<SpvStats>>)
-//! 4. mempool_state (Arc<RwLock<MempoolState>>)
-//! 5. storage (Arc<Mutex<S>>)
+//! 1. running (`Arc<RwLock<bool>>`)
+//! 2. state (`Arc<RwLock<ChainState>>`)
+//! 3. stats (`Arc<RwLock<SpvStats>>`)
+//! 4. mempool_state (`Arc<RwLock<MempoolState>>`)
+//! 5. storage (`Arc<Mutex<S>>`)
 //!
 //! Never acquire locks in reverse order or deadlock will occur!
 

dash-spv/src/logging.rs

@@ -74,7 +74,7 @@ pub fn init_console_logging(level: LevelFilter) -> LoggingResult<LoggingGuard> {
 /// Note: If neither console nor file output is enabled, logging is disabled
 /// (tracing macros become no-ops) and Ok is returned.
 ///
-/// # Example
+/// # Examples
 ///
 /// ```no_run
 /// use dash_spv::logging::{init_logging, LoggingConfig, LogFileConfig};

dash-spv/src/sync/manager.rs

@@ -304,7 +304,7 @@ impl<
     /// - `filters_downloaded`: Should be calculated from storage
     /// - `last_synced_filter_height`: Should be queried from storage
     ///
-    /// # Example
+    /// # Examples
     /// ```ignore
     /// let mut progress = sync_manager.get_progress();
     /// progress.header_height = storage.get_tip_height().await?.unwrap_or(0);

dash-spv/src/types.rs

@@ -9,7 +9,7 @@
 //! - types/balances.rs - AddressBalance, UnconfirmedTransaction
 //!
 //! # Thread Safety
-//! Many types here are wrapped in Arc<RwLock> or Arc<Mutex> when used.
+//! Many types here are wrapped in `Arc<RwLock>` or `Arc<Mutex>` when used.
 //! Always acquire locks in consistent order to prevent deadlocks:
 //! 1. state (ChainState)
 //! 2. stats (SpvStats)
@@ -27,13 +27,13 @@ use std::sync::Arc;
 
 /// Shared, mutex-protected set of filter heights used across components.
 ///
-/// # Why Arc<Mutex<HashSet>>?
+/// # Why `Arc<Mutex<HashSet>>`?
 /// - Arc: Shared ownership between FilterSyncManager and SpvStats
 /// - Mutex: Interior mutability for concurrent updates from filter download tasks
 /// - HashSet: Fast O(1) membership testing for gap detection
 ///
 /// # Performance Note
-/// Consider Arc<RwLock> if read contention becomes an issue (most operations are reads).
+/// Consider `Arc<RwLock>` if read contention becomes an issue (most operations are reads).
 pub type SharedFilterHeights = std::sync::Arc<tokio::sync::Mutex<std::collections::HashSet<u32>>>;
 
 /// A block header with its cached hash to avoid expensive X11 recomputation.
@@ -240,7 +240,7 @@ impl DetailedSyncProgress {
 /// # CRITICAL: This is the heart of the SPV client's state
 ///
 /// ## Thread Safety
-/// Almost always wrapped in Arc<RwLock<ChainState>> for shared access.
+/// Almost always wrapped in `Arc<RwLock<ChainState>>` for shared access.
 /// Multiple readers can access simultaneously, but writes are exclusive.
 ///
 /// ## Checkpoint Sync

dash/src/blockdata/transaction/mod.rs

@@ -52,7 +52,7 @@ use crate::prelude::*;
 pub use crate::transaction::outpoint::*;
 use crate::{ScriptBuf, Weight, io};
 
-/// Result of [`SighashCache::legacy_encode_signing_data_to`].
+/// Result of `SighashCache::legacy_encode_signing_data_to`.
 ///
 /// This type forces the caller to handle SIGHASH_SINGLE bug case.
 ///
@@ -232,10 +232,10 @@ impl Transaction {
     /// sighash flag can be computed.
     ///
     /// To actually produce a scriptSig, this hash needs to be run through an ECDSA signer, the
-    /// [`EcdsaSighashType`] appended to the resulting sig, and a script written around this, but
+    /// `EcdsaSighashType` appended to the resulting sig, and a script written around this, but
     /// this is the general (and hard) part.
     ///
-    /// The `sighash_type` supports an arbitrary `u32` value, instead of just [`EcdsaSighashType`],
+    /// The `sighash_type` supports an arbitrary `u32` value, instead of just `EcdsaSighashType`,
     /// because internally 4 bytes are being hashed, even though only the lowest byte is appended to
     /// signature in a transaction.
     ///
@@ -245,7 +245,7 @@ impl Transaction {
     ///   `script_pubkey` to determine which separators get evaluated and which don't, which we don't
     ///   have the information to determine.
     /// - Does NOT handle the sighash single bug, you should either handle that manually or use
-    ///   [`Self::signature_hash()`] instead.
+    ///   `Self::signature_hash()` instead.
     ///
     /// # Panics
     ///
@@ -254,10 +254,10 @@ impl Transaction {
     /// sighash flag can be computed.
     ///
     /// To actually produce a scriptSig, this hash needs to be run through an ECDSA signer, the
-    /// [`EcdsaSighashType`] appended to the resulting sig, and a script written around this, but
+    /// `EcdsaSighashType` appended to the resulting sig, and a script written around this, but
     /// this is the general (and hard) part.
     ///
-    /// The `sighash_type` supports an arbitrary `u32` value, instead of just [`EcdsaSighashType`],
+    /// The `sighash_type` supports an arbitrary `u32` value, instead of just `EcdsaSighashType`,
     /// because internally 4 bytes are being hashed, even though only the lowest byte is appended to
     /// signature in a transaction.
     ///