Struct JsVault

pub struct JsVault { /* private fields */ }

This object provides a safe serialization format for an in-rest encoded vault file for the IOP Stack™.

Implementations

impl JsVault

pub fn create( phrase: &str, bip39_password: &str, unlock_password: &str, language: Option<String>, ) -> Result<JsVault, JsValue>

Creates a new in-memory vault object from a BIP39 phrase, a seed password (aka 25th word), an unlock password used for encryption of the secrets in rest, and optionally a language code (e.g. ‘zh-hans’ or ‘es’) for the BIP39 phrase words (‘en’ by default).

pub fn load(data: &JsValue) -> Result<JsVault, JsValue>

Loads the vault from its JSON serialization format. Note that no private keys can be calculated without unlocking the loaded vault with {@link unlock} or with some plugins like {@link HydraPlugin.private} or {@link MorpheusPlugin.private}. The public keys can be enumerated and used without the unlock password.

pub fn save(&mut self) -> Result<JsValue, JsValue>

Saves the vault into its JSON serialization format. The private keys are encrypted with the unlock password, but the public keys can be enumerated from the file, so make sure you understand the privacy aspects of sharing such file with 3rd parties.

Note that calling this method clears the {@link dirty} flag on the vault.

pub fn is_dirty(&self) -> Result<bool, JsValue>

Returns whether the vault has changes since it has been last saved.

@see save

pub fn set_to_dirty(&mut self) -> Result<(), JsValue>

Manually sets the dirty flag on the vault.

pub fn unlock(&self, password: &str) -> Result<JsSeed, JsValue>

Unlocks the secrets in the vault with a password. Make sure the password is difficult to guess. Good passwords are a few words randomly picked from huge dictionaries, like what the passphrase option of the Bitwarden password generator creates (See correct horse battery staple).

Trait Implementations

impl From<JsVault> for JsValue

fn from(value: JsVault) -> Self

Converts to this type from the input type.

impl From<Vault> for JsVault

fn from(inner: Vault) -> Self

Converts to this type from the input type.

impl FromWasmAbi for JsVault

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 JsVault

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 JsVault

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsVault>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for JsVault

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 JsVault

fn none() -> Self::Abi

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

impl RefFromWasmAbi for JsVault

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsVault>

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 JsVault

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsVault>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for JsVault

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for JsVault

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

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[JsVault]>

impl VectorIntoJsValue for JsVault

fn vector_into_jsvalue(vector: Box<[JsVault]>) -> JsValue

impl VectorIntoWasmAbi for JsVault

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

fn vector_into_abi(vector: Box<[JsVault]>) -> Self::Abi

impl WasmDescribe for JsVault

fn describe()

impl WasmDescribeVector for JsVault

fn describe_vector()

impl Wraps<Vault> for JsVault

fn inner(&self) -> &Vault

Converts a reference to a WASM type to a reference to the underlying Rust type.

impl WrapsMut<Vault> for JsVault

fn inner_mut(&mut self) -> &mut Vault

Converts an exclusive reference to a WASM type to an exclusive reference to the underlying Rust type.

impl SupportsConstructor for JsVault

impl SupportsInstanceProperty for JsVault

impl SupportsStaticProperty for JsVault