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 @ f9adb2a4
...@@ -20,7 +20,7 @@ Indicates if wallet exists only in memory or is saved into a file. ...@@ -20,7 +20,7 @@ Indicates if wallet exists only in memory or is saved into a file.
#### Defined in #### Defined in
[src/detailed/interfaces.ts:31](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L31) [src/detailed/interfaces.ts:31](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L31)
*** ***
...@@ -36,7 +36,7 @@ Name of this wallet ...@@ -36,7 +36,7 @@ Name of this wallet
#### Defined in #### Defined in
[src/detailed/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L23) [src/detailed/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L23)
## Methods ## Methods
...@@ -62,7 +62,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -62,7 +62,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:15](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L15) [src/detailed/interfaces.ts:15](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L15)
*** ***
...@@ -96,7 +96,7 @@ other public key to find the private key in the wallet and decrypt the data (opt ...@@ -96,7 +96,7 @@ other public key to find the private key in the wallet and decrypt the data (opt
`string` `string`
decrypted buffer decrypted buffer as a JS string
#### Throws #### Throws
...@@ -104,7 +104,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -104,7 +104,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:167](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L167) [src/detailed/interfaces.ts:168](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L168)
*** ***
...@@ -120,25 +120,25 @@ Encrypts given data for a specific entity and returns the encrypted message ...@@ -120,25 +120,25 @@ Encrypts given data for a specific entity and returns the encrypted message
`string` `string`
Content to be encrypted Content to be encrypted. Does not have to be in any specific format. Can contain any characters encodable by JS string (UTF-16 characters)
##### key ##### key
`string` `string`
public key to find the private key in the wallet and encrypt the data public key in WIF format to find the private key in the wallet and encrypt the data
##### anotherKey? ##### anotherKey?
`string` `string`
other public key to find the private key in the wallet and encrypt the data (optional - use if the message is to encrypt for somebody else) other public key in WIF format to find the private key in the wallet and encrypt the data (optional - use if the message is to encrypt for somebody else)
##### nonce? ##### nonce?
`number` `number`
optional nonce to be explicitly specified for encryption optional nonce to be explicitly specified for encryption. Used for reproducible results. If not provided, random nonce is generated internally
#### Returns #### Returns
...@@ -152,7 +152,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -152,7 +152,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:154](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L154) [src/detailed/interfaces.ts:155](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L155)
*** ***
...@@ -174,7 +174,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -174,7 +174,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:176](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L176) [src/detailed/interfaces.ts:177](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L177)
*** ***
...@@ -182,7 +182,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -182,7 +182,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
> **importKey**(`wifKey`): `Promise`\<`string`\> > **importKey**(`wifKey`): `Promise`\<`string`\>
Imports given private key to this wallet Imports given private key to this wallet and returns the associated public key for further use
#### Parameters #### Parameters
...@@ -196,7 +196,7 @@ private key in WIF format to import ...@@ -196,7 +196,7 @@ private key in WIF format to import
`Promise`\<`string`\> `Promise`\<`string`\>
Public key generated from the imported private key Public key associated with the imported private key in WIF format with 'STM' prefix
#### Throws #### Throws
...@@ -204,7 +204,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -204,7 +204,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:120](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L120) [src/detailed/interfaces.ts:121](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L121)
*** ***
...@@ -226,7 +226,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -226,7 +226,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:109](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L109) [src/detailed/interfaces.ts:110](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L110)
*** ***
...@@ -250,11 +250,11 @@ public key in WIF format to match the private key in the wallet to remove ...@@ -250,11 +250,11 @@ public key in WIF format to match the private key in the wallet to remove
#### Throws #### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) if key not found or on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in #### Defined in
[src/detailed/interfaces.ts:129](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L129) [src/detailed/interfaces.ts:130](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L130)
*** ***
...@@ -274,9 +274,9 @@ public key in WIF format to match the private key in the wallet. It will be used ...@@ -274,9 +274,9 @@ public key in WIF format to match the private key in the wallet. It will be used
##### sigDigest ##### sigDigest
`string` digest of a transaction in hex format or as an array of bytes to be signed
digest of a transaction in hex format `string` | `Uint8Array`\<`ArrayBufferLike`\>
#### Returns #### Returns
...@@ -290,4 +290,4 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -290,4 +290,4 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
[src/detailed/interfaces.ts:141](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L141) [src/detailed/interfaces.ts:142](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L142)