milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Properly deprecate util::ecdsa key re-exports

This commit is contained in:
Dr Maxim Orlovsky 2022-01-09 20:41:00 +01:00
parent bcb8932ccf
commit 8a993e8a58
1 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/util/schnorr.rs
View File

@ -20,19 +20,27 @@
use core::fmt; use core::fmt;
use prelude::*; use prelude::*;
#[deprecated(since = "0.28.0", note = "Please use `util::key` instead")] use secp256k1::{XOnlyPublicKey as _XOnlyPublicKey, KeyPair as _KeyPair};
pub use secp256k1::{XOnlyPublicKey, KeyPair};
use secp256k1::{self, Secp256k1, Verification, constants}; use secp256k1::{self, Secp256k1, Verification, constants};
use hashes::Hash; use hashes::Hash;
use util::taproot::{TapBranchHash, TapTweakHash}; use util::taproot::{TapBranchHash, TapTweakHash};
use SchnorrSigHashType; use SchnorrSigHashType;
/// Deprecated re-export of [`secp256k1::XOnlyPublicKey`]
#[deprecated(since = "0.28.0", note = "Please use `util::key::XOnlyPublicKey` instead")]
pub type XOnlyPublicKey = _XOnlyPublicKey;
/// Deprecated re-export of [`secp256k1::KeyPair`]
#[deprecated(since = "0.28.0", note = "Please use `util::key::KeyPair` instead")]
pub type KeyPair = _KeyPair;
/// Untweaked BIP-340 X-coord-only public key /// Untweaked BIP-340 X-coord-only public key
pub type UntweakedPublicKey = XOnlyPublicKey; pub type UntweakedPublicKey = ::XOnlyPublicKey;
/// Tweaked BIP-340 X-coord-only public key /// Tweaked BIP-340 X-coord-only public key
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TweakedPublicKey(XOnlyPublicKey); pub struct TweakedPublicKey(::XOnlyPublicKey);
impl fmt::LowerHex for TweakedPublicKey { impl fmt::LowerHex for TweakedPublicKey {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
@ -47,13 +55,13 @@ impl fmt::Display for TweakedPublicKey {
} }
/// Untweaked BIP-340 key pair /// Untweaked BIP-340 key pair
pub type UntweakedKeyPair = KeyPair; pub type UntweakedKeyPair = ::KeyPair;
/// Tweaked BIP-340 key pair /// Tweaked BIP-340 key pair
#[derive(Clone)] #[derive(Clone)]
#[cfg_attr(feature = "std", derive(Debug))] #[cfg_attr(feature = "std", derive(Debug))]
// TODO: Add other derives once secp256k1 v0.21.3 released // TODO: Add other derives once secp256k1 v0.21.3 released
pub struct TweakedKeyPair(KeyPair); pub struct TweakedKeyPair(::KeyPair);
/// A trait for tweaking BIP340 key types (x-only public keys and key pairs). /// A trait for tweaking BIP340 key types (x-only public keys and key pairs).
pub trait TapTweak { pub trait TapTweak {
@ -130,7 +138,7 @@ impl TapTweak for UntweakedKeyPair {
/// # Returns /// # Returns
/// The tweaked key and its parity. /// The tweaked key and its parity.
fn tap_tweak<C: Verification>(mut self, secp: &Secp256k1<C>, merkle_root: Option<TapBranchHash>) -> TweakedKeyPair { fn tap_tweak<C: Verification>(mut self, secp: &Secp256k1<C>, merkle_root: Option<TapBranchHash>) -> TweakedKeyPair {
let pubkey = XOnlyPublicKey::from_keypair(&self); let pubkey = ::XOnlyPublicKey::from_keypair(&self);
let tweak_value = TapTweakHash::from_key_and_tweak(pubkey, merkle_root).into_inner(); let tweak_value = TapTweakHash::from_key_and_tweak(pubkey, merkle_root).into_inner();
self.tweak_add_assign(&secp, &tweak_value).expect("Tap tweak failed"); self.tweak_add_assign(&secp, &tweak_value).expect("Tap tweak failed");
TweakedKeyPair(self) TweakedKeyPair(self)
@ -148,17 +156,17 @@ impl TweakedPublicKey {
/// This method is dangerous and can lead to loss of funds if used incorrectly. /// 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. /// Specifically, in multi-party protocols a peer can provide a value that allows them to steal.
#[inline] #[inline]
pub fn dangerous_assume_tweaked(key: XOnlyPublicKey) -> TweakedPublicKey { pub fn dangerous_assume_tweaked(key: ::XOnlyPublicKey) -> TweakedPublicKey {
TweakedPublicKey(key) TweakedPublicKey(key)
} }
/// Returns the underlying public key. /// Returns the underlying public key.
pub fn into_inner(self) -> XOnlyPublicKey { pub fn into_inner(self) -> ::XOnlyPublicKey {
self.0 self.0
} }
/// Returns a reference to underlying public key. /// Returns a reference to underlying public key.
pub fn as_inner(&self) -> &XOnlyPublicKey { pub fn as_inner(&self) -> &::XOnlyPublicKey {
&self.0 &self.0
} }
@ -178,25 +186,25 @@ impl TweakedKeyPair {
/// This method is dangerous and can lead to loss of funds if used incorrectly. /// 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. /// Specifically, in multi-party protocols a peer can provide a value that allows them to steal.
#[inline] #[inline]
pub fn dangerous_assume_tweaked(pair: KeyPair) -> TweakedKeyPair { pub fn dangerous_assume_tweaked(pair: ::KeyPair) -> TweakedKeyPair {
TweakedKeyPair(pair) TweakedKeyPair(pair)
} }
/// Returns the underlying key pair /// Returns the underlying key pair
#[inline] #[inline]
pub fn into_inner(self) -> KeyPair { pub fn into_inner(self) -> ::KeyPair {
self.0 self.0
} }
} }
impl From<TweakedPublicKey> for XOnlyPublicKey { impl From<TweakedPublicKey> for ::XOnlyPublicKey {
#[inline] #[inline]
fn from(pair: TweakedPublicKey) -> Self { fn from(pair: TweakedPublicKey) -> Self {
pair.0 pair.0
} }
} }
impl From<TweakedKeyPair> for KeyPair { impl From<TweakedKeyPair> for ::KeyPair {
#[inline] #[inline]
fn from(pair: TweakedKeyPair) -> Self { fn from(pair: TweakedKeyPair) -> Self {
pair.0 pair.0