Merge pull request #40 from bitcoinjs/fix/cjs

Fix CJS for bip174

Author: junderw

.github/workflows/main_ci.yml

@@ -47,6 +47,16 @@ jobs:
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm run format:ci
+  check-hybrid:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run checkHybrid
   gitdiff:
     runs-on: ubuntu-latest
     steps:

fixup.cjs

@@ -0,0 +1,24 @@
+const fs = require('fs');
+const path = require('path');
+
+const updateRequires = (filePath) => {
+  let content = fs.readFileSync(filePath, 'utf8');
+  //replace local imports eg. require("./ecpair.js") to require("ecpair.cjs")
+  content = content.replace(/require\('\.([^']*)\.js'\)/g, "require('.$1.cjs')");
+
+  fs.writeFileSync(filePath, content, 'utf8');
+};
+
+const processFiles = (dir) => {
+  fs.readdirSync(dir).forEach((file) => {
+    const filePath = path.join(dir, file);
+    if (fs.lstatSync(filePath).isDirectory()) {
+      processFiles(filePath);
+    } else if (filePath.endsWith('.cjs')) {
+      updateRequires(filePath);
+    }
+  });
+};
+
+const dir = path.join(__dirname, 'src', 'cjs');
+processFiles(dir);

package-lock.json

@@ -1,15 +1,15 @@
 {
   "name": "bip174",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0-rc.1",
   "description": "",
-  "main": "src/cjs/lib/psbt.js",
+  "main": "src/cjs/lib/psbt.cjs",
   "module": "src/esm/lib/psbt.js",
-  "types": "src/cjs/lib/psbt.d.ts",
+  "types": "src/esm/lib/psbt.d.ts",
   "exports": {
     ".": {
-      "types": "./src/cjs/lib/psbt.d.ts",
+      "types": "./src/esm/lib/psbt.d.ts",
       "import": "./src/esm/lib/psbt.js",
-      "require": "./src/cjs/lib/psbt.js"
+      "require": "./src/cjs/lib/psbt.cjs"
     }
   },
   "type": "module",
@@ -22,6 +22,7 @@
   },
   "scripts": {
     "build": "npm run clean && tsc -p ./tsconfig.json && tsc -p ./tsconfig.cjs.json && npm run formatjs",
+    "checkHybrid": "chmod +x test.cjs && node test.cjs",
     "clean": "rimraf src types",
     "coverage": "c8 --check-coverage --include='src/esm/lib/**/*.js' --reporter=lcov --reporter=text --branches 90 --functions 90 --lines 90 npm run unit",
     "flb": "npm run format && npm run lint && npm run build",
@@ -30,6 +31,7 @@
     "format:ci": "npm run prettier -- --check && npm run prettierjs -- --check",
     "gitdiff:ci": "npm run build && git diff --exit-code",
     "lint": "tslint -p tsconfig.json -c tslint.json",
+    "postbuild": "find src/cjs -type f -name \"*.js\" -exec bash -c 'mv \"$0\" \"${0%.js}.cjs\"' {} \\; && chmod +x fixup.cjs && node fixup.cjs",
     "prettier": "prettier 'ts_src/**/*.ts' --ignore-path ./.prettierignore",
     "prettierjs": "prettier 'src/**/*.js' --ignore-path ./.prettierignore",
     "test": "npm run format:ci && npm run lint && npm run build && npm run coverage",

package.json

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const index_js_1 = require('../parser/index.js');
+const index_js_1 = require('../parser/index.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function combine(psbts) {
   const self = psbts[0];

src/cjs/lib/combiner/index.js renamed to src/cjs/lib/combiner/index.cjs

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 const range = n => [...Array(n).keys()];
 function decode(keyVal) {

src/cjs/lib/combiner/index.d.ts

@@ -1,6 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 function encode(data) {
   return {
     key: new Uint8Array([typeFields_js_1.GlobalTypes.UNSIGNED_TX]),

src/cjs/lib/converter/global/globalXpub.js renamed to src/cjs/lib/converter/global/globalXpub.cjs

@@ -11,31 +11,31 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../typeFields.js');
-const globalXpub = __importStar(require('./global/globalXpub.js'));
-const unsignedTx = __importStar(require('./global/unsignedTx.js'));
-const finalScriptSig = __importStar(require('./input/finalScriptSig.js'));
+const typeFields_js_1 = require('../typeFields.cjs');
+const globalXpub = __importStar(require('./global/globalXpub.cjs'));
+const unsignedTx = __importStar(require('./global/unsignedTx.cjs'));
+const finalScriptSig = __importStar(require('./input/finalScriptSig.cjs'));
 const finalScriptWitness = __importStar(
-  require('./input/finalScriptWitness.js'),
+  require('./input/finalScriptWitness.cjs'),
 );
-const nonWitnessUtxo = __importStar(require('./input/nonWitnessUtxo.js'));
-const partialSig = __importStar(require('./input/partialSig.js'));
-const porCommitment = __importStar(require('./input/porCommitment.js'));
-const sighashType = __importStar(require('./input/sighashType.js'));
-const tapKeySig = __importStar(require('./input/tapKeySig.js'));
-const tapLeafScript = __importStar(require('./input/tapLeafScript.js'));
-const tapMerkleRoot = __importStar(require('./input/tapMerkleRoot.js'));
-const tapScriptSig = __importStar(require('./input/tapScriptSig.js'));
-const witnessUtxo = __importStar(require('./input/witnessUtxo.js'));
-const tapTree = __importStar(require('./output/tapTree.js'));
-const bip32Derivation = __importStar(require('./shared/bip32Derivation.js'));
-const checkPubkey = __importStar(require('./shared/checkPubkey.js'));
-const redeemScript = __importStar(require('./shared/redeemScript.js'));
+const nonWitnessUtxo = __importStar(require('./input/nonWitnessUtxo.cjs'));
+const partialSig = __importStar(require('./input/partialSig.cjs'));
+const porCommitment = __importStar(require('./input/porCommitment.cjs'));
+const sighashType = __importStar(require('./input/sighashType.cjs'));
+const tapKeySig = __importStar(require('./input/tapKeySig.cjs'));
+const tapLeafScript = __importStar(require('./input/tapLeafScript.cjs'));
+const tapMerkleRoot = __importStar(require('./input/tapMerkleRoot.cjs'));
+const tapScriptSig = __importStar(require('./input/tapScriptSig.cjs'));
+const witnessUtxo = __importStar(require('./input/witnessUtxo.cjs'));
+const tapTree = __importStar(require('./output/tapTree.cjs'));
+const bip32Derivation = __importStar(require('./shared/bip32Derivation.cjs'));
+const checkPubkey = __importStar(require('./shared/checkPubkey.cjs'));
+const redeemScript = __importStar(require('./shared/redeemScript.cjs'));
 const tapBip32Derivation = __importStar(
-  require('./shared/tapBip32Derivation.js'),
+  require('./shared/tapBip32Derivation.cjs'),
 );
-const tapInternalKey = __importStar(require('./shared/tapInternalKey.js'));
-const witnessScript = __importStar(require('./shared/witnessScript.js'));
+const tapInternalKey = __importStar(require('./shared/tapInternalKey.cjs'));
+const witnessScript = __importStar(require('./shared/witnessScript.cjs'));
 const globals = {
   unsignedTx,
   globalXpub,

src/cjs/lib/converter/global/globalXpub.d.ts

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (keyVal.key[0] !== typeFields_js_1.InputTypes.FINAL_SCRIPTSIG) {

src/cjs/lib/converter/global/unsignedTx.js renamed to src/cjs/lib/converter/global/unsignedTx.cjs

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (keyVal.key[0] !== typeFields_js_1.InputTypes.FINAL_SCRIPTWITNESS) {

src/cjs/lib/converter/global/unsignedTx.d.ts

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (keyVal.key[0] !== typeFields_js_1.InputTypes.NON_WITNESS_UTXO) {

src/cjs/lib/converter/index.js renamed to src/cjs/lib/converter/index.cjs

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (keyVal.key[0] !== typeFields_js_1.InputTypes.PARTIAL_SIG) {

src/cjs/lib/converter/index.d.ts

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (keyVal.key[0] !== typeFields_js_1.InputTypes.POR_COMMITMENT) {

src/cjs/lib/converter/input/finalScriptSig.js renamed to src/cjs/lib/converter/input/finalScriptSig.cjs

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (keyVal.key[0] !== typeFields_js_1.InputTypes.SIGHASH_TYPE) {

src/cjs/lib/converter/input/finalScriptSig.d.ts

@@ -11,7 +11,7 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-const typeFields_js_1 = require('../../typeFields.js');
+const typeFields_js_1 = require('../../typeFields.cjs');
 const tools = __importStar(require('uint8array-tools'));
 function decode(keyVal) {
   if (