Fix wallet CKD documentation. Add documentation to Ledger lock and unlock methods...

diff --git a/src/lib/wallet.ts b/src/lib/wallet.ts
index 7a7ae26b896c6281377b86e609df398ad9b52c1a..32d80c734f29fb9f32ce8b1b1aaa47b55dd738e9 100644 (file)
--- a/src/lib/wallet.ts
+++ b/src/lib/wallet.ts
@@ -374,9 +374,8 @@ export class Bip44Wallet extends Wallet {
        /**\r
        * Derives BIP-44 Nano account private keys.\r
        *\r
-       * @param {number} from - Start index of private keys. Default: 0\r
-       * @param {number} to - End index of private keys. Default: `from`\r
-       * @returns {Promise<Account[]>}\r
+       * @param {number} index - Index of the account\r
+       * @returns {Promise<Account>}\r
        */\r
        async ckd (index: number): Promise<Account> {\r
                const key = await nanoCKD(this.seed, index)\r
@@ -502,8 +501,8 @@ export class Blake2bWallet extends Wallet {
        /**\r
        * Derives BLAKE2b account private keys.\r
        *\r
-       * @param {number} from - Start index of private keys. Default: 0\r
-       * @param {number} to - End index of private keys. Default: `from`\r
+       * @param {number} index - Index of the account\r
+       * @returns {Promise<Account>}\r
        */\r
        async ckd (index: number): Promise<Account> {\r
                const hash = await Tools.blake2b([this.seed, dec.toHex(index, 4)])\r
@@ -551,6 +550,12 @@ export class LedgerWallet extends Wallet {
                return new this(l)\r
        }\r
 \r
+       /**\r
+       * Gets the public key for an account from the Ledger device.\r
+       *\r
+       * @param {number} index - Index of the account\r
+       * @returns {Promise<Account>}\r
+       */\r
        async ckd (index: number): Promise<Account | null> {\r
                const { status, publicKey } = await this.ledger.account(index)\r
                if (status === 'OK' && publicKey != null) {\r
@@ -559,6 +564,14 @@ export class LedgerWallet extends Wallet {
                return null\r
        }\r
 \r
+       /**\r
+       * Attempts to close the current process on the Ledger device.\r
+       *\r
+       * Overrides the default wallet `lock()` method since as a hardware wallet it\r
+       * does not need to be encrypted by software.\r
+       *\r
+       * @returns True if successfully locked\r
+       */\r
        async lock (): Promise<boolean> {\r
                if (this.#ledger == null) {\r
                        return false\r
@@ -567,6 +580,14 @@ export class LedgerWallet extends Wallet {
                return result === 'OK'\r
        }\r
 \r
+       /**\r
+       * Attempts to connect to the Ledger device.\r
+       *\r
+       * Overrides the default wallet `unlock()` method since as a hardware wallet it\r
+       * does not need to be encrypted by software.\r
+       *\r
+       * @returns True if successfully unlocked\r
+       */\r
        async unlock (): Promise<boolean> {\r
                if (this.#ledger == null) {\r
                        return false\r