interfaces/IBeekeeperWallet.md

+[@hiveio/beekeeper v1.27.6-rc1-stable.240626220315](../globals) / IBeekeeperWallet
+
+# Interface: IBeekeeperWallet
+
+## Extends
+
+- [`IWallet`](./IWallet)
+
+## Properties
+
+### name
+
+> `readonly` **name**: `string`
+
+Name of this wallet
+
+#### Inherited from
+
+[`IWallet`](./IWallet).[`name`](./IWallet#name)
+
+#### Source
+
+[src/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L23)
+
+***
+
+### unlocked?
+
+> `optional` `readonly` **unlocked**: [`IBeekeeperUnlockedWallet`](./IBeekeeperUnlockedWallet)
+
+Indicates if the wallet is unlocked. If the wallet is locked, this property will be undefined. IBeekeeperUnlockedWallet type otherwise
+
+#### Source
+
+[src/interfaces.ts:170](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L170)
+
+## Methods
+
+### close()
+
+> **close**(): [`IBeekeeperSession`](./IBeekeeperSession)
+
+Ensures that this wallet is locked, then closes it
+
+#### Returns
+
+[`IBeekeeperSession`](./IBeekeeperSession)
+
+Beekeeper session owning the closed wallet
+
+#### Inherited from
+
+[`IWallet`](./IWallet).[`close`](./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](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L15)
+
+***
+
+### unlock()
+
+> **unlock**(`password`): [`IBeekeeperUnlockedWallet`](./IBeekeeperUnlockedWallet)
+
+Unlocks this wallet
+
+#### Parameters
+
+• **password**: `string`
+
+password to the wallet
+
+#### Returns
+
+[`IBeekeeperUnlockedWallet`](./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:162](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L162)