Skip to content

Commit

Permalink
include missing docs due to ci errors
Browse files Browse the repository at this point in the history
  • Loading branch information
thetheveloper committed Aug 3, 2024
1 parent 5457f28 commit ec92d77
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions starknet-providers/src/jsonrpc/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,13 @@ pub enum JsonRpcMethod {
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum JsonRpcRequestParams<'a> {
/// Parameters for getting a block with transaction hashes.
GetBlockWithTxHashes(GetBlockWithTxHashesRequestRef<'a>),
/// Parameters for getting a block with full transactions.
GetBlockWithTxs(GetBlockWithTxsRequestRef<'a>),
}

/// Represents a JSON-RPC request with a unique identifier.
#[derive(Debug, Clone)]
pub struct JsonRpcRequest {
/// ID of the request. Useful for identifying responses in certain transports like `WebSocket`.
Expand Down
1 change: 1 addition & 0 deletions starknet-providers/src/jsonrpc/transports/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ pub trait JsonRpcTransport {
P: Serialize + Send + Sync,
R: DeserializeOwned;

/// Sends multiple JSON-RPC requests and retrieves their responses.
async fn send_requests<I, P, R>(
&self,
requests: I,
Expand Down
2 changes: 2 additions & 0 deletions starknet-providers/src/provider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ use std::{any::Any, error::Error, fmt::Debug};
/// in practice, as public sequencer servers have generally block access to most methods.
use crate::jsonrpc::JsonRpcMethod;

/// Represents a provider interface for interacting with the Starknet network.
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[auto_impl(&, Box, Arc)]
Expand Down Expand Up @@ -335,6 +336,7 @@ pub trait Provider {
I: IntoIterator<Item = (JsonRpcMethod, P)> + Send + Sync,
P: Serialize + Send + Sync;

/// Retrieves blocks information with transaction hashes for a batch of block IDs.
async fn get_block_with_tx_hashes_batch<B>(
&self,
block_ids: Vec<B>,
Expand Down

0 comments on commit ec92d77

Please sign in to comment.