Struct SigningKey 

pub struct SigningKey { /* private fields */ }

Taproot Schnorr signing key.

Implementations

impl SigningKey

pub fn from_bytes(bytes: &FieldBytes) -> Result<Self>

Parse signing key from big endian-encoded bytes.

Errors

Returns Error in the event the provided bytes overflow the curve order n.

pub fn from_slice(bytes: &[u8]) -> Result<Self>

Parse signing key from big endian-encoded byte slice.

Errors

Returns Error if bytes is not 32-bytes long, or if it overflows the curve order n.

pub fn to_bytes(&self) -> FieldBytes

Serialize as bytes.

pub fn verifying_key(&self) -> &VerifyingKey

Get the VerifyingKey that corresponds to this signing key.

pub fn as_nonzero_scalar(&self) -> &NonZeroScalar

Borrow the secret NonZeroScalar value for this key.

Security Warning

This value is key material. Please treat it with the care it deserves!

pub fn random<R: CryptoRng + ?Sized>(rng: &mut R) -> Self

👎Deprecated since 0.14.0:

use the Generate trait instead

Deprecated: Generate a cryptographically random SigningKey.

Trait Implementations

impl AsRef<VerifyingKey> for SigningKey

fn as_ref(&self) -> &VerifyingKey

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SigningKey

fn clone(&self) -> SigningKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SigningKey

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

Formats the value using the given formatter.

impl<D> DigestSigner<D, Signature> for SigningKey

where D: Digest<OutputSize = U32> + Update,

fn try_sign_digest<F: Fn(&mut D) -> Result<()>>( &self, f: F, ) -> Result<Signature>

Attempt to sign a message by updating the received Digest with it, returning a digital signature on success, or an error if something went wrong.

fn sign_digest<F>(&self, f: F) -> S

where F: Fn(&mut D),

Sign a message by updating the received Digest with it, returning a signature.

impl Drop for SigningKey

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<&SecretKey<Secp256k1>> for SigningKey

fn from(secret_key: &SecretKey) -> SigningKey

Converts to this type from the input type.

impl From<NonZeroScalar<Secp256k1>> for SigningKey

fn from(secret_key: NonZeroScalar) -> SigningKey

Converts to this type from the input type.

impl From<SecretKey<Secp256k1>> for SigningKey

fn from(secret_key: SecretKey) -> SigningKey

Converts to this type from the input type.

impl Generate for SigningKey

fn try_generate_from_rng<R: TryCryptoRng + ?Sized>( rng: &mut R, ) -> Result<Self, R::Error>

Generate random key using the provided TryCryptoRng.

fn generate_from_rng<R>(rng: &mut R) -> Self

where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.

fn try_generate() -> Result<Self, Error>

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

fn generate() -> Self

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

impl KeypairRef for SigningKey

type VerifyingKey = VerifyingKey

Verifying key type for this keypair.

impl MultipartSigner<Signature> for SigningKey

fn try_multipart_sign(&self, msg: &[&[u8]]) -> Result<Signature>

Equivalent of Signer::try_sign() but the message is provided in non-contiguous byte slices.

fn multipart_sign(&self, msg: &[&[u8]]) -> S

Equivalent of Signer::sign() but the message is provided in non-contiguous byte slices.

impl PrehashSigner<Signature> for SigningKey

fn sign_prehash(&self, prehash: &[u8]) -> Result<Signature>

Attempt to sign the given message digest, returning a digital signature on success, or an error if something went wrong.

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey

where D: Digest<OutputSize = U32> + Update,

fn try_sign_digest_with_rng<R: TryCryptoRng + ?Sized, F: Fn(&mut D) -> Result<()>>( &self, rng: &mut R, f: F, ) -> Result<Signature>

Attempt to sign a message by updating the received Digest with it, returning a digital signature on success, or an error if something went wrong.

fn sign_digest_with_rng<R, F>(&self, rng: &mut R, f: F) -> S

where R: CryptoRng + ?Sized, F: Fn(&mut D),

Sign a message by updating the received Digest with it, returning a signature.

impl RandomizedMultipartSigner<Signature> for SigningKey

fn try_multipart_sign_with_rng<R: TryCryptoRng + ?Sized>( &self, rng: &mut R, msg: &[&[u8]], ) -> Result<Signature>

Equivalent of RandomizedSigner::try_sign_with_rng() but the message is provided in non-contiguous byte slices.

fn multipart_sign_with_rng<R>(&self, rng: &mut R, msg: &[&[u8]]) -> S

where R: CryptoRng + ?Sized,

Equivalent of RandomizedSigner::sign_with_rng() but the message is provided in non-contiguous byte slices.

impl RandomizedPrehashSigner<Signature> for SigningKey

fn sign_prehash_with_rng<R: TryCryptoRng + ?Sized>( &self, rng: &mut R, prehash: &[u8], ) -> Result<Signature>

Attempt to sign the given message digest, returning a digital signature on success, or an error if something went wrong.

impl RandomizedSigner<Signature> for SigningKey

fn try_sign_with_rng<R: TryCryptoRng + ?Sized>( &self, rng: &mut R, msg: &[u8], ) -> Result<Signature>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_rng<R>(&self, rng: &mut R, msg: &[u8]) -> S

where R: CryptoRng + ?Sized,

Sign the given message and return a digital signature

impl Signer<Signature> for SigningKey

fn try_sign(&self, msg: &[u8]) -> Result<Signature>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature.

impl TryFrom<&[u8]> for SigningKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<SigningKey>

Performs the conversion.

impl ZeroizeOnDrop for SigningKey