Merge pull request #2 from bitcoincoretech/p2tr-v1-addr-check

feat: add stricter validation for taproot addresses

Author: motorina0

src/address.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { Network } from './networks';
+import { TinySecp256k1Interface } from './types';
 export interface Base58CheckResult {
     hash: Buffer;
     version: number;
@@ -13,5 +14,5 @@ export declare function fromBase58Check(address: string): Base58CheckResult;
 export declare function fromBech32(address: string): Bech32Result;
 export declare function toBase58Check(hash: Buffer, version: number): string;
 export declare function toBech32(data: Buffer, version: number, prefix: string): string;
-export declare function fromOutputScript(output: Buffer, network?: Network): string;
-export declare function toOutputScript(address: string, network?: Network): Buffer;
+export declare function fromOutputScript(output: Buffer, network?: Network, eccLib?: TinySecp256k1Interface): string;
+export declare function toOutputScript(address: string, network?: Network, eccLib?: TinySecp256k1Interface): Buffer;

src/address.js

@@ -4,14 +4,13 @@ exports.toOutputScript = exports.fromOutputScript = exports.toBech32 = exports.t
 const networks = require('./networks');
 const payments = require('./payments');
 const bscript = require('./script');
-const types = require('./types');
+const types_1 = require('./types');
 const bech32_1 = require('bech32');
 const bs58check = require('bs58check');
-const { typeforce } = types;
 const FUTURE_SEGWIT_MAX_SIZE = 40;
 const FUTURE_SEGWIT_MIN_SIZE = 2;
 const FUTURE_SEGWIT_MAX_VERSION = 16;
-const FUTURE_SEGWIT_MIN_VERSION = 1;
+const FUTURE_SEGWIT_MIN_VERSION = 2;
 const FUTURE_SEGWIT_VERSION_DIFF = 0x50;
 const FUTURE_SEGWIT_VERSION_WARNING =
   'WARNING: Sending to a future segwit version address can lead to loss of funds. ' +
@@ -69,7 +68,10 @@ function fromBech32(address) {
 }
 exports.fromBech32 = fromBech32;
 function toBase58Check(hash, version) {
-  typeforce(types.tuple(types.Hash160bit, types.UInt8), arguments);
+  (0, types_1.typeforce)(
+    (0, types_1.tuple)(types_1.Hash160bit, types_1.UInt8),
+    arguments,
+  );
   const payload = Buffer.allocUnsafe(21);
   payload.writeUInt8(version, 0);
   hash.copy(payload, 1);
@@ -84,7 +86,7 @@ function toBech32(data, version, prefix) {
     : bech32_1.bech32m.encode(prefix, words);
 }
 exports.toBech32 = toBech32;
-function fromOutputScript(output, network) {
+function fromOutputScript(output, network, eccLib) {
   // TODO: Network
   network = network || networks.bitcoin;
   try {
@@ -99,13 +101,16 @@ function fromOutputScript(output, network) {
   try {
     return payments.p2wsh({ output, network }).address;
   } catch (e) {}
+  try {
+    if (eccLib) return payments.p2tr({ output, network }, { eccLib }).address;
+  } catch (e) {}
   try {
     return _toFutureSegwitAddress(output, network);
   } catch (e) {}
   throw new Error(bscript.toASM(output) + ' has no matching Address');
 }
 exports.fromOutputScript = fromOutputScript;
-function toOutputScript(address, network) {
+function toOutputScript(address, network, eccLib) {
   network = network || networks.bitcoin;
   let decodeBase58;
   let decodeBech32;
@@ -129,6 +134,10 @@ function toOutputScript(address, network) {
           return payments.p2wpkh({ hash: decodeBech32.data }).output;
         if (decodeBech32.data.length === 32)
           return payments.p2wsh({ hash: decodeBech32.data }).output;
+      } else if (decodeBech32.version === 1) {
+        if (decodeBech32.data.length === 32 && eccLib)
+          return payments.p2tr({ pubkey: decodeBech32.data }, { eccLib })
+            .output;
       } else if (
         decodeBech32.version >= FUTURE_SEGWIT_MIN_VERSION &&
         decodeBech32.version <= FUTURE_SEGWIT_MAX_VERSION &&

test/address.spec.ts

@@ -1,5 +1,6 @@
 import * as assert from 'assert';
 import { describe, it } from 'mocha';
+import * as ecc from 'tiny-secp256k1';
 import * as baddress from '../src/address';
 import * as bscript from '../src/script';
 import * as fixtures from './fixtures/address.json';
@@ -68,7 +69,11 @@ describe('address', () => {
     fixtures.standard.forEach(f => {
       it('encodes ' + f.script.slice(0, 30) + '... (' + f.network + ')', () => {
         const script = bscript.fromASM(f.script);
-        const address = baddress.fromOutputScript(script, NETWORKS[f.network]);
+        const address = baddress.fromOutputScript(
+          script,
+          NETWORKS[f.network],
+          ecc,
+        );
 
         assert.strictEqual(address, f.base58check || f.bech32!.toLowerCase());
       });
@@ -79,7 +84,7 @@ describe('address', () => {
         const script = bscript.fromASM(f.script);
 
         assert.throws(() => {
-          baddress.fromOutputScript(script);
+          baddress.fromOutputScript(script, undefined, ecc);
         }, new RegExp(f.exception));
       });
     });
@@ -131,17 +136,19 @@ describe('address', () => {
         const script = baddress.toOutputScript(
           (f.base58check || f.bech32)!,
           NETWORKS[f.network],
+          ecc,
         );
 
         assert.strictEqual(bscript.toASM(script), f.script);
       });
     });
 
     fixtures.invalid.toOutputScript.forEach(f => {
-      it('throws when ' + f.exception, () => {
+      it('throws when ' + (f.exception || f.paymentException), () => {
+        const exception = f.paymentException || `${f.address} ${f.exception}`;
         assert.throws(() => {
-          baddress.toOutputScript(f.address, f.network as any);
-        }, new RegExp(f.address + ' ' + f.exception));
+          baddress.toOutputScript(f.address, f.network as any, ecc);
+        }, new RegExp(exception));
       });
     });
   });

test/fixtures/address.json

@@ -80,10 +80,10 @@
     },
     {
       "network": "bitcoin",
-      "bech32": "bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kt5nd6y",
+      "bech32": "bc1p3efq8ujsj0qr5xvms7mv89p8cz0crqdtuxe9ms6grqgxc9sgsntslthf6w",
       "version": 1,
-      "data": "751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6",
-      "script": "OP_1 751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6"
+      "data": "8e5203f25093c03a199b87b6c39427c09f8181abe1b25dc34818106c160884d7",
+      "script": "OP_1 8e5203f25093c03a199b87b6c39427c09f8181abe1b25dc34818106c160884d7"
     },
     {
       "network": "bitcoin",
@@ -116,10 +116,16 @@
   ],
   "bech32": [
     {
-      "address": "bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kt5nd6y",
+      "address": "tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy",
+      "version": 0,
+      "prefix": "tb",
+      "data": "000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433"
+    },
+    {
+      "address": "bc1p3efq8ujsj0qr5xvms7mv89p8cz0crqdtuxe9ms6grqgxc9sgsntslthf6w",
       "version": 1,
       "prefix": "bc",
-      "data": "751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6"
+      "data": "8e5203f25093c03a199b87b6c39427c09f8181abe1b25dc34818106c160884d7"
     },
     {
       "address": "bc1zw508d6qejxtdg4y5r3zarvaryvaxxpcs",
@@ -195,6 +201,19 @@
       {
         "exception": "has no matching Address",
         "script": "OP_0 751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd675"
+      },
+      {
+        "exception": "has no matching Address",
+        "script": "OP_1 75"
+      },
+      {
+        "exception": "has no matching Address",
+        "script": "OP_1 751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd675"
+      },
+      {
+        "description": "pubkey is not valid x coordinate",
+        "exception": "has no matching Address",
+        "script": "OP_1 fffffffffffffffffffffffffffffffffffffffffffffffffffffffefffffc2f"
       }
     ],
     "toOutputScript": [
@@ -297,6 +316,14 @@
       {
         "address": "bc1gmk9yu",
         "exception": "has no matching Script"
+      },
+      {
+        "address": "bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kw55h884v",
+        "exception": "has no matching Script"
+      },
+      {
+        "address": "bc1pllllllllllllllllllllllllllllllllllllllllllllallllshsdfvw2y",
+        "paymentException": "TypeError: Invalid pubkey for p2tr"
       }
     ]
   }

test/integration/taproot.spec.ts

@@ -12,7 +12,7 @@ describe('bitcoinjs-lib (transaction with taproot)', () => {
     const myKey = bip32.fromSeed(rng(64), regtest);
 
     const output = createKeySpendOutput(myKey.publicKey);
-    const address = bitcoin.address.fromOutputScript(output, regtest);
+    const address = bitcoin.address.fromOutputScript(output, regtest, ecc);
     // amount from faucet
     const amount = 42e4;
     // amount to send

ts_src/address.ts

@@ -2,11 +2,15 @@ import { Network } from './networks';
 import * as networks from './networks';
 import * as payments from './payments';
 import * as bscript from './script';
-import * as types from './types';
+import {
+  typeforce,
+  tuple,
+  Hash160bit,
+  UInt8,
+  TinySecp256k1Interface,
+} from './types';
 import { bech32, bech32m } from 'bech32';
 import * as bs58check from 'bs58check';
-const { typeforce } = types;
-
 export interface Base58CheckResult {
   hash: Buffer;
   version: number;
@@ -21,7 +25,7 @@ export interface Bech32Result {
 const FUTURE_SEGWIT_MAX_SIZE: number = 40;
 const FUTURE_SEGWIT_MIN_SIZE: number = 2;
 const FUTURE_SEGWIT_MAX_VERSION: number = 16;
-const FUTURE_SEGWIT_MIN_VERSION: number = 1;
+const FUTURE_SEGWIT_MIN_VERSION: number = 2;
 const FUTURE_SEGWIT_VERSION_DIFF: number = 0x50;
 const FUTURE_SEGWIT_VERSION_WARNING: string =
   'WARNING: Sending to a future segwit version address can lead to loss of funds. ' +
@@ -93,7 +97,7 @@ export function fromBech32(address: string): Bech32Result {
 }
 
 export function toBase58Check(hash: Buffer, version: number): string {
-  typeforce(types.tuple(types.Hash160bit, types.UInt8), arguments);
+  typeforce(tuple(Hash160bit, UInt8), arguments);
 
   const payload = Buffer.allocUnsafe(21);
   payload.writeUInt8(version, 0);
@@ -115,7 +119,11 @@ export function toBech32(
     : bech32m.encode(prefix, words);
 }
 
-export function fromOutputScript(output: Buffer, network?: Network): string {
+export function fromOutputScript(
+  output: Buffer,
+  network?: Network,
+  eccLib?: TinySecp256k1Interface,
+): string {
   // TODO: Network
   network = network || networks.bitcoin;
 
@@ -131,14 +139,22 @@ export function fromOutputScript(output: Buffer, network?: Network): string {
   try {
     return payments.p2wsh({ output, network }).address as string;
   } catch (e) {}
+  try {
+    if (eccLib)
+      return payments.p2tr({ output, network }, { eccLib }).address as string;
+  } catch (e) {}
   try {
     return _toFutureSegwitAddress(output, network);
   } catch (e) {}
 
   throw new Error(bscript.toASM(output) + ' has no matching Address');
 }
 
-export function toOutputScript(address: string, network?: Network): Buffer {
+export function toOutputScript(
+  address: string,
+  network?: Network,
+  eccLib?: TinySecp256k1Interface,
+): Buffer {
   network = network || networks.bitcoin;
 
   let decodeBase58: Base58CheckResult | undefined;
@@ -165,6 +181,10 @@ export function toOutputScript(address: string, network?: Network): Buffer {
           return payments.p2wpkh({ hash: decodeBech32.data }).output as Buffer;
         if (decodeBech32.data.length === 32)
           return payments.p2wsh({ hash: decodeBech32.data }).output as Buffer;
+      } else if (decodeBech32.version === 1) {
+        if (decodeBech32.data.length === 32 && eccLib)
+          return payments.p2tr({ pubkey: decodeBech32.data }, { eccLib })
+            .output as Buffer;
       } else if (
         decodeBech32.version >= FUTURE_SEGWIT_MIN_VERSION &&
         decodeBech32.version <= FUTURE_SEGWIT_MAX_VERSION &&