Struct CompactBlock 

pub struct CompactBlock {
    pub height: u64,
    pub hash: Vec<u8>,
    pub prev_hash: Vec<u8>,
    pub time: u32,
    pub header: Vec<u8>,
    pub vtx: Vec<CompactTx>,
    pub chain_metadata: Option<ChainMetadata>,
}

A compact representation of a Zcash block.

CompactBlock is a packaging of ONLY the data from a block that’s needed to:

1. Detect a payment to your Shielded address
2. Detect a spend of your Shielded notes
3. Update your witnesses to generate new spend proofs.
4. Spend UTXOs associated to t-addresses of your wallet.

Currently, the header field should always be unset (empty). In the future, the presence or absence of header data may be made dependent on request parameters, although it is likely that such flexibility will only be provided via newly-added service methods, not via existing APIs.

Fields

height: u64

the height of this block

hash: Vec<u8>

if present, the ID (hash) of this block

prev_hash: Vec<u8>

if present, the ID (hash) of this block’s predecessor

time: u32

if non-zero, Unix epoch time when the block was mined

header: Vec<u8>

if present, full header (as returned by the getblock RPC)

vtx: Vec<CompactTx>

zero or more compact transactions from this block

chain_metadata: Option<ChainMetadata>

information about the state of the chain as of this block

Implementations

impl CompactBlock

pub fn hash(&self) -> BlockHash

Returns the [BlockHash] for this block.

Panics

This function will panic if Self::header is not set and Self::hash is not exactly 32 bytes.

pub fn prev_hash(&self) -> BlockHash

Returns the [BlockHash] for this block’s parent.

Panics

This function will panic if Self::header is not set and Self::prev_hash is not exactly 32 bytes.

pub fn height(&self) -> BlockHeight

Returns the [BlockHeight] value for this block

Panics

This function will panic if Self::height is not representable within a u32.

pub fn header(&self) -> Option<BlockHeader>

Returns the [BlockHeader] for this block if present.

A convenience method that parses Self::header if present.

Trait Implementations

impl Clone for CompactBlock

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompactBlock

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

Formats the value using the given formatter.

impl Default for CompactBlock

fn default() -> Self

Returns the “default value” for a type.

impl Message for CompactBlock

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CompactBlock

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CompactBlock