chore: take the garbage out. Remove tweakSigner() and ecpair dep from PSBT

Author: motorina0

src/index.d.ts

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

src/index.js

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

src/psbt.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { Psbt as PsbtBase } from 'bip174';
 import { KeyValue, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate } from 'bip174/src/lib/interfaces';
-import { TinySecp256k1Interface as ECPairTinySecp256k1Interface } from 'ecpair';
 import { Network } from './networks';
 import { Transaction } from './transaction';
 import { TinySecp256k1Interface } from './types';
@@ -109,17 +108,6 @@ export declare class Psbt {
     addUnknownKeyValToOutput(outputIndex: number, keyVal: KeyValue): this;
     clearFinalizedInput(inputIndex: number): this;
 }
-/**
- * Helper method for converting a normal Signer into a Taproot Signer.
- * Note that this helper method requires the Private Key of the Signer to be present.
- * Steps:
- *  - if the Y coordinate of the Signer Public Key is odd then negate the Private Key
- *  - tweak the private key with the provided hash (should be empty for key-path spending)
- * @param signer - a taproot signer object, the Private Key must be present
- * @param opts - tweak options
- * @returns a Signer having the Private and Public keys tweaked
- */
-export declare function tweakSigner(signer: Signer, opts: TaprootSignerOpts): Signer;
 interface PsbtOptsOptional {
     network?: Network;
     maximumFeeRate?: number;
@@ -169,25 +157,11 @@ export interface HDSignerAsync extends HDSignerBase {
 }
 export interface Signer {
     publicKey: Buffer;
-    /**
-     * Private Key is optional, it is required only if the signer must be tweaked.
-     * See the `tweakSigner()` method.
-     */
-    privateKey?: Buffer;
     network?: any;
     sign(hash: Buffer, lowR?: boolean): Buffer;
     signSchnorr?(hash: Buffer): Buffer;
     getPublicKey?(): Buffer;
 }
-/**
- * Options for tweaking a Signer into a valid Taproot Signer
- */
-export interface TaprootSignerOpts {
-    network?: Network;
-    eccLib: TinySecp256k1Interface & ECPairTinySecp256k1Interface;
-    /** The hash used to tweak the Signer */
-    tweakHash?: Buffer;
-}
 export interface SignerAsync {
     publicKey: Buffer;
     network?: any;

src/psbt.js

@@ -1,7 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.tweakSigner = exports.Psbt = void 0;
-const ecpair_1 = require('ecpair');
+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');
@@ -12,7 +11,6 @@ const networks_1 = require('./networks');
 const payments = require('./payments');
 const bscript = require('./script');
 const transaction_1 = require('./transaction');
-const taprootutils_1 = require('./payments/taprootutils');
 /**
  * These are the default arguments for a Psbt instance.
  */
@@ -648,41 +646,6 @@ class Psbt {
   }
 }
 exports.Psbt = Psbt;
-/**
- * Helper method for converting a normal Signer into a Taproot Signer.
- * Note that this helper method requires the Private Key of the Signer to be present.
- * Steps:
- *  - if the Y coordinate of the Signer Public Key is odd then negate the Private Key
- *  - tweak the private key with the provided hash (should be empty for key-path spending)
- * @param signer - a taproot signer object, the Private Key must be present
- * @param opts - tweak options
- * @returns a Signer having the Private and Public keys tweaked
- */
-function tweakSigner(signer, opts) {
-  // todo: test ecc??
-  let privateKey = signer.privateKey;
-  if (!privateKey) {
-    throw new Error('Private key is required for tweaking signer!');
-  }
-  if (signer.publicKey[0] === 3) {
-    privateKey = opts.eccLib.privateNegate(privateKey);
-  }
-  const tweakedPrivateKey = opts.eccLib.privateAdd(
-    privateKey,
-    (0, taprootutils_1.tapTweakHash)(
-      signer.publicKey.slice(1, 33),
-      opts.tweakHash,
-    ),
-  );
-  if (!tweakedPrivateKey) {
-    throw new Error('Invalid tweaked private key!');
-  }
-  const ECPair = (0, ecpair_1.ECPairFactory)(opts.eccLib);
-  return ECPair.fromPrivateKey(Buffer.from(tweakedPrivateKey), {
-    network: opts.network,
-  });
-}
-exports.tweakSigner = tweakSigner;
 /**
  * This function is needed to pass to the bip174 base class's fromBuffer.
  * It takes the "transaction buffer" portion of the psbt buffer and returns a

test/psbt.spec.ts

@@ -8,14 +8,7 @@ import { describe, it } from 'mocha';
 const bip32 = BIP32Factory(ecc);
 const ECPair = ECPairFactory(ecc);
 
-import {
-  networks as NETWORKS,
-  payments,
-  Psbt,
-  Signer,
-  SignerAsync,
-  tweakSigner,
-} from '..';
+import { networks as NETWORKS, payments, Psbt, Signer, SignerAsync } from '..';
 
 import * as preFixtures from './fixtures/psbt.json';
 
@@ -1013,35 +1006,6 @@ describe(`Psbt`, () => {
     });
   });
 
-  describe('tweakSigner', () => {
-    it('Throws error if signer is missing private key', () => {
-      const keyPair = Object.assign({}, ECPair.makeRandom(), {
-        privateKey: null,
-      });
-      assert.throws(() => {
-        tweakSigner(keyPair, { eccLib: ecc });
-      }, new RegExp('Private key is required for tweaking signer!'));
-    });
-
-    it('Correctly creates tweaked signer', () => {
-      const keyPair = ECPair.fromPrivateKey(
-        Buffer.from(
-          'accaf12e04e11b08fc28f5fe75b47ea663843b698981e31f1cafa2224d6e28c0',
-          'hex',
-        ),
-      );
-      const tweakedSigner: Signer = tweakSigner(keyPair, { eccLib: ecc });
-      assert.strictEqual(
-        '029421e734b0f9d2c467ea7dd197c61acb4467cdcbc9f4cb0c571f8b63a5c40cae',
-        tweakedSigner.publicKey.toString('hex'),
-      );
-      assert.strictEqual(
-        '1853f5034982ec659e015873a0a958a73eac785850f425fd3444b12430d58692',
-        tweakedSigner.privateKey!.toString('hex'),
-      );
-    });
-  });
-
   describe('create 1-to-1 transaction', () => {
     const alice = ECPair.fromWIF(
       'L2uPYXe17xSTqbCjZvL2DsyXPCbXspvcu5mHLDYUgzdUbZGSKrSr',

ts_src/index.ts

@@ -16,7 +16,6 @@ export {
   SignerAsync,
   HDSigner,
   HDSignerAsync,
-  tweakSigner,
 } from './psbt';
 export { OPS as opcodes } from './ops';
 export { Transaction } from './transaction';

ts_src/psbt.ts

@@ -1,5 +1,3 @@
-import { ECPairFactory } from 'ecpair';
-
 import { Psbt as PsbtBase } from 'bip174';
 import * as varuint from 'bip174/src/lib/converter/varint';
 import {
@@ -15,7 +13,6 @@ import {
   TransactionFromBuffer,
 } from 'bip174/src/lib/interfaces';
 import { checkForInput, checkForOutput } from 'bip174/src/lib/utils';
-import { TinySecp256k1Interface as ECPairTinySecp256k1Interface } from 'ecpair';
 
 import { fromOutputScript, toOutputScript } from './address';
 import { cloneBuffer, reverseBuffer } from './bufferutils';
@@ -24,7 +21,6 @@ import { bitcoin as btcNetwork, Network } from './networks';
 import * as payments from './payments';
 import * as bscript from './script';
 import { Output, Transaction } from './transaction';
-import { tapTweakHash } from './payments/taprootutils';
 import { TinySecp256k1Interface } from './types';
 
 export interface TransactionInput {
@@ -782,40 +778,6 @@ export class Psbt {
   }
 }
 
-/**
- * Helper method for converting a normal Signer into a Taproot Signer.
- * Note that this helper method requires the Private Key of the Signer to be present.
- * Steps:
- *  - if the Y coordinate of the Signer Public Key is odd then negate the Private Key
- *  - tweak the private key with the provided hash (should be empty for key-path spending)
- * @param signer - a taproot signer object, the Private Key must be present
- * @param opts - tweak options
- * @returns a Signer having the Private and Public keys tweaked
- */
-export function tweakSigner(signer: Signer, opts: TaprootSignerOpts): Signer {
-  // todo: test ecc??
-  let privateKey: Uint8Array | undefined = signer.privateKey;
-  if (!privateKey) {
-    throw new Error('Private key is required for tweaking signer!');
-  }
-  if (signer.publicKey[0] === 3) {
-    privateKey = opts.eccLib.privateNegate(privateKey!);
-  }
-
-  const tweakedPrivateKey = opts.eccLib.privateAdd(
-    privateKey,
-    tapTweakHash(signer.publicKey.slice(1, 33), opts.tweakHash),
-  );
-  if (!tweakedPrivateKey) {
-    throw new Error('Invalid tweaked private key!');
-  }
-
-  const ECPair = ECPairFactory(opts.eccLib);
-  return ECPair.fromPrivateKey(Buffer.from(tweakedPrivateKey), {
-    network: opts.network,
-  });
-}
-
 interface PsbtCache {
   __NON_WITNESS_UTXO_TX_CACHE: Transaction[];
   __NON_WITNESS_UTXO_BUF_CACHE: Buffer[];
@@ -889,25 +851,11 @@ export interface HDSignerAsync extends HDSignerBase {
 
 export interface Signer {
   publicKey: Buffer;
-  /**
-   * Private Key is optional, it is required only if the signer must be tweaked.
-   * See the `tweakSigner()` method.
-   */
-  privateKey?: Buffer;
   network?: any;
   sign(hash: Buffer, lowR?: boolean): Buffer;
   signSchnorr?(hash: Buffer): Buffer;
   getPublicKey?(): Buffer;
 }
-/**
- * Options for tweaking a Signer into a valid Taproot Signer
- */
-export interface TaprootSignerOpts {
-  network?: Network;
-  eccLib: TinySecp256k1Interface & ECPairTinySecp256k1Interface;
-  /** The hash used to tweak the Signer */
-  tweakHash?: Buffer;
-}
 
 export interface SignerAsync {
   publicKey: Buffer;