Struct RpcImpl 

pub struct RpcImpl<Mempool, State, ReadState, Tip, AddressBook, BlockVerifierRouter, SyncStatus>
where
    Mempool: MempoolService,
    State: StateService,
    ReadState: ReadStateService,
    Tip: ChainTip + Clone + Send + Sync + 'static,
    AddressBook: AddressBookPeers + Clone + Send + Sync + 'static,
    BlockVerifierRouter: BlockVerifierService,
    SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static,
{

    build_version: String,
    user_agent: String,
    network: Network,
    debug_force_finished_sync: bool,
    end_of_support_height: Option<Height>,
    max_address_query_results: usize,
    mempool: Mempool,
    state: State,
    read_state: ReadState,
    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.

end_of_support_height: Option<Height>

The estimated last height this node release supports before its end of support halt, if end of support is enforced on network. Reported by the getdeprecationinfo RPC.

max_address_query_results: usize

The maximum number of results the address RPCs return before rejecting the query.

mempool: Mempool

A handle to the mempool service.

state: State

A handle to the state service.

read_state: ReadState

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, ReadState, Tip, AddressBook, BlockVerifierRouter, SyncStatus> RpcImpl<Mempool, State, ReadState, Tip, AddressBook, BlockVerifierRouter, SyncStatus>

where Mempool: MempoolService, State: StateService, ReadState: ReadStateService, Tip: ChainTip + Clone + Send + Sync + 'static, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static, BlockVerifierRouter: BlockVerifierService, 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, read_state: ReadState, 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.

fn template_clock_now(&self) -> DateTime32

Reads wall time for template deadlines and serve-time timestamp validation.

pub fn spawn_block_template_updater(&self) -> Option<JoinHandle<()>>

Spawns a task that keeps a block template for the current chain tip precomputed, so getblocktemplate calls only validate the tip against the state instead of reading the mempool, selecting transactions, and building a coinbase transaction.

Returns None if mining isn’t configured.

async fn precomputed_block_template( &self, client_long_poll_id: Option<LongPollId>, long_poll_started: DateTime32, ) -> Option<BlockTemplateResponse>

Returns the block template that Self::spawn_block_template_updater() keeps precomputed, if it extends the current chain tip, and if it isn’t the template the client already has.

The precomputed template’s mempool transactions can be a few seconds old, which only costs the miner the fees of the transactions that arrived in the meantime, and the next call picks them up. But it always extends the current tip, so miners never work on a chain that Zebra has already seen a block for.

A long polling client waits here until the updater publishes a template it doesn’t have yet, the chain tip changes, or its timestamp range expires during this request.

Correctness

Long polling must not fall through to the synchronous path below while this cache is serving. That path derives its own long poll ID from a fresh state and mempool read, so with two independent ID sources neither side ever matches the other: the client alternates between a cached template and a freshly built one, each call returning immediately, and it never waits. Its work is cancelled on every response, so it mines nothing.

Returns None if there is no updater task, if it hasn’t caught up with a recent chain tip change, or if the chain tip channel closed.

async fn precomputed_template_for_state_tip( &self, cache: &TemplateCache, ) -> Option<Arc<BlockTemplateResponse>>

Returns the precomputed template, if it extends the tip the state has committed.

Waits up to precompute::new_tip_timeout() for the updater task to catch up with a recent tip change, re-reading the tip every time it publishes.

pub fn network(&self) -> &Network

Returns a reference to the configured network.

pub fn with_end_of_support_height( self, end_of_support_height: Option<Height>, ) -> Self

Sets the estimated end of support height reported by the getdeprecationinfo RPC.

When unset, or set to None, getdeprecationinfo omits the end_of_service object.

Trait Implementations

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

where Mempool: MempoolService + Clone, State: StateService + Clone, ReadState: ReadStateService + Clone, Tip: ChainTip + Clone + Send + Sync + 'static + Clone, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static + Clone, BlockVerifierRouter: BlockVerifierService + Clone, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where Mempool: MempoolService, State: StateService, ReadState: ReadStateService, Tip: ChainTip + Clone + Send + Sync + 'static, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static, BlockVerifierRouter: BlockVerifierService, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static,

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

Formats the value using the given formatter.

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

where Mempool: MempoolService, State: StateService, ReadState: ReadStateService, Tip: ChainTip + Clone + Send + Sync + 'static, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static, BlockVerifierRouter: BlockVerifierService, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static,

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

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

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

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

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

Returns end of support information for this node release, as a GetDeprecationInfoResponse JSON struct.

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

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

Returns blockchain state information, as a GetBlockchainInfoResponse JSON struct.

fn get_address_balance<'life0, 'async_trait>( &'life0 self, address_strings: GetAddressBalanceRequest, ) -> Pin<Box<dyn Future<Output = Result<GetAddressBalanceResponse>> + 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<SendRawTransactionResponse>> + 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<GetBlockResponse>> + 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<GetBlockHeaderResponse>> + 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<GetBlockHashResponse>

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

fn get_best_block_height_and_hash( &self, ) -> Result<GetBlockHeightAndHashResponse>

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

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

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

Returns details on the active state of the TX memory pool.

fn get_raw_mempool<'life0, 'async_trait>( &'life0 self, verbose: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<GetRawMempoolResponse>> + 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>, block_hash: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<GetRawTransactionResponse>> + 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<GetTreestateResponse>> + 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<GetSubtreesByIndexResponse>> + 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, utxos_request: GetAddressUtxosRequest, ) -> Pin<Box<dyn Future<Output = Result<GetAddressUtxosResponse>> + 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<GetBlockHashResponse>> + 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<GetBlockTemplateParameters>, ) -> Pin<Box<dyn Future<Output = Result<GetBlockTemplateResponse>> + 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<SubmitBlockParameters>, ) -> Pin<Box<dyn Future<Output = Result<SubmitBlockResponse>> + Send + 'async_trait>>

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

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

fn get_mining_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetMiningInfoResponse>> + 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_network_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetNetworkInfoResponse>> + Send + 'async_trait>>

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

Returns an object containing various state info regarding P2P networking.

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 ping<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Requests that a ping be sent to all other nodes, to measure ping time.

fn validate_address<'life0, 'async_trait>( &'life0 self, raw_address: String, ) -> Pin<Box<dyn Future<Output = Result<ValidateAddressResponse>> + 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<ZValidateAddressResponse>> + 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_standard_fee<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetStandardFeeResponse>> + Send + 'async_trait>>

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

Returns the recommended standard fee per logical action, in zatoshis.

fn get_block_subsidy<'life0, 'async_trait>( &'life0 self, height: Option<u32>, ) -> Pin<Box<dyn Future<Output = Result<GetBlockSubsidyResponse>> + 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. Once NSM reissuance starts, the preceding block must exist: future reserves cannot be forecast.

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<ZListUnifiedReceiversResponse>> + Send + 'async_trait>>

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

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

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

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

Invalidates a block if it is not yet finalized, removing it from the non-finalized state if it is present and rejecting it during contextual validation if it is submitted.

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

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

Reconsiders a previously invalidated block if it exists in the cache of previously invalidated blocks.

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

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

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

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

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

Mine blocks immediately, paying the coinbase to address. Returns the block hashes of the generated blocks.

fn add_node<'life0, 'async_trait>( &'life0 self, addr: PeerSocketAddr, command: AddNodeCommand, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Add or remove a node from the address book.

fn openrpc(&self) -> Response

Returns an OpenRPC schema as a description of this service.

fn get_tx_out<'life0, 'async_trait>( &'life0 self, txid: String, n: u32, include_mempool: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<GetTxOutResponse>> + Send + 'async_trait>>

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

Returns details about an unspent transaction output.

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.

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.