Struct RpcImpl

pub struct RpcImpl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus>
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,
    AddressBook: AddressBookPeers + Clone + Send + Sync + 'static,
    BlockVerifierRouter: Service<Request, Response = Hash, Error = BoxError> + Clone + Send + Sync + 'static,
    <BlockVerifierRouter as Service<Request>>::Future: Send,
    SyncStatus: ChainSyncStatus + 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>,
    address_book: AddressBook,
    last_warn_error_log_rx: LoggedLastEvent,
    gbt: GetBlockTemplateHandler<BlockVerifierRouter, SyncStatus>,
}

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.

address_book: AddressBook

Peer address book.

last_warn_error_log_rx: LoggedLastEvent

The last warning or error event logged by the server.

gbt: GetBlockTemplateHandler<BlockVerifierRouter, SyncStatus>

Handler for the getblocktemplate RPC.

Implementations

impl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus> RpcImpl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus>

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, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static, BlockVerifierRouter: Service<Request, Response = Hash, Error = BoxError> + Clone + Send + Sync + 'static, <BlockVerifierRouter as Service<Request>>::Future: Send, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static,

pub fn new<VersionString, UserAgentString>( network: Network, mining_config: Config, debug_force_finished_sync: bool, build_version: VersionString, user_agent: UserAgentString, mempool: Mempool, state: State, block_verifier_router: BlockVerifierRouter, sync_status: SyncStatus, latest_chain_tip: Tip, address_book: AddressBook, last_warn_error_log_rx: LoggedLastEvent, mined_block_sender: Option<Sender<(Hash, Height)>>, ) -> (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, AddressBook, BlockVerifierRouter, SyncStatus> Clone for RpcImpl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus>

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, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static + Clone, BlockVerifierRouter: Service<Request, Response = Hash, Error = BoxError> + Clone + Send + Sync + 'static + Clone, <BlockVerifierRouter as Service<Request>>::Future: Send, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus> Debug for RpcImpl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus>

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, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static, BlockVerifierRouter: Service<Request, Response = Hash, Error = BoxError> + Clone + Send + Sync + 'static, <BlockVerifierRouter as Service<Request>>::Future: Send, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus> RpcServer for RpcImpl<Mempool, State, Tip, AddressBook, BlockVerifierRouter, SyncStatus>

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, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static, BlockVerifierRouter: Service<Request, Response = Hash, Error = BoxError> + Clone + Send + Sync + 'static, <BlockVerifierRouter as Service<Request>>::Future: Send, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static,

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

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

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, _allow_high_fees: Option<bool>, ) -> 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, verbose: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<GetRawMempool>> + 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 get_block_count(&self) -> Result<u32>

Returns the height of the most recent block in the best valid block chain (equivalently, the number of blocks in this chain excluding the genesis block).

fn get_block_hash<'life0, 'async_trait>( &'life0 self, index: i32, ) -> Pin<Box<dyn Future<Output = Result<GetBlockHash>> + Send + 'async_trait>>

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

Returns the hash of the block of a given height iff the index argument correspond to a block in the best chain.

fn get_block_template<'life0, 'async_trait>( &'life0 self, parameters: Option<JsonParameters>, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

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

Returns a block template for mining new Zcash blocks.

fn submit_block<'life0, 'async_trait>( &'life0 self, __arg1: HexData, _parameters: Option<JsonParameters>, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

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

Submits block to the node to be validated and committed. Returns the submit_block::Response for the operation, as a JSON string.

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

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

Returns mining-related information.

fn get_network_sol_ps<'life0, 'async_trait>( &'life0 self, num_blocks: Option<i32>, height: Option<i32>, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

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

Returns the estimated network solutions per second based on the last num_blocks before height.

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

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

Returns data about each connected network node.

fn validate_address<'life0, 'async_trait>( &'life0 self, raw_address: String, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

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

Checks if a zcash transparent address of type P2PKH, P2SH or TEX is valid. Returns information about the given address if valid.

fn z_validate_address<'life0, 'async_trait>( &'life0 self, raw_address: String, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

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

Checks if a zcash address of type P2PKH, P2SH, TEX, SAPLING or UNIFIED is valid. Returns information about the given address if valid.

fn get_block_subsidy<'life0, 'async_trait>( &'life0 self, height: Option<u32>, ) -> Pin<Box<dyn Future<Output = Result<BlockSubsidy>> + Send + 'async_trait>>

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

Returns the block subsidy reward of the block at height, taking into account the mining slow start. Returns an error if height is less than the height of the first halving for the current network.

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

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

Returns the proof-of-work difficulty as a multiple of the minimum difficulty.

fn z_list_unified_receivers<'life0, 'async_trait>( &'life0 self, address: String, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

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

Returns the list of individual payment addresses given a unified address.

fn generate<'life0, 'async_trait>( &'life0 self, num_blocks: u32, ) -> Pin<Box<dyn Future<Output = Result<Vec<GetBlockHash>>> + Send + 'async_trait>>

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

Mine blocks immediately. Returns the block hashes of the generated blocks.

fn get_network_hash_ps<'life0, 'async_trait>( &'life0 self, num_blocks: Option<i32>, height: Option<i32>, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

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

Returns the estimated network solutions per second based on the last num_blocks before height.

fn into_rpc(self) -> RpcModule<Self>

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