Struct BatchHeader

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

Implementations

impl<N: Network> BatchHeader<N>

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

Returns the batch ID.

impl<N: Network> BatchHeader<N>

pub fn compute_batch_id( author: Address<N>, round: u64, timestamp: i64, committee_id: Field<N>, transmission_ids: &IndexSet<TransmissionID<N>>, previous_certificate_ids: &IndexSet<Field<N>>, ) -> Result<Field<N>>

Returns the batch ID.

impl<N: Network> BatchHeader<N>

pub const MAX_CERTIFICATES: u16 = N::MAX_CERTIFICATES

The maximum number of certificates in a batch.

pub const MAX_GC_ROUNDS: usize = 100usize

The maximum number of rounds to store before garbage collecting.

pub const MAX_TRANSMISSIONS_PER_BATCH: usize = 50usize

The maximum number of transmissions in a batch. Note: This limit is set to 50 as part of safety measures to prevent DoS attacks. This limit can be increased in the future as performance improves. Alternatively, the rate of block production can be sped up to compensate for the limit set here.

impl<N: Network> BatchHeader<N>

pub fn new<R: Rng + CryptoRng>( private_key: &PrivateKey<N>, round: u64, timestamp: i64, committee_id: Field<N>, transmission_ids: IndexSet<TransmissionID<N>>, previous_certificate_ids: IndexSet<Field<N>>, rng: &mut R, ) -> Result<Self>

Initializes a new batch header.

pub fn from( author: Address<N>, round: u64, timestamp: i64, committee_id: Field<N>, transmission_ids: IndexSet<TransmissionID<N>>, previous_certificate_ids: IndexSet<Field<N>>, signature: Signature<N>, ) -> Result<Self>

Initializes a new batch header.

impl<N: Network> BatchHeader<N>

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

Returns the batch ID.

pub const fn author(&self) -> Address<N>

Returns the author.

pub const fn round(&self) -> u64

Returns the round number.

pub const fn timestamp(&self) -> i64

Returns the timestamp.

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

Returns the committee ID.

pub const fn transmission_ids(&self) -> &IndexSet<TransmissionID<N>>

Returns the transmission IDs.

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

Returns the batch certificate IDs for the previous round.

pub const fn signature(&self) -> &Signature<N>

Returns the signature.

impl<N: Network> BatchHeader<N>

pub fn is_empty(&self) -> bool

Returns true if the batch header is empty.

pub fn len(&self) -> usize

Returns the number of transmissions in the batch header.

pub fn contains(&self, transmission_id: impl Into<TransmissionID<N>>) -> bool

Returns true if the batch contains the specified transmission ID.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Prints the batch header as a JSON-string.

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

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

Deserialize this value from the given Serde deserializer.

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

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

Displays the batch header as a JSON-string.

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

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

Reads the batch header from the buffer.

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

where Self: Sized,

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

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

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

Initializes the batch header from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

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

fn eq(&self, other: &BatchHeader<N>) -> 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<N: Network> Serialize for BatchHeader<N>

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

Serialize this value into the given Serde serializer.

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

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

Writes the batch header to the buffer.

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

where Self: Sized,

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

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

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