@hiveio/beekeeper / IBeekeeperWallet

Interface: IBeekeeperWallet

Extends

• IWallet

Properties

isTemporary

readonly isTemporary: boolean

Indicates if wallet exists only in memory or is saved into a file.

Inherited from

IWallet.isTemporary

Defined in

src/detailed/interfaces.ts:31

---

name

readonly name: string

Name of this wallet

Inherited from

IWallet.name

Defined in

src/detailed/interfaces.ts:23

---

unlocked?

readonly optional unlocked: IBeekeeperUnlockedWallet

Indicates if the wallet is unlocked. If the wallet is locked, this property will be undefined. IBeekeeperUnlockedWallet type otherwise

Defined in

src/detailed/interfaces.ts:187

Methods

close()

close(): IBeekeeperSession

Ensures that this wallet is locked, then closes it

Returns

IBeekeeperSession

Beekeeper session owning the closed wallet

Throws

on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)

Inherited from

IWallet.close

Defined in

src/detailed/interfaces.ts:15

---

unlock()

unlock(password): IBeekeeperUnlockedWallet

Unlocks this wallet

Parameters

password

string

password to the wallet

Returns

IBeekeeperUnlockedWallet

Unlocked Beekeeper wallet

Throws

on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)

Defined in

src/detailed/interfaces.ts:179