@hiveio/beekeeper v1.27.6-rc3-stable.241008151748 / 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

Source

src/interfaces.ts:31

---

name

readonly name: string

Name of this wallet

Inherited from

IWallet.name

Source

src/interfaces.ts:23

---

unlocked?

optional readonly unlocked: IBeekeeperUnlockedWallet

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

Source

src/interfaces.ts:178

Methods

close()

close(): IBeekeeperSession

Ensures that this wallet is locked, then closes it

Returns

IBeekeeperSession

Beekeeper session owning the closed wallet

Inherited from

IWallet.close

Throws

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

Source

src/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.)

Source

src/interfaces.ts:170