Struct zaino_serve::rpc::GrpcClient

pub struct GrpcClient {
    pub lightwalletd_uri: Uri,
    pub zebrad_uri: Uri,
    pub online: Arc<AtomicBool>,
}

Configuration data for gRPC server.

Fields

lightwalletd_uri: Uri

Lightwalletd uri. Used by grpc_passthrough to pass on unimplemented RPCs.

zebrad_uri: Uri

Zebrad uri.

online: Arc<AtomicBool>

Represents the Online status of the gRPC server.

Trait Implementations

impl Clone for GrpcClient

fn clone(&self) -> GrpcClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompactTxStreamer for GrpcClient

fn get_latest_block<'life0, 'async_trait>( &'life0 self, _request: Request<ChainSpec>, ) -> Pin<Box<dyn Future<Output = Result<Response<BlockId>, Status>> + Send + 'async_trait>>

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

Return the height of the tip of the best chain.

fn get_block<'life0, 'async_trait>( &'life0 self, request: Request<BlockId>, ) -> Pin<Box<dyn Future<Output = Result<Response<CompactBlock>, Status>> + Send + 'async_trait>>

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

Return the compact block corresponding to the given block identifier.

TODO: This implementation is slow. An internal block cache should be implemented that this rpc, along with the get_block rpc, can rely on. - add get_block function that queries the block cache / internal state for block and calls get_block_from_node to fetch block if not present. - use chain height held in internal state to validate block height being requested.

fn get_block_nullifiers<'life0, 'async_trait>( &'life0 self, request: Request<BlockId>, ) -> Pin<Box<dyn Future<Output = Result<Response<CompactBlock>, Status>> + Send + 'async_trait>>

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

Same as GetBlock except actions contain only nullifiers.

NOTE: This should be reimplemented with the introduction of the BlockCache. - use chain height held in internal state to validate block height being requested.

type GetBlockRangeStream = Pin<Box<CompactBlockStream>>

Server streaming response type for the GetBlockRange method. Server streaming response type for the GetBlockRange method.

fn get_block_range<'life0, 'async_trait>( &'life0 self, request: Request<BlockRange>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetBlockRangeStream>, Status>> + Send + 'async_trait>>

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

Return a list of consecutive compact blocks.

TODO: This implementation is slow. An internal block cache should be implemented that this rpc, along with the get_block rpc, can rely on. - add get_block function that queries the block cache for block and calls get_block_from_node to fetch block if not present. - use chain height held in internal state to validate block height being requested.

type GetBlockRangeNullifiersStream = Pin<Box<CompactBlockStream>>

Server streaming response type for the GetBlockRangeNullifiers method. Server streaming response type for the GetBlockRangeNullifiers method.

fn get_block_range_nullifiers<'life0, 'async_trait>( &'life0 self, request: Request<BlockRange>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetBlockRangeNullifiersStream>, Status>> + Send + 'async_trait>>

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

Same as GetBlockRange except actions contain only nullifiers.

NOTE: This should be reimplemented with the introduction of the BlockCache. - use chain height held in internal state to validate block height being requested.

fn get_transaction<'life0, 'async_trait>( &'life0 self, request: Request<TxFilter>, ) -> Pin<Box<dyn Future<Output = Result<Response<RawTransaction>, Status>> + Send + 'async_trait>>

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

Return the requested full (not compact) transaction (as from zcashd).

fn send_transaction<'life0, 'async_trait>( &'life0 self, request: Request<RawTransaction>, ) -> Pin<Box<dyn Future<Output = Result<Response<SendResponse>, Status>> + Send + 'async_trait>>

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

Submit the given transaction to the Zcash network.

type GetTaddressTxidsStream = Pin<Box<RawTransactionStream>>

Server streaming response type for the GetTaddressTxids method. Server streaming response type for the GetTaddressTxids method.

fn get_taddress_txids<'life0, 'async_trait>( &'life0 self, request: Request<TransparentAddressBlockFilter>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetTaddressTxidsStream>, Status>> + Send + 'async_trait>>

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

This name is misleading, returns the full transactions that have either inputs or outputs connected to the given transparent address.

fn get_taddress_balance<'life0, 'async_trait>( &'life0 self, request: Request<AddressList>, ) -> Pin<Box<dyn Future<Output = Result<Response<Balance>, Status>> + Send + 'async_trait>>

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

Returns the total balance for a list of taddrs

fn get_taddress_balance_stream<'life0, 'async_trait>( &'life0 self, request: Request<Streaming<Address>>, ) -> Pin<Box<dyn Future<Output = Result<Response<Balance>, Status>> + Send + 'async_trait>>

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

Returns the total balance for a list of taddrs

type GetMempoolTxStream = Pin<Box<CompactTransactionStream>>

Server streaming response type for the GetMempoolTx method. Server streaming response type for the GetMempoolTx method.

fn get_mempool_tx<'life0, 'async_trait>( &'life0 self, request: Request<Exclude>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetMempoolTxStream>, Status>> + Send + 'async_trait>>

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

Return the compact transactions currently in the mempool; the results can be a few seconds out of date. If the Exclude list is empty, return all transactions; otherwise return all except those in the Exclude list (if any); this allows the client to avoid receiving transactions that it already has (from an earlier call to this rpc). The transaction IDs in the Exclude list can be shortened to any number of bytes to make the request more bandwidth-efficient; if two or more transactions in the mempool match a shortened txid, they are all sent (none is excluded). Transactions in the exclude list that don’t exist in the mempool are ignored.

NOTE: This implementation is slow and should be re-implemented with the addition of the internal mempool and blockcache.

type GetMempoolStreamStream = Pin<Box<RawTransactionStream>>

Server streaming response type for the GetMempoolStream method. Server streaming response type for the GetMempoolStream method.

fn get_mempool_stream<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetMempoolStreamStream>, Status>> + Send + 'async_trait>>

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

Return a stream of current Mempool transactions. This will keep the output stream open while there are mempool transactions. It will close the returned stream when a new block is mined.

TODO: This implementation is slow. Zingo-Indexer’s blockcache state engine should keep its own internal mempool state. - This RPC should query Zingo-Indexer’s internal mempool state rather than creating its own mempool and directly querying zebrad.

fn get_tree_state<'life0, 'async_trait>( &'life0 self, request: Request<BlockId>, ) -> Pin<Box<dyn Future<Output = Result<Response<TreeState>, Status>> + Send + 'async_trait>>

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

GetTreeState returns the note commitment tree state corresponding to the given block. See section 3.7 of the Zcash protocol specification. It returns several other useful values also (even though they can be obtained using GetBlock). The block can be specified by either height or hash.

TODO: This is slow. Chain, along with other blockchain info should be saved on startup and used here [blockcache?].

fn get_latest_tree_state<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<TreeState>, Status>> + Send + 'async_trait>>

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

GetLatestTreeState returns the note commitment tree state corresponding to the chain tip.

TODO: This is slow. Chain, along with other blockchain info should be saved on startup and used here [blockcache?].

type GetSubtreeRootsStream = Pin<Box<SubtreeRootReplyStream>>

Server streaming response type for the GetSubtreeRoots method. Server streaming response type for the GetSubtreeRoots method.

fn get_subtree_roots<'life0, 'async_trait>( &'life0 self, request: Request<GetSubtreeRootsArg>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetSubtreeRootsStream>, Status>> + Send + 'async_trait>>

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

Returns a stream of information about roots of subtrees of the Sapling and Orchard note commitment trees.

fn get_address_utxos<'life0, 'async_trait>( &'life0 self, request: Request<GetAddressUtxosArg>, ) -> Pin<Box<dyn Future<Output = Result<Response<GetAddressUtxosReplyList>, Status>> + Send + 'async_trait>>

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

Returns all unspent outputs for a list of addresses.

Ignores all utxos below block height [GetAddressUtxosArg.start_height]. Returns max [GetAddressUtxosArg.max_entries] utxos, or unrestricted if [GetAddressUtxosArg.max_entries] = 0. Utxos are collected and returned as a single Vec.

type GetAddressUtxosStreamStream = Pin<Box<UtxoReplyStream>>

Server streaming response type for the GetAddressUtxosStream method. Server streaming response type for the GetAddressUtxosStream method.

fn get_address_utxos_stream<'life0, 'async_trait>( &'life0 self, request: Request<GetAddressUtxosArg>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::GetAddressUtxosStreamStream>, Status>> + Send + 'async_trait>>

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

Returns all unspent outputs for a list of addresses.

Ignores all utxos below block height [GetAddressUtxosArg.start_height]. Returns max [GetAddressUtxosArg.max_entries] utxos, or unrestricted if [GetAddressUtxosArg.max_entries] = 0. Utxos are returned in a stream.

fn get_lightd_info<'life0, 'async_trait>( &'life0 self, _request: Request<Empty>, ) -> Pin<Box<dyn Future<Output = Result<Response<LightdInfo>, Status>> + Send + 'async_trait>>

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

Return information about this lightwalletd instance and the blockchain

fn ping<'life0, 'async_trait>( &'life0 self, _request: Request<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Response<PingResponse>, Status>> + Send + 'async_trait>>

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

Testing-only, requires lightwalletd –ping-very-insecure (do not enable in production) [from zebrad] This RPC has not been implemented as it is not currently used by zingolib. If you require this RPC please open an issue or PR at the Zingo-Indexer github (https://github.com/zingolabs/zingo-indexer).

impl Debug for GrpcClient

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

Formats the value using the given formatter.