Merge PR #918 from 'nodech/wallet-doc-updates'

handshake-org · Jan 15, 2025 · 886f651 · 886f651
2 parents 343525a + 0205dce
commit 886f651
Show file tree

Hide file tree

Showing 21 changed files with 846 additions and 602 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -13,11 +13,14 @@ jobs:
     - name: Setup
       uses: actions/setup-node@v4
       with:
-        node-version: 18.x
+        node-version: 22.x
 
     - name: Install dependencies
       run: npm install --location=global bslint @hns-dev/bsdoc
 
+    - name: Install bslintrc
+      run: npm install bslintrc
+
     - name: Lint
       run: npm run lint
 
@@ -34,7 +37,7 @@ jobs:
     - name: Setup
       uses: actions/setup-node@v4
       with:
-        node-version: 20.x
+        node-version: 22.x
 
     - name: Install dependencies
       run: sudo apt-get update && sudo apt-get install -y libunbound-dev |

diff --git a/eslint.config.cjs b/eslint.config.cjs
@@ -0,0 +1,54 @@
+'use strict';
+
+const rc = require('bslintrc');
+
+module.exports = [
+  rc.configs.recommended,
+  rc.configs.bcoin,
+  {
+    languageOptions: {
+      globals: {
+        ...rc.globals.node
+      },
+      ecmaVersion: 'latest'
+    }
+  },
+  {
+    files: [
+      'bin/cli',
+      'bin/hsd',
+      'bin/node',
+      'bin/hs-seeder',
+      'bin/node',
+      'bin/_seeder',
+      'bin/spvnode',
+      'bin/wallet',
+      'bin/hsd-cli',
+      'bin/hsw-cli',
+      'etc/genesis',
+      '**/*.cjs',
+      '**/*.mjs',
+      '**/*.js',
+      '*.js',
+      '*.mjs',
+      '*.cjs'
+    ],
+    languageOptions: {
+      sourceType: 'commonjs'
+    }
+  },
+  {
+    files: ['test/{,**/}*.{js,cjs,mjs}'],
+    languageOptions: {
+      globals: {
+        ...rc.globals.mocha,
+        register: 'readable'
+      }
+    },
+    rules: {
+      'max-len': 'off',
+      'prefer-arrow-callback': 'off',
+      'no-return-assign': 'off'
+    }
+  }
+];
diff --git a/lib/coins/coinview.js b/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) {

diff --git a/lib/hd/common.js b/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}
  */
 

diff --git a/lib/hd/public.js b/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}
    */
 

diff --git a/lib/primitives/coin.js b/lib/primitives/coin.js
@@ -314,6 +314,7 @@ class Coin extends Output {
    * @param {TX} tx
    * @param {Number} index
    * @param {Number} height
+   * @returns {this}
    */
 
   fromTX(tx, index, height) {

diff --git a/lib/primitives/keyring.js b/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) {