Merge #511: Remove deprecated code

apoelstra · apoelstra · commit 191184539c86 · 2022-11-13T01:03:58.000Z
8c7c5e7 Remove deprecated code (Tobin C. Harding) e779e5d doc: Use add_tweak in example code (Tobin C. Harding) eedbd0b secp256k1-sys: Remove deprecated code (Tobin C. Harding) Pull request description: Remove deprecated code from `secp256k1-sys` and `secp256k1`. ACKs for top commit: apoelstra: ACK 8c7c5e7 Tree-SHA512: 830d4459cf21fba98e75e1c099c96316c9db1c1fb87dd28343cea066544ac8568685ec9fc85969caee3d35014f64c3f42b5a5afbf4f4d16221a57a204e6a3524
diff --git a/secp256k1-sys/src/lib.rs b/secp256k1-sys/src/lib.rs
@@ -346,35 +346,15 @@ extern "C" {
     pub fn secp256k1_ec_seckey_verify(cx: *const Context,
                                       sk: *const c_uchar) -> c_int;
 
-    #[deprecated(since = "0.2.0",note = "Please use the secp256k1_ec_seckey_tweak_add function instead")]
-    #[cfg_attr(not(rust_secp_no_symbol_renaming), link_name = "rustsecp256k1_v0_6_1_ec_privkey_negate")]
-    pub fn secp256k1_ec_privkey_negate(cx: *const Context,
-                                       sk: *mut c_uchar) -> c_int;
-
     #[cfg_attr(not(rust_secp_no_symbol_renaming), link_name = "rustsecp256k1_v0_6_1_ec_seckey_negate")]
     pub fn secp256k1_ec_seckey_negate(cx: *const Context,
                                       sk: *mut c_uchar) -> c_int;
 
-    #[deprecated(since = "0.2.0",note = "Please use the secp256k1_ec_seckey_tweak_add function instead")]
-    #[cfg_attr(not(rust_secp_no_symbol_renaming), link_name = "rustsecp256k1_v0_6_1_ec_privkey_tweak_add")]
-    pub fn secp256k1_ec_privkey_tweak_add(cx: *const Context,
-                                          sk: *mut c_uchar,
-                                          tweak: *const c_uchar)
-                                          -> c_int;
-
     #[cfg_attr(not(rust_secp_no_symbol_renaming), link_name = "rustsecp256k1_v0_6_1_ec_seckey_tweak_add")]
     pub fn secp256k1_ec_seckey_tweak_add(cx: *const Context,
                                         sk: *mut c_uchar,
                                         tweak: *const c_uchar)
                                         -> c_int;
-
-    #[deprecated(since = "0.2.0",note = "Please use the secp256k1_ec_seckey_tweak_mul function instead")]
-    #[cfg_attr(not(rust_secp_no_symbol_renaming), link_name = "rustsecp256k1_v0_6_1_ec_privkey_tweak_mul")]
-    pub fn secp256k1_ec_privkey_tweak_mul(cx: *const Context,
-                                          sk: *mut c_uchar,
-                                          tweak: *const c_uchar)
-                                          -> c_int;
-
     #[cfg_attr(not(rust_secp_no_symbol_renaming), link_name = "rustsecp256k1_v0_6_1_ec_seckey_tweak_mul")]
     pub fn secp256k1_ec_seckey_tweak_mul(cx: *const Context,
                                         sk: *mut c_uchar,
diff --git a/src/constants.rs b/src/constants.rs
@@ -37,17 +37,9 @@ pub const COMPACT_SIGNATURE_SIZE: usize = 64;
 /// The size of a Schnorr signature.
 pub const SCHNORR_SIGNATURE_SIZE: usize = 64;
 
-/// The size of a Schnorr signature.
-#[deprecated(since = "0.22.0", note = "Use SCHNORR_SIGNATURE_SIZE instead.")]
-pub const SCHNORRSIG_SIGNATURE_SIZE: usize = SCHNORR_SIGNATURE_SIZE;
-
 /// The size of a Schnorr public key.
 pub const SCHNORR_PUBLIC_KEY_SIZE: usize = 32;
 
-/// The size of a Schnorr public key.
-#[deprecated(since = "0.22.0", note = "Use SCHNORR_PUBLIC_KEY_SIZE instead.")]
-pub const SCHNORRSIG_PUBLIC_KEY_SIZE: usize = SCHNORR_PUBLIC_KEY_SIZE;
-
 /// The size of a key pair.
 pub const KEY_PAIR_SIZE: usize = 96;
 
diff --git a/src/ecdsa/mod.rs b/src/ecdsa/mod.rs
@@ -245,14 +245,6 @@ impl<'de> serde::Deserialize<'de> for Signature {
 }
 
 impl<C: Signing> Secp256k1<C> {
-
-    /// Constructs a signature for `msg` using the secret key `sk` and RFC6979 nonce
-    /// Requires a signing-capable context.
-    #[deprecated(since = "0.21.0", note = "Use sign_ecdsa instead.")]
-    pub fn sign(&self, msg: &Message, sk: &SecretKey) -> Signature {
-        self.sign_ecdsa(msg, sk)
-    }
-
     fn sign_ecdsa_with_noncedata_pointer(
         &self,
         msg: &Message,
@@ -324,17 +316,6 @@ impl<C: Signing> Secp256k1<C> {
             }
     }
 
-    /// Constructs a signature for `msg` using the secret key `sk`, RFC6979 nonce
-    /// and "grinds" the nonce by passing extra entropy if necessary to produce
-    /// a signature that is less than 71 - `bytes_to_grind` bytes. The number
-    /// of signing operation performed by this function is exponential in the
-    /// number of bytes grinded.
-    /// Requires a signing capable context.
-    #[deprecated(since = "0.21.0", note = "Use sign_ecdsa_grind_r instead.")]
-    pub fn sign_grind_r(&self, msg: &Message, sk: &SecretKey, bytes_to_grind: usize) -> Signature {
-        self.sign_ecdsa_grind_r(msg, sk, bytes_to_grind)
-    }
-
     /// Constructs a signature for `msg` using the secret key `sk`, RFC6979 nonce
     /// and "grinds" the nonce by passing extra entropy if necessary to produce
     /// a signature that is less than 71 - `bytes_to_grind` bytes. The number
@@ -346,17 +327,6 @@ impl<C: Signing> Secp256k1<C> {
         self.sign_grind_with_check(msg, sk, len_check)
     }
 
-    /// Constructs a signature for `msg` using the secret key `sk`, RFC6979 nonce
-    /// and "grinds" the nonce by passing extra entropy if necessary to produce
-    /// a signature that is less than 71 bytes and compatible with the low r
-    /// signature implementation of bitcoin core. In average, this function
-    /// will perform two signing operations.
-    /// Requires a signing capable context.
-    #[deprecated(since = "0.21.0", note = "Use sign_ecdsa_low_r instead.")]
-    pub fn sign_low_r(&self, msg: &Message, sk: &SecretKey) -> Signature {
-        self.sign_grind_with_check(msg, sk, compact_sig_has_zero_first_bit)
-    }
-
     /// Constructs a signature for `msg` using the secret key `sk`, RFC6979 nonce
     /// and "grinds" the nonce by passing extra entropy if necessary to produce
     /// a signature that is less than 71 bytes and compatible with the low r
@@ -369,34 +339,6 @@ impl<C: Signing> Secp256k1<C> {
 }
 
 impl<C: Verification> Secp256k1<C> {
-    /// Checks that `sig` is a valid ECDSA signature for `msg` using the public
-    /// key `pubkey`. Returns `Ok(())` on success. Note that this function cannot
-    /// be used for Bitcoin consensus checking since there may exist signatures
-    /// which OpenSSL would verify but not libsecp256k1, or vice-versa. Requires a
-    /// verify-capable context.
-    ///
-    /// ```rust
-    /// # #[cfg(all(feature = "std", feature = "rand-std"))] {
-    /// # use secp256k1::rand::thread_rng;
-    /// # use secp256k1::{Secp256k1, Message, Error};
-    /// #
-    /// # let secp = Secp256k1::new();
-    /// # let (secret_key, public_key) = secp.generate_keypair(&mut thread_rng());
-    /// #
-    /// let message = Message::from_slice(&[0xab; 32]).expect("32 bytes");
-    /// let sig = secp.sign(&message, &secret_key);
-    /// assert_eq!(secp.verify(&message, &sig, &public_key), Ok(()));
-    ///
-    /// let message = Message::from_slice(&[0xcd; 32]).expect("32 bytes");
-    /// assert_eq!(secp.verify(&message, &sig, &public_key), Err(Error::IncorrectSignature));
-    /// # }
-    /// ```
-    #[inline]
-    #[deprecated(since = "0.21.0", note = "Use verify_ecdsa instead")]
-    pub fn verify(&self, msg: &Message, sig: &Signature, pk: &PublicKey) -> Result<(), Error> {
-        self.verify_ecdsa(msg, sig, pk)
-    }
-
     /// Checks that `sig` is a valid ECDSA signature for `msg` using the public
     /// key `pubkey`. Returns `Ok(())` on success. Note that this function cannot
     /// be used for Bitcoin consensus checking since there may exist signatures
diff --git a/src/ecdsa/recovery.rs b/src/ecdsa/recovery.rs
@@ -150,13 +150,6 @@ impl From<ffi::RecoverableSignature> for RecoverableSignature {
 }
 
 impl<C: Signing> Secp256k1<C> {
-    /// Constructs a signature for `msg` using the secret key `sk` and RFC6979 nonce.
-    /// Requires a signing-capable context.
-    #[deprecated(since = "0.21.0", note = "Use sign_ecdsa_recoverable instead.")]
-    pub fn sign_recoverable(&self, msg: &Message, sk: &key::SecretKey) -> RecoverableSignature {
-        self.sign_ecdsa_recoverable(msg, sk)
-    }
-
     fn sign_ecdsa_recoverable_with_noncedata_pointer(
         &self,
         msg: &Message,
@@ -206,13 +199,6 @@ impl<C: Signing> Secp256k1<C> {
 }
 
 impl<C: Verification> Secp256k1<C> {
-    /// Determines the public key for which `sig` is a valid signature for
-    /// `msg`. Requires a verify-capable context.
-    #[deprecated(since = "0.21.0", note = "Use recover_ecdsa instead.")]
-    pub fn recover(&self, msg: &Message, sig: &RecoverableSignature) -> Result<key::PublicKey, Error> {
-        self.recover_ecdsa(msg, sig)
-    }
-
     /// Determines the public key for which `sig` is a valid signature for
     /// `msg`. Requires a verify-capable context.
     pub fn recover_ecdsa(&self, msg: &Message, sig: &RecoverableSignature)
diff --git a/src/key.rs b/src/key.rs
@@ -259,13 +259,6 @@ impl SecretKey {
         self.0
     }
 
-    /// Negates the secret key.
-    #[inline]
-    #[deprecated(since = "0.23.0", note = "Use negate instead")]
-    pub fn negate_assign(&mut self) {
-        *self = self.negate()
-    }
-
     /// Negates the secret key.
     #[inline]
     #[must_use = "you forgot to use the negated secret key"]
@@ -280,18 +273,6 @@ impl SecretKey {
         self
     }
 
-    /// Adds one secret key to another, modulo the curve order.
-    ///
-    /// # Errors
-    ///
-    /// Returns an error if the resulting key would be invalid.
-    #[inline]
-    #[deprecated(since = "0.23.0", note = "Use add_tweak instead")]
-    pub fn add_assign(&mut self, other: &Scalar) -> Result<(), Error> {
-        *self = self.add_tweak(other)?;
-        Ok(())
-    }
-
     /// Tweaks a [`SecretKey`] by adding `tweak` modulo the curve order.
     ///
     /// # Errors
@@ -313,15 +294,6 @@ impl SecretKey {
         }
     }
 
-    /// Multiplies one secret key by another, modulo the curve order. Will
-    /// return an error if the resulting key would be invalid.
-    #[inline]
-    #[deprecated(since = "0.23.0", note = "Use mul_tweak instead")]
-    pub fn mul_assign(&mut self, other: &Scalar) -> Result<(), Error> {
-        *self = self.mul_tweak(other)?;
-        Ok(())
-    }
-
     /// Tweaks a [`SecretKey`] by multiplying by `tweak` modulo the curve order.
     ///
     /// # Errors
@@ -561,13 +533,6 @@ impl PublicKey {
         debug_assert_eq!(ret_len, ret.len());
     }
 
-    /// Negates the public key in place.
-    #[inline]
-    #[deprecated(since = "0.23.0", note = "Use negate instead")]
-    pub fn negate_assign<C: Verification>(&mut self, secp: &Secp256k1<C>) {
-        *self = self.negate(secp)
-    }
-
     /// Negates the public key.
     #[inline]
     #[must_use = "you forgot to use the negated public key"]
@@ -579,22 +544,6 @@ impl PublicKey {
         self
     }
 
-    /// Adds `other * G` to `self` in place.
-    ///
-    /// # Errors
-    ///
-    /// Returns an error if the resulting key would be invalid.
-    #[inline]
-    #[deprecated(since = "0.23.0", note = "Use add_exp_tweak instead")]
-    pub fn add_exp_assign<C: Verification>(
-        &mut self,
-        secp: &Secp256k1<C>,
-        other: &Scalar
-    ) -> Result<(), Error> {
-        *self = self.add_exp_tweak(secp, other)?;
-        Ok(())
-    }
-
     /// Tweaks a [`PublicKey`] by adding `tweak * G` modulo the curve order.
     ///
     /// # Errors
@@ -615,22 +564,6 @@ impl PublicKey {
         }
     }
 
-    /// Muliplies the public key in place by the scalar `other`.
-    ///
-    /// # Errors
-    ///
-    /// Returns an error if the resulting key would be invalid.
-    #[deprecated(since = "0.23.0", note = "Use mul_tweak instead")]
-    #[inline]
-    pub fn mul_assign<C: Verification>(
-        &mut self,
-        secp: &Secp256k1<C>,
-        other: &Scalar,
-    ) -> Result<(), Error> {
-        *self = self.mul_tweak(secp, other)?;
-        Ok(())
-    }
-
     /// Tweaks a [`PublicKey`] by multiplying by `tweak` modulo the curve order.
     ///
     /// # Errors
@@ -986,19 +919,6 @@ impl KeyPair {
         *SecretKey::from_keypair(self).as_ref()
     }
 
-    /// Tweaks a keypair by adding the given tweak to the secret key and updating the public key
-    /// accordingly.
-    #[inline]
-    #[deprecated(since = "0.23.0", note = "Use add_xonly_tweak instead")]
-    pub fn tweak_add_assign<C: Verification>(
-        &mut self,
-        secp: &Secp256k1<C>,
-        tweak: &Scalar,
-    ) -> Result<(), Error> {
-        *self = self.add_xonly_tweak(secp, tweak)?;
-        Ok(())
-    }
-
     /// Tweaks a keypair by first converting the public key to an xonly key and tweaking it.
     ///
     /// # Errors
@@ -1300,18 +1220,6 @@ impl XOnlyPublicKey {
         ret
     }
 
-    /// Tweaks an x-only PublicKey by adding the generator multiplied with the given tweak to it.
-    #[deprecated(since = "0.23.0", note = "Use add_tweak instead")]
-    pub fn tweak_add_assign<V: Verification>(
-        &mut self,
-        secp: &Secp256k1<V>,
-        tweak: &Scalar,
-    ) -> Result<Parity, Error> {
-        let (tweaked, parity) = self.add_tweak(secp, tweak)?;
-        *self = tweaked;
-        Ok(parity)
-    }
-
     /// Tweaks an [`XOnlyPublicKey`] by adding the generator multiplied with the given tweak to it.
     ///
     /// # Returns
@@ -1398,8 +1306,8 @@ impl XOnlyPublicKey {
     /// let mut key_pair = KeyPair::new(&secp, &mut thread_rng());
     /// let (mut public_key, _) = key_pair.x_only_public_key();
     /// let original = public_key;
-    /// let parity = public_key.tweak_add_assign(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
-    /// assert!(original.tweak_add_check(&secp, &public_key, parity, tweak));
+    /// let (tweaked, parity) = public_key.add_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
+    /// assert!(original.tweak_add_check(&secp, &tweaked, parity, tweak));
     /// # }
     /// ```
     pub fn tweak_add_check<V: Verification>(
diff --git a/src/lib.rs b/src/lib.rs
@@ -206,25 +206,6 @@ use crate::ffi::{CPtr, impl_array_newtype, types::AlignedType};
 #[cfg(feature = "bitcoin_hashes")]
 use crate::hashes::Hash;
 
-// Backwards compatible changes
-/// Schnorr Signature related methods.
-#[deprecated(since = "0.21.0", note = "Use schnorr instead.")]
-pub mod schnorrsig {
-    #[deprecated(since = "0.21.0", note = "Use crate::XOnlyPublicKey instead.")]
-    /// backwards compatible re-export of xonly key
-    pub type PublicKey = crate::key::XOnlyPublicKey;
-    /// backwards compatible re-export of keypair
-    #[deprecated(since = "0.21.0", note = "Use crate::KeyPair instead.")]
-    pub type KeyPair = crate::key::KeyPair;
-    /// backwards compatible re-export of schnorr signatures
-    #[deprecated(since = "0.21.0", note = "Use schnorr::Signature instead.")]
-    pub type Signature = crate::schnorr::Signature;
-}
-
-#[deprecated(since = "0.21.0", note = "Use ecdsa::Signature instead.")]
-/// backwards compatible re-export of ecdsa signatures
-pub type Signature = ecdsa::Signature;
-
 /// Trait describing something that promises to be a 32-byte random number; in particular,
 /// it has negligible probability of being zero or overflowing the group order. Such objects
 /// may be converted to `Message`s without any error paths.
diff --git a/src/schnorr.rs b/src/schnorr.rs
