feat: expose Signature<T>

crates/core/Cargo.toml

@@ -59,6 +59,4 @@ arbitrary = [
     "alloy-dyn-abi?/arbitrary",
 ]
 k256 = ["alloy-primitives/k256"]
-eip712 = ["alloy-sol-types?/eip712-serde", "alloy-dyn-abi?/eip712"]
-
-unstable-doc = ["alloy-primitives/unstable-doc"]
+eip712 = ["alloy-sol-types?/eip712-serde", "alloy-dyn-abi?/eip712"]

crates/core/src/lib.rs

@@ -12,11 +12,6 @@ pub use alloy_primitives as primitives;
 #[doc(no_inline)]
 pub use primitives::{hex, uint};
 
-#[cfg(feature = "unstable-doc")]
-#[doc(hidden)]
-#[allow(unused_imports)]
-pub use primitives::PrivateSignature as _;
-
 #[cfg(feature = "dyn-abi")]
 #[doc(inline)]
 pub use alloy_dyn_abi as dyn_abi;

crates/primitives/Cargo.toml

@@ -110,8 +110,6 @@ allocative = ["dep:allocative"]
 # Should not be needed most of the time.
 hex-compat = ["hex/hex"]
 
-unstable-doc = []
-
 [[bench]]
 name = "primitives"
 path = "benches/primitives.rs"

crates/primitives/src/lib.rs

@@ -51,21 +51,13 @@ mod signed;
 pub use signed::{BigIntConversionError, ParseSignedError, Sign, Signed};
 
 mod signature;
-pub use signature::{to_eip155_v, Parity, SignatureError};
-
-/// Only available for documentation purposes.
-// Without this visible (not `#[doc(hidden)]`) re-export, `rustdoc` will not generate documentation
-// for the `Signature` type alias below.
-#[cfg(feature = "unstable-doc")]
-pub use signature::Signature as PrivateSignature;
+pub use signature::{
+    to_eip155_v, BuildableSignature, Parity, RawSignature, Signature, SignatureError,
+};
 
-/// An ECDSA Signature, consisting of V, R, and S.
+/// A memoized ECDSA Signature, consisting of V, R, and S.
 #[cfg(feature = "k256")]
-pub type Signature = signature::Signature<k256::ecdsa::Signature>;
-
-/// An ECDSA Signature, consisting of V, R, and S.
-#[cfg(not(feature = "k256"))]
-pub type Signature = signature::Signature<()>;
+pub type MemoizedSignature = signature::Signature<k256::ecdsa::Signature>;
 
 pub mod utils;
 pub use utils::{eip191_hash_message, keccak256, Keccak256};

crates/primitives/src/signature/buildable.rs

@@ -0,0 +1,22 @@
+use crate::{Parity, SignatureError, U256};
+
+use super::RawSignature;
+
+/// Trait used to uniformize signature creation.
+pub trait BuildableSignature: Sized {
+    /// Instantiate from v, r, s.
+    fn from_rs_and_parity<P: TryInto<Parity, Error = E>, E: Into<SignatureError>>(
+        r: U256,
+        s: U256,
+        parity: P,
+    ) -> Result<Self, SignatureError>;
+
+    /// Parses a signature from a byte slice, with a v value
+    fn from_bytes_and_parity<P: TryInto<Parity, Error = E>, E: Into<SignatureError>>(
+        bytes: &[u8],
+        parity: P,
+    ) -> Result<Self, SignatureError>;
+
+    /// Converts the signature into a [`RawSignature`].
+    fn into_raw(self) -> RawSignature;
+}

crates/primitives/src/signature/mod.rs

@@ -1,14 +1,14 @@
+mod buildable;
+pub use buildable::BuildableSignature;
+
 mod error;
 pub use error::SignatureError;
 
 mod parity;
 pub use parity::Parity;
 
 mod sig;
-#[cfg(feature = "unstable-doc")]
-pub use sig::Signature;
-#[cfg(not(feature = "unstable-doc"))]
-pub(crate) use sig::Signature;
+pub use sig::{RawSignature, Signature};
 
 mod utils;
 pub use utils::to_eip155_v;