Skip to content
Snippets Groups Projects
Verified Commit 2f453c94 authored by Mateusz Tyszczak's avatar Mateusz Tyszczak :scroll:
Browse files

Fix minor node beekeeper documentation issues

parent 8a236ab9
No related branches found
No related tags found
3 merge requests!1506Changes made since last release,!1463Merge develop to master for release,!1206Fix minor node beekeeper documentation issues
Hide whitespace changes
Inline Side-by-side
programs/beekeeper/beekeeper_wasm/api.md
+ 45
− 35
View file @ 2f453c94
......@@ -22,7 +22,7 @@
#### Defined in
src/interfaces.ts:1
src/interfaces.ts:4
___
......@@ -32,21 +32,31 @@ ___
#### Defined in
src/interfaces.ts:2
src/interfaces.ts:5
## Variables
### DEFAULT\_STORAGE\_ROOT
• `Const` **DEFAULT\_STORAGE\_ROOT**: ``"/storage_root"``
#### Defined in
src/web.ts:10
## Functions
### default
▸ **default**(`options?`): `Promise`\<[`IBeekeeperInstance`](#interfacesibeekeeperinstancemd)\>
▸ **default**(`...args`): `Promise`\<[`IBeekeeperInstance`](#interfacesibeekeeperinstancemd)\>
Creates a Beekeeper instance able to own sessions and wallets
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `options` | `Partial`\<[`IBeekeeperOptions`](#interfacesibeekeeperoptionsmd)\> | options passed to the WASM Beekeeper |
| Name | Type |
| :------ | :------ |
| `...args` | [options: Partial\<IBeekeeperOptions\>] |
#### Returns
......@@ -60,7 +70,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/detailed/beekeeper.web.ts:21
node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:365
<a name="interfacesibeekeeperinfomd"></a>
......@@ -79,7 +89,7 @@ Note: Time is in format: YYYY-MM-DDTHH:mm:ss
#### Defined in
src/interfaces.ts:31
src/interfaces.ts:34
___
......@@ -93,7 +103,7 @@ Note: Time is in format: YYYY-MM-DDTHH:mm:ss
#### Defined in
src/interfaces.ts:40
src/interfaces.ts:43
<a name="interfacesibeekeeperinstancemd"></a>
......@@ -126,7 +136,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:232
src/interfaces.ts:235
___
......@@ -146,7 +156,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:239
src/interfaces.ts:242
<a name="interfacesibeekeeperoptionsmd"></a>
......@@ -169,7 +179,7 @@ true
#### Defined in
src/interfaces.ts:58
src/interfaces.ts:61
___
......@@ -183,7 +193,7 @@ Defaults to "/storage_root" for web and "." for web
#### Defined in
src/interfaces.ts:51
src/interfaces.ts:54
___
......@@ -203,7 +213,7 @@ Activity is defined as any wallet command e.g. list-wallets
#### Defined in
src/interfaces.ts:68
src/interfaces.ts:71
<a name="interfacesibeekeepersessionmd"></a>
......@@ -230,7 +240,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:219
src/interfaces.ts:222
___
......@@ -259,7 +269,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:190
src/interfaces.ts:193
___
......@@ -281,7 +291,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:169
src/interfaces.ts:172
___
......@@ -303,7 +313,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:178
src/interfaces.ts:181
___
......@@ -325,7 +335,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:210
src/interfaces.ts:213
___
......@@ -353,7 +363,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:201
src/interfaces.ts:204
<a name="interfacesibeekeeperunlockedwalletmd"></a>
......@@ -380,7 +390,7 @@ Name of this wallet
#### Defined in
src/interfaces.ts:20
src/interfaces.ts:23
## Methods
......@@ -406,7 +416,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:12
src/interfaces.ts:15
___
......@@ -428,7 +438,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:121
src/interfaces.ts:124
___
......@@ -456,7 +466,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:90
src/interfaces.ts:93
___
......@@ -478,7 +488,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:79
src/interfaces.ts:82
___
......@@ -505,7 +515,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:100
src/interfaces.ts:103
___
......@@ -534,7 +544,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:112
src/interfaces.ts:115
<a name="interfacesibeekeeperwalletmd"></a>
......@@ -561,7 +571,7 @@ Name of this wallet
#### Defined in
src/interfaces.ts:20
src/interfaces.ts:23
___
......@@ -573,7 +583,7 @@ Indicates if the wallet is unlocked. If the wallet is locked, this property will
#### Defined in
src/interfaces.ts:142
src/interfaces.ts:145
## Methods
......@@ -599,7 +609,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:12
src/interfaces.ts:15
___
......@@ -627,7 +637,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:134
src/interfaces.ts:137
<a name="interfacesiwalletmd"></a>
......@@ -652,7 +662,7 @@ Name of this wallet
#### Defined in
src/interfaces.ts:20
src/interfaces.ts:23
## Methods
......@@ -674,7 +684,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in
src/interfaces.ts:12
src/interfaces.ts:15
<a name="interfacesiwalletcreatedmd"></a>
......@@ -691,7 +701,7 @@ Password used for unlocking your wallet
#### Defined in
src/interfaces.ts:158
src/interfaces.ts:161
___
......@@ -703,4 +713,4 @@ Unlocked, ready to use wallet
#### Defined in
src/interfaces.ts:151
src/interfaces.ts:154
programs/beekeeper/beekeeper_wasm/package.json
+ 2
− 1
View file @ 2f453c94
......@@ -40,7 +40,8 @@
"types": "./dist/bundle/node.d.ts",
"default": "./dist/bundle/node.js"
}
}
},
"./package.json": "./package.json"
},
"files": [
"LICENSE.md",
......
programs/beekeeper/beekeeper_wasm/src/interfaces.ts
+ 18
− 15
View file @ 2f453c94
// @ts-expect-error ts(6133) Type BeekeeperError is used in JSDoc
import type { BeekeeperError } from "./errors";
export type TPublicKey = string;
export type TSignature = string;
......@@ -7,7 +10,7 @@ export interface IWallet {
*
* @returns {IBeekeeperSession} Beekeeper session owning the closed wallet
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
close(): IBeekeeperSession;
......@@ -74,7 +77,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
*
* @returns {IBeekeeperWallet} Locked beekeeper wallet
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
lock(): IBeekeeperWallet;
......@@ -85,7 +88,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
*
* @returns {Promise<TPublicKey>} Public key generated from the imported private key
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
importKey(wifKey: string): Promise<TPublicKey>;
......@@ -95,7 +98,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
* @param {string} password password to the wallet
* @param {TPublicKey} publicKey public key in WIF format to match the private key in the wallet to remove
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
removeKey(password: string, publicKey: TPublicKey): Promise<void>;
......@@ -107,7 +110,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
*
* @returns {TSignature} signed data in hex format
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
signDigest(publicKey: TPublicKey, sigDigest: string): TSignature;
......@@ -116,7 +119,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
*
* @returns {TPublicKey[]} a set of all keys for all unlocked wallets
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
getPublicKeys(): TPublicKey[];
}
......@@ -129,7 +132,7 @@ export interface IBeekeeperWallet extends IWallet {
*
* @returns {IBeekeeperUnlockedWallet} Unlocked Beekeeper wallet
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
unlock(password: string): IBeekeeperUnlockedWallet;
......@@ -164,7 +167,7 @@ export interface IBeekeeperSession {
*
* @returns {IBeekeeperInfo} Current session information
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
getInfo(): IBeekeeperInfo;
......@@ -173,7 +176,7 @@ export interface IBeekeeperSession {
*
* @returns {Array<IBeekeeperWallet>} array of opened Beekeeper wallets (either unlocked or locked)
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
listWallets(): Array<IBeekeeperWallet>;
......@@ -185,7 +188,7 @@ export interface IBeekeeperSession {
*
* @returns {Promise<IWalletCreated>} the created unlocked Beekeeper wallet object
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
createWallet(name: string, password?: string): Promise<IWalletCreated>;
......@@ -196,7 +199,7 @@ export interface IBeekeeperSession {
*
* @returns {IBeekeeperWallet} the opened Beekeeper wallet object (may be unlocked if it has been previously unlocked)
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
openWallet(name: string): IBeekeeperWallet;
......@@ -205,7 +208,7 @@ export interface IBeekeeperSession {
*
* @returns {Array<IBeekeeperWallet>} array of the locked Beekeeper wallets
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
lockAll(): Array<IBeekeeperWallet>;
......@@ -214,7 +217,7 @@ export interface IBeekeeperSession {
*
* @returns {IBeekeeperInstance} Beekeeper instance owning the closed session
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
close(): IBeekeeperInstance;
}
......@@ -227,14 +230,14 @@ export interface IBeekeeperInstance {
*
* @returns {IBeekeeperSession} a beekeeper session created explicitly. It can be used for further work for example: creating/closing wallets, importing keys, signing transactions etc.
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
createSession(salt: string): IBeekeeperSession;
/**
* Locks all of the unlocked wallets, closes them, closes opened sessions and deletes the current Beekeeper API instance making it unusable
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
delete(): Promise<void>;
}
programs/beekeeper/beekeeper_wasm/src/node.ts
+ 4
− 1
View file @ 2f453c94
// @ts-expect-error ts(6133) Type BeekeeperError is used in JSDoc
import type { BeekeeperError } from "./errors";
import createBeekeeperBase from "./detailed/beekeeper.js";
import Beekeeper from "./beekeeper.js";
......@@ -13,7 +16,7 @@ export const DEFAULT_STORAGE_ROOT = "./storage_root-node";
*
* @returns {Promise<IBeekeeperInstance>} Beekeeper API Instance
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
const createBeekeeper = createBeekeeperBase.bind(undefined, Beekeeper, DEFAULT_STORAGE_ROOT);
......
programs/beekeeper/beekeeper_wasm/src/web.ts
+ 4
− 1
View file @ 2f453c94
// @ts-expect-error ts(6133) Type BeekeeperError is used in JSDoc
import type { BeekeeperError } from "./errors";
import createBeekeeperBase from "./detailed/beekeeper.js";
import Beekeeper from "./beekeeper.js";
......@@ -13,7 +16,7 @@ export const DEFAULT_STORAGE_ROOT = "/storage_root";
*
* @returns {Promise<IBeekeeperInstance>} Beekeeper API Instance
*
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
* @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/
const createBeekeeper = createBeekeeperBase.bind(undefined, Beekeeper, DEFAULT_STORAGE_ROOT);
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment