Skip to main content

RpcClient

Struct RpcClient 

Source
pub struct RpcClient { /* private fields */ }
Expand description

Low-level JSON-RPC client for NEAR.

Implementations§

Source§

impl RpcClient

Source

pub fn new(url: impl Into<String>) -> Self

Create a new RPC client with the given URL.

Source

pub fn with_retry_config( url: impl Into<String>, retry_config: RetryConfig, ) -> Self

Create a new RPC client with custom retry configuration.

Source

pub fn url(&self) -> &str

Get the RPC URL.

Source

pub async fn call<P: Serialize, R: DeserializeOwned>( &self, method: &str, params: P, ) -> Result<R, RpcError>

Make a raw RPC call with retries.

Source

pub async fn view_account( &self, account_id: &AccountId, block: BlockReference, ) -> Result<AccountView, RpcError>

View account information.

Source

pub async fn view_access_key( &self, account_id: &AccountId, public_key: &PublicKey, block: BlockReference, ) -> Result<AccessKeyView, RpcError>

View access key information.

Source

pub async fn view_access_key_list( &self, account_id: &AccountId, block: BlockReference, ) -> Result<AccessKeyListView, RpcError>

View all access keys for an account.

Source

pub async fn view_function( &self, account_id: &AccountId, method_name: &str, args: &[u8], block: BlockReference, ) -> Result<ViewFunctionResult, RpcError>

Call a view function on a contract.

Source

pub async fn block(&self, block: BlockReference) -> Result<BlockView, RpcError>

Get block information.

Source

pub async fn status(&self) -> Result<StatusResponse, RpcError>

Get node status.

Source

pub async fn gas_price( &self, block_hash: Option<&CryptoHash>, ) -> Result<GasPrice, RpcError>

Get current gas price.

Source

pub async fn send_tx( &self, signed_tx: &SignedTransaction, wait_until: TxExecutionStatus, ) -> Result<SendTxResponse, RpcError>

Send a signed transaction.

Source

pub async fn tx_status( &self, tx_hash: &CryptoHash, sender_id: &AccountId, wait_until: TxExecutionStatus, ) -> Result<SendTxWithReceiptsResponse, RpcError>

Get transaction status with full receipt details.

Uses EXPERIMENTAL_tx_status which returns complete receipt information.

Source

pub async fn sandbox_patch_state(&self, records: Value) -> Result<(), RpcError>

Patch account state in sandbox.

This is a sandbox-only method that allows modifying account state directly, useful for testing scenarios that require specific account configurations (e.g., setting a high balance for staking tests).

§Arguments
  • records - State records to patch (Account, Data, Contract, AccessKey, etc.)
§Example
// Set account balance to 1M NEAR
rpc.sandbox_patch_state(serde_json::json!([
    {
        "Account": {
            "account_id": "alice.sandbox",
            "account": {
                "amount": "1000000000000000000000000000000",
                "locked": "0",
                "code_hash": "11111111111111111111111111111111",
                "storage_usage": 182
            }
        }
    }
])).await?;

Trait Implementations§

Source§

impl Clone for RpcClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RpcClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more