Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperUnlockedWallet.md
View page @ 831efad8
......@@ -2,8 +2,6 @@
# Interface: IBeekeeperUnlockedWallet
Defined in: [src/detailed/interfaces.ts:82](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L82)
## Extends
- [`IWallet`](./IWallet)
......@@ -14,36 +12,38 @@ Defined in: [src/detailed/interfaces.ts:82](https://gitlab.syncad.com/hive/hive/
> `readonly` **isTemporary**: `boolean`
Defined in: [src/detailed/interfaces.ts:31](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L31)
Indicates if wallet exists only in memory or is saved into a file.
#### Inherited from
[`IWallet`](./IWallet).[`isTemporary`](./IWallet#istemporary)
#### Defined in
[src/detailed/interfaces.ts:31](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L31)
***
### name
> `readonly` **name**: `string`
Defined in: [src/detailed/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L23)
Name of this wallet
#### Inherited from
[`IWallet`](./IWallet).[`name`](./IWallet#name)
#### Defined in
[src/detailed/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L23)
## Methods
### close()
> **close**(): [`IBeekeeperSession`](./IBeekeeperSession)
Defined in: [src/detailed/interfaces.ts:15](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L15)
Ensures that this wallet is locked, then closes it
#### Returns
......@@ -60,14 +60,16 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
[`IWallet`](./IWallet).[`close`](./IWallet#close)
#### Defined in
[src/detailed/interfaces.ts:15](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L15)
***
### decryptData()
> **decryptData**(`content`, `key`, `anotherKey`?): `string`
Defined in: [src/detailed/interfaces.ts:148](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L148)
Decrypts given data from a specific entity and returns the decrypted message
#### Parameters
......@@ -100,14 +102,16 @@ decrypted buffer
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:148](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L148)
***
### encryptData()
> **encryptData**(`content`, `key`, `anotherKey`?, `nonce`?): `string`
Defined in: [src/detailed/interfaces.ts:135](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L135)
Encrypts given data for a specific entity and returns the encrypted message
#### Parameters
......@@ -146,14 +150,16 @@ base58 encrypted buffer
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:135](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L135)
***
### getPublicKeys()
> **getPublicKeys**(): `string`[]
Defined in: [src/detailed/interfaces.ts:157](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L157)
Lists all of the public keys
#### Returns
......@@ -166,14 +172,16 @@ a set of all keys for all unlocked wallets
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:157](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L157)
***
### importKey()
> **importKey**(`wifKey`): `Promise`\<`string`\>
Defined in: [src/detailed/interfaces.ts:101](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L101)
Imports given private key to this wallet
#### Parameters
......@@ -194,14 +202,16 @@ Public key generated from the imported private key
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:101](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L101)
***
### lock()
> **lock**(): [`IBeekeeperWallet`](./IBeekeeperWallet)
Defined in: [src/detailed/interfaces.ts:90](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L90)
Locks the current wallet
#### Returns
......@@ -214,14 +224,16 @@ Locked beekeeper wallet
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:90](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L90)
***
### removeKey()
> **removeKey**(`publicKey`): `Promise`\<`void`\>
Defined in: [src/detailed/interfaces.ts:110](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L110)
Removes given key from this wallet
#### Parameters
......@@ -240,14 +252,16 @@ public key in WIF format to match the private key in the wallet to remove
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:110](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L110)
***
### signDigest()
> **signDigest**(`publicKey`, `sigDigest`): `string`
Defined in: [src/detailed/interfaces.ts:122](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L122)
Signs a transaction by signing a digest of the transaction
#### Parameters
......@@ -273,3 +287,7 @@ signed data in hex format
#### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:122](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L122)