Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): revise crate-level docs #88

Merged
merged 5 commits into from
Jan 7, 2024
Merged

chore(docs): revise crate-level docs #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3659fd3
chore(docs): revised crate-level docs
iTranscend Apr 25, 2022
fc5ca7c
Merge branch 'master' into feature/docs/crate-level-lib
iTranscend Apr 25, 2022
544b6c0
Merge branch 'master' into feature/docs/crate-level-lib
frol Dec 22, 2023
ea99eff
Merge branch 'master' into feature/docs/crate-level-lib
frol Dec 26, 2023
e5a2604
disabled examples testing that depend on archival RPC as it is flacky
frol Jan 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 62 additions & 72 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let testnet_client = JsonRpcClient::connect("https://rpc.testnet.near.org");
//! let client = JsonRpcClient::connect("https://rpc.testnet.near.org");
//!
//! let status_request = methods::status::RpcStatusRequest; // no params
//! let request = methods::status::RpcStatusRequest; // no params
//!
//! // call a method on the server via the connected client
//! let server_status = testnet_client.call(status_request).await?;
//! let server_status = client.call(request).await?;
//!
//! println!("{:?}", server_status);
//! # Ok(())
Expand All @@ -35,13 +35,13 @@
//!
//! 2. Query transaction status from mainnet RPC
//!
//! ```
//! ```no_run
//! use near_jsonrpc_client::{methods, JsonRpcClient};
//! use near_jsonrpc_primitives::types::transactions::TransactionInfo;
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
//! let mainnet_client = JsonRpcClient::connect("https://archival-rpc.mainnet.near.org");
//! let client = JsonRpcClient::connect("https://archival-rpc.mainnet.near.org");
//!
//! let tx_status_request = methods::tx::RpcTransactionStatusRequest {
//! transaction_info: TransactionInfo::TransactionId {
Expand All @@ -50,67 +50,12 @@
//! },
//! };
//!
//! let tx_status = mainnet_client.call(tx_status_request).await?;
//! let tx_status = client.call(tx_status_request).await?;
//!
//! println!("{:?}", tx_status);
//! # Ok(())
//! # }
//! ```
//!
//! 3. For all intents and purposes, the predefined structures in `methods` should suffice, if you find that they
//! don't or you crave extra flexibility, well, you can opt in to use the generic constructor `methods::any()` with the `any` feature flag.
//!
//! In this example, we retrieve only the parts from the genesis config response that we care about.
//!
//! ```toml
//! # in Cargo.toml
//! near-jsonrpc-client = { ..., features = ["any"] }
//! ```
//!
//! ```
//! use serde::Deserialize;
//! use serde_json::json;
//!
//! # use near_jsonrpc_client::errors::JsonRpcError;
//! use near_jsonrpc_client::{methods, JsonRpcClient};
//! use near_primitives::serialize::dec_format;
//! use near_primitives::types::*;
//!
//! #[derive(Debug, Deserialize)]
//! struct PartialGenesisConfig {
//! protocol_version: ProtocolVersion,
//! chain_id: String,
//! genesis_height: BlockHeight,
//! epoch_length: BlockHeightDelta,
//! #[serde(with = "dec_format")]
//! min_gas_price: Balance,
//! #[serde(with = "dec_format")]
//! max_gas_price: Balance,
//! #[serde(with = "dec_format")]
//! total_supply: Balance,
//! validators: Vec<AccountInfo>,
//! }
//!
//! impl methods::RpcHandlerResponse for PartialGenesisConfig {}
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), JsonRpcError<()>> {
//! let mainnet_client = JsonRpcClient::connect("https://rpc.mainnet.near.org");
//!
//! # #[cfg(feature = "any")] {
//! let genesis_config_request = methods::any::<Result<PartialGenesisConfig, ()>>(
//! "EXPERIMENTAL_genesis_config",
//! json!(null),
//! );
//!
//! let partial_genesis = mainnet_client.call(genesis_config_request).await?;
//!
//! println!("{:#?}", partial_genesis);
//! # }
//! # Ok(())
//! # }
//! ```

use std::{fmt, sync::Arc};

use lazy_static::lazy_static;
Expand Down Expand Up @@ -159,6 +104,29 @@ struct JsonRpcInnerClient {

#[derive(Clone)]
/// A NEAR JSON RPC Client.
///
/// This is the main struct that you will use to interact with the NEAR JSON RPC API.
///
/// ## Example
///
///```
/// use near_jsonrpc_client::{methods, JsonRpcClient};
/// use near_primitives::types::{BlockReference, Finality};
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = JsonRpcClient::connect("https://rpc.testnet.near.org");
///
/// let request = methods::block::RpcBlockRequest {
/// block_reference: BlockReference::Finality(Finality::Final),
/// };
///
/// let server_status = client.call(request).await?;
///
/// println!("{:?}", server_status);
/// # Ok(())
/// # }
/// ```
pub struct JsonRpcClient {
inner: Arc<JsonRpcInnerClient>,
headers: reqwest::header::HeaderMap,
Expand All @@ -175,29 +143,51 @@ impl JsonRpcClient {
/// ## Example
///
/// ```
/// use near_jsonrpc_client::{methods, JsonRpcClient};
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mainnet_client = JsonRpcClient::connect("https://rpc.testnet.near.org");
///
/// let status_request = methods::status::RpcStatusRequest;
/// let server_status = mainnet_client.call(status_request).await?;
/// use near_jsonrpc_client::JsonRpcClient;
///
/// println!("{:?}", server_status);
/// # Ok(())
/// # }
/// let client = JsonRpcClient::connect("https://rpc.testnet.near.org");
/// ```
pub fn connect<U: AsUrl>(server_addr: U) -> JsonRpcClient {
DEFAULT_CONNECTOR.connect(server_addr)
}

/// Get the server address the client connects to.
///
/// It basically returns the server address passed to `connect()`.
///
/// ## Example
///
/// ```
/// # use near_jsonrpc_client::JsonRpcClient;
/// let client = JsonRpcClient::connect("https://rpc.testnet.near.org");
///
/// assert_eq!(client.server_addr(), "https://rpc.testnet.near.org");
/// ```
pub fn server_addr(&self) -> &str {
&self.inner.server_addr
}

/// RPC method executor for the client.
///
/// ## Example
///
/// ```
/// use near_jsonrpc_client::{methods, JsonRpcClient};
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = JsonRpcClient::connect("https://rpc.testnet.near.org");
///
/// let request = methods::status::RpcStatusRequest;
/// let response = client.call(request).await?;
///
/// assert!(matches!(
/// response,
/// methods::status::RpcStatusResponse { .. }
/// ));
/// # Ok(())
/// # }
/// ```
pub async fn call<M>(&self, method: M) -> MethodCallResult<M::Response, M::Error>
where
M: methods::RpcMethod,
Expand Down
2 changes: 1 addition & 1 deletion src/methods/tx.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//! Returns the final transaction result for
//! <https://explorer.near.org/transactions/B9aypWiMuiWR5kqzewL9eC96uZWA3qCMhLe67eBMWacq>
//!
//! ```
//! ```no_run
//! use near_jsonrpc_client::{methods, JsonRpcClient};
//!
//! # #[tokio::main]
Expand Down
Loading