Struct JsHydraPrivate

pub struct JsHydraPrivate { /* private fields */ }

Private keys of a Hydra account in a vault.

@see HydraPlugin.priv

Implementations

impl JsHydraPrivate

pub fn public(&self) -> JsHydraPublic

Access to the public keys of the account. Same as {@link HydraPlugin.pub} would return.

pub fn network(&self) -> String

Name of the network this account belongs to.

pub fn key(&mut self, idx: i32) -> Result<JsBip44Key, JsValue>

Calculates the receiving address having the given index and takes note that the address was already generated in the account.

@see Bip44Account.key, Bip44Account.chain

pub fn key_by_pk(&self, id: &JsSecpPublicKey) -> Result<JsBip44Key, JsValue>

Finds the {@link Bip44Key} private api that belongs to the given {@link SecpPublicKey}. You can check the index of the key or get the actual {@link SecpPrivateKey} from the returned object.

Throws an error if the public key is not in this account, which can also happen when the key was derived outside the vault and therefore the vault does not know it was already used. In that case, make sure to “touch” the last key index used by calling {@link key} before calling this method.

pub fn xpub(&self) -> Result<String, JsValue>

The extended public key for auditing the whole Bip44 account or deriving new public keys outside the vault.

pub fn xprv(&self) -> String

The extended private key for the whole account. This is only for exporting into other BIP32 compatible wallets.

This is a secret that must not be kept unencrypted in transit or in rest!

pub fn receive_keys(&self) -> Result<u32, JsValue>

How many receive addresses have been used in this {@link Bip44Account}

pub fn change_keys(&self) -> Result<u32, JsValue>

How many change addresses have been used in this {@link Bip44Account}

pub fn sign_hydra_transaction( &self, hyd_addr: &str, tx: &JsValue, ) -> Result<JsValue, JsValue>

Signs the Hydra transaction with the private key that belongs to the given P2PKH address.

Fills in signature and id fields, so those can be missing in the unsigned input, but the public key needs to be already properly set to the one matching the signer address.

Throws an error if the address is not in this account, which can also happen when the key was derived outside the vault and therefore the vault does not know it was already used. In that case, make sure to “touch” the last key index used by calling {@link key} before calling this method.

Trait Implementations

impl From<JsHydraPrivate> for JsValue

fn from(value: JsHydraPrivate) -> Self

Converts to this type from the input type.

impl From<Private> for JsHydraPrivate

fn from(inner: Private) -> Self

Converts to this type from the input type.

impl FromWasmAbi for JsHydraPrivate

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 JsHydraPrivate

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 JsHydraPrivate

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsHydraPrivate>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for JsHydraPrivate

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 JsHydraPrivate

fn none() -> Self::Abi

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

impl RefFromWasmAbi for JsHydraPrivate

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsHydraPrivate>

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 JsHydraPrivate

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsHydraPrivate>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for JsHydraPrivate

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 JsHydraPrivate

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

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

impl VectorIntoJsValue for JsHydraPrivate

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

impl VectorIntoWasmAbi for JsHydraPrivate

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

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

impl WasmDescribe for JsHydraPrivate

fn describe()

impl WasmDescribeVector for JsHydraPrivate

fn describe_vector()

impl Wraps<Private> for JsHydraPrivate

fn inner(&self) -> &Private

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

impl SupportsConstructor for JsHydraPrivate

impl SupportsInstanceProperty for JsHydraPrivate

impl SupportsStaticProperty for JsHydraPrivate