update robust provider docs

Author: 0xNeshi

src/robust_provider/provider.rs

@@ -42,6 +42,8 @@ impl<N: Network> RobustProvider<N> {
 
     /// Fetch a block by [`BlockNumberOrTag`] with retry and timeout.
     ///
+    /// This is a wrapper function for [`Provider::get_block_by_number`].
+    ///
     /// # Errors
     ///
     /// See [retry errors](#retry-errors).
@@ -65,6 +67,8 @@ impl<N: Network> RobustProvider<N> {
 
     /// Fetch a block number by [`BlockId`]  with retry and timeout.
     ///
+    /// This is a wrapper function for [`Provider::get_block`].
+    ///
     /// # Errors
     ///
     /// See [retry errors](#retry-errors).
@@ -81,6 +85,8 @@ impl<N: Network> RobustProvider<N> {
 
     /// Fetch the latest block number with retry and timeout.
     ///
+    /// This is a wrapper function for [`Provider::get_block_number`].
+    ///
     /// # Errors
     ///
     /// See [retry errors](#retry-errors).
@@ -100,21 +106,27 @@ impl<N: Network> RobustProvider<N> {
 
     /// Get the block number for a given block identifier.
     ///
+    /// This is a wrapper function for [`Provider::get_block_number_by_id`].
+    ///
+    /// # Arguments
+    ///
+    /// * `block_id` - The block identifier to fetch the block number for.
+    ///
     /// # Errors
     ///
     /// See [retry errors](#retry-errors).
-    pub async fn get_block_number_by_id(&self, id: BlockId) -> Result<u64, Error> {
+    pub async fn get_block_number_by_id(&self, block_id: BlockId) -> Result<u64, Error> {
         info!("get_block_number_by_id called");
         let result = self
             .retry_with_total_timeout(
-                move |provider| async move { provider.get_block_number_by_id(id).await },
+                move |provider| async move { provider.get_block_number_by_id(block_id).await },
                 false,
             )
             .await;
         if let Err(e) = &result {
             error!(error = %e, "get_block_number_by_id failed");
         }
-        result?.ok_or_else(|| Error::BlockNotFound(id))
+        result?.ok_or_else(|| Error::BlockNotFound(block_id))
     }
 
     /// Fetch the latest confirmed block number with retry and timeout.
@@ -139,6 +151,8 @@ impl<N: Network> RobustProvider<N> {
 
     /// Fetch a block by [`BlockHash`] with retry and timeout.
     ///
+    /// This is a wrapper function for [`Provider::get_block_by_hash`].
+    ///
     /// # Errors
     ///
     /// See [retry errors](#retry-errors).
@@ -159,6 +173,8 @@ impl<N: Network> RobustProvider<N> {
 
     /// Fetch logs for the given [`Filter`] with retry and timeout.
     ///
+    /// This is a wrapper function for [`Provider::get_logs`].
+    ///
     /// # Errors
     ///
     /// See [retry errors](#retry-errors).
@@ -178,6 +194,8 @@ impl<N: Network> RobustProvider<N> {
 
     /// Subscribe to new block headers with retry and timeout.
     ///
+    /// This is a wrapper function for [`Provider::subscribe_blocks`].
+    ///
     /// # Errors
     ///
     /// see [retry errors](#retry-errors).