Enum bc_components::SigningPublicKey

pub enum SigningPublicKey {
    Schnorr(SchnorrPublicKey),
    ECDSA(ECPublicKey),
}

A public key that can be used for signing. Supports both ECDSA and Schnorr.

Variants

Schnorr(SchnorrPublicKey)

ECDSA(ECPublicKey)

Implementations

impl SigningPublicKey

pub fn from_schnorr(key: SchnorrPublicKey) -> Self

Restores a SigningPublicKey from a SchnorrPublicKey.

pub fn from_ecdsa(key: ECPublicKey) -> Self

Restores a SigningPublicKey from an ECPublicKey.

pub fn schnorr(&self) -> Option<&SchnorrPublicKey>

Returns the SchnorrPublicKey of this SigningPublicKey, if it is a Schnorr key.

pub fn ecdsa(&self) -> Option<&ECPublicKey>

Returns the ECPublicKey of this SigningPublicKey, if it is an ECDSA key.

pub fn verify(&self, signature: &Signature, message: impl AsRef<[u8]>) -> bool

Verifies a signature against a message.

The type of signature must match the type of this key, and the signature must be valid for the message, or the verification will fail.

Trait Implementations

impl AsRef<SigningPublicKey> for PublicKeyBase

fn as_ref(&self) -> &SigningPublicKey

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

impl AsRef<SigningPublicKey> for SigningPublicKey

fn as_ref(&self) -> &SigningPublicKey

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

impl CBORDecodable for SigningPublicKey

fn from_cbor(cbor: &CBOR) -> Result<Self>

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for SigningPublicKey

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

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

Returns the value in CBOR binary representation.

impl CBORTagged for SigningPublicKey

const CBOR_TAG: Tag = tags::SIGNING_PUBLIC_KEY

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for SigningPublicKey

fn from_untagged_cbor(untagged_cbor: &CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: &CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for SigningPublicKey

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

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

Returns the tagged value in CBOR binary representation.

impl Clone for SigningPublicKey

fn clone(&self) -> SigningPublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigningPublicKey

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

Formats the value using the given formatter.

impl From<SigningPublicKey> for CBOR

fn from(value: SigningPublicKey) -> Self

Converts to this type from the input type.

impl Hash for SigningPublicKey

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 PartialEq for SigningPublicKey

fn eq(&self, other: &SigningPublicKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&CBOR> for SigningPublicKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: &CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CBOR> for SigningPublicKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl URDecodable for SigningPublicKey

fn from_ur(ur: &UR) -> Result<Self, Error>

where Self: Sized,

fn from_ur_string<T>(ur_string: T) -> Result<Self, Error>

where T: Into<String>, Self: Sized,

impl UREncodable for SigningPublicKey

fn ur(&self) -> UR

Returns the UR representation of the object.

fn ur_string(&self) -> String

Returns the UR string representation of the object.

impl Eq for SigningPublicKey

impl StructuralPartialEq for SigningPublicKey

impl URCodable for SigningPublicKey