Struct SecretKey 

pub struct SecretKey { /* private fields */ }

Ed25519 or Secp256k1 secret key.

Implementations

impl SecretKey

pub fn generate_ed25519() -> Self

Generate a new random Ed25519 key pair.

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

Create an Ed25519 secret key from raw 32 bytes.

pub fn key_type(&self) -> KeyType

Get the key type.

pub fn as_bytes(&self) -> &[u8]

Get the raw key bytes.

pub fn public_key(&self) -> PublicKey

Derive the public key.

pub fn sign(&self, message: &[u8]) -> Signature

Sign a message.

pub fn from_seed_phrase(phrase: impl AsRef<str>) -> Result<Self, SignerError>

Derive an Ed25519 secret key from a BIP-39 seed phrase.

Uses SLIP-10 derivation with the default NEAR HD path (m/44'/397'/0').

Arguments

• phrase - BIP-39 mnemonic phrase (12, 15, 18, 21, or 24 words)

Example

use near_kit::SecretKey;

// Valid BIP-39 mnemonic (all zeros entropy)
let phrase = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
let secret_key = SecretKey::from_seed_phrase(phrase).unwrap();

pub fn from_seed_phrase_with_path( phrase: impl AsRef<str>, hd_path: impl AsRef<str>, ) -> Result<Self, SignerError>

Derive an Ed25519 secret key from a BIP-39 seed phrase with custom HD path.

Uses SLIP-10 derivation for Ed25519 keys. Only hardened derivation paths are supported (all path components must use ' suffix).

Arguments

• phrase - BIP-39 mnemonic phrase (12, 15, 18, 21, or 24 words)
• hd_path - BIP-32 derivation path (e.g., "m/44'/397'/0'")

Example

use near_kit::SecretKey;

let phrase = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
let secret_key = SecretKey::from_seed_phrase_with_path(phrase, "m/44'/397'/1'").unwrap();

pub fn from_seed_phrase_with_path_and_passphrase( phrase: impl AsRef<str>, hd_path: impl AsRef<str>, passphrase: Option<&str>, ) -> Result<Self, SignerError>

Derive an Ed25519 secret key from a BIP-39 seed phrase with passphrase.

The passphrase provides additional entropy for seed generation (BIP-39 feature). An empty passphrase is equivalent to no passphrase.

Arguments

• phrase - BIP-39 mnemonic phrase
• hd_path - BIP-32 derivation path
• passphrase - Optional passphrase for additional entropy

Example

use near_kit::SecretKey;

let phrase = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
let secret_key = SecretKey::from_seed_phrase_with_path_and_passphrase(
    phrase,
    "m/44'/397'/0'",
    Some("my-passphrase")
).unwrap();

pub fn generate_with_seed_phrase() -> Result<(String, Self), SignerError>

Generate a new random seed phrase and derive the corresponding secret key.

Returns both the seed phrase (for backup) and the derived secret key. Uses 12 words by default and the standard NEAR HD path.

Example

use near_kit::SecretKey;

let (phrase, secret_key) = SecretKey::generate_with_seed_phrase().unwrap();
println!("Backup your seed phrase: {}", phrase);

pub fn generate_with_seed_phrase_words( word_count: usize, ) -> Result<(String, Self), SignerError>

Generate a new random seed phrase with custom word count.

Arguments

• word_count - Number of words (12, 15, 18, 21, or 24)

Example

use near_kit::SecretKey;

let (phrase, secret_key) = SecretKey::generate_with_seed_phrase_words(24).unwrap();
assert_eq!(phrase.split_whitespace().count(), 24);

pub fn generate_with_seed_phrase_custom( word_count: usize, hd_path: impl AsRef<str>, passphrase: Option<&str>, ) -> Result<(String, Self), SignerError>

Generate a new random seed phrase with full customization.

Arguments

• word_count - Number of words (12, 15, 18, 21, or 24)
• hd_path - BIP-32 derivation path
• passphrase - Optional passphrase for additional entropy

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate 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 Display for SecretKey

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

Formats the value using the given formatter.

impl FromStr for SecretKey

type Err = ParseKeyError

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 TryFrom<&str> for SecretKey

type Error = ParseKeyError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.