Enum InventoryHash

pub enum InventoryHash {
    Error,
    Tx(Hash),
    Block(Hash),
    FilteredBlock(Hash),
    Wtx(WtxId),
}

An inventory hash which refers to some advertised or requested data.

Bitcoin calls this an “inventory vector” but it is just a typed hash, not a container, so we do not use that term to avoid confusion with Vec<T>.

Bitcoin reference

Variants

Error

An error.

The Bitcoin wiki just says “Any data of with this number may be ignored”, so we don’t include a typed hash.

Tx(Hash)

A hash of a transaction.

Block(Hash)

A hash of a block.

FilteredBlock(Hash)

A hash of a filtered block.

The Bitcoin wiki says: Hash of a block header, but only to be used in getdata message. Indicates the reply should be a merkleblock message rather than a block message; this only works if a bloom filter has been set.

Wtx(WtxId)

A pair with the hash of a V5 transaction and the Authorizing Data Commitment.

Introduced by ZIP-239, which is analogous to Bitcoin’s BIP-339.

Implementations

impl InventoryHash

pub fn from_legacy_tx_id(legacy_tx_id: Hash) -> InventoryHash

Creates a new inventory hash from a legacy transaction ID.

Correctness

This method must only be used for v1-v4 transaction IDs. transaction::Hash does not uniquely identify unmined v5 transactions.

pub fn block_hash(&self) -> Option<Hash>

Returns the block hash for this inventory hash, if this inventory hash is a non-filtered block variant.

pub fn unmined_tx_id(&self) -> Option<UnminedTxId>

Returns the unmined transaction ID for this inventory hash, if this inventory hash is a transaction variant.

fn code(&self) -> u32

Returns the serialized Zcash network protocol code for the current variant.

impl InventoryHash

pub fn error_strategy() -> BoxedStrategy<Self>

Generate a proptest strategy for InventoryHash::Errors.

pub fn tx_strategy() -> BoxedStrategy<Self>

Generate a proptest strategy for InventoryHash::Tx hashes.

pub fn block_strategy() -> BoxedStrategy<Self>

Generate a proptest strategy for InventoryHash::Block hashes.

pub fn filtered_block_strategy() -> BoxedStrategy<Self>

Generate a proptest strategy for InventoryHash::FilteredBlock hashes.

pub fn wtx_strategy() -> BoxedStrategy<Self>

Generate a proptest strategy for InventoryHash::Wtx hashes.

pub fn smallest_types_strategy() -> BoxedStrategy<Self>

Generate a proptest strategy for InventoryHash variants of the smallest serialized size.

Trait Implementations

impl Arbitrary for InventoryHash

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<InventoryHash>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for InventoryHash

fn clone(&self) -> InventoryHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InventoryHash

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

Formats the value using the given formatter.

impl From<&UnminedTxId> for InventoryHash

fn from(tx_id: &UnminedTxId) -> InventoryHash

Converts to this type from the input type.

impl From<&WtxId> for InventoryHash

fn from(wtx_id: &WtxId) -> InventoryHash

Converts to this type from the input type.

impl From<Hash> for InventoryHash

fn from(hash: Hash) -> InventoryHash

Converts to this type from the input type.

impl From<UnminedTxId> for InventoryHash

fn from(tx_id: UnminedTxId) -> InventoryHash

Converts to this type from the input type.

impl From<WtxId> for InventoryHash

fn from(wtx_id: WtxId) -> InventoryHash

Converts to this type from the input type.

impl Hash for InventoryHash

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InventoryHash

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TrustedPreallocate for InventoryHash

fn max_allocation() -> u64

Provides a loose upper bound on the size of the Vec<T: TrustedPreallocate> which can possibly be received from an honest peer.

impl ZcashDeserialize for InventoryHash

fn zcash_deserialize<R: Read>(reader: R) -> Result<Self, SerializationError>

Try to read self from the given reader.

impl ZcashSerialize for InventoryHash

fn zcash_serialize<W: Write>(&self, writer: W) -> Result<(), Error>

Write self to the given writer using the canonical format.

fn zcash_serialize_to_vec(&self) -> Result<Vec<u8>, Error>

Helper function to construct a vec to serialize the current struct into

fn zcash_serialized_size(&self) -> usize

Get the size of self by using a fake writer.

impl Copy for InventoryHash

impl Eq for InventoryHash

impl StructuralPartialEq for InventoryHash