absolutebi/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2025-12-12 22:19:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation on functions

Browse Source
This commit is contained in:
Luke Parker
2024-08-06 00:27:54 -04:00
parent d943e037e5
commit 8c50a31633
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
substrate/primitives/src/account.rs
View File

@@ -90,16 +90,17 @@ impl std::fmt::Display for SeraiAddress {
} }
} }
/// Create a Substraate key pair by a name.
///
/// This should never be considered to have a secure private key. It has effectively no entropy.
#[cfg(feature = "std")] #[cfg(feature = "std")]
pub fn insecure_pair_from_name(name: &str) -> Pair { pub fn insecure_pair_from_name(name: &str) -> Pair {
Pair::from_string(&format!("//{name}"), None).unwrap() Pair::from_string(&format!("//{name}"), None).unwrap()
} }
/// Create a private key for an arbitrary curve by a name. /// Create a private key for an arbitrary ciphersuite by a name.
/// ///
/// This key is not in any regards to be treated as an actual private key, as it is not private, /// This key should never be considered a secure private key. It has effectively no entropy.
/// nor is it even collision-resistant (crafted names may collide). It's solely for testing
/// purposes.
#[cfg(feature = "std")] #[cfg(feature = "std")]
pub fn insecure_arbitrary_key_from_name<C: ciphersuite::Ciphersuite>(name: &str) -> C::F { pub fn insecure_arbitrary_key_from_name<C: ciphersuite::Ciphersuite>(name: &str) -> C::F {
C::hash_to_F(b"insecure arbitrary key", name.as_bytes()) C::hash_to_F(b"insecure arbitrary key", name.as_bytes())