wallet: update client types.

Author: nodech

lib/node/spvnode.js

@@ -372,7 +372,7 @@ class SPVNode extends Node {
   /**
    * Get current name state.
    * @param {Buffer} nameHash
-   * @returns {NameState}
+   * @returns {Promise<NameState>}
    */
 
   async getNameStatus(nameHash) {

lib/wallet/client.js

@@ -114,6 +114,12 @@ class WalletClient extends NodeClient {
     return NameState.fromJSON(json);
   }
 
+  /**
+   * @param {Hash} hash
+   * @param {Number} index
+   * @returns {Promise<Coin>}
+   */
+
   async getCoin(hash, index) {
     const json = super.getCoin(hash, index);
     return Coin.fromJSON(json);

lib/wallet/migrations.js

@@ -35,7 +35,7 @@ const {
 const layouts = require('./layout');
 const wlayout = layouts.wdb;
 
-/** @typedef {import('../migrations/migrator').MigrationType} MigrationType */
+/** @typedef {import('../migrations/migrator').types} MigrationType */
 /** @typedef {ReturnType<bdb.DB['batch']>} Batch */
 /** @typedef {ReturnType<bdb.DB['bucket']>} Bucket */
 /** @typedef {import('./walletdb')} WalletDB */
@@ -166,7 +166,7 @@ class MigrateChangeAddress extends AbstractMigration {
   /**
    * Actual migration
    * @param {Batch} b
-   * @param {WalletMigrationResult} pending
+   * @param {WalletMigrationResult} [pending]
    * @returns {Promise}
    */
 
@@ -520,7 +520,7 @@ class MigrateTXDBBalances extends AbstractMigration {
   /**
    * Actual migration
    * @param {Batch} b
-   * @param {WalletMigrationResult} pending
+   * @param {WalletMigrationResult} [pending]
    * @returns {Promise}
    */
 
@@ -1458,7 +1458,7 @@ class WalletMigratorOptions {
 
 function fromU32(num) {
   const data = Buffer.allocUnsafe(4);
-  data.writeUInt32LE(num, 0, true);
+  data.writeUInt32LE(num, 0);
   return data;
 }
 

lib/wallet/nodeclient.js

@@ -10,7 +10,15 @@ const assert = require('bsert');
 const blacklist = require('bsock/lib/blacklist');
 const AsyncEmitter = require('bevent');
 
-/** @typedef {import('../node/node')} Node */
+/** @typedef {import('@handshake-org/bfilter').BloomFilter} BloomFilter */
+/** @typedef {import('../types').Hash} Hash */
+/** @typedef {import('../primitives/tx')} TX */
+/** @typedef {import('../primitives/claim')} Claim */
+/** @typedef {import('../covenants/namestate')} NameState */
+/** @typedef {import('../blockchain/chainentry')} ChainEntry */
+/** @typedef {import('../node/fullnode')} FullNode */
+/** @typedef {import('../node/spvnode')} SPVNode */
+/** @typedef {FullNode|SPVNode} Node */
 
 /**
  * Node Client
@@ -73,7 +81,7 @@ class NodeClient extends AsyncEmitter {
 
   /**
    * Open the client.
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async open() {
@@ -84,7 +92,7 @@ class NodeClient extends AsyncEmitter {
 
   /**
    * Close the client.
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async close() {
@@ -148,7 +156,7 @@ class NodeClient extends AsyncEmitter {
 
   /**
    * Get chain tip.
-   * @returns {Promise}
+   * @returns {Promise<ChainEntry>}
    */
 
   async getTip() {
@@ -158,7 +166,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Get chain entry.
    * @param {Hash} hash
-   * @returns {Promise}
+   * @returns {Promise<ChainEntry?>}
    */
 
   async getEntry(hash) {
@@ -176,7 +184,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Send a transaction. Do not wait for promise.
    * @param {TX} tx
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async send(tx) {
@@ -186,7 +194,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Send a claim. Do not wait for promise.
    * @param {Claim} claim
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async sendClaim(claim) {
@@ -195,8 +203,8 @@ class NodeClient extends AsyncEmitter {
 
   /**
    * Set bloom filter.
-   * @param {Bloom} filter
-   * @returns {Promise}
+   * @param {BloomFilter} filter
+   * @returns {Promise<void>}
    */
 
   async setFilter(filter) {
@@ -207,7 +215,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Add data to filter.
    * @param {Buffer} data
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async addFilter(data) {
@@ -220,7 +228,7 @@ class NodeClient extends AsyncEmitter {
 
   /**
    * Reset filter.
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async resetFilter() {
@@ -230,7 +238,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Esimate smart fee.
    * @param {Number?} blocks
-   * @returns {Promise}
+   * @returns {Promise<Number>}
    */
 
   async estimateFee(blocks) {
@@ -244,7 +252,7 @@ class NodeClient extends AsyncEmitter {
    * Get hash range.
    * @param {Number} start
    * @param {Number} end
-   * @returns {Promise}
+   * @returns {Promise<Hash[]>}
    */
 
   async getHashes(start = -1, end = -1) {
@@ -265,7 +273,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Rescan for any missed transactions.
    * @param {Number|Hash} start - Start block.
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async rescan(start) {
@@ -281,7 +289,7 @@ class NodeClient extends AsyncEmitter {
    * Rescan interactive for any missed transactions.
    * @param {Number|Hash} start - Start block.
    * @param {Boolean} [fullLock=false]
-   * @returns {Promise}
+   * @returns {Promise<void>}
    */
 
   async rescanInteractive(start, fullLock = true) {
@@ -308,7 +316,7 @@ class NodeClient extends AsyncEmitter {
   /**
    * Get name state.
    * @param {Buffer} nameHash
-   * @returns {Object}
+   * @returns {Promise<NameState>}
    */
 
   async getNameStatus(nameHash) {