Struct TweakedKeypair

pub struct TweakedKeypair(/* private fields */);

Tweaked BIP-340 key pair

Examples

// There are various conversion methods available to get a tweaked pubkey from a tweaked keypair.
let (_pk, _parity) = keypair.public_parts();
let _pk  = TweakedPublicKey::from_keypair(keypair);
let _pk = TweakedPublicKey::from(keypair);

Implementations

impl TweakedKeypair

pub fn dangerous_assume_tweaked(pair: Keypair) -> TweakedKeypair

Creates a new TweakedKeypair from a Keypair. No tweak is applied, consider calling tap_tweak on an UntweakedKeypair instead of using this constructor.

This method is dangerous and can lead to loss of funds if used incorrectly. Specifically, in multi-party protocols a peer can provide a value that allows them to steal.

pub fn to_inner(self) -> Keypair

Returns the underlying key pair.

pub fn public_parts(&self) -> (TweakedPublicKey, Parity)

Returns the TweakedPublicKey and its Parity for this TweakedKeypair.

Trait Implementations

impl Clone for TweakedKeypair

fn clone(&self) -> TweakedKeypair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TweakedKeypair

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TweakedKeypair

fn deserialize<__D>( __deserializer: __D, ) -> Result<TweakedKeypair, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TweakedKeypair> for Keypair

fn from(pair: TweakedKeypair) -> Keypair

Converts to this type from the input type.

impl From<TweakedKeypair> for TweakedPublicKey

fn from(pair: TweakedKeypair) -> TweakedPublicKey

Converts to this type from the input type.

impl Hash for TweakedKeypair

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for TweakedKeypair

fn cmp(&self, other: &TweakedKeypair) -> 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 TweakedKeypair

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

fn partial_cmp(&self, other: &TweakedKeypair) -> 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 TweakedKeypair

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TweakedKeypair

impl Eq for TweakedKeypair

impl StructuralPartialEq for TweakedKeypair