Struct RpcImpl

pub struct RpcImpl<Mempool, State, Tip>
where
    Mempool: Service<Request, Response = Response, Error = BoxError> + Clone + Send + Sync + 'static,
    Mempool::Future: Send,
    State: Service<ReadRequest, Response = ReadResponse, Error = BoxError> + Clone + Send + Sync + 'static,
    State::Future: Send,
    Tip: ChainTip + Clone + Send + Sync + 'static,
{
    build_version: String,
    user_agent: String,
    network: Network,
    debug_force_finished_sync: bool,
    debug_like_zcashd: bool,
    mempool: Mempool,
    state: State,
    latest_chain_tip: Tip,
    queue_sender: Sender<UnminedTx>,
}

RPC method implementations.

Fields

build_version: String

Zebra’s application version, with build metadata.

user_agent: String

Zebra’s RPC user agent.

network: Network

The configured network for this RPC service.

debug_force_finished_sync: bool

Test-only option that makes Zebra say it is at the chain tip, no matter what the estimated height or local clock is.

debug_like_zcashd: bool

Test-only option that makes RPC responses more like zcashd.

mempool: Mempool

A handle to the mempool service.

state: State

A handle to the state service.

latest_chain_tip: Tip

Allows efficient access to the best tip of the blockchain.

queue_sender: Sender<UnminedTx>

A sender component of a channel used to send transactions to the mempool queue.

Implementations

impl<Mempool, State, Tip> RpcImpl<Mempool, State, Tip>

where Mempool: Service<Request, Response = Response, Error = BoxError> + Clone + Send + Sync + 'static, Mempool::Future: Send, State: Service<ReadRequest, Response = ReadResponse, Error = BoxError> + Clone + Send + Sync + 'static, State::Future: Send, Tip: ChainTip + Clone + Send + Sync + 'static,

pub fn new<VersionString, UserAgentString>( build_version: VersionString, user_agent: UserAgentString, network: Network, debug_force_finished_sync: bool, debug_like_zcashd: bool, mempool: Mempool, state: State, latest_chain_tip: Tip, ) -> (Self, JoinHandle<()>)

where VersionString: ToString + Clone + Send + 'static, UserAgentString: ToString + Clone + Send + 'static,

Create a new instance of the RPC handler.

Trait Implementations

impl<Mempool, State, Tip> Clone for RpcImpl<Mempool, State, Tip>

where Mempool: Service<Request, Response = Response, Error = BoxError> + Clone + Send + Sync + 'static + Clone, Mempool::Future: Send, State: Service<ReadRequest, Response = ReadResponse, Error = BoxError> + Clone + Send + Sync + 'static + Clone, State::Future: Send, Tip: ChainTip + Clone + Send + Sync + 'static + Clone,

fn clone(&self) -> RpcImpl<Mempool, State, Tip>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Mempool, State, Tip> Debug for RpcImpl<Mempool, State, Tip>

where Mempool: Service<Request, Response = Response, Error = BoxError> + Clone + Send + Sync + 'static, Mempool::Future: Send, State: Service<ReadRequest, Response = ReadResponse, Error = BoxError> + Clone + Send + Sync + 'static, State::Future: Send, Tip: ChainTip + Clone + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<Mempool, State, Tip> RpcServer for RpcImpl<Mempool, State, Tip>

where Mempool: Service<Request, Response = Response, Error = BoxError> + Clone + Send + Sync + 'static, Mempool::Future: Send, State: Service<ReadRequest, Response = ReadResponse, Error = BoxError> + Clone + Send + Sync + 'static, State::Future: Send, Tip: ChainTip + Clone + Send + Sync + 'static,

fn get_info(&self) -> Result<GetInfo>

Returns software information from the RPC server, as a GetInfo JSON struct.

fn get_blockchain_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetBlockChainInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns blockchain state information, as a GetBlockChainInfo JSON struct.

fn get_address_balance<'life0, 'async_trait>( &'life0 self, address_strings: AddressStrings, ) -> Pin<Box<dyn Future<Output = Result<AddressBalance>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the total balance of a provided addresses in an AddressBalance instance.

fn send_raw_transaction<'life0, 'async_trait>( &'life0 self, raw_transaction_hex: String, ) -> Pin<Box<dyn Future<Output = Result<SentTransactionHash>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends the raw bytes of a signed transaction to the local node’s mempool, if the transaction is valid. Returns the SentTransactionHash for the transaction, as a JSON string.

fn get_block<'life0, 'async_trait>( &'life0 self, hash_or_height: String, verbosity: Option<u8>, ) -> Pin<Box<dyn Future<Output = Result<GetBlock>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the requested block by hash or height, as a GetBlock JSON string. If the block is not in Zebra’s state, returns error code -8. if a height was passed or -5 if a hash was passed.

fn get_block_header<'life0, 'async_trait>( &'life0 self, hash_or_height: String, verbose: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<GetBlockHeader>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the requested block header by hash or height, as a GetBlockHeader JSON string. If the block is not in Zebra’s state, returns error code -8. if a height was passed or -5 if a hash was passed.

fn get_best_block_hash(&self) -> Result<GetBlockHash>

Returns the hash of the current best blockchain tip block, as a GetBlockHash JSON string.

fn get_best_block_height_and_hash(&self) -> Result<GetBlockHeightAndHash>

Returns the height and hash of the current best blockchain tip block, as a GetBlockHeightAndHash JSON struct.

fn get_raw_mempool<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns all transaction ids in the memory pool, as a JSON array.

fn get_raw_transaction<'life0, 'async_trait>( &'life0 self, txid: String, verbose: Option<u8>, ) -> Pin<Box<dyn Future<Output = Result<GetRawTransaction>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the raw transaction data, as a GetRawTransaction JSON string or structure.

fn z_get_treestate<'life0, 'async_trait>( &'life0 self, hash_or_height: String, ) -> Pin<Box<dyn Future<Output = Result<GetTreestate>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns information about the given block’s Sapling & Orchard tree state.

fn z_get_subtrees_by_index<'life0, 'async_trait>( &'life0 self, pool: String, start_index: NoteCommitmentSubtreeIndex, limit: Option<NoteCommitmentSubtreeIndex>, ) -> Pin<Box<dyn Future<Output = Result<GetSubtrees>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns information about a range of Sapling or Orchard subtrees.

fn get_address_tx_ids<'life0, 'async_trait>( &'life0 self, request: GetAddressTxIdsRequest, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the transaction ids made by the provided transparent addresses.

fn get_address_utxos<'life0, 'async_trait>( &'life0 self, address_strings: AddressStrings, ) -> Pin<Box<dyn Future<Output = Result<Vec<GetAddressUtxos>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns all unspent outputs for a list of addresses.

fn stop(&self) -> Result<String>

Stop the running zebrad process.

fn into_rpc(self) -> RpcModule<Self>

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.