Merge pull request #174 from helius-labs/feat/more-comprehensive-comments

feat(docs): Add Doc Comments For Everything

Author: 0xIchigo

src/client.rs

@@ -13,7 +13,7 @@ use solana_commitment_config::CommitmentConfig;
 
 /// The `Helius` struct is the main entry point to interacting with the SDK
 ///
-/// This client is responsible for setting up the network and configuration settins used to interact with the various provided methods.
+/// This client is responsible for setting up the network and configuration settings used to interact with the various provided methods.
 /// It also provides methods to access RPC client functionalities. The client ensures thread-safe access to the underlying RPC client
 pub struct Helius {
     /// The configuration which specifies an `api_key`, `cluster`, and the requisite `endpoints`
@@ -203,10 +203,21 @@ impl Helius {
         self.rpc_client.solana_client.clone()
     }
 
+    /// Returns the enhanced (Geyser) WebSocket client, if one was initialized.
+    ///
+    /// The WebSocket client is only available when the `Helius` instance was created with
+    /// `new_async()` or via `HeliusBuilder::with_websocket()`.
+    ///
+    /// # Returns
+    /// `Some(Arc<EnhancedWebsocket>)` if a WebSocket client is available, `None` otherwise
     pub fn ws(&self) -> Option<Arc<EnhancedWebsocket>> {
         self.ws_client.clone()
     }
 
+    /// Returns the client configuration.
+    ///
+    /// # Returns
+    /// A cloned `Arc<Config>` containing the API key, cluster, and endpoint settings
     pub fn config(&self) -> Arc<Config> {
         self.config.clone()
     }

src/error.rs

@@ -14,7 +14,7 @@ pub enum HeliusError {
     /// Indicates an improperly formatted request
     ///
     /// This error occurs when the request parameters do not meet the expected format, are missing required fields,
-    /// or contains invalid data
+    /// or contain invalid data
     #[error("Bad request to {path}: {text}")]
     BadRequest { path: String, text: String },
 
@@ -24,7 +24,7 @@ pub enum HeliusError {
     #[error("Solana client error: {0}")]
     ClientError(#[from] ClientError),
 
-    /// Indicates if a client is not already initialized
+    /// Indicates that a client has not been initialized
     ///
     /// Returned when accessing `async_connection()` without enabling async via `HeliusBuilder` or `new_async()`
     #[error("Client not initialized: {text}")]
@@ -112,18 +112,33 @@ pub enum HeliusError {
     #[error("Unknown error has occurred: HTTP {code} - {text}")]
     Unknown { code: StatusCode, text: String },
 
+    /// Indicates a failure in the underlying WebSocket (tungstenite) connection
+    ///
+    /// This captures connection errors, protocol violations, and other WebSocket-level failures
     #[error("Unable to connect to server: {0}")]
     Tungstenite(#[from] tokio_tungstenite::tungstenite::Error),
 
-    #[error("Websocket connection closed (({0})")]
+    /// Indicates the WebSocket connection was closed unexpectedly
+    ///
+    /// Includes a message describing the close reason or frame
+    #[error("Websocket connection closed ({0})")]
     WebsocketClosed(String),
 
+    /// Represents errors specific to the Helius enhanced (Geyser) WebSocket
+    ///
+    /// Returned for subscription failures, unsupported cluster configurations, or server-side errors
     #[error("Enhanced websocket: {message}: {reason}")]
     EnhancedWebsocket { reason: String, message: String },
 
+    /// Indicates a failure to parse a URL
+    ///
+    /// Returned when a provided RPC or WebSocket URL is malformed
     #[error("Url parse error")]
     UrlParseError(#[from] url::ParseError),
 
+    /// Indicates a TLS/SSL handshake or configuration error
+    ///
+    /// Returned when the HTTP client fails to establish a secure connection
     #[error("TLS error: {0}")]
     TlsError(String),
 }
@@ -154,12 +169,17 @@ impl From<SerdeJsonError> for HeliusError {
 }
 
 impl From<SanitizeError> for HeliusError {
+    /// Converts a Solana `SanitizeError` into [`HeliusError::InvalidInput`]
     fn from(err: SanitizeError) -> Self {
         HeliusError::InvalidInput(err.to_string())
     }
 }
 
 impl From<ReqwestError> for HeliusError {
+    /// Converts a `reqwest::Error` into the appropriate `HeliusError` variant
+    ///
+    /// Builder errors (typically TLS configuration issues) are mapped to [`HeliusError::TlsError`],
+    /// while all other request errors are mapped to [`HeliusError::ReqwestError`]
     fn from(err: reqwest::Error) -> Self {
         if err.is_builder() {
             HeliusError::TlsError(err.to_string())

src/rpc_client.rs

@@ -1,20 +1,20 @@
 /// # RPC Client for Helius
 ///
-/// This module provides access to the Helius API using an RPC client with an embedded Solana client
+/// This module provides access to the Helius API using an RPC client with an embedded Solana client.
 ///
 /// ## Errors
 ///
-/// Most methods in this client will return a `Result<T, HeliusError>`, where `HeliusError` can be:
+/// Most methods in this client will return a `Result<T, HeliusError>`, where common variants include:
 /// - `BadRequest`: Incorrect request format or parameters. Check the path and the text for details
 /// - `Unauthorized`: Incorrect or missing API key. Ensure you've provided the correct API key
 /// - `NotFound`: The requested resource was not found. This could mean an invalid ID or a non-existent endpoint
 /// - `RateLimitExceeded`: Too many requests have been sent in a short period. Consider implementing retries with an exponential backoff
 /// - `InternalError`: Server-side errors. These are rare and typically indicate issues on the server side. If these issues persist, please contact Helius support
-/// - `Network`: Errors during HTTP communication, typically from underlying network issues
+/// - `ReqwestError`: Errors during HTTP communication, typically from underlying network issues
 /// - `SerdeJson`: Errors during the serialization or deserialization process
 /// - `Unknown`: Catch-all for unclassified errors, with a status code and message provided for further investigation
 ///
-/// Ensure to handle these errors gracefully in your application to maintain robustness and stellar UX
+/// See [`HeliusError`](crate::error::HeliusError) for the full list of error variants.
 use std::collections::HashMap;
 use std::fmt::Debug;
 use std::sync::Arc;
@@ -39,9 +39,21 @@ use serde::Serialize;
 use solana_client::rpc_client::RpcClient as SolanaRpcClient;
 use solana_commitment_config::CommitmentConfig;
 
+/// Helius RPC client with an embedded Solana RPC client.
+///
+/// Provides methods for interacting with the Helius DAS API, priority fee estimation,
+/// and enhanced RPC V2 endpoints (`getProgramAccountsV2`, `getTokenAccountsByOwnerV2`,
+/// `getTransactionsForAddress`). The embedded Solana client handles standard Solana
+/// RPC calls.
+///
+/// Constructed internally by [`Helius`](crate::Helius) — use [`HeliusBuilder`](crate::HeliusBuilder)
+/// or [`Helius::new`](crate::Helius::new) to create a client.
 pub struct RpcClient {
+    /// HTTP request handler for Helius API calls
     pub handler: RequestHandler,
+    /// Shared SDK configuration (API key, endpoints)
     pub config: Arc<Config>,
+    /// Embedded Solana RPC client for standard RPC methods
     pub solana_client: Arc<SolanaRpcClient>,
 }
 
@@ -289,7 +301,7 @@ impl RpcClient {
     ///
     /// # Pagination
     /// * If `pagination_key` is `Some`, pass it into the **next** request to continue
-    /// * If `pagination_key` is `None`, ypu've reached the end
+    /// * If `pagination_key` is `None`, you've reached the end
     /// * Note that if there are fewer than `limit` accounts in a given page it does not imply the end; always check the cursor
     ///
     /// # Incremental Updates
@@ -321,7 +333,7 @@ impl RpcClient {
     ///     
     /// # Pagination
     /// * If `pagination_key` is `Some`, pass it into the **next** request to continue
-    /// * If `pagination_key` is `None`, ypu've reached the end
+    /// * If `pagination_key` is `None`, you've reached the end
     /// * Note that if there are fewer than `limit` accounts in a given page it does not imply the end; always check the cursor
     ///
     /// # Incremental Updates