Struct kaspa_bip32::Mnemonic

pub struct Mnemonic { /* private fields */ }

BIP39 mnemonic phrases: sequences of words representing cryptographic keys.

Implementations

impl Mnemonic

pub fn constructor( phrase: String, language: Option<Language> ) -> Result<Mnemonic>

pub fn get_entropy(&self) -> String

pub fn set_entropy(&mut self, entropy: String)

pub fn create_random_js(word_count: JsValue) -> Result<Mnemonic>

pub fn phrase_string(&self) -> String

pub fn set_phrase(&mut self, phrase: &str)

pub fn create_seed(&self, password: Option<String>) -> String

impl Mnemonic

pub fn random(word_count: WordCount, language: Language) -> Result<Mnemonic>

pub fn random_impl( word_count: WordCount, rng: impl RngCore + CryptoRng, language: Language ) -> Result<Self>

Create a random BIP39 mnemonic phrase.

pub fn from_entropy(entropy: Vec<u8>, language: Language) -> Result<Self>

Create a new BIP39 mnemonic phrase from the given entropy

pub fn new<S>(phrase: S, language: Language) -> Result<Self>

where S: AsRef<str>,

Create a new BIP39 mnemonic phrase from the given string.

The phrase supplied will be checked for word length and validated according to the checksum specified in BIP0039.

To use the default language, English, (the only one supported by this library and also the only one standardized for BIP39) you can supply Default::default() as the language.

pub fn entropy(&self) -> &Vec<u8>

Get source entropy for this phrase.

pub fn phrase(&self) -> &str

Get the mnemonic phrase as a string reference.

pub fn language(&self) -> Language

Language this phrase’s wordlist is for

pub fn to_seed(&self, password: &str) -> Seed

Convert this mnemonic phrase into the BIP39 seed value.

Trait Implementations

impl Clone for Mnemonic

fn clone(&self) -> Mnemonic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Mnemonic

fn drop(&mut self)

Executes the destructor for this type.

impl From<Mnemonic> for JsValue

fn from(value: Mnemonic) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Mnemonic

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Mnemonic

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Mnemonic

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, Mnemonic>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Mnemonic

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Mnemonic

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Mnemonic

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Mnemonic>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Mnemonic

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Mnemonic>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for Mnemonic

fn describe()