Struct snarkvm_compiler::Header

source · [−]

pub struct Header<N: Network> { /* private fields */ }

Expand description

The header for the block contains metadata that uniquely identifies the block.

Implementations

source

impl<N: Network> Header<N>

source

pub fn to_root(&self) -> Result<Field<N>>

Returns the block header root.

source

pub fn to_path(&self, leaf: &HeaderLeaf<N>) -> Result<HeaderPath<N>>

Returns the Merkle path for the Merkle tree of the block header.

source

pub fn to_leaf(&self, id: &Field<N>) -> Result<HeaderLeaf<N>>

Returns the Merkle leaf for the given ID in the header.

source

pub fn to_tree(&self) -> Result<BHPMerkleTree<N, HEADER_DEPTH>>

Returns an instance of the Merkle tree for the block header.

source

impl<N: Network> Header<N>

source

pub fn genesis(transactions: &Transactions<N>) -> Result<Self>

Initializes the genesis block header.

source

pub fn is_genesis(&self) -> bool

Returns true if the block header is a genesis block header.

source

impl<N: Network> Header<N>

source

pub fn from(
 previous_state_root: Field<N>,
 transactions_root: Field<N>,
 metadata: Metadata<N>
) -> Result<Self>

Initializes a new block header with the given inputs.

source

pub fn is_valid(&self) -> bool

Returns true if the block header is well-formed.

source

pub const fn previous_state_root(&self) -> &Field<N>

Returns the previous state root from the block header.

source

pub const fn transactions_root(&self) -> &Field<N>

Returns the transactions root in the block header.

source

pub const fn metadata(&self) -> &Metadata<N>

Returns the metadata in the block header.

source

pub const fn network(&self) -> u16

Returns the network ID of the block.

source

pub const fn round(&self) -> u64

Returns the round number of the block.

source

pub const fn height(&self) -> u32

Returns the height of the block.

source

pub const fn coinbase_target(&self) -> u64

Returns the coinbase target for this block.

source

pub const fn proof_target(&self) -> u64

Returns the proof target for this block.

source

pub const fn timestamp(&self) -> i64

Returns the Unix timestamp (UTC) for this block.

Trait Implementations

source

impl<N: Clone + Network> Clone for Header<N>

source

fn clone(&self) -> Header<N>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<N: Network> Debug for Header<N>

source

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

Prints the header as a JSON-string.

source

impl<'de, N: Network> Deserialize<'de> for Header<N>

source

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the header from a JSON-string or buffer.

source

impl<N: Network> Display for Header<N>

source

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

Displays the header as a JSON-string.

source

impl<N: Network> FromBytes for Header<N>

source

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the block header from the buffer.

source

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

Returns Self from a byte array in little-endian order.

source

impl<N: Network> FromStr for Header<N>

source

fn from_str(header: &str) -> Result<Self, Self::Err>

Initializes the header from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

source

impl<N: Hash + Network> Hash for Header<N>

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<N: PartialEq + Network> PartialEq<Header<N>> for Header<N>

source

fn eq(&self, other: &Header<N>) -> bool

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<N: Network> Serialize for Header<N>

source

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes the header to a JSON-string or buffer.

source

impl<N: Network> ToBytes for Header<N>

source

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the block header to the buffer.

source

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

Returns self as a byte array in little-endian order.

source

impl<N: Network> StructuralPartialEq for Header<N>

Auto Trait Implementations

impl<N> RefUnwindSafe for Header<N> where
N: RefUnwindSafe,
<N as Environment>::Field: RefUnwindSafe,

impl<N> Send for Header<N>

impl<N> Sync for Header<N>

impl<N> Unpin for Header<N> where
N: Unpin,
<N as Environment>::Field: Unpin,

impl<N> UnwindSafe for Header<N> where
N: UnwindSafe,
<N as Environment>::Field: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

fn clone_into(&self, target: &mut T)

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

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct snarkvm_compiler::Header

Implementations

impl<N: Network> Header<N>

pub fn to_root(&self) -> Result<Field<N>>

pub fn to_path(&self, leaf: &HeaderLeaf<N>) -> Result<HeaderPath<N>>

pub fn to_leaf(&self, id: &Field<N>) -> Result<HeaderLeaf<N>>

pub fn to_tree(&self) -> Result<BHPMerkleTree<N, HEADER_DEPTH>>

impl<N: Network> Header<N>

pub fn genesis(transactions: &Transactions<N>) -> Result<Self>

pub fn is_genesis(&self) -> bool

impl<N: Network> Header<N>

pub fn from( previous_state_root: Field<N>, transactions_root: Field<N>, metadata: Metadata<N>) -> Result<Self>

pub fn is_valid(&self) -> bool

pub const fn previous_state_root(&self) -> &Field<N>

pub const fn transactions_root(&self) -> &Field<N>

pub const fn metadata(&self) -> &Metadata<N>

pub const fn network(&self) -> u16

pub const fn round(&self) -> u64

pub const fn height(&self) -> u32

pub const fn coinbase_target(&self) -> u64

pub const fn proof_target(&self) -> u64

pub const fn timestamp(&self) -> i64

Trait Implementations

impl<N: Clone + Network> Clone for Header<N>

fn clone(&self) -> Header<N>

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

impl<N: Network> Debug for Header<N>

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

impl<'de, N: Network> Deserialize<'de> for Header<N>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

impl<N: Network> Display for Header<N>

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

impl<N: Network> FromBytes for Header<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

impl<N: Network> FromStr for Header<N>

fn from_str(header: &str) -> Result<Self, Self::Err>

type Err = Error

impl<N: Hash + Network> Hash for Header<N>

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

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

impl<N: PartialEq + Network> PartialEq<Header<N>> for Header<N>

fn eq(&self, other: &Header<N>) -> bool

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

impl<N: Network> Serialize for Header<N>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

impl<N: Network> ToBytes for Header<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

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

impl<N: Copy + Network> Copy for Header<N>

impl<N: Eq + Network> Eq for Header<N>

impl<N: Network> StructuralEq for Header<N>

impl<N: Network> StructuralPartialEq for Header<N>

Auto Trait Implementations

impl<N> RefUnwindSafe for Header<N> where N: RefUnwindSafe, <N as Environment>::Field: RefUnwindSafe,

impl<N> Send for Header<N>

impl<N> Sync for Header<N>

impl<N> Unpin for Header<N> where N: Unpin, <N as Environment>::Field: Unpin,

impl<N> UnwindSafe for Header<N> where N: UnwindSafe, <N as Environment>::Field: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

pub fn from(
previous_state_root: Field<N>,
transactions_root: Field<N>,
metadata: Metadata<N>
) -> Result<Self>

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

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

impl<N> RefUnwindSafe for Header<N> where
N: RefUnwindSafe,
<N as Environment>::Field: RefUnwindSafe,

impl<N> Unpin for Header<N> where
N: Unpin,
<N as Environment>::Field: Unpin,

impl<N> UnwindSafe for Header<N> where
N: UnwindSafe,
<N as Environment>::Field: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,