Struct fuel_crypto::SecretKey

#[repr(transparent)]
pub struct SecretKey(_);

Asymmetric secret key

Implementations

impl SecretKey

pub fn random<R>(rng: &mut R) -> Selfwhere R: Rng + ?Sized,

Available on crate features std and random only.

Create a new random secret

pub fn new_from_mnemonic_phrase_with_path( phrase: &str, path: &str ) -> Result<Self, Error>

Available on crate feature std only.

Generate a new secret key from a mnemonic phrase and its derivation path. Both are passed as &str. If you want to manually create a DerivationPath and Mnemonic, use SecretKey::new_from_mnemonic. The derivation path is a list of integers, each representing a child index.

pub fn new_from_mnemonic( d: DerivationPath, m: Mnemonic<English> ) -> Result<Self, Error>

Available on crate feature std only.

Generate a new secret key from a DerivationPath and Mnemonic. If you want to pass strings instead, use SecretKey::new_from_mnemonic_phrase_with_path.

pub unsafe fn is_slice_in_field_unchecked(slice: &[u8]) -> bool

Available on crate feature std only.

Check if the provided slice represents a scalar that fits the field.

Safety

This function extends the unsafety of SecretKey::as_ref_unchecked.

pub fn is_in_field(&self) -> bool

Available on crate feature std only.

Check if the secret key representation fits the scalar field.

pub fn public_key(&self) -> PublicKey

Available on crate feature std only.

Return the curve representation of this secret.

The discrete logarithm property guarantees this is a one-way function.

impl SecretKey

pub const LEN: usize = 32usize

Memory length of the type

pub unsafe fn from_bytes_unchecked(bytes: [u8; 32]) -> Self

Add a conversion from arbitrary slices into owned

Safety

There is no guarantee the provided bytes will fit the field. The field security can be checked with SecretKey::is_in_field.

pub unsafe fn from_slice_unchecked(bytes: &[u8]) -> Self

Add a conversion from arbitrary slices into owned

Safety

This function will not panic if the length of the slice is smaller than Self::LEN. Instead, it will cause undefined behavior and read random disowned bytes.

There is no guarantee the provided bytes will fit the field.

pub unsafe fn as_ref_unchecked(bytes: &[u8]) -> &Self

Copy-free reference cast

There is no guarantee the provided bytes will fit the field.

Safety

Inputs smaller than Self::LEN will cause undefined behavior.

Methods from Deref<Target = [u8; 32]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn each_ref(&self) -> [&T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

Trait Implementations

impl AsRef<[u8]> for SecretKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<SecretKey> for SecretKey

Available on crate feature std only.

fn borrow(&self) -> &Secp256k1SecretKey

Immutably borrows from an owned value.

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SecretKey

fn default() -> SecretKey

Returns the “default value” for a type.

impl Deref for SecretKey

type Target = [u8; 32]

The resulting type after dereferencing.

fn deref(&self) -> &[u8; 32]

Dereferences the value.

impl<'de> Deserialize<'de> for SecretKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Distribution<SecretKey> for Standard

Available on crate features std and random only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> SecretKey

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl Fill for SecretKey

Available on crate features std and random only.

fn try_fill<R: Rng + ?Sized>(&mut self, rng: &mut R) -> Result<(), Error>

Fill self with random data

impl From<&SecretKey> for PublicKey

Available on crate feature std only.

fn from(s: &SecretKey) -> PublicKey

Converts to this type from the input type.

impl From<SecretKey> for [u8; 32]

fn from(salt: SecretKey) -> [u8; 32]

Converts to this type from the input type.

impl FromStr for SecretKey

Available on crate feature std only.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SecretKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for SecretKey

fn cmp(&self, other: &SecretKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SecretKey> for SecretKey

fn eq(&self, other: &SecretKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<SecretKey> for SecretKey

fn partial_cmp(&self, other: &SecretKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SecretKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for SecretKey

Available on crate feature std only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bytes32> for SecretKey

Available on crate feature std only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(b: Bytes32) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Zeroize for SecretKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Copy for SecretKey

impl Eq for SecretKey

impl StructuralEq for SecretKey

impl StructuralPartialEq for SecretKey