Struct fuel_crypto::SecretKey

source · [−]

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

Expand description

Asymmetric secret key

Implementations

source

impl SecretKey

source

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

Available on crate features std and random only.

Create a new random secret

source

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.

source

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.

source

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.

source

pub fn is_in_field(&self) -> bool

Available on crate feature std only.

Check if the secret key representation fits the scalar field.

source

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.

source

impl SecretKey

source

pub const LEN: usize = 32usize

Memory length of the type

source

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.

source

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.

source

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]>

1.57.0 · source

pub fn as_slice(&self) -> &[T]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

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

source

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);

source

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, &[]);
}

source

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]);
}