From 45841fcb807e384c2e21f411a68c8d2139c58c69 Mon Sep 17 00:00:00 2001
From: Evan <0xIchigo@protonmail.com>
Date: Wed, 1 May 2024 14:04:33 -0400
Subject: [PATCH] Better Documentation For error.rs

---
 src/error.rs | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/src/error.rs b/src/error.rs
index 6ae74a1..3dcbaaa 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -2,40 +2,81 @@ use reqwest::{Error as ReqwestError, StatusCode};
 use serde_json::Error as SerdeJsonError;
 use thiserror::Error;
 
+/// Represents all possible errors returned by the `Helius` client
+///
+/// This enum provides a detailed categorization of various error scenarios, ranging from network failures to data serialization issues
 #[derive(Debug, Error)]
 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
     #[error("Bad request to {path}: {text}")]
     BadRequest { path: String, text: String },
 
+    /// Represents errors that occur internally with Helius and our servers
+    ///
+    /// If the server encounters an unexpected condition that prevents it from fulfilling the request, this error is returned.
+    /// It includes the HTTP status code and a more detailed message about what went wrong.
+    /// If you are seeing this error continually, please reach out to Helius support.
     #[error("Internal server error: {code} - {text}")]
     InternalError { code: StatusCode, text: String },
 
+    /// Indicates that a required input was either missing or invalid.
+    ///
+    /// This error is used for scenarios where user input does not conform to expected values, such as an empty string for an API key
     #[error("Invalid input: {0}")]
     InvalidInput(String),
 
+    /// Covers general network failures
+    ///
+    /// This could range from DNS resolution failures, lost connections, issues with Solana, or any issue that prevents the client from reaching the server
     #[error("Network error: {0}")]
     Network(ReqwestError),
 
+    /// Indicates the requested resource was not found
+    ///
+    /// This error can occur if a specified identifier does not match any existing entities known to the server
     #[error("Not found: {text}")]
     NotFound { text: String },
 
+    /// Indicates too many requests are sent in a given amount of time
+    ///
+    /// This error includes the path to help identify a throttled request. Please visit https://docs.helius.dev/welcome/pricing-and-rate-limits to see all the
+    /// current rate limits for each standard plan
     #[error("Too many requests made to {path}")]
     RateLimitExceeded { path: String },
 
+    /// Indicates an error from the underlying HTTP client (i.e., reqwest)
+    ///
+    /// This captures errors from the `reqwest` library specifically
     #[error("Request error: {0}")]
     ReqwestError(ReqwestError),
 
+    /// Occurs during the serialization or deserialization of JSON data
+    ///
+    /// If the JSON data cannot be encoded or decoded, this error will be thrown, typically indicating an issue with the data structure
+    ///
     #[error("Serialization / Deserialization error: {0}")]
     SerdeJson(SerdeJsonError),
 
+    /// Indicates the request lacked valid authentication credentials
+    ///
+    /// This error is returned in response to a missing, invalid, or expired API key
     #[error("Unauthorized access to {path}: {text}")]
     Unauthorized { path: String, text: String },
 
+    /// A fallback error used when an unexpected or uncategorized issue occurs
+    ///
+    /// This error includes the HTTP status code and message to help with debugging, acting as a generic catch-all for all other errors
     #[error("Unknown error has occurred: HTTP {code} - {text}")]
     Unknown { code: StatusCode, text: String },
 }
 
 impl HeliusError {
+    /// Converts a `StatusCode` and message into the appropriate `HeliusError`
+    ///
+    /// This utility function helps map HTTP status codes to the more specific errors detailed in this enum
     pub fn from_response_status(status: StatusCode, path: String, text: String) -> Self {
         match status {
             StatusCode::BAD_REQUEST => HeliusError::BadRequest { path, text },
@@ -49,10 +90,13 @@ impl HeliusError {
 }
 
 impl From<SerdeJsonError> for HeliusError {
+    /// Converts a `SerdeJsonError` into a `HeliusError`
+    ///
+    /// This allows for the seamless integration of JSON parsing errors into the broader error handling system
     fn from(err: SerdeJsonError) -> HeliusError {
         HeliusError::SerdeJson(err)
     }
 }
 
-// Handy type alias
+/// A handy type alias for handling results across the Helius SDK
 pub type Result<T> = std::result::Result<T, HeliusError>;