Enum Signature 

#[repr(u8)]
pub enum Signature {
    Falcon512Poseidon2(Signature),
    EcdsaK256Keccak(Signature),
}

Represents a signature object ready for native verification.

In order to use this signature within the Miden VM, an encoding step may be necessary to convert the native signature into a vector of field elements that can be loaded into the advice provider. To encode the signature, use the provided Signature::to_encoded_signature method:

use miden_protocol::account::auth::Signature;
use miden_protocol::crypto::dsa::falcon512_poseidon2::SecretKey;
use miden_protocol::{Felt, Word};

let secret_key = SecretKey::new();
let message = Word::default();
let signature: Signature = secret_key.sign(message).into();
let encoded_signature: Vec<Felt> = signature.to_encoded_signature(message);

Variants

Falcon512Poseidon2(Signature)

EcdsaK256Keccak(Signature)

Implementations

impl Signature

pub const MAX_NUM_ENCODED_SIGNATURE_FELTS: usize = 2058

The maximum number of field elements that Signature::to_encoded_signature can return for any variant.

This lets consumers reject an encoded signature of an impossible length before allocating for it. The largest encoding is the one of Signature::Falcon512Poseidon2.

pub fn auth_scheme(&self) -> AuthScheme

Returns the authentication scheme of this signature.

pub fn to_encoded_signature(&self, msg: Word) -> Vec<Felt>

Converts this signature to a sequence of field elements in the format expected by the native verification procedure in the VM.

The returned vector contains at most Signature::MAX_NUM_ENCODED_SIGNATURE_FELTS elements.

The order of elements in the returned vector is reversed because it is expected that the data will be pushed into the advice stack

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl Deserializable for Signature

fn read_from<R>(source: &mut R) -> Result<Signature, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl From<Signature> for Signature

fn from(signature: Signature) -> Signature

Converts to this type from the input type.

impl Serializable for Signature

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.