Merge pull request #40 from BitGo/utxo_psbt

Prep for BitGo PSBTs

Author: brandonblack

package-lock.json

@@ -33,7 +33,7 @@
     "mocha:ts": "mocha --recursive --require test/ts-node-register",
     "nobuild:coverage-report": "nyc report --reporter=lcov",
     "nobuild:coverage-html": "nyc report --reporter=html",
-    "nobuild:coverage": "npm run build:tests && nyc --check-coverage --branches 90 --functions 90 --lines 90 mocha && npm run clean:jstests",
+    "nobuild:coverage": "npm run build:tests && nyc --check-coverage --branches 89 --functions 90 --lines 90 mocha && npm run clean:jstests",
     "nobuild:integration": "npm run mocha:ts -- --timeout 50000 'test/integration/*.ts'",
     "nobuild:unit": "npm run mocha:ts -- 'test/*.ts'",
     "prettier": "prettier \"ts_src/**/*.ts\" \"test/**/*.ts\" --ignore-path ./.prettierignore",
@@ -50,7 +50,7 @@
   ],
   "dependencies": {
     "bech32": "^2.0.0",
-    "bip174": "git+https://github.com/brandonblack/bip174#c2ca5fa9ccdb6244b9617b1d78d77c82c2403185",
+    "bip174": "npm:@bitgo/bip174@3.0.0",
     "bs58check": "^2.1.2",
     "create-hash": "^1.1.0",
     "fastpriorityqueue": "^0.7.1",
@@ -77,7 +77,7 @@
     "bn.js": "^4.11.8",
     "bs58": "^4.0.0",
     "dhttp": "^3.0.0",
-    "ecpair": "^2.0.1",
+    "ecpair": "git+https://github.com/brandonblack/ecpair#2fd5696110aa8bba136c5a5240019cd1ced16431",
     "hoodwink": "^2.0.0",
     "minimaldata": "^1.0.2",
     "mocha": "^10.0.0",
@@ -87,7 +87,7 @@
     "randombytes": "^2.1.0",
     "regtest-client": "0.2.0",
     "rimraf": "^2.6.3",
-    "tiny-secp256k1": "^2.2.0",
+    "tiny-secp256k1": "^2.2.1",
     "ts-node": "^8.3.0",
     "tslint": "^6.1.3",
     "typescript": "^4.4.4"

package.json

@@ -34,6 +34,9 @@ function _toFutureSegwitAddress(output, network) {
   if (output[1] !== data.length)
     throw new TypeError('Invalid script for segwit address');
   console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
   return toBech32(data, version, network.bech32);
 }
 function fromBase58Check(address) {

src/address.js

@@ -8,7 +8,7 @@ import * as ScriptSignature from './script_signature';
 export { ScriptSignature, address, crypto, networks, payments, script, taproot, };
 export { Block } from './block';
 export { TaggedHashPrefix } from './crypto';
-export { Psbt, PsbtTxInput, PsbtTxOutput, Signer, SignerAsync, HDSigner, HDSignerAsync, } from './psbt';
+export { Psbt, PsbtTransaction, PsbtTxInput, PsbtTxOutput, Signer, SignerAsync, HDSigner, HDSignerAsync, } from './psbt';
 export { OPS as opcodes } from './ops';
 export { Transaction } from './transaction';
 export { Network } from './networks';

src/index.d.ts

@@ -1,6 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.Transaction = exports.opcodes = exports.Psbt = exports.Block = exports.taproot = exports.script = exports.payments = exports.networks = exports.crypto = exports.address = exports.ScriptSignature = void 0;
+exports.Transaction = exports.opcodes = exports.PsbtTransaction = exports.Psbt = exports.Block = exports.taproot = exports.script = exports.payments = exports.networks = exports.crypto = exports.address = exports.ScriptSignature = void 0;
 const address = require('./address');
 exports.address = address;
 const crypto = require('./crypto');
@@ -29,6 +29,12 @@ Object.defineProperty(exports, 'Psbt', {
     return psbt_1.Psbt;
   },
 });
+Object.defineProperty(exports, 'PsbtTransaction', {
+  enumerable: true,
+  get: function() {
+    return psbt_1.PsbtTransaction;
+  },
+});
 var ops_1 = require('./ops');
 Object.defineProperty(exports, 'opcodes', {
   enumerable: true,

src/index.js

@@ -1,6 +1,6 @@
 export interface Network {
     messagePrefix: string;
-    bech32: string;
+    bech32?: string;
     bip32: Bip32;
     pubKeyHash: number;
     scriptHash: number;

src/networks.d.ts

@@ -43,6 +43,9 @@ function p2wpkh(a, opts) {
   });
   const network = a.network || networks_1.bitcoin;
   const o = { name: 'p2wpkh', network };
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
   lazy.prop(o, 'address', () => {
     if (!o.hash) return;
     const words = bech32_1.bech32.toWords(o.hash);

src/payments/p2wpkh.js

@@ -72,6 +72,9 @@ function p2wsh(a, opts) {
   if (!network) {
     network = (a.redeem && a.redeem.network) || networks_1.bitcoin;
   }
+  if (!network.bech32) {
+    throw new TypeError("Network doesn't support native segwit");
+  }
   const o = { network };
   lazy.prop(o, 'address', () => {
     if (!o.hash) return;

src/payments/p2wsh.js

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Psbt as PsbtBase } from 'bip174';
-import { KeyValue, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate } from 'bip174/src/lib/interfaces';
+import { KeyValue, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate, Transaction as ITransaction } from 'bip174/src/lib/interfaces';
 import { Network } from './networks';
 import { Transaction } from './transaction';
 export interface TransactionInput {
@@ -163,6 +163,24 @@ export interface SignerAsync {
     sign(hash: Buffer, lowR?: boolean): Promise<Buffer>;
     getPublicKey?(): Buffer;
 }
+/**
+ * This class implements the Transaction interface from bip174 library.
+ * It contains a bitcoinjs-lib Transaction object.
+ */
+export declare class PsbtTransaction implements ITransaction {
+    tx: Transaction<bigint>;
+    constructor({ tx, buffer, }?: {
+        tx?: Transaction<bigint>;
+        buffer?: Buffer;
+    });
+    getInputOutputCounts(): {
+        inputCount: number;
+        outputCount: number;
+    };
+    addInput(input: any): void;
+    addOutput(output: any): void;
+    toBuffer(): Buffer;
+}
 /**
  * This function must do two things:
  * 1. Check if the `input` can be finalized. If it can not be finalized, throw.

src/psbt.d.ts

@@ -1,6 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.Psbt = void 0;
+exports.PsbtTransaction = exports.Psbt = void 0;
 const bip174_1 = require('bip174');
 const varuint = require('bip174/src/lib/converter/varint');
 const utils_1 = require('bip174/src/lib/utils');
@@ -613,14 +613,23 @@ exports.Psbt = Psbt;
  * It takes the "transaction buffer" portion of the psbt buffer and returns a
  * Transaction (From the bip174 library) interface.
  */
-const transactionFromBuffer = buffer => new PsbtTransaction(buffer);
+const transactionFromBuffer = buffer => new PsbtTransaction({ buffer });
 /**
  * This class implements the Transaction interface from bip174 library.
  * It contains a bitcoinjs-lib Transaction object.
  */
 class PsbtTransaction {
-  constructor(buffer = Buffer.from([2, 0, 0, 0, 0, 0, 0, 0, 0, 0])) {
-    this.tx = transaction_1.Transaction.fromBuffer(buffer, undefined, 'bigint');
+  constructor({ tx, buffer } = {}) {
+    if (tx !== undefined) {
+      this.tx = tx;
+    } else {
+      buffer = buffer || Buffer.from([2, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
+      this.tx = transaction_1.Transaction.fromBuffer(
+        buffer,
+        undefined,
+        'bigint',
+      );
+    }
     checkTxEmpty(this.tx);
     Object.defineProperty(this, 'tx', {
       enumerable: false,
@@ -663,6 +672,7 @@ class PsbtTransaction {
     return this.tx.toBuffer();
   }
 }
+exports.PsbtTransaction = PsbtTransaction;
 function canFinalize(input, script, scriptType) {
   switch (scriptType) {
     case 'pubkey':