Struct CompactTxStreamerClient 

pub struct CompactTxStreamerClient<T> { /* private fields */ }

Available on crate feature lightwalletd-tonic only.

Implementations

impl<T> CompactTxStreamerClient<T>

where T: GrpcService<Body>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> CompactTxStreamerClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<Body>, Response = Response<<T as GrpcService<Body>>::ResponseBody>>, <T as Service<Request<Body>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn get_latest_block( &mut self, request: impl IntoRequest<ChainSpec>, ) -> Result<Response<BlockId>, Status>

Return the BlockID of the block at the tip of the best chain

pub async fn get_block( &mut self, request: impl IntoRequest<BlockId>, ) -> Result<Response<CompactBlock>, Status>

Return the compact block corresponding to the given block identifier.

The returned CompactBlock includes transaction data for all value pools, including transparent inputs (vin) and outputs (vout). This differs from GetBlockRange, which supports filtering by pool type and defaults to returning only shielded (Sapling, Orchard, and Ironwood) data. Clients that require only data for specific pools should use GetBlockRange with the appropriate poolTypes set.

Note: the single null-outpoint input for coinbase transactions is omitted from the vin field of the corresponding CompactTx. See the documentation of the CompactTx message for details.

pub async fn get_block_nullifiers( &mut self, request: impl IntoRequest<BlockId>, ) -> Result<Response<CompactBlock>, Status>

👎Deprecated

Return a compact block containing only nullifier information for the shielded pools (Sapling spend nullifiers, Orchard action nullifiers, and Ironwood action nullifiers). Transparent transaction data, Sapling outputs, full Orchard/Ironwood action data, and commitment tree sizes are not included.

Note: this method is deprecated; use GetBlockRange with the appropriate poolTypes instead.

pub async fn get_block_range( &mut self, request: impl IntoRequest<BlockRange>, ) -> Result<Response<Streaming<CompactBlock>>, Status>

Return a list of consecutive compact blocks in the specified range, which is inclusive of range.end.

If range.start <= range.end, blocks are returned increasing height order; otherwise blocks are returned in decreasing height order.

pub async fn get_block_range_nullifiers( &mut self, request: impl IntoRequest<BlockRange>, ) -> Result<Response<Streaming<CompactBlock>>, Status>

👎Deprecated

Return a stream of compact blocks for the specified range, where each block contains only nullifier information for the shielded pools (Sapling spend nullifiers, Orchard action nullifiers, and Ironwood action nullifiers). Transparent transaction data, Sapling outputs, full Orchard/Ironwood action data, and commitment tree sizes are not included. Implementations MUST ignore any PoolType::TRANSPARENT member of the poolTypes field of the request.

Note: this method is deprecated; use GetBlockRange with the appropriate poolTypes instead.

pub async fn get_transaction( &mut self, request: impl IntoRequest<TxFilter>, ) -> Result<Response<RawTransaction>, Status>

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

pub async fn send_transaction( &mut self, request: impl IntoRequest<RawTransaction>, ) -> Result<Response<SendResponse>, Status>

Submit the given transaction to the Zcash network

pub async fn get_taddress_txids( &mut self, request: impl IntoRequest<TransparentAddressBlockFilter>, ) -> Result<Response<Streaming<RawTransaction>>, Status>

Return RawTransactions that match the given transparent address filter.

Note: This function is misnamed, it returns complete RawTransaction values, not TxIds. NOTE: this method is deprecated, please use GetTaddressTransactions instead.

pub async fn get_taddress_transactions( &mut self, request: impl IntoRequest<TransparentAddressBlockFilter>, ) -> Result<Response<Streaming<RawTransaction>>, Status>

Return the transactions corresponding to the given t-address within the given block range. Mempool transactions are not included in the results.

pub async fn get_taddress_balance( &mut self, request: impl IntoRequest<AddressList>, ) -> Result<Response<Balance>, Status>

pub async fn get_taddress_balance_stream( &mut self, request: impl IntoStreamingRequest<Message = Address>, ) -> Result<Response<Balance>, Status>

pub async fn get_mempool_tx( &mut self, request: impl IntoRequest<GetMempoolTxRequest>, ) -> Result<Response<Streaming<CompactTx>>, Status>

Returns a stream of the compact transaction representation for transactions currently in the mempool. The results of this operation may be a few seconds out of date. If the exclude_txid_suffixes list is empty, return all transactions; otherwise return all except those in the exclude_txid_suffixes 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_txid_suffixes 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 txid suffix, none of the matching transactions are excluded. Txid suffixes in the exclude list that don’t match any transactions in the mempool are ignored.

pub async fn get_mempool_stream( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<Streaming<RawTransaction>>, Status>

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.

pub async fn get_tree_state( &mut self, request: impl IntoRequest<BlockId>, ) -> Result<Response<TreeState>, Status>

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.

pub async fn get_latest_tree_state( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<TreeState>, Status>

pub async fn get_subtree_roots( &mut self, request: impl IntoRequest<GetSubtreeRootsArg>, ) -> Result<Response<Streaming<SubtreeRoot>>, Status>

Returns a stream of information about roots of subtrees of the note commitment tree for the specified shielded pool (Sapling, Orchard, or Ironwood).

pub async fn get_address_utxos( &mut self, request: impl IntoRequest<GetAddressUtxosArg>, ) -> Result<Response<GetAddressUtxosReplyList>, Status>

pub async fn get_address_utxos_stream( &mut self, request: impl IntoRequest<GetAddressUtxosArg>, ) -> Result<Response<Streaming<GetAddressUtxosReply>>, Status>

pub async fn get_lightd_info( &mut self, request: impl IntoRequest<Empty>, ) -> Result<Response<LightdInfo>, Status>

Return information about this lightwalletd instance and the blockchain

pub async fn ping( &mut self, request: impl IntoRequest<Duration>, ) -> Result<Response<PingResponse>, Status>

Testing-only, requires lightwalletd –ping-very-insecure (do not enable in production)

impl CompactTxStreamerClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Available on crate feature lightwalletd-tonic-transport only.

Attempt to create a new client by connecting to a given endpoint.

Trait Implementations

impl<T: Clone> Clone for CompactTxStreamerClient<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CompactTxStreamerClient<T>

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

Formats the value using the given formatter.