Struct FinalitySignatureV1

pub struct FinalitySignatureV1 { /* private fields */ }

A validator’s signature of a block, confirming it is finalized.

Clients and joining nodes should wait until the signers’ combined weight exceeds the fault tolerance threshold before accepting the block as finalized.

Implementations

impl FinalitySignatureV1

pub fn create( block_hash: BlockHash, era_id: EraId, secret_key: &SecretKey, ) -> Self

Constructs a new FinalitySignatureV1.

pub fn block_hash(&self) -> &BlockHash

Returns the block hash of the associated block.

pub fn era_id(&self) -> EraId

Returns the era in which the associated block was created.

pub fn signature(&self) -> &Signature

Returns the signature over the block hash of the associated block.

pub fn public_key(&self) -> &PublicKey

Returns the public key of the signing validator.

pub fn is_verified(&self) -> Result<(), Error>

Returns Ok if the signature is cryptographically valid.

pub fn new( block_hash: BlockHash, era_id: EraId, signature: Signature, public_key: PublicKey, ) -> Self

Available on crate feature testing only.

Constructs a new FinalitySignatureV1.

pub fn random(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random FinalitySignatureV1.

pub fn random_for_block( block_hash: BlockHash, era_id: EraId, rng: &mut TestRng, ) -> Self

Available on crate feature testing only.

Returns a random FinalitySignatureV1 for the provided block_hash and era_id.

Trait Implementations

impl Clone for FinalitySignatureV1

fn clone(&self) -> FinalitySignatureV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for FinalitySignatureV1

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for FinalitySignatureV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FinalitySignatureV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FinalitySignatureV1

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

Formats the value using the given formatter.

impl From<FinalitySignatureV1> for FinalitySignature

fn from(fs: FinalitySignatureV1) -> Self

Converts to this type from the input type.

impl Hash for FinalitySignatureV1

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 JsonSchema for FinalitySignatureV1

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for FinalitySignatureV1

fn cmp(&self, other: &FinalitySignatureV1) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FinalitySignatureV1

fn eq(&self, other: &FinalitySignatureV1) -> 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 PartialOrd for FinalitySignatureV1

fn partial_cmp(&self, other: &FinalitySignatureV1) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FinalitySignatureV1

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FinalitySignatureV1