chore: updates for linter and type checker

Author: coolaj86

bin/gobject-prepare.js

@@ -4,7 +4,7 @@
 import DashGov from "dashgov";
 import DashKeys from "dashkeys";
 import DashTx from "dashtx";
-import Secp256k1 from "@dashincubator/secp256k1";
+import * as Secp256k1 from "@dashincubator/secp256k1";
 
 import Fs from "node:fs/promises";
 
@@ -216,7 +216,6 @@ async function main() {
     return;
   }
 
-  /** @type {import('../dashgov.js').GObjectData} */
   let gobjData = DashGov.proposal.draftJson(selected, {
     name: proposalName,
     payment_address: paymentAddr,
@@ -251,15 +250,15 @@ async function main() {
   let keyUtils = {
     /**
      * @param {DashTx.TxInputForSig} txInput
-     * @param {Number} i
+     * @param {Number} [i]
      */
     getPrivateKey: async function (txInput, i) {
       return DashKeys.wifToPrivKey(burnWif, { version: network });
     },
 
     /**
      * @param {DashTx.TxInputForSig} txInput
-     * @param {Number} i
+     * @param {Number} [i]
      */
     getPublicKey: async function (txInput, i) {
       let privKeyBytes = await keyUtils.getPrivateKey(txInput, i);

dashgov.js

@@ -22,12 +22,12 @@
 
 /**
  * @typedef GObjectData
- * @prop {Uint53} end_epoch - whole seconds since epoch (like web-standard `exp`)
+ * @prop {Uint53} [end_epoch] - whole seconds since epoch (like web-standard `exp`)
  * @prop {String} name - kebab case (no spaces)
  * @prop {String} payment_address - base58-encoded p2pkh
  * @prop {Uint32} payment_amount - in whole DASH
- * @prop {Uint53} start_epoch - whole seconds since epoch (like web-standard `iat`)
- * @prop {Uint32} type - TODO
+ * @prop {Uint53} [start_epoch] - whole seconds since epoch (like web-standard `iat`)
+ * @prop {Uint32} [type] - TODO
  * @prop {String} url - conventionally dashcentral, with page the same as the 'name'
  */
 
@@ -363,6 +363,7 @@ DashGov.proposal = {};
  * @param {Estimate} selected.start
  * @param {Estimate} selected.end
  * @param {GObjectData} proposalData
+ * @returns {Required<GObjectData>}
  */
 DashGov.proposal.draftJson = function (selected, proposalData) {
   let startEpoch = selected.start.startMs / 1000;
@@ -389,8 +390,8 @@ DashGov.proposal.draftJson = function (selected, proposalData) {
  * Creates a draft object with reasonable and default values
  * @param {Uint53} now - use Date.now(), except in testing
  * @param {Uint53} startEpochMs - used to create a deterministic gobject time
- * @param {GObjectData} data - will be sorted and hex-ified
- * @param {GObject} [gobj] - override values
+ * @param {Required<GObjectData>} data - will be sorted and hex-ified
+ * @param {Partial<GObject>} [gobj] - override values
  */
 DashGov.proposal.draft = function (now, startEpochMs, data, gobj) {
   let dataHex = gobj?.dataHex || DashGov.proposal.sortAndEncodeJson(data);
@@ -413,7 +414,7 @@ DashGov.proposal.draft = function (now, startEpochMs, data, gobj) {
 };
 
 /**
- * @param {GObjectData} normalizedData
+ * @param {Required<GObjectData>} normalizedData
  */
 DashGov.proposal.sortAndEncodeJson = function (normalizedData) {
   let keys = Object.keys(normalizedData);

package.json

@@ -22,7 +22,7 @@
     "--------": "-------------------------------------------------",
     "jshint": "npx -p [email protected] -- jshint -c ./.jshintrc ./*.js",
     "prettier": "npx -p [email protected] -- prettier -w '**/*.{js,md}'",
-    "tsc": "npx -p [email protected] -- tsc -p ./jsconfig.json",
+    "tsc": "! npx -p [email protected] -- tsc -p ./jsconfig.json | grep '\\.js(\\d\\+,\\d\\+): error' | grep -v '\\<node_modules/'",
     "---------": "------------------------------------------------",
     "reexport-types": "npx -p [email protected] -- reexport",
     "prepublish": "npm run reexport-types"

tests/gobject-propose-txid.js

@@ -2,6 +2,8 @@
 
 import GObj from "dashgov";
 
+let Crypto = globalThis.crypto;
+
 // function hexToBytes(hex) {
 //   let len = hex.length / 2;
 //   let bytes = new Uint8Array(len);
@@ -63,8 +65,8 @@ async function main() {
 
   let hashBytes;
   {
-    let hash1 = await crypto.subtle.digest("SHA-256", gobjBurnBytes);
-    let hash2 = await crypto.subtle.digest("SHA-256", hash1);
+    let hash1 = await Crypto.subtle.digest("SHA-256", gobjBurnBytes);
+    let hash2 = await Crypto.subtle.digest("SHA-256", hash1);
 
     let hash1Bytes = new Uint8Array(hash1);
     let hash1Hex = GObj.utils.bytesToHex(hash1Bytes);
@@ -83,20 +85,20 @@ async function main() {
   return hashBytes;
 }
 
-function logLine64(str, comment, value) {
-  for (let i = 0; i < str.length; i += 64) {
-    let line = str.substring(i, i + 64);
-    if (i === 0) {
-      if (typeof value !== "undefined") {
-        line = `${line} (${value})`;
-      }
-      line = line.padEnd(64, " ");
-      console.info(line, comment);
-    } else {
-      console.info(line);
-    }
-  }
-}
+// function logLine64(str, comment, value) {
+//   for (let i = 0; i < str.length; i += 64) {
+//     let line = str.substring(i, i + 64);
+//     if (i === 0) {
+//       if (typeof value !== "undefined") {
+//         line = `${line} (${value})`;
+//       }
+//       line = line.padEnd(64, " ");
+//       console.info(line, comment);
+//     } else {
+//       console.info(line);
+//     }
+//   }
+// }
 
 main()
   .then(function () {