Changes

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