Struct monero_serai::rpc::Rpc

pub struct Rpc<R: RpcConnection>(/* private fields */);

Implementations

impl<R: RpcConnection> Rpc<R>

pub async fn rpc_call<Params: Serialize + Debug, Response: DeserializeOwned + Debug>( &self, route: &str, params: Option<Params>, ) -> Result<Response, RpcError>

Perform a RPC call to the specified route with the provided parameters.

This is NOT a JSON-RPC call. They use a route of “json_rpc” and are available via json_rpc_call.

pub async fn json_rpc_call<Response: DeserializeOwned + Debug>( &self, method: &str, params: Option<Value>, ) -> Result<Response, RpcError>

Perform a JSON-RPC call with the specified method with the provided parameters

pub async fn bin_call( &self, route: &str, params: Vec<u8>, ) -> Result<Vec<u8>, RpcError>

Perform a binary call to the specified route with the provided parameters.

pub async fn get_protocol(&self) -> Result<Protocol, RpcError>

Get the active blockchain protocol version.

pub async fn get_height(&self) -> Result<usize, RpcError>

pub async fn get_transactions( &self, hashes: &[[u8; 32]], ) -> Result<Vec<Transaction>, RpcError>

pub async fn get_transaction( &self, tx: [u8; 32], ) -> Result<Transaction, RpcError>

pub async fn get_block_hash(&self, number: usize) -> Result<[u8; 32], RpcError>

Get the hash of a block from the node by the block’s numbers. This function does not verify the returned block hash is actually for the number in question.

pub async fn get_block(&self, hash: [u8; 32]) -> Result<Block, RpcError>

Get a block from the node by its hash. This function does not verify the returned block actually has the hash in question.

pub async fn get_block_by_number( &self, number: usize, ) -> Result<Block, RpcError>

pub async fn get_block_transactions( &self, hash: [u8; 32], ) -> Result<Vec<Transaction>, RpcError>

pub async fn get_block_transactions_by_number( &self, number: usize, ) -> Result<Vec<Transaction>, RpcError>

pub async fn get_o_indexes(&self, hash: [u8; 32]) -> Result<Vec<u64>, RpcError>

Get the output indexes of the specified transaction.

pub async fn get_output_distribution( &self, from: usize, to: usize, ) -> Result<Vec<u64>, RpcError>

Get the output distribution, from the specified height to the specified height (both inclusive).

pub async fn get_outs( &self, indexes: &[u64], ) -> Result<Vec<OutputResponse>, RpcError>

Get the specified outputs from the RingCT (zero-amount) pool

pub async fn get_unlocked_outputs( &self, indexes: &[u64], height: usize, fingerprintable_canonical: bool, ) -> Result<Vec<Option<[EdwardsPoint; 2]>>, RpcError>

Get the specified outputs from the RingCT (zero-amount) pool, but only return them if their timelock has been satisfied.

The timelock being satisfied is distinct from being free of the 10-block lock applied to all Monero transactions.

pub async fn get_fee( &self, protocol: Protocol, priority: FeePriority, ) -> Result<Fee, RpcError>

Get the currently estimated fee from the node.

This may be manipulated to unsafe levels and MUST be sanity checked.

pub async fn publish_transaction( &self, tx: &Transaction, ) -> Result<(), RpcError>

pub async fn generate_blocks( &self, address: &str, block_count: usize, ) -> Result<(Vec<[u8; 32]>, usize), RpcError>

Trait Implementations

impl<R: Clone + RpcConnection> Clone for Rpc<R>

fn clone(&self) -> Rpc<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug + RpcConnection> Debug for Rpc<R>

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

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.