Struct Signature

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

Implementations

impl<N: Network> Signature<N>

pub fn verify(&self, address: &Address<N>, message: &[Field<N>]) -> bool

Verifies (challenge == challenge’) && (address == address’) where: challenge’ := HashToScalar(G^response pk_sig^challenge, pk_sig, pr_sig, address, message)

pub fn verify_bytes(&self, address: &Address<N>, message: &[u8]) -> bool

Verifies a signature for the given address and message (as bytes).

pub fn verify_bits(&self, address: &Address<N>, message: &[bool]) -> bool

Verifies a signature for the given address and message (as bits).

impl<N: Network> Signature<N>

pub fn sign<R: Rng + CryptoRng>( private_key: &PrivateKey<N>, message: &[Field<N>], rng: &mut R, ) -> Result<Self>

Returns a signature (challenge, response, compute_key) for a given message and RNG, where: challenge := HashToScalar(nonce * G, pk_sig, pr_sig, address, message) response := nonce - challenge * private_key.sk_sig()

pub fn sign_bytes<R: Rng + CryptoRng>( private_key: &PrivateKey<N>, message: &[u8], rng: &mut R, ) -> Result<Signature<N>>

Returns a signature for the given message (as bytes) using the private key.

pub fn sign_bits<R: Rng + CryptoRng>( private_key: &PrivateKey<N>, message: &[bool], rng: &mut R, ) -> Result<Signature<N>>

Returns a signature for the given message (as bits) using the private key.

impl<N: Network> Signature<N>

pub const fn challenge(&self) -> Scalar<N>

Returns the verifier challenge.

pub const fn response(&self) -> Scalar<N>

Returns the prover response.

pub const fn compute_key(&self) -> ComputeKey<N>

Returns the signer compute key.

pub fn to_address(&self) -> Address<N>

Returns the signer address.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Deserializes the signature from a string or bytes.

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

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

Writes the signature as a bech32m string.

impl<N: Network> Equal for Signature<N>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

impl<N: Network> From<&(Scalar<N>, Scalar<N>, ComputeKey<N>)> for Signature<N>

fn from( (challenge, response, compute_key): &(Scalar<N>, Scalar<N>, ComputeKey<N>), ) -> Self

Derives the account signature from a tuple (challenge, response, compute_key).

impl<N: Network> From<(Scalar<N>, Scalar<N>, ComputeKey<N>)> for Signature<N>

fn from( (challenge, response, compute_key): (Scalar<N>, Scalar<N>, ComputeKey<N>), ) -> Self

Derives the account signature from a tuple (challenge, response, compute_key).

impl<N: Network> FromBits for Signature<N>

fn from_bits_le(bits_le: &[bool]) -> Result<Self>

Initializes a new signature from a list of little-endian bits.

fn from_bits_be(bits_be: &[bool]) -> Result<Self>

Initializes a new signature from a list of big-endian bits.

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

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

Reads an account signature from a 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 Signature<N>

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

Reads in the signature string.

type Err = Error

The associated error which can be returned from parsing.

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

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<N: Network> Parser for Signature<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into an signature.

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

fn eq(&self, other: &Signature<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 Signature<N>

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

Serializes the signature into string or bytes.

impl<N: Network> SizeInBits for Signature<N>

fn size_in_bits() -> usize

Returns the signature size in bits.

impl<N: Network> SizeInBytes for Signature<N>

fn size_in_bytes() -> usize

Returns the signature size in bytes.

impl<N: Network> Ternary for Signature<N>

fn ternary( condition: &Self::Boolean, first: &Self, second: &Self, ) -> Self::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<N>

type Output = Signature<N>

impl<N: Network> ToBits for Signature<N>

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the little-endian bits of the signature.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the big-endian bits of the signature.

fn to_bits_le(&self) -> Vec<bool>

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

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

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

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

Writes an account signature to a 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: Network> ToFields for Signature<N>

fn to_fields(&self) -> Result<Vec<Self::Field>>

Casts a signature into a list of base fields.

type Field = Field<N>

impl<N: Network> TypeName for Signature<N>

fn type_name() -> &'static str

Returns the type name as a string.

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

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

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