-
Notifications
You must be signed in to change notification settings - Fork 261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deprecate from_slice methods in favor of arrays #737
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -115,7 +115,7 @@ impl str::FromStr for SecretKey { | |
fn from_str(s: &str) -> Result<SecretKey, Error> { | ||
let mut res = [0u8; constants::SECRET_KEY_SIZE]; | ||
match from_hex(s, &mut res) { | ||
Ok(constants::SECRET_KEY_SIZE) => SecretKey::from_slice(&res), | ||
Ok(constants::SECRET_KEY_SIZE) => SecretKey::from_byte_array(&res), | ||
_ => Err(Error::InvalidSecretKey), | ||
} | ||
} | ||
|
@@ -138,7 +138,7 @@ impl str::FromStr for SecretKey { | |
/// use secp256k1::{SecretKey, Secp256k1, PublicKey}; | ||
/// | ||
/// let secp = Secp256k1::new(); | ||
/// let secret_key = SecretKey::from_slice(&[0xcd; 32]).expect("32 bytes, within curve order"); | ||
/// let secret_key = SecretKey::from_byte_array(&[0xcd; 32]).expect("32 bytes, within curve order"); | ||
/// let public_key = PublicKey::from_secret_key(&secp, &secret_key); | ||
/// # } | ||
/// ``` | ||
|
@@ -168,9 +168,13 @@ impl str::FromStr for PublicKey { | |
fn from_str(s: &str) -> Result<PublicKey, Error> { | ||
let mut res = [0u8; constants::UNCOMPRESSED_PUBLIC_KEY_SIZE]; | ||
match from_hex(s, &mut res) { | ||
Ok(constants::PUBLIC_KEY_SIZE) => | ||
PublicKey::from_slice(&res[0..constants::PUBLIC_KEY_SIZE]), | ||
Ok(constants::UNCOMPRESSED_PUBLIC_KEY_SIZE) => PublicKey::from_slice(&res), | ||
Ok(constants::PUBLIC_KEY_SIZE) => { | ||
let bytes: [u8; constants::PUBLIC_KEY_SIZE] = | ||
res[0..constants::PUBLIC_KEY_SIZE].try_into().unwrap(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Strictly speaking, it'd be better to create a reference here (simply annotating the type with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are you saying you can convert a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Exactly. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wow, that's a huge win and I feel like a clippy lint should exist for it. (Though it'd be a bit tough in general to tell when the array is only used by reference.) |
||
PublicKey::from_byte_array_compressed(&bytes) | ||
} | ||
Ok(constants::UNCOMPRESSED_PUBLIC_KEY_SIZE) => | ||
PublicKey::from_byte_array_uncompressed(&res), | ||
_ => Err(Error::InvalidPublicKey), | ||
} | ||
} | ||
|
@@ -211,6 +215,7 @@ impl SecretKey { | |
/// use secp256k1::SecretKey; | ||
/// let sk = SecretKey::from_slice(&[0xcd; 32]).expect("32 bytes, within curve order"); | ||
/// ``` | ||
#[deprecated(since = "TBD", note = "Use `from_byte_array` instead.")] | ||
#[inline] | ||
pub fn from_slice(data: &[u8]) -> Result<SecretKey, Error> { | ||
match <[u8; constants::SECRET_KEY_SIZE]>::try_from(data) { | ||
|
@@ -362,7 +367,7 @@ impl SecretKey { | |
impl<T: ThirtyTwoByteHash> From<T> for SecretKey { | ||
/// Converts a 32-byte hash directly to a secret key without error paths. | ||
fn from(t: T) -> SecretKey { | ||
SecretKey::from_slice(&t.into_32()).expect("failed to create secret key") | ||
SecretKey::from_byte_array(&t.into_32()).expect("failed to create secret key") | ||
} | ||
} | ||
|
||
|
@@ -542,7 +547,7 @@ impl PublicKey { | |
}; | ||
buf[1..].clone_from_slice(&pk.serialize()); | ||
|
||
PublicKey::from_slice(&buf).expect("we know the buffer is valid") | ||
PublicKey::from_byte_array_compressed(&buf).expect("we know the buffer is valid") | ||
} | ||
|
||
#[inline] | ||
|
@@ -1156,8 +1161,7 @@ impl str::FromStr for XOnlyPublicKey { | |
fn from_str(s: &str) -> Result<XOnlyPublicKey, Error> { | ||
let mut res = [0u8; constants::SCHNORR_PUBLIC_KEY_SIZE]; | ||
match from_hex(s, &mut res) { | ||
Ok(constants::SCHNORR_PUBLIC_KEY_SIZE) => | ||
XOnlyPublicKey::from_slice(&res[0..constants::SCHNORR_PUBLIC_KEY_SIZE]), | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. LOL, the previous code... |
||
Ok(constants::SCHNORR_PUBLIC_KEY_SIZE) => XOnlyPublicKey::from_byte_array(&res), | ||
_ => Err(Error::InvalidPublicKey), | ||
} | ||
} | ||
|
@@ -1203,6 +1207,7 @@ impl XOnlyPublicKey { | |
/// | ||
/// Returns [`Error::InvalidPublicKey`] if the length of the data slice is not 32 bytes or the | ||
/// slice does not represent a valid Secp256k1 point x coordinate. | ||
#[deprecated(since = "TBD", note = "Use `from_byte_array` instead.")] | ||
#[inline] | ||
pub fn from_slice(data: &[u8]) -> Result<XOnlyPublicKey, Error> { | ||
match <[u8; constants::SCHNORR_PUBLIC_KEY_SIZE]>::try_from(data) { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would have expected with this addition to see a change to call
from_bytes
. If you like the combinator style you could useThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I need to change anything again I'll add this too, thanks