Enum zcash_primitives::consensus::BranchId[][src]

pub enum BranchId {
    Sprout,
    Overwinter,
    Sapling,
    Blossom,
    Heartwood,
    Canopy,
    Nu5,
    ZFuture,
}
Expand description

A globally-unique identifier for a set of consensus rules within the Zcash chain.

Each branch ID in this enum corresponds to one of the epochs between a pair of Zcash network upgrades. For example, BranchId::Overwinter corresponds to the blocks starting at Overwinter activation, and ending the block before Sapling activation.

The main use of the branch ID is in signature generation: transactions commit to a specific branch ID by including it as part of signature_hash. This ensures two-way replay protection for transactions across network upgrades.

See ZIP 200 for more details.

Variants

Sprout

The consensus rules at the launch of Zcash.

Overwinter

The consensus rules deployed by NetworkUpgrade::Overwinter.

Sapling

The consensus rules deployed by NetworkUpgrade::Sapling.

Blossom

The consensus rules deployed by NetworkUpgrade::Blossom.

Heartwood

The consensus rules deployed by NetworkUpgrade::Heartwood.

Canopy

The consensus rules deployed by NetworkUpgrade::Canopy.

Nu5

The consensus rules deployed by NetworkUpgrade::Nu5.

ZFuture

Candidates for future consensus rules; this branch will never activate on mainnet.

Implementations

Returns the branch ID corresponding to the consensus rule set that is active at the given height.

This is the branch ID that should be used when creating transactions.

Returns the range of heights for the consensus epoch associated with this branch id.

The resulting tuple implements the RangeBounds<BlockHeight> trait.

Returns the range of heights for the consensus epoch associated with this branch id.

The return type of this value is slightly more precise than Self::height_range:

  • Some((x, Some(y))) means that the consensus rules corresponding to this branch id are in effect for the range x..y
  • Some((x, None)) means that the consensus rules corresponding to this branch id are in effect for the range x..
  • None means that the consensus rules corresponding to this branch id are never in effect.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Converts self into T using Into<T>. Read more

Causes self to use its Binary implementation when Debug-formatted.

Causes self to use its Display implementation when Debug-formatted. Read more

Causes self to use its LowerExp implementation when Debug-formatted. Read more

Causes self to use its LowerHex implementation when Debug-formatted. Read more

Causes self to use its Octal implementation when Debug-formatted.

Causes self to use its Pointer implementation when Debug-formatted. Read more

Causes self to use its UpperExp implementation when Debug-formatted. Read more

Causes self to use its UpperHex implementation when Debug-formatted. Read more

Performs the conversion.

Performs the conversion.

Pipes by value. This is generally the method you want to use. Read more

Borrows self and passes that borrow into the pipe function. Read more

Mutably borrows self and passes that borrow into the pipe function. Read more

Borrows self, then passes self.borrow() into the pipe function. Read more

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Borrows self, then passes self.as_ref() into the pipe function.

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

Borrows self, then passes self.deref() into the pipe function.

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

Immutable access to a value. Read more

Mutable access to a value. Read more

Immutable access to the Borrow<B> of a value. Read more

Mutable access to the BorrowMut<B> of a value. Read more

Immutable access to the AsRef<R> view of a value. Read more

Mutable access to the AsMut<R> view of a value. Read more

Immutable access to the Deref::Target of a value. Read more

Mutable access to the Deref::Target of a value. Read more

Calls .tap() only in debug builds, and is erased in release builds.

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Attempts to convert self into T using TryInto<T>. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.