]> zoso.dev Git - libnemo.git/commitdiff
In Wallet class, greatly expand on accounts method documentation.
authorChris Duncan <chris@zoso.dev>
Tue, 19 Nov 2024 07:03:21 +0000 (23:03 -0800)
committerChris Duncan <chris@zoso.dev>
Tue, 19 Nov 2024 07:03:21 +0000 (23:03 -0800)
src/lib/wallet.ts

index ae3bea24ef1f229e7c654cb55225fe7b33d66c5b..43794964a02ff5c8cc25a18d2ad90e0355dc7677 100644 (file)
@@ -59,6 +59,17 @@ abstract class Wallet {
 \r
        /**\r
        * Retrieves accounts from a wallet using its child key derivation function.\r
+       * Defaults to the first account at index 0.\r
+       *\r
+       * Note: The wallet index of a given requested account might not correlate with\r
+       * its index in the returned array.\r
+       *\r
+       * For example, calling `await wallet.accounts(5)` will return the sixth\r
+       * account of the wallet in the first array element position at index 0.\r
+       *\r
+       * A shorthand way of getting one specific account could be\r
+       * `const account = (await wallet.accounts(N))[0]` where N is the wallet index\r
+       * of the desired account.\r
        *\r
        * @param {number} from - Start index of secret keys. Default: 0\r
        * @param {number} to - End index of secret keys. Default: `from`\r