wdb: update types.

Author: nodech

lib/coins/coinview.js

@@ -313,7 +313,7 @@ class CoinView extends View {
    * Get an HD path by prevout.
    * Implemented in {@link WalletCoinView}.
    * @param {Outpoint} prevout
-   * @returns {null}
+   * @returns {*}
    */
 
   getPath(prevout) {
@@ -404,7 +404,7 @@ class CoinView extends View {
    * Get a single path by input.
    * Implemented in {@link WalletCoinView}.
    * @param {Input} input
-   * @returns {null}
+   * @returns {*}
    */
 
   getPathFor(input) {

lib/hd/common.js

@@ -118,7 +118,7 @@ common.isMaster = function isMaster(key) {
 /**
  * Test whether the key is (most likely) a BIP44 account key.
  * @param {HDPrivateKey|HDPublicKey} key
- * @param {Number?} account
+ * @param {Number?} [account]
  * @returns {Boolean}
  */
 

lib/hd/public.js

@@ -237,7 +237,7 @@ class HDPublicKey extends bio.Struct {
   /**
    * Test whether the key is (most likely) a BIP44 account key.
    * @method
-   * @param {Number?} account
+   * @param {Number?} [account]
    * @returns {Boolean}
    */
 

lib/primitives/keyring.js

@@ -106,6 +106,7 @@ class KeyRing extends bio.Struct {
   /**
    * Inject data from private key.
    * @param {Buffer} key
+   * @returns {this}
    */
 
   fromPrivate(key) {

lib/wallet/account.js

@@ -13,7 +13,14 @@ const Path = require('./path');
 const common = require('./common');
 const Script = require('../script/script');
 const WalletKey = require('./walletkey');
-const {HDPublicKey} = require('../hd/hd');
+const HDPublicKey = require('../hd/public');
+
+/** @typedef {import('bdb').DB} DB */
+/** @typedef {ReturnType<DB['batch']>} Batch */
+/** @typedef {import('../types').BufioWriter} BufioWriter */
+/** @typedef {import('./walletdb')} WalletDB */
+/** @typedef {import('./masterkey')} MasterKey */
+/** @typedef {import('../primitives/address')} Address */
 
 /**
  * Account
@@ -28,6 +35,7 @@ class Account extends bio.Struct {
   /**
    * Create an account.
    * @constructor
+   * @param {WalletDB} wdb
    * @param {Object} options
    */
 
@@ -36,22 +44,28 @@ class Account extends bio.Struct {
 
     assert(wdb, 'Database is required.');
 
+    /** @type {WalletDB} */
     this.wdb = wdb;
     this.network = wdb.network;
 
     this.wid = 0;
+    /** @type {String|null} */
     this.id = null;
     this.accountIndex = 0;
+    /** @type {String|null} */
     this.name = null;
     this.initialized = false;
     this.watchOnly = false;
+    /** @type {Account.types} */
     this.type = Account.types.PUBKEYHASH;
     this.m = 1;
     this.n = 1;
     this.receiveDepth = 0;
     this.changeDepth = 0;
     this.lookahead = 200;
+    /** @type {HDPublicKey|null} */
     this.accountKey = null;
+    /** @type {HDPublicKey[]} */
     this.keys = [];
 
     if (options)
@@ -60,8 +74,8 @@ class Account extends bio.Struct {
 
   /**
    * Inject properties from options object.
-   * @private
    * @param {Object} options
+   * @returns {this}
    */
 
   fromOptions(options) {
@@ -155,7 +169,7 @@ class Account extends bio.Struct {
 
   /**
    * Inject properties from options object.
-   * @private
+   * @param {WalletDB} wdb
    * @param {Object} options
    */
 
@@ -168,6 +182,7 @@ class Account extends bio.Struct {
    * the first addresses along with the lookahead
    * addresses). Called automatically from the
    * walletdb.
+   * @param {Batch} b
    * @returns {Promise}
    */
 
@@ -193,6 +208,7 @@ class Account extends bio.Struct {
    * @param {HDPublicKey} key - Account (bip44)
    * key (can be in base58 form).
    * @throws Error on non-hdkey/non-accountkey.
+   * @returns {Boolean} - Whether the key was added.
    */
 
   pushKey(key) {
@@ -230,6 +246,7 @@ class Account extends bio.Struct {
    * @param {HDPublicKey} key - Account (bip44)
    * key (can be in base58 form).
    * @throws Error on non-hdkey/non-accountkey.
+   * @returns {Boolean} - Whether the key was removed.
    */
 
   spliceKey(key) {
@@ -254,8 +271,9 @@ class Account extends bio.Struct {
   /**
    * Add a public account key to the account (multisig).
    * Saves the key in the wallet database.
+   * @param {Batch} b
    * @param {HDPublicKey} key
-   * @returns {Promise}
+   * @returns {Promise<Boolean>}
    */
 
   async addSharedKey(b, key) {
@@ -275,7 +293,7 @@ class Account extends bio.Struct {
   /**
    * Ensure accounts are not sharing keys.
    * @private
-   * @returns {Promise}
+   * @returns {Promise<Boolean>}
    */
 
   async hasDuplicate() {
@@ -291,8 +309,9 @@ class Account extends bio.Struct {
   /**
    * Remove a public account key from the account (multisig).
    * Remove the key from the wallet database.
+   * @param {Batch} b
    * @param {HDPublicKey} key
-   * @returns {Promise}
+   * @returns {Boolean}
    */
 
   removeSharedKey(b, key) {
@@ -308,26 +327,29 @@ class Account extends bio.Struct {
 
   /**
    * Create a new receiving address (increments receiveDepth).
-   * @returns {WalletKey}
+   * @param {Batch} b
+   * @returns {Promise<WalletKey>}
    */
 
-  createReceive() {
-    return this.createKey(0);
+  createReceive(b) {
+    return this.createKey(b, 0);
   }
 
   /**
    * Create a new change address (increments changeDepth).
-   * @returns {WalletKey}
+   * @param {Batch} b
+   * @returns {Promise<WalletKey>}
    */
 
-  createChange() {
-    return this.createKey(1);
+  createChange(b) {
+    return this.createKey(b, 1);
   }
 
   /**
    * Create a new address (increments depth).
-   * @param {Boolean} change
-   * @returns {Promise} - Returns {@link WalletKey}.
+   * @param {Batch} b
+   * @param {Number} branch
+   * @returns {Promise<WalletKey>} - Returns {@link WalletKey}.
    */
 
   async createKey(b, branch) {
@@ -360,6 +382,7 @@ class Account extends bio.Struct {
   /**
    * Derive a receiving address at `index`. Do not increment depth.
    * @param {Number} index
+   * @param {MasterKey} [master]
    * @returns {WalletKey}
    */
 
@@ -370,6 +393,7 @@ class Account extends bio.Struct {
   /**
    * Derive a change address at `index`. Do not increment depth.
    * @param {Number} index
+   * @param {MasterKey} [master]
    * @returns {WalletKey}
    */
 
@@ -381,7 +405,7 @@ class Account extends bio.Struct {
    * Derive an address from `path` object.
    * @param {Path} path
    * @param {MasterKey} master
-   * @returns {WalletKey}
+   * @returns {WalletKey?}
    */
 
   derivePath(path, master) {
@@ -415,6 +439,7 @@ class Account extends bio.Struct {
    * Derive an address at `index`. Do not increment depth.
    * @param {Number} branch
    * @param {Number} index
+   * @param {MasterKey} [master]
    * @returns {WalletKey}
    */
 
@@ -456,7 +481,8 @@ class Account extends bio.Struct {
   /**
    * Save the account to the database. Necessary
    * when address depth and keys change.
-   * @returns {Promise}
+   * @param {Batch} b
+   * @returns {void}
    */
 
   save(b) {
@@ -465,7 +491,8 @@ class Account extends bio.Struct {
 
   /**
    * Save addresses to path map.
-   * @param {WalletKey[]} rings
+   * @param {Batch} b
+   * @param {WalletKey} ring
    * @returns {Promise}
    */
 
@@ -475,7 +502,8 @@ class Account extends bio.Struct {
 
   /**
    * Save paths to path map.
-   * @param {Path[]} rings
+   * @param {Batch} b
+   * @param {Path} path
    * @returns {Promise}
    */
 
@@ -485,6 +513,7 @@ class Account extends bio.Struct {
 
   /**
    * Initialize address depths (including lookahead).
+   * @param {Batch} b
    * @returns {Promise}
    */
 
@@ -510,8 +539,9 @@ class Account extends bio.Struct {
 
   /**
    * Allocate new lookahead addresses if necessary.
-   * @param {Number} receiveDepth
-   * @param {Number} changeDepth
+   * @param {Batch} b
+   * @param {Number} receive
+   * @param {Number} change
    * @returns {Promise<WalletKey?>}
    */
 
@@ -558,6 +588,7 @@ class Account extends bio.Struct {
 
   /**
    * Allocate new lookahead addresses.
+   * @param {Batch} b
    * @param {Number} lookahead
    * @returns {Promise}
    */
@@ -607,7 +638,7 @@ class Account extends bio.Struct {
 
   /**
    * Get current receive key.
-   * @returns {WalletKey}
+   * @returns {WalletKey?}
    */
 
   receiveKey() {
@@ -619,7 +650,7 @@ class Account extends bio.Struct {
 
   /**
    * Get current change key.
-   * @returns {WalletKey}
+   * @returns {WalletKey?}
    */
 
   changeKey() {
@@ -631,7 +662,7 @@ class Account extends bio.Struct {
 
   /**
    * Get current receive address.
-   * @returns {Address}
+   * @returns {Address?}
    */
 
   receiveAddress() {
@@ -645,7 +676,7 @@ class Account extends bio.Struct {
 
   /**
    * Get current change address.
-   * @returns {Address}
+   * @returns {Address?}
    */
 
   changeAddress() {
@@ -690,6 +721,7 @@ class Account extends bio.Struct {
   /**
    * Convert the account to an object suitable for
    * serialization.
+   * @param {Object} [balance=null]
    * @returns {Object}
    */
 
@@ -730,7 +762,8 @@ class Account extends bio.Struct {
 
   /**
    * Serialize the account.
-   * @returns {Buffer}
+   * @param {BufioWriter} bw
+   * @returns {BufioWriter}
    */
 
   write(bw) {
@@ -757,9 +790,7 @@ class Account extends bio.Struct {
 
   /**
    * Inject properties from serialized data.
-   * @private
-   * @param {Buffer} data
-   * @returns {Object}
+   * @param {bio.BufferReader} br
    */
 
   read(br) {
@@ -837,6 +868,12 @@ function cmp(a, b) {
   return a.compare(b);
 }
 
+/**
+ * @param {HDPublicKey} key
+ * @param {BufioWriter} bw
+ * @returns {void}
+ */
+
 function writeKey(key, bw) {
   bw.writeU8(key.depth);
   bw.writeU32BE(key.parentFingerPrint);
@@ -845,6 +882,11 @@ function writeKey(key, bw) {
   bw.writeBytes(key.publicKey);
 }
 
+/**
+ * @param {bio.BufferReader} br
+ * @returns {HDPublicKey}
+ */
+
 function readKey(br) {
   const key = new HDPublicKey();
   key.depth = br.readU8();