chore: mark Signature as deprecated (#819)

* chore: mark Signature as `deprecated` * fix: put deprecation notice on the struct defs * add `allow(deprecated)` * add `allow(deprecated)`
alloy-rs · Dec 9, 2024 · ed0837c · ed0837c
1 parent dc0de77
commit ed0837c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/crates/primitives/src/lib.rs b/crates/primitives/src/lib.rs
@@ -54,9 +54,9 @@ mod signed;
 pub use signed::{BigIntConversionError, ParseSignedError, Sign, Signed};
 
 mod signature;
-pub use signature::{
-    normalize_v, to_eip155_v, Parity, PrimitiveSignature, Signature, SignatureError,
-};
+pub use signature::{normalize_v, to_eip155_v, PrimitiveSignature, SignatureError};
+#[allow(deprecated)]
+pub use signature::{Parity, Signature};
 
 pub mod utils;
 pub use utils::{eip191_hash_message, keccak256, Keccak256};

diff --git a/crates/primitives/src/signature/mod.rs b/crates/primitives/src/signature/mod.rs
@@ -1,10 +1,14 @@
 mod error;
 pub use error::SignatureError;
 
+#[allow(deprecated)]
 mod parity;
+#[allow(deprecated)]
 pub use parity::Parity;
 
+#[allow(deprecated)]
 mod sig;
+#[allow(deprecated)]
 pub use sig::Signature;
 
 mod utils;

diff --git a/crates/primitives/src/signature/parity.rs b/crates/primitives/src/signature/parity.rs
@@ -5,6 +5,7 @@ use crate::{
 
 /// The parity of the signature, stored as either a V value (which may include
 /// a chain id), or the y-parity.
+#[deprecated(since = "0.8.15", note = "see https://github.com/alloy-rs/core/pull/776")]
 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 #[cfg_attr(feature = "arbitrary", derive(derive_arbitrary::Arbitrary, proptest_derive::Arbitrary))]
 pub enum Parity {

diff --git a/crates/primitives/src/signature/sig.rs b/crates/primitives/src/signature/sig.rs
@@ -13,6 +13,7 @@ const SECP256K1N_ORDER: U256 =
     uint!(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141_U256);
 
 /// An Ethereum ECDSA signature.
+#[deprecated(since = "0.8.15", note = "use PrimitiveSignature instead")]
 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 pub struct Signature {
     v: Parity,