From abe4598265aa394ac10f3cef7ce40204d7cfa555 Mon Sep 17 00:00:00 2001
From: Chris Duncan <chris@zoso.dev>
Date: Mon, 7 Oct 2024 12:44:31 -0700
Subject: [PATCH] Fix wallet CKD documentation. Add documentation to Ledger
 lock and unlock methods to indicate that the default behavior is overridden.

---
 src/lib/wallet.ts | 31 ++++++++++++++++++++++++++-----
 1 file changed, 26 insertions(+), 5 deletions(-)

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