@btc-vision/bitcoin 6.3.1 → 6.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (259) hide show
  1. package/.babelrc +4 -0
  2. package/.gitattributes +2 -0
  3. package/.nyc_output/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +1 -0
  4. package/.nyc_output/processinfo/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +1 -0
  5. package/.nyc_output/processinfo/index.json +1 -0
  6. package/.prettierrc.json +12 -0
  7. package/CHANGELOG.md +403 -0
  8. package/CONTRIBUTING.md +83 -0
  9. package/browser/address.d.ts +16 -0
  10. package/{src → browser}/bip66.d.ts +6 -7
  11. package/{src → browser}/block.d.ts +29 -30
  12. package/{src → browser}/bufferutils.d.ts +34 -54
  13. package/browser/crypto/crypto.d.ts +1 -0
  14. package/{src → browser}/crypto.d.ts +13 -18
  15. package/browser/ecc_lib.d.ts +3 -0
  16. package/browser/hooks/AdvancedSignatureManager.d.ts +16 -0
  17. package/{src → browser}/hooks/HookedSigner.d.ts +4 -4
  18. package/browser/hooks/SignatureManager.d.ts +13 -0
  19. package/browser/index.d.ts +58 -0
  20. package/browser/index.js +2 -0
  21. package/browser/index.js.LICENSE.txt +14 -0
  22. package/browser/merkle.d.ts +1 -0
  23. package/browser/networks.d.ts +23 -0
  24. package/{src → browser}/ops.d.ts +126 -126
  25. package/browser/payments/bip341.d.ts +23 -0
  26. package/browser/payments/embed.d.ts +2 -0
  27. package/browser/payments/index.d.ts +41 -0
  28. package/{src → browser}/payments/lazy.d.ts +2 -2
  29. package/browser/payments/p2ms.d.ts +2 -0
  30. package/browser/payments/p2pk.d.ts +2 -0
  31. package/browser/payments/p2pkh.d.ts +2 -0
  32. package/browser/payments/p2sh.d.ts +2 -0
  33. package/browser/payments/p2tr.d.ts +2 -0
  34. package/browser/payments/p2wpkh.d.ts +2 -0
  35. package/browser/payments/p2wsh.d.ts +2 -0
  36. package/browser/psbt/bip371.d.ts +16 -0
  37. package/browser/psbt/psbtutils.d.ts +26 -0
  38. package/{src → browser}/psbt.d.ts +167 -238
  39. package/browser/push_data.d.ts +7 -0
  40. package/browser/script.d.ts +17 -0
  41. package/browser/script_number.d.ts +2 -0
  42. package/browser/script_signature.d.ts +7 -0
  43. package/{src → browser}/transaction.d.ts +48 -60
  44. package/{src → browser}/types.d.ts +37 -54
  45. package/build/address.d.ts +16 -0
  46. package/build/address.js +148 -0
  47. package/build/bip66.d.ts +6 -0
  48. package/build/bip66.js +99 -0
  49. package/build/block.d.ts +29 -0
  50. package/build/block.js +181 -0
  51. package/build/bufferutils.d.ts +34 -0
  52. package/build/bufferutils.js +141 -0
  53. package/build/crypto/crypto.d.ts +1 -0
  54. package/build/crypto/crypto.js +1 -0
  55. package/build/crypto.d.ts +13 -0
  56. package/build/crypto.js +87 -0
  57. package/build/ecc_lib.d.ts +3 -0
  58. package/build/ecc_lib.js +61 -0
  59. package/build/hooks/AdvancedSignatureManager.d.ts +16 -0
  60. package/build/hooks/AdvancedSignatureManager.js +52 -0
  61. package/build/hooks/HookedSigner.d.ts +4 -0
  62. package/build/hooks/HookedSigner.js +64 -0
  63. package/build/hooks/SignatureManager.d.ts +13 -0
  64. package/build/hooks/SignatureManager.js +45 -0
  65. package/build/index.d.ts +58 -0
  66. package/build/index.js +32 -0
  67. package/build/merkle.d.ts +1 -0
  68. package/build/merkle.js +19 -0
  69. package/build/networks.d.ts +23 -0
  70. package/build/networks.js +121 -0
  71. package/build/ops.d.ts +126 -0
  72. package/{src → build}/ops.js +127 -131
  73. package/build/payments/bip341.d.ts +23 -0
  74. package/build/payments/bip341.js +82 -0
  75. package/build/payments/embed.d.ts +2 -0
  76. package/build/payments/embed.js +39 -0
  77. package/build/payments/index.d.ts +41 -0
  78. package/build/payments/index.js +10 -0
  79. package/build/payments/lazy.d.ts +2 -0
  80. package/{src → build}/payments/lazy.js +28 -32
  81. package/build/payments/p2ms.d.ts +2 -0
  82. package/{src → build}/payments/p2ms.js +128 -158
  83. package/build/payments/p2pk.d.ts +2 -0
  84. package/build/payments/p2pk.js +68 -0
  85. package/build/payments/p2pkh.d.ts +2 -0
  86. package/build/payments/p2pkh.js +135 -0
  87. package/build/payments/p2sh.d.ts +2 -0
  88. package/build/payments/p2sh.js +175 -0
  89. package/build/payments/p2tr.d.ts +2 -0
  90. package/build/payments/p2tr.js +254 -0
  91. package/build/payments/p2wpkh.d.ts +2 -0
  92. package/build/payments/p2wpkh.js +130 -0
  93. package/build/payments/p2wsh.d.ts +2 -0
  94. package/build/payments/p2wsh.js +180 -0
  95. package/build/psbt/bip371.d.ts +16 -0
  96. package/build/psbt/bip371.js +246 -0
  97. package/build/psbt/psbtutils.d.ts +26 -0
  98. package/build/psbt/psbtutils.js +170 -0
  99. package/build/psbt.d.ts +167 -0
  100. package/build/psbt.js +1305 -0
  101. package/build/push_data.d.ts +7 -0
  102. package/build/push_data.js +57 -0
  103. package/build/script.d.ts +17 -0
  104. package/build/script.js +167 -0
  105. package/build/script_number.d.ts +2 -0
  106. package/build/script_number.js +49 -0
  107. package/build/script_signature.d.ts +7 -0
  108. package/build/script_signature.js +49 -0
  109. package/build/transaction.d.ts +48 -0
  110. package/build/transaction.js +445 -0
  111. package/build/types.d.ts +37 -0
  112. package/build/types.js +73 -0
  113. package/cjs/package.json +3 -0
  114. package/eslint.config.js +56 -0
  115. package/gulpfile.js +42 -0
  116. package/package.json +105 -50
  117. package/src/{address.js → address.ts} +93 -73
  118. package/src/{bip66.js → bip66.ts} +23 -19
  119. package/src/{block.js → block.ts} +114 -105
  120. package/src/{bufferutils.js → bufferutils.ts} +65 -67
  121. package/src/crypto/crypto-browser.js +75 -0
  122. package/src/crypto/crypto.ts +1 -0
  123. package/src/crypto.ts +108 -0
  124. package/src/{ecc_lib.js → ecc_lib.ts} +25 -53
  125. package/src/hooks/{AdvancedSignatureManager.js → AdvancedSignatureManager.ts} +34 -18
  126. package/src/hooks/HookedSigner.ts +108 -0
  127. package/src/hooks/{SignatureManager.js → SignatureManager.ts} +26 -14
  128. package/src/index.ts +86 -0
  129. package/src/{merkle.js → merkle.ts} +8 -7
  130. package/src/{networks.js → networks.ts} +44 -29
  131. package/src/ops.ts +282 -0
  132. package/src/payments/bip341.ts +140 -0
  133. package/src/payments/embed.ts +55 -0
  134. package/src/payments/{index.d.ts → index.ts} +20 -10
  135. package/src/payments/lazy.ts +28 -0
  136. package/src/payments/p2ms.ts +150 -0
  137. package/src/payments/{p2pk.js → p2pk.ts} +32 -29
  138. package/src/payments/{p2pkh.js → p2pkh.ts} +53 -47
  139. package/src/payments/{p2sh.js → p2sh.ts} +72 -71
  140. package/src/payments/{p2tr.js → p2tr.ts} +114 -125
  141. package/src/payments/{p2wpkh.js → p2wpkh.ts} +51 -56
  142. package/src/payments/{p2wsh.js → p2wsh.ts} +69 -81
  143. package/src/psbt/{bip371.js → bip371.ts} +191 -174
  144. package/src/psbt/psbtutils.ts +299 -0
  145. package/src/{psbt.js → psbt.ts} +1025 -679
  146. package/src/{push_data.js → push_data.ts} +35 -21
  147. package/src/{script.js → script.ts} +93 -77
  148. package/src/{script_number.js → script_number.ts} +15 -21
  149. package/src/{script_signature.js → script_signature.ts} +26 -14
  150. package/src/{transaction.js → transaction.ts} +247 -167
  151. package/src/types.ts +122 -0
  152. package/test/address.spec.js +124 -0
  153. package/test/address.spec.ts +177 -0
  154. package/test/bitcoin.core.spec.js +170 -0
  155. package/test/bitcoin.core.spec.ts +234 -0
  156. package/test/block.spec.js +141 -0
  157. package/test/block.spec.ts +194 -0
  158. package/test/bufferutils.spec.js +427 -0
  159. package/test/bufferutils.spec.ts +513 -0
  160. package/test/crypto.spec.js +41 -0
  161. package/test/crypto.spec.ts +55 -0
  162. package/test/fixtures/address.json +329 -0
  163. package/test/fixtures/block.json +148 -0
  164. package/test/fixtures/bufferutils.json +102 -0
  165. package/test/fixtures/core/README.md +26 -0
  166. package/test/fixtures/core/base58_encode_decode.json +50 -0
  167. package/test/fixtures/core/base58_keys_invalid.json +152 -0
  168. package/test/fixtures/core/base58_keys_valid.json +452 -0
  169. package/test/fixtures/core/blocks.json +27 -0
  170. package/test/fixtures/core/sig_canonical.json +7 -0
  171. package/test/fixtures/core/sig_noncanonical.json +33 -0
  172. package/test/fixtures/core/sighash.json +3505 -0
  173. package/test/fixtures/core/tx_valid.json +2023 -0
  174. package/test/fixtures/crypto.json +43 -0
  175. package/test/fixtures/ecdsa.json +217 -0
  176. package/test/fixtures/ecpair.json +141 -0
  177. package/test/fixtures/embed.json +108 -0
  178. package/test/fixtures/p2ms.json +434 -0
  179. package/test/fixtures/p2pk.json +179 -0
  180. package/test/fixtures/p2pkh.json +276 -0
  181. package/test/fixtures/p2sh.json +508 -0
  182. package/test/fixtures/p2tr.json +1198 -0
  183. package/test/fixtures/p2wpkh.json +290 -0
  184. package/test/fixtures/p2wsh.json +489 -0
  185. package/test/fixtures/psbt.json +924 -0
  186. package/test/fixtures/script.json +465 -0
  187. package/test/fixtures/script_number.json +225 -0
  188. package/test/fixtures/signature.json +140 -0
  189. package/test/fixtures/transaction.json +916 -0
  190. package/test/integration/_regtest.js +7 -0
  191. package/test/integration/_regtest.ts +6 -0
  192. package/test/integration/addresses.spec.js +116 -0
  193. package/test/integration/addresses.spec.ts +154 -0
  194. package/test/integration/bip32.spec.js +85 -0
  195. package/test/integration/bip32.spec.ts +151 -0
  196. package/test/integration/blocks.spec.js +26 -0
  197. package/test/integration/blocks.spec.ts +28 -0
  198. package/test/integration/cltv.spec.js +199 -0
  199. package/test/integration/cltv.spec.ts +283 -0
  200. package/test/integration/csv.spec.js +362 -0
  201. package/test/integration/csv.spec.ts +527 -0
  202. package/test/integration/payments.spec.js +98 -0
  203. package/test/integration/payments.spec.ts +135 -0
  204. package/test/integration/taproot.spec.js +532 -0
  205. package/test/integration/taproot.spec.ts +707 -0
  206. package/test/integration/transactions.spec.js +561 -0
  207. package/test/integration/transactions.spec.ts +769 -0
  208. package/test/payments.spec.js +97 -0
  209. package/test/payments.spec.ts +125 -0
  210. package/test/payments.utils.js +190 -0
  211. package/test/payments.utils.ts +208 -0
  212. package/test/psbt.spec.js +1044 -0
  213. package/test/psbt.spec.ts +1414 -0
  214. package/test/script.spec.js +151 -0
  215. package/test/script.spec.ts +210 -0
  216. package/test/script_number.spec.js +24 -0
  217. package/test/script_number.spec.ts +29 -0
  218. package/test/script_signature.spec.js +52 -0
  219. package/test/script_signature.spec.ts +66 -0
  220. package/test/transaction.spec.js +269 -0
  221. package/test/transaction.spec.ts +387 -0
  222. package/test/ts-node-register.js +5 -0
  223. package/test/tsconfig.json +45 -0
  224. package/test/types.spec.js +46 -0
  225. package/test/types.spec.ts +58 -0
  226. package/tsconfig.base.json +27 -0
  227. package/tsconfig.json +19 -0
  228. package/tsconfig.webpack.json +18 -0
  229. package/webpack.config.js +79 -0
  230. package/src/address.d.ts +0 -42
  231. package/src/crypto.js +0 -128
  232. package/src/ecc_lib.d.ts +0 -17
  233. package/src/hooks/AdvancedSignatureManager.d.ts +0 -44
  234. package/src/hooks/HookedSigner.js +0 -90
  235. package/src/hooks/SignatureManager.d.ts +0 -35
  236. package/src/index.d.ts +0 -42
  237. package/src/index.js +0 -87
  238. package/src/merkle.d.ts +0 -10
  239. package/src/networks.d.ts +0 -83
  240. package/src/payments/bip341.d.ts +0 -49
  241. package/src/payments/bip341.js +0 -124
  242. package/src/payments/embed.d.ts +0 -9
  243. package/src/payments/embed.js +0 -54
  244. package/src/payments/index.js +0 -69
  245. package/src/payments/p2ms.d.ts +0 -9
  246. package/src/payments/p2pk.d.ts +0 -10
  247. package/src/payments/p2pkh.d.ts +0 -10
  248. package/src/payments/p2sh.d.ts +0 -10
  249. package/src/payments/p2tr.d.ts +0 -10
  250. package/src/payments/p2wpkh.d.ts +0 -10
  251. package/src/payments/p2wsh.d.ts +0 -10
  252. package/src/psbt/bip371.d.ts +0 -42
  253. package/src/psbt/psbtutils.d.ts +0 -64
  254. package/src/psbt/psbtutils.js +0 -191
  255. package/src/push_data.d.ts +0 -29
  256. package/src/script.d.ts +0 -42
  257. package/src/script_number.d.ts +0 -19
  258. package/src/script_signature.d.ts +0 -21
  259. package/src/types.js +0 -106
@@ -0,0 +1,707 @@
1
+ import * as assert from 'assert';
2
+ import BIP32Factory from 'bip32';
3
+ import * as bip39 from 'bip39';
4
+ import * as ecc from 'tiny-secp256k1';
5
+ import { describe, it } from 'mocha';
6
+ import { PsbtInput, TapLeaf, TapLeafScript } from 'bip174/src/lib/interfaces';
7
+ import { regtestUtils } from './_regtest';
8
+ import * as bitcoin from '../..';
9
+ import { Taptree } from '../../src/types';
10
+ import { LEAF_VERSION_TAPSCRIPT } from '../../src/payments/bip341';
11
+ import { tapTreeFromList, tapTreeToList, toXOnly } from '../../src/psbt/bip371';
12
+ import { witnessStackToScriptWitness } from '../../src/psbt/psbtutils';
13
+
14
+ const rng = require('randombytes');
15
+ const regtest = regtestUtils.network;
16
+ bitcoin.initEccLib(ecc);
17
+ const bip32 = BIP32Factory(ecc);
18
+
19
+ describe('bitcoinjs-lib (transaction with taproot)', () => {
20
+ it('can verify the BIP86 HD wallet vectors for taproot single sig (& sending example)', async () => {
21
+ // Values taken from BIP86 document
22
+ const mnemonic =
23
+ 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about';
24
+ const xprv =
25
+ 'xprv9s21ZrQH143K3GJpoapnV8SFfukcVBSfeCficPSGfubmSFDxo1kuHnLisriDvSnRRuL2Qrg5ggqHKNVpxR86QEC8w35uxmGoggxtQTPvfUu';
26
+ const path = `m/86'/0'/0'/0/0`; // Path to first child of receiving wallet on first account
27
+ const internalPubkey = Buffer.from(
28
+ 'cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115',
29
+ 'hex',
30
+ );
31
+ const expectedAddress =
32
+ 'bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr';
33
+
34
+ // Verify the above (Below is no different than other HD wallets)
35
+ const seed = await bip39.mnemonicToSeed(mnemonic);
36
+ const rootKey = bip32.fromSeed(seed);
37
+ assert.strictEqual(rootKey.toBase58(), xprv);
38
+ const childNode = rootKey.derivePath(path);
39
+ // Since internalKey is an xOnly pubkey, we drop the DER header byte
40
+ const childNodeXOnlyPubkey = toXOnly(childNode.publicKey);
41
+ assert.deepEqual(childNodeXOnlyPubkey, internalPubkey);
42
+
43
+ // This is new for taproot
44
+ // Note: we are using mainnet here to get the correct address
45
+ // The output is the same no matter what the network is.
46
+ const { address, output } = bitcoin.payments.p2tr({
47
+ internalPubkey,
48
+ });
49
+ assert(output);
50
+ assert.strictEqual(address, expectedAddress);
51
+ // Used for signing, since the output and address are using a tweaked key
52
+ // We must tweak the signer in the same way.
53
+ const tweakedChildNode = childNode.tweak(
54
+ bitcoin.crypto.taggedHash('TapTweak', childNodeXOnlyPubkey),
55
+ );
56
+
57
+ // amount from faucet
58
+ const amount = 42e4;
59
+ // amount to send
60
+ const sendAmount = amount - 1e4;
61
+ // Send some sats to the address via faucet. Get the hash and index. (txid/vout)
62
+ const { txId: hash, vout: index } = await regtestUtils.faucetComplex(
63
+ output,
64
+ amount,
65
+ );
66
+ // Sent 420000 sats to taproot address
67
+
68
+ const psbt = new bitcoin.Psbt({ network: regtest })
69
+ .addInput({
70
+ hash,
71
+ index,
72
+ witnessUtxo: { value: amount, script: output },
73
+ tapInternalKey: childNodeXOnlyPubkey,
74
+ })
75
+ .addOutput({
76
+ value: sendAmount,
77
+ address: regtestUtils.RANDOM_ADDRESS,
78
+ })
79
+ .signInput(0, tweakedChildNode)
80
+ .finalizeAllInputs();
81
+
82
+ const tx = psbt.extractTransaction();
83
+ await regtestUtils.broadcast(tx.toHex());
84
+ await regtestUtils.verify({
85
+ txId: tx.getId(),
86
+ address: regtestUtils.RANDOM_ADDRESS,
87
+ vout: 0,
88
+ value: sendAmount,
89
+ });
90
+ });
91
+
92
+ it('can create (and broadcast via 3PBP) a taproot key-path spend Transaction', async () => {
93
+ const internalKey = bip32.fromSeed(rng(64), regtest);
94
+ const p2pkhKey = bip32.fromSeed(rng(64), regtest);
95
+
96
+ const { output } = bitcoin.payments.p2tr({
97
+ internalPubkey: toXOnly(internalKey.publicKey),
98
+ network: regtest,
99
+ });
100
+
101
+ const { output: p2pkhOutput } = bitcoin.payments.p2pkh({
102
+ pubkey: p2pkhKey.publicKey,
103
+ network: regtest,
104
+ });
105
+
106
+ // amount from faucet
107
+ const amount = 42e4;
108
+ // amount to send
109
+ const sendAmount = amount - 1e4;
110
+ // get faucet
111
+ const unspent = await regtestUtils.faucetComplex(output!, amount);
112
+
113
+ // non segwit utxo
114
+ const p2pkhUnspent = await regtestUtils.faucetComplex(
115
+ p2pkhOutput!,
116
+ amount,
117
+ );
118
+ const utx = await regtestUtils.fetch(p2pkhUnspent.txId);
119
+ const nonWitnessUtxo = Buffer.from(utx.txHex, 'hex');
120
+
121
+ const psbt = new bitcoin.Psbt({ network: regtest });
122
+ psbt.addInput({
123
+ hash: unspent.txId,
124
+ index: 0,
125
+ witnessUtxo: { value: amount, script: output! },
126
+ tapInternalKey: toXOnly(internalKey.publicKey),
127
+ });
128
+ psbt.addInput({ index: 0, hash: p2pkhUnspent.txId, nonWitnessUtxo });
129
+
130
+ const sendInternalKey = bip32.fromSeed(rng(64), regtest);
131
+ const sendPubKey = toXOnly(sendInternalKey.publicKey);
132
+ const { address: sendAddress } = bitcoin.payments.p2tr({
133
+ internalPubkey: sendPubKey,
134
+ network: regtest,
135
+ });
136
+
137
+ psbt.addOutput({
138
+ value: sendAmount,
139
+ address: sendAddress!,
140
+ tapInternalKey: sendPubKey,
141
+ });
142
+
143
+ const tweakedSigner = internalKey.tweak(
144
+ bitcoin.crypto.taggedHash(
145
+ 'TapTweak',
146
+ toXOnly(internalKey.publicKey),
147
+ ),
148
+ );
149
+ await psbt.signInputAsync(0, tweakedSigner);
150
+ await psbt.signInputAsync(1, p2pkhKey);
151
+
152
+ psbt.finalizeAllInputs();
153
+ const tx = psbt.extractTransaction();
154
+ const rawTx = tx.toBuffer();
155
+
156
+ const hex = rawTx.toString('hex');
157
+
158
+ await regtestUtils.broadcast(hex);
159
+ await regtestUtils.verify({
160
+ txId: tx.getId(),
161
+ address: sendAddress!,
162
+ vout: 0,
163
+ value: sendAmount,
164
+ });
165
+ });
166
+
167
+ it('can create (and broadcast via 3PBP) a taproot key-path spend Transaction (with unused scriptTree)', async () => {
168
+ const internalKey = bip32.fromSeed(rng(64), regtest);
169
+ const leafKey = bip32.fromSeed(rng(64), regtest);
170
+
171
+ const leafScriptAsm = `${toXOnly(leafKey.publicKey).toString(
172
+ 'hex',
173
+ )} OP_CHECKSIG`;
174
+ const leafScript = bitcoin.script.fromASM(leafScriptAsm);
175
+
176
+ const scriptTree = {
177
+ output: leafScript,
178
+ };
179
+
180
+ const { output, address, hash } = bitcoin.payments.p2tr({
181
+ internalPubkey: toXOnly(internalKey.publicKey),
182
+ scriptTree,
183
+ network: regtest,
184
+ });
185
+
186
+ // amount from faucet
187
+ const amount = 42e4;
188
+ // amount to send
189
+ const sendAmount = amount - 1e4;
190
+ // get faucet
191
+ const unspent = await regtestUtils.faucetComplex(output!, amount);
192
+
193
+ const psbt = new bitcoin.Psbt({ network: regtest });
194
+ psbt.addInput({
195
+ hash: unspent.txId,
196
+ index: 0,
197
+ witnessUtxo: { value: amount, script: output! },
198
+ tapInternalKey: toXOnly(internalKey.publicKey),
199
+ tapMerkleRoot: hash,
200
+ });
201
+ psbt.addOutput({ value: sendAmount, address: address! });
202
+
203
+ const tweakedSigner = internalKey.tweak(
204
+ bitcoin.crypto.taggedHash(
205
+ 'TapTweak',
206
+ Buffer.concat([toXOnly(internalKey.publicKey), hash!]),
207
+ ),
208
+ );
209
+ psbt.signInput(0, tweakedSigner);
210
+
211
+ psbt.finalizeAllInputs();
212
+ const tx = psbt.extractTransaction();
213
+ const rawTx = tx.toBuffer();
214
+
215
+ const hex = rawTx.toString('hex');
216
+
217
+ await regtestUtils.broadcast(hex);
218
+ await regtestUtils.verify({
219
+ txId: tx.getId(),
220
+ address: address!,
221
+ vout: 0,
222
+ value: sendAmount,
223
+ });
224
+ });
225
+
226
+ it('can create (and broadcast via 3PBP) a taproot script-path spend Transaction - OP_CHECKSIG', async () => {
227
+ const internalKey = bip32.fromSeed(rng(64), regtest);
228
+ const leafKey = bip32.fromSeed(rng(64), regtest);
229
+
230
+ const leafScriptAsm = `${toXOnly(leafKey.publicKey).toString(
231
+ 'hex',
232
+ )} OP_CHECKSIG`;
233
+ const leafScript = bitcoin.script.fromASM(leafScriptAsm);
234
+
235
+ const scriptTree: Taptree = [
236
+ [
237
+ {
238
+ output: bitcoin.script.fromASM(
239
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0 OP_CHECKSIG',
240
+ ),
241
+ },
242
+ [
243
+ {
244
+ output: bitcoin.script.fromASM(
245
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac1 OP_CHECKSIG',
246
+ ),
247
+ },
248
+ {
249
+ output: bitcoin.script.fromASM(
250
+ '2258b1c3160be0864a541854eec9164a572f094f7562628281a8073bb89173a7 OP_CHECKSIG',
251
+ ),
252
+ },
253
+ ],
254
+ ],
255
+ [
256
+ {
257
+ output: bitcoin.script.fromASM(
258
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac2 OP_CHECKSIG',
259
+ ),
260
+ },
261
+ [
262
+ {
263
+ output: bitcoin.script.fromASM(
264
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac3 OP_CHECKSIG',
265
+ ),
266
+ },
267
+ [
268
+ {
269
+ output: bitcoin.script.fromASM(
270
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac4 OP_CHECKSIG',
271
+ ),
272
+ },
273
+ {
274
+ output: leafScript,
275
+ },
276
+ ],
277
+ ],
278
+ ],
279
+ ];
280
+ const redeem = {
281
+ output: leafScript,
282
+ redeemVersion: LEAF_VERSION_TAPSCRIPT,
283
+ };
284
+
285
+ const { output, witness } = bitcoin.payments.p2tr({
286
+ internalPubkey: toXOnly(internalKey.publicKey),
287
+ scriptTree,
288
+ redeem,
289
+ network: regtest,
290
+ });
291
+
292
+ // amount from faucet
293
+ const amount = 42e4;
294
+ // amount to send
295
+ const sendAmount = amount - 1e4;
296
+ // get faucet
297
+ const unspent = await regtestUtils.faucetComplex(output!, amount);
298
+
299
+ const psbt = new bitcoin.Psbt({ network: regtest });
300
+ psbt.addInput({
301
+ hash: unspent.txId,
302
+ index: 0,
303
+ witnessUtxo: { value: amount, script: output! },
304
+ });
305
+ psbt.updateInput(0, {
306
+ tapLeafScript: [
307
+ {
308
+ leafVersion: redeem.redeemVersion,
309
+ script: redeem.output,
310
+ controlBlock: witness![witness!.length - 1],
311
+ },
312
+ ],
313
+ });
314
+
315
+ const sendInternalKey = bip32.fromSeed(rng(64), regtest);
316
+ const sendPubKey = toXOnly(sendInternalKey.publicKey);
317
+ const { address: sendAddress } = bitcoin.payments.p2tr({
318
+ internalPubkey: sendPubKey,
319
+ scriptTree,
320
+ network: regtest,
321
+ });
322
+
323
+ psbt.addOutput({
324
+ value: sendAmount,
325
+ address: sendAddress!,
326
+ tapInternalKey: sendPubKey,
327
+ tapTree: { leaves: tapTreeToList(scriptTree) },
328
+ });
329
+
330
+ psbt.signInput(0, leafKey);
331
+ psbt.finalizeInput(0);
332
+ const tx = psbt.extractTransaction();
333
+ const rawTx = tx.toBuffer();
334
+ const hex = rawTx.toString('hex');
335
+
336
+ await regtestUtils.broadcast(hex);
337
+ await regtestUtils.verify({
338
+ txId: tx.getId(),
339
+ address: sendAddress!,
340
+ vout: 0,
341
+ value: sendAmount,
342
+ });
343
+ });
344
+
345
+ it('can create (and broadcast via 3PBP) a taproot script-path spend Transaction - OP_CHECKSEQUENCEVERIFY', async () => {
346
+ const internalKey = bip32.fromSeed(rng(64), regtest);
347
+ const leafKey = bip32.fromSeed(rng(64), regtest);
348
+ const leafPubkey = toXOnly(leafKey.publicKey).toString('hex');
349
+
350
+ const leafScriptAsm = `OP_10 OP_CHECKSEQUENCEVERIFY OP_DROP ${leafPubkey} OP_CHECKSIG`;
351
+ const leafScript = bitcoin.script.fromASM(leafScriptAsm);
352
+
353
+ const scriptTree: Taptree = [
354
+ {
355
+ output: bitcoin.script.fromASM(
356
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0 OP_CHECKSIG',
357
+ ),
358
+ },
359
+ [
360
+ {
361
+ output: bitcoin.script.fromASM(
362
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0 OP_CHECKSIG',
363
+ ),
364
+ },
365
+ {
366
+ output: leafScript,
367
+ },
368
+ ],
369
+ ];
370
+ const redeem = {
371
+ output: leafScript,
372
+ redeemVersion: LEAF_VERSION_TAPSCRIPT,
373
+ };
374
+
375
+ const { output, witness } = bitcoin.payments.p2tr({
376
+ internalPubkey: toXOnly(internalKey.publicKey),
377
+ scriptTree,
378
+ redeem,
379
+ network: regtest,
380
+ });
381
+
382
+ // amount from faucet
383
+ const amount = 42e4;
384
+ // amount to send
385
+ const sendAmount = amount - 1e4;
386
+ // get faucet
387
+ const unspent = await regtestUtils.faucetComplex(output!, amount);
388
+
389
+ const psbt = new bitcoin.Psbt({ network: regtest });
390
+ psbt.addInput({
391
+ hash: unspent.txId,
392
+ index: 0,
393
+ sequence: 10,
394
+ witnessUtxo: { value: amount, script: output! },
395
+ });
396
+ psbt.updateInput(0, {
397
+ tapLeafScript: [
398
+ {
399
+ leafVersion: redeem.redeemVersion,
400
+ script: redeem.output,
401
+ controlBlock: witness![witness!.length - 1],
402
+ },
403
+ ],
404
+ });
405
+
406
+ const sendInternalKey = bip32.fromSeed(rng(64), regtest);
407
+ const sendPubKey = toXOnly(sendInternalKey.publicKey);
408
+ const { address: sendAddress } = bitcoin.payments.p2tr({
409
+ internalPubkey: sendPubKey,
410
+ scriptTree,
411
+ network: regtest,
412
+ });
413
+
414
+ psbt.addOutput({ value: sendAmount, address: sendAddress! });
415
+ // just to test that updateOutput works as expected
416
+ psbt.updateOutput(0, {
417
+ tapInternalKey: sendPubKey,
418
+ tapTree: { leaves: tapTreeToList(scriptTree) },
419
+ });
420
+
421
+ await psbt.signInputAsync(0, leafKey);
422
+
423
+ psbt.finalizeInput(0);
424
+ const tx = psbt.extractTransaction();
425
+ const rawTx = tx.toBuffer();
426
+ const hex = rawTx.toString('hex');
427
+
428
+ try {
429
+ // broadcast before the confirmation period has expired
430
+ await regtestUtils.broadcast(hex);
431
+ throw new Error('Broadcast should fail.');
432
+ } catch (err) {
433
+ if ((err as any).message !== 'non-BIP68-final')
434
+ throw new Error(
435
+ 'Expected OP_CHECKSEQUENCEVERIFY validation to fail. But it faild with: ' +
436
+ err,
437
+ );
438
+ }
439
+ await regtestUtils.mine(10);
440
+ await regtestUtils.broadcast(hex);
441
+ await regtestUtils.verify({
442
+ txId: tx.getId(),
443
+ address: sendAddress!,
444
+ vout: 0,
445
+ value: sendAmount,
446
+ });
447
+ });
448
+
449
+ it('can create (and broadcast via 3PBP) a taproot script-path spend Transaction - OP_CHECKSIGADD (3-of-3)', async () => {
450
+ const internalKey = bip32.fromSeed(rng(64), regtest);
451
+
452
+ const leafKeys = [];
453
+ const leafPubkeys = [];
454
+ for (let i = 0; i < 3; i++) {
455
+ const leafKey = bip32.fromSeed(rng(64), regtest);
456
+ leafKeys.push(leafKey);
457
+ leafPubkeys.push(toXOnly(leafKey.publicKey).toString('hex'));
458
+ }
459
+
460
+ const leafScriptAsm = `${leafPubkeys[2]} OP_CHECKSIG ${leafPubkeys[1]} OP_CHECKSIGADD ${leafPubkeys[0]} OP_CHECKSIGADD OP_3 OP_NUMEQUAL`;
461
+
462
+ const leafScript = bitcoin.script.fromASM(leafScriptAsm);
463
+
464
+ const scriptTree: Taptree = [
465
+ {
466
+ output: bitcoin.script.fromASM(
467
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0 OP_CHECKSIG',
468
+ ),
469
+ },
470
+ [
471
+ {
472
+ output: bitcoin.script.fromASM(
473
+ '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0 OP_CHECKSIG',
474
+ ),
475
+ },
476
+ {
477
+ output: leafScript,
478
+ },
479
+ ],
480
+ ];
481
+ const redeem = {
482
+ output: leafScript,
483
+ redeemVersion: LEAF_VERSION_TAPSCRIPT,
484
+ };
485
+
486
+ const { output, address, witness } = bitcoin.payments.p2tr({
487
+ internalPubkey: toXOnly(internalKey.publicKey),
488
+ scriptTree,
489
+ redeem,
490
+ network: regtest,
491
+ });
492
+
493
+ // amount from faucet
494
+ const amount = 42e4;
495
+ // amount to send
496
+ const sendAmount = amount - 1e4;
497
+ // get faucet
498
+ const unspent = await regtestUtils.faucetComplex(output!, amount);
499
+
500
+ const psbt = new bitcoin.Psbt({ network: regtest });
501
+ psbt.addInput({
502
+ hash: unspent.txId,
503
+ index: 0,
504
+ witnessUtxo: { value: amount, script: output! },
505
+ });
506
+ psbt.updateInput(0, {
507
+ tapLeafScript: [
508
+ {
509
+ leafVersion: redeem.redeemVersion,
510
+ script: redeem.output,
511
+ controlBlock: witness![witness!.length - 1],
512
+ },
513
+ ],
514
+ });
515
+
516
+ psbt.addOutput({ value: sendAmount, address: address! });
517
+
518
+ // random order for signers
519
+ psbt.signInput(0, leafKeys[1]);
520
+ psbt.signInput(0, leafKeys[2]);
521
+ psbt.signInput(0, leafKeys[0]);
522
+
523
+ psbt.finalizeInput(0);
524
+ const tx = psbt.extractTransaction();
525
+ const rawTx = tx.toBuffer();
526
+ const hex = rawTx.toString('hex');
527
+
528
+ await regtestUtils.broadcast(hex);
529
+ await regtestUtils.verify({
530
+ txId: tx.getId(),
531
+ address: address!,
532
+ vout: 0,
533
+ value: sendAmount,
534
+ });
535
+ });
536
+
537
+ it('can create (and broadcast via 3PBP) a taproot script-path spend Transaction - custom finalizer', async () => {
538
+ const leafCount = 8;
539
+ const leaves = Array.from({ length: leafCount }).map(
540
+ (_, index) =>
541
+ ({
542
+ depth: 3,
543
+ leafVersion: LEAF_VERSION_TAPSCRIPT,
544
+ script: bitcoin.script.fromASM(
545
+ `OP_ADD OP_${index * 2} OP_EQUAL`,
546
+ ),
547
+ } as TapLeaf),
548
+ );
549
+ const scriptTree = tapTreeFromList(leaves);
550
+
551
+ for (let leafIndex = 1; leafIndex < leafCount; leafIndex++) {
552
+ const redeem = {
553
+ output: bitcoin.script.fromASM(
554
+ `OP_ADD OP_${leafIndex * 2} OP_EQUAL`,
555
+ ),
556
+ redeemVersion: LEAF_VERSION_TAPSCRIPT,
557
+ };
558
+
559
+ const internalKey = bip32.fromSeed(rng(64), regtest);
560
+ const { output, witness } = bitcoin.payments.p2tr({
561
+ internalPubkey: toXOnly(internalKey.publicKey),
562
+ scriptTree,
563
+ redeem,
564
+ network: regtest,
565
+ });
566
+
567
+ // amount from faucet
568
+ const amount = 42e4;
569
+ // amount to send
570
+ const sendAmount = amount - 1e4;
571
+ // get faucet
572
+ const unspent = await regtestUtils.faucetComplex(output!, amount);
573
+
574
+ const psbt = new bitcoin.Psbt({ network: regtest });
575
+ psbt.addInput({
576
+ hash: unspent.txId,
577
+ index: 0,
578
+ witnessUtxo: { value: amount, script: output! },
579
+ });
580
+
581
+ const tapLeafScript: TapLeafScript = {
582
+ leafVersion: redeem.redeemVersion,
583
+ script: redeem.output,
584
+ controlBlock: witness![witness!.length - 1],
585
+ };
586
+ psbt.updateInput(0, { tapLeafScript: [tapLeafScript] });
587
+
588
+ const sendAddress =
589
+ 'bcrt1pqknex3jwpsaatu5e5dcjw70nac3fr5k5y3hcxr4hgg6rljzp59nqs6a0vh';
590
+ psbt.addOutput({
591
+ value: sendAmount,
592
+ address: sendAddress,
593
+ });
594
+
595
+ const leafIndexFinalizerFn = buildLeafIndexFinalizer(
596
+ tapLeafScript,
597
+ leafIndex,
598
+ );
599
+ psbt.finalizeInput(0, leafIndexFinalizerFn);
600
+ const tx = psbt.extractTransaction();
601
+ const rawTx = tx.toBuffer();
602
+ const hex = rawTx.toString('hex');
603
+
604
+ await regtestUtils.broadcast(hex);
605
+ await regtestUtils.verify({
606
+ txId: tx.getId(),
607
+ address: sendAddress!,
608
+ vout: 0,
609
+ value: sendAmount,
610
+ });
611
+ }
612
+ });
613
+
614
+ it('should fail validating invalid signatures for taproot (See issue #1931)', () => {
615
+ const schnorrValidator = (
616
+ pubkey: Buffer,
617
+ msghash: Buffer,
618
+ signature: Buffer,
619
+ ) => {
620
+ return ecc.verifySchnorr(msghash, pubkey, signature);
621
+ };
622
+
623
+ const psbtBase64 =
624
+ `cHNidP8BAFICAAAAAe1h73A6zedruNERV6JU7Ty1IlYZh2KO1cBklZqCMEy8AAAAAAD/////ARA
625
+ nAAAAAAAAFgAUS0GlfqWSeEWIpwPwrvRIjBbJQroAAAAAAAEA/TgBAQAAAAABAnGJ6st1FIvYLEV
626
+ bJMQaZ3HSOJnkw5C+ViCuJYiFEYosAAAAAAD9////xuZd0xArNSaBuElLX3nzjwtZW95O7L/wbz9
627
+ 4v+v0vuYAAAAAAP3///8CECcAAAAAAAAiUSAVbMSHgwYVdyBgfNy0syr6TMaFOGhFjXJYuQcRLlp
628
+ DS8hgBwAAAAAAIlEgthWGz3o2R7WpgjIK52ODoEaA/0HcImSUjVk6agZgghwBQIP9WWErMfeBBYy
629
+ uHuSZS7MdXVICtlFgNveDrvuXeQGSZl1gGG6/r3Aw7h9TifGtoA+7JwYBjLMcEG6hbeyQGXIBQNS
630
+ qKH1p/NFzO9bxe9vpvBZQIaX5Qa9SY2NfNCgSRNabmX5EiaihWcLC+ALgchm7DUfYrAmi1r4uSI/
631
+ YaQ1lq8gAAAAAAQErECcAAAAAAAAiUSAVbMSHgwYVdyBgfNy0syr6TMaFOGhFjXJYuQcRLlpDSwE
632
+ DBIMAAAABCEMBQZUpv6e1Hwfpi/PpglkkK/Rx40vZIIHwtJ7dXWFZ5TcZUEelCnfKOAWZ4xWjauY
633
+ M2y+JcgFcVsuPzPuiM+z5AH+DARNBlSm/p7UfB+mL8+mCWSQr9HHjS9kggfC0nt1dYVnlNxlQR6U
634
+ Kd8o4BZnjFaNq5gzbL4lyAVxWy4/M+6Iz7PkAf4MBFyC6ZCT2zZVrEbkw/T1fyS8eLKQaP2MH6rz
635
+ dlMauGvQzLQAA`.replace(/\s+/g, '');
636
+
637
+ const psbt = bitcoin.Psbt.fromBase64(psbtBase64);
638
+
639
+ assert(
640
+ !psbt.validateSignaturesOfAllInputs(schnorrValidator),
641
+ 'Should fail validation',
642
+ );
643
+ });
644
+
645
+ it('should succeed validating valid signatures for taproot (See issue #1934)', () => {
646
+ const schnorrValidator = (
647
+ pubkey: Buffer,
648
+ msghash: Buffer,
649
+ signature: Buffer,
650
+ ) => {
651
+ return ecc.verifySchnorr(msghash, pubkey, signature);
652
+ };
653
+
654
+ const psbtBase64 =
655
+ `cHNidP8BAF4CAAAAAU6UzYPa7tES0HoS+obnRJuXX41Ob64Zs59qDEyKsu1ZAAAAAAD/////AYA
656
+ zAjsAAAAAIlEgIlIzfR+flIWYTyewD9v+1N84IubZ/7qg6oHlYLzv1aYAAAAAAAEAXgEAAAAB8f+
657
+ afEJBun7sRQLFE1Olc/gK9LBaduUpz3vB4fjXVF0AAAAAAP3///8BECcAAAAAAAAiUSAiUjN9H5+
658
+ UhZhPJ7AP2/7U3zgi5tn/uqDqgeVgvO/VpgAAAAABASsQJwAAAAAAACJRICJSM30fn5SFmE8nsA/
659
+ b/tTfOCLm2f+6oOqB5WC879WmAQMEgwAAAAETQWQwNOao3RMOBWPuAQ9Iph7Qzk47MvroTHbJR49
660
+ MxKJmQ6hfhZa5wVVrdKYea5BW/loqa7al2pYYZMlGvdS06wODARcgjuYXxIpyOMVTYEvl35gDidC
661
+ m/vUICZyuNNZKaPz9dxAAAQUgjuYXxIpyOMVTYEvl35gDidCm/vUICZyuNNZKaPz9dxAA`.replace(
662
+ /\s+/g,
663
+ '',
664
+ );
665
+
666
+ const psbt = bitcoin.Psbt.fromBase64(psbtBase64);
667
+
668
+ assert(
669
+ psbt.validateSignaturesOfAllInputs(schnorrValidator),
670
+ 'Should succeed validation',
671
+ );
672
+ });
673
+ });
674
+
675
+ function buildLeafIndexFinalizer(
676
+ tapLeafScript: TapLeafScript,
677
+ leafIndex: number,
678
+ ): (
679
+ inputIndex: number,
680
+ _input: PsbtInput,
681
+ _tapLeafHashToFinalize?: Buffer,
682
+ ) => {
683
+ finalScriptWitness: Buffer | undefined;
684
+ } {
685
+ return (
686
+ inputIndex: number,
687
+ _input: PsbtInput,
688
+ _tapLeafHashToFinalize?: Buffer,
689
+ ): {
690
+ finalScriptWitness: Buffer | undefined;
691
+ } => {
692
+ try {
693
+ const scriptSolution = [
694
+ Buffer.from([leafIndex]),
695
+ Buffer.from([leafIndex]),
696
+ ];
697
+ const witness = scriptSolution
698
+ .concat(tapLeafScript.script)
699
+ .concat(tapLeafScript.controlBlock);
700
+ return { finalScriptWitness: witnessStackToScriptWitness(witness) };
701
+ } catch (err) {
702
+ throw new Error(
703
+ `Can not finalize taproot input #${inputIndex}: ${err}`,
704
+ );
705
+ }
706
+ };
707
+ }