Struct JsBip39

pub struct JsBip39 { /* private fields */ }

Tool for generating, validating and parsing BIP-0039 phrases in different supported languages.

Implementations

impl JsBip39

pub fn new(lang_code: &str) -> Result<JsBip39, JsValue>

Creates an object that can handle BIP39 phrases in a given language. (e.g. ‘en’)

pub fn generate(&self) -> Result<JsBip39Phrase, JsValue>

Creates a new phrase using the CSPRNG available on the platform.

pub fn entropy(&self, entropy: &[u8]) -> Result<JsBip39Phrase, JsValue>

Creates a new phrase using the 256 bits of entropy provided in a buffer. IOP encourages using 24 word phrases everywhere.

pub fn short_entropy(&self, entropy: &[u8]) -> Result<JsBip39Phrase, JsValue>

Creates a new phrase using the entropy provided in a buffer. This method is only for compatibility with other wallets. Check the BIP39 standard for the buffer sizes allowed.

pub fn validate_phrase(&self, phrase: &str) -> Result<(), JsValue>

Validates a whole BIP39 mnemonic phrase. Because the phrase contains some checksum, the whole phrase can be invalid even when each word itself is valid. Note also, that the standards only allows NFKD normalization of Unicode codepoints, and a single space between words, but this library is more tolerant and provides normalization for those.

pub fn list_words(&self, prefix: &str) -> Box<[JsValue]>

Lists all words in the BIP39 dictionary, which start with the given prefix.

Can be used in 3 different ways:

• When the prefix is empty, the sorted list of all words are returned
• When the prefix is a partial word, the returned list can be used for auto-completion
• When the returned list is empty, the prefix is not a valid word in the dictionary

pub fn phrase(&self, phrase: &str) -> Result<JsBip39Phrase, JsValue>

Validates a whole 24-word BIP39 mnemonic phrase and returns an intermediate object that can be later converted into a Seed with an optional password.

pub fn short_phrase(&self, phrase: &str) -> Result<JsBip39Phrase, JsValue>

Validates a whole BIP39 mnemonic phrase and returns an intermediate object similar to {@link phrase}. This method is only for compatibility with other wallets. Check the BIP39 standard for the number of words allowed.

Trait Implementations

impl Clone for JsBip39

fn clone(&self) -> JsBip39

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsBip39

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

Formats the value using the given formatter.

impl From<JsBip39> for JsValue

fn from(value: JsBip39) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for JsBip39

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

Recover a Self from Self::Abi.

impl IntoWasmAbi for JsBip39

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 JsBip39

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsBip39>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <JsBip39 as LongRefFromWasmAbi>::Abi, ) -> <JsBip39 as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for JsBip39

fn is_none(abi: &<JsBip39 as FromWasmAbi>::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 JsBip39

fn none() -> <JsBip39 as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for JsBip39

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsBip39>

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: <JsBip39 as RefFromWasmAbi>::Abi, ) -> <JsBip39 as RefFromWasmAbi>::Anchor

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

impl RefMutFromWasmAbi for JsBip39

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsBip39>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <JsBip39 as RefMutFromWasmAbi>::Abi, ) -> <JsBip39 as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for JsBip39

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<JsBip39, <JsBip39 as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for JsBip39

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <JsBip39 as VectorFromWasmAbi>::Abi, ) -> Box<[JsBip39]>

impl VectorIntoWasmAbi for JsBip39

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[JsBip39]>, ) -> <JsBip39 as VectorIntoWasmAbi>::Abi