@btc-vision/bitcoin 6.3.5 → 6.4.0

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 (72) hide show
  1. package/.mocharc.json +13 -0
  2. package/browser/address.d.ts +1 -1
  3. package/browser/index.js +1 -1
  4. package/browser/index.js.LICENSE.txt +3 -3
  5. package/browser/networks.d.ts +1 -0
  6. package/browser/psbt/psbtutils.d.ts +1 -1
  7. package/build/address.d.ts +1 -1
  8. package/build/address.js +12 -5
  9. package/build/block.js +2 -2
  10. package/build/bufferutils.js +5 -5
  11. package/build/networks.d.ts +1 -0
  12. package/build/networks.js +11 -0
  13. package/build/psbt/psbtutils.js +2 -2
  14. package/build/psbt.js +3 -7
  15. package/package.json +26 -26
  16. package/src/address.ts +20 -6
  17. package/src/block.ts +233 -233
  18. package/src/bufferutils.ts +188 -180
  19. package/src/index.ts +86 -86
  20. package/src/networks.ts +12 -0
  21. package/src/psbt/bip371.ts +441 -441
  22. package/src/psbt/psbtutils.ts +4 -3
  23. package/src/psbt.ts +2187 -2187
  24. package/test/address.spec.ts +155 -177
  25. package/test/bitcoin.core.spec.ts +212 -234
  26. package/test/block.spec.ts +171 -194
  27. package/test/bufferutils.spec.ts +450 -513
  28. package/test/crypto.spec.ts +49 -55
  29. package/test/fixtures/address.json +3 -3
  30. package/test/integration/addresses.spec.ts +142 -154
  31. package/test/integration/bip32.spec.ts +130 -151
  32. package/test/integration/blocks.spec.ts +28 -28
  33. package/test/integration/cltv.spec.ts +241 -283
  34. package/test/integration/csv.spec.ts +452 -527
  35. package/test/integration/payments.spec.ts +110 -135
  36. package/test/integration/taproot.spec.ts +663 -707
  37. package/test/integration/transactions.spec.ts +668 -769
  38. package/test/payments.spec.ts +114 -125
  39. package/test/payments.utils.ts +165 -208
  40. package/test/psbt.spec.ts +1285 -1414
  41. package/test/script.spec.ts +186 -210
  42. package/test/script_number.spec.ts +26 -29
  43. package/test/script_signature.spec.ts +66 -66
  44. package/test/transaction.spec.ts +337 -387
  45. package/test/ts-node-register.js +7 -5
  46. package/test/tsconfig.json +4 -1
  47. package/test/types.spec.ts +53 -58
  48. package/.nyc_output/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +0 -1
  49. package/.nyc_output/processinfo/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +0 -1
  50. package/.nyc_output/processinfo/index.json +0 -1
  51. package/test/address.spec.js +0 -124
  52. package/test/bitcoin.core.spec.js +0 -170
  53. package/test/block.spec.js +0 -141
  54. package/test/bufferutils.spec.js +0 -427
  55. package/test/crypto.spec.js +0 -41
  56. package/test/integration/_regtest.js +0 -7
  57. package/test/integration/addresses.spec.js +0 -116
  58. package/test/integration/bip32.spec.js +0 -85
  59. package/test/integration/blocks.spec.js +0 -26
  60. package/test/integration/cltv.spec.js +0 -199
  61. package/test/integration/csv.spec.js +0 -362
  62. package/test/integration/payments.spec.js +0 -98
  63. package/test/integration/taproot.spec.js +0 -532
  64. package/test/integration/transactions.spec.js +0 -561
  65. package/test/payments.spec.js +0 -97
  66. package/test/payments.utils.js +0 -190
  67. package/test/psbt.spec.js +0 -1044
  68. package/test/script.spec.js +0 -151
  69. package/test/script_number.spec.js +0 -24
  70. package/test/script_signature.spec.js +0 -52
  71. package/test/transaction.spec.js +0 -269
  72. package/test/types.spec.js +0 -46
@@ -1,527 +1,452 @@
1
- import * as assert from 'assert';
2
- import { PsbtInput } from 'bip174/src/lib/interfaces';
3
- import ECPairFactory from 'ecpair';
4
- import * as ecc from 'tiny-secp256k1';
5
- import { before, describe, it } from 'mocha';
6
- import * as bitcoin from '../..';
7
- import { regtestUtils } from './_regtest';
8
-
9
- const ECPair = ECPairFactory(ecc);
10
- const regtest = regtestUtils.network;
11
- const bip68 = require('bip68');
12
- const varuint = require('varuint-bitcoin');
13
-
14
- function toOutputScript(address: string): Buffer {
15
- return bitcoin.address.toOutputScript(address, regtest);
16
- }
17
-
18
- function idToHash(txid: string): Buffer {
19
- return Buffer.from(txid, 'hex').reverse();
20
- }
21
-
22
- const alice = ECPair.fromWIF(
23
- 'cScfkGjbzzoeewVWmU2hYPUHeVGJRDdFt7WhmrVVGkxpmPP8BHWe',
24
- regtest,
25
- );
26
- const bob = ECPair.fromWIF(
27
- 'cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsLwjHXA9x',
28
- regtest,
29
- );
30
- const charles = ECPair.fromWIF(
31
- 'cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsMSb4Ubnf',
32
- regtest,
33
- );
34
- const dave = ECPair.fromWIF(
35
- 'cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsMwS4pqnx',
36
- regtest,
37
- );
38
-
39
- describe('bitcoinjs-lib (transactions w/ CSV)', () => {
40
- // force update MTP
41
- before(async () => {
42
- await regtestUtils.mine(11);
43
- });
44
-
45
- const hashType = bitcoin.Transaction.SIGHASH_ALL;
46
-
47
- interface KeyPair {
48
- publicKey: Buffer;
49
- }
50
-
51
- // IF MTP (from when confirmed) > seconds, _alice can redeem
52
- function csvCheckSigOutput(
53
- _alice: KeyPair,
54
- _bob: KeyPair,
55
- sequence: number,
56
- ): Buffer {
57
- return bitcoin.script.fromASM(
58
- `
59
- OP_IF
60
- ${bitcoin.script.number.encode(sequence).toString('hex')}
61
- OP_CHECKSEQUENCEVERIFY
62
- OP_DROP
63
- OP_ELSE
64
- ${_bob.publicKey.toString('hex')}
65
- OP_CHECKSIGVERIFY
66
- OP_ENDIF
67
- ${_alice.publicKey.toString('hex')}
68
- OP_CHECKSIG
69
- `
70
- .trim()
71
- .replace(/\s+/g, ' '),
72
- );
73
- }
74
-
75
- // 2 of 3 multisig of _bob, _charles, _dave,
76
- // but after sequence1 time, _alice can allow the multisig to become 1 of 3.
77
- // but after sequence2 time, _alice can sign for the output all by themself.
78
-
79
- // Ref: https://github.com/bitcoinbook/bitcoinbook/blob/f8b883dcd4e3d1b9adf40fed59b7e898fbd9241f/ch07.asciidoc#complex-script-example
80
-
81
- // Note: bitcoinjs-lib will not offer specific support for problems with
82
- // advanced script usages such as below. Use at your own risk.
83
- function complexCsvOutput(
84
- _alice: KeyPair,
85
- _bob: KeyPair,
86
- _charles: KeyPair,
87
- _dave: KeyPair,
88
- sequence1: number,
89
- sequence2: number,
90
- ): Buffer {
91
- return bitcoin.script.fromASM(
92
- `
93
- OP_IF
94
- OP_IF
95
- OP_2
96
- OP_ELSE
97
- ${bitcoin.script.number.encode(sequence1).toString('hex')}
98
- OP_CHECKSEQUENCEVERIFY
99
- OP_DROP
100
- ${_alice.publicKey.toString('hex')}
101
- OP_CHECKSIGVERIFY
102
- OP_1
103
- OP_ENDIF
104
- ${_bob.publicKey.toString('hex')}
105
- ${_charles.publicKey.toString('hex')}
106
- ${_dave.publicKey.toString('hex')}
107
- OP_3
108
- OP_CHECKMULTISIG
109
- OP_ELSE
110
- ${bitcoin.script.number.encode(sequence2).toString('hex')}
111
- OP_CHECKSEQUENCEVERIFY
112
- OP_DROP
113
- ${_alice.publicKey.toString('hex')}
114
- OP_CHECKSIG
115
- OP_ENDIF
116
- `
117
- .trim()
118
- .replace(/\s+/g, ' '),
119
- );
120
- }
121
-
122
- // expiry will pass, {Alice's signature} OP_TRUE
123
- it(
124
- 'can create (and broadcast via 3PBP) a Transaction where Alice can redeem ' +
125
- 'the output after the expiry (in the future) (simple CHECKSEQUENCEVERIFY)',
126
- async () => {
127
- // 5 blocks from now
128
- const sequence = bip68.encode({ blocks: 5 });
129
- const p2sh = bitcoin.payments.p2sh({
130
- redeem: {
131
- output: csvCheckSigOutput(alice, bob, sequence),
132
- },
133
- network: regtest,
134
- });
135
-
136
- // fund the P2SH(CSV) address
137
- const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
138
- const utx = await regtestUtils.fetch(unspent.txId);
139
- // for non segwit inputs, you must pass the full transaction buffer
140
- const nonWitnessUtxo = Buffer.from(utx.txHex, 'hex');
141
-
142
- // This is an example of using the finalizeInput second parameter to
143
- // define how you finalize the inputs, allowing for any type of script.
144
- const tx = new bitcoin.Psbt({ network: regtest })
145
- .setVersion(2)
146
- .addInput({
147
- hash: unspent.txId,
148
- index: unspent.vout,
149
- sequence,
150
- redeemScript: p2sh.redeem!.output!,
151
- nonWitnessUtxo,
152
- })
153
- .addOutput({
154
- address: regtestUtils.RANDOM_ADDRESS,
155
- value: 7e4,
156
- })
157
- .signInput(0, alice)
158
- .finalizeInput(0, csvGetFinalScripts) // See csvGetFinalScripts below
159
- .extractTransaction();
160
-
161
- // TODO: test that it failures _prior_ to expiry, unfortunately, race conditions when run concurrently
162
- // ...
163
- // into the future!
164
- await regtestUtils.mine(10);
165
-
166
- await regtestUtils.broadcast(tx.toHex());
167
-
168
- await regtestUtils.verify({
169
- txId: tx.getId(),
170
- address: regtestUtils.RANDOM_ADDRESS,
171
- vout: 0,
172
- value: 7e4,
173
- });
174
- },
175
- );
176
-
177
- // expiry in the future, {Alice's signature} OP_TRUE
178
- it(
179
- 'can create (but fail to broadcast via 3PBP) a Transaction where Alice ' +
180
- 'attempts to redeem before the expiry (simple CHECKSEQUENCEVERIFY)',
181
- async () => {
182
- // two hours after confirmation
183
- const sequence = bip68.encode({ seconds: 7168 });
184
- const p2sh = bitcoin.payments.p2sh({
185
- network: regtest,
186
- redeem: {
187
- output: csvCheckSigOutput(alice, bob, sequence),
188
- },
189
- });
190
-
191
- // fund the P2SH(CSV) address
192
- const unspent = await regtestUtils.faucet(p2sh.address!, 2e4);
193
-
194
- const tx = new bitcoin.Transaction();
195
- tx.version = 2;
196
- tx.addInput(idToHash(unspent.txId), unspent.vout, sequence);
197
- tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 1e4);
198
-
199
- // {Alice's signature} OP_TRUE
200
- const signatureHash = tx.hashForSignature(
201
- 0,
202
- p2sh.redeem!.output!,
203
- hashType,
204
- );
205
- const redeemScriptSig = bitcoin.payments.p2sh({
206
- network: regtest,
207
- redeem: {
208
- network: regtest,
209
- output: p2sh.redeem!.output,
210
- input: bitcoin.script.compile([
211
- bitcoin.script.signature.encode(
212
- alice.sign(signatureHash),
213
- hashType,
214
- ),
215
- bitcoin.script.signature.encode(
216
- bob.sign(signatureHash),
217
- hashType,
218
- ),
219
- bitcoin.opcodes.OP_TRUE,
220
- ]),
221
- },
222
- }).input;
223
- tx.setInputScript(0, redeemScriptSig!);
224
-
225
- await regtestUtils.broadcast(tx.toHex()).catch(err => {
226
- assert.throws(() => {
227
- if (err) throw err;
228
- }, /Error: non-BIP68-final/);
229
- });
230
- },
231
- );
232
-
233
- // Check first combination of complex CSV, 2 of 3
234
- it(
235
- 'can create (and broadcast via 3PBP) a Transaction where Bob and Charles ' +
236
- 'can send (complex CHECKSEQUENCEVERIFY)',
237
- async () => {
238
- // 2 blocks from now
239
- const sequence1 = bip68.encode({ blocks: 2 });
240
- // 5 blocks from now
241
- const sequence2 = bip68.encode({ blocks: 5 });
242
- const p2sh = bitcoin.payments.p2sh({
243
- redeem: {
244
- output: complexCsvOutput(
245
- alice,
246
- bob,
247
- charles,
248
- dave,
249
- sequence1,
250
- sequence2,
251
- ),
252
- },
253
- network: regtest,
254
- });
255
-
256
- // fund the P2SH(CCSV) address
257
- const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
258
-
259
- const tx = new bitcoin.Transaction();
260
- tx.version = 2;
261
- tx.addInput(idToHash(unspent.txId), unspent.vout);
262
- tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 7e4);
263
-
264
- // OP_0 {Bob sig} {Charles sig} OP_TRUE OP_TRUE
265
- const signatureHash = tx.hashForSignature(
266
- 0,
267
- p2sh.redeem!.output!,
268
- hashType,
269
- );
270
- const redeemScriptSig = bitcoin.payments.p2sh({
271
- network: regtest,
272
- redeem: {
273
- network: regtest,
274
- output: p2sh.redeem!.output,
275
- input: bitcoin.script.compile([
276
- bitcoin.opcodes.OP_0,
277
- bitcoin.script.signature.encode(
278
- bob.sign(signatureHash),
279
- hashType,
280
- ),
281
- bitcoin.script.signature.encode(
282
- charles.sign(signatureHash),
283
- hashType,
284
- ),
285
- bitcoin.opcodes.OP_TRUE,
286
- bitcoin.opcodes.OP_TRUE,
287
- ]),
288
- },
289
- }).input;
290
- tx.setInputScript(0, redeemScriptSig!);
291
-
292
- await regtestUtils.broadcast(tx.toHex());
293
-
294
- await regtestUtils.verify({
295
- txId: tx.getId(),
296
- address: regtestUtils.RANDOM_ADDRESS,
297
- vout: 0,
298
- value: 7e4,
299
- });
300
- },
301
- );
302
-
303
- // Check first combination of complex CSV, mediator + 1 of 3 after 2 blocks
304
- it(
305
- 'can create (and broadcast via 3PBP) a Transaction where Alice (mediator) ' +
306
- 'and Bob can send after 2 blocks (complex CHECKSEQUENCEVERIFY)',
307
- async () => {
308
- // 2 blocks from now
309
- const sequence1 = bip68.encode({ blocks: 2 });
310
- // 5 blocks from now
311
- const sequence2 = bip68.encode({ blocks: 5 });
312
- const p2sh = bitcoin.payments.p2sh({
313
- redeem: {
314
- output: complexCsvOutput(
315
- alice,
316
- bob,
317
- charles,
318
- dave,
319
- sequence1,
320
- sequence2,
321
- ),
322
- },
323
- network: regtest,
324
- });
325
-
326
- // fund the P2SH(CCSV) address
327
- const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
328
-
329
- const tx = new bitcoin.Transaction();
330
- tx.version = 2;
331
- tx.addInput(idToHash(unspent.txId), unspent.vout, sequence1); // Set sequence1 for input
332
- tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 7e4);
333
-
334
- // OP_0 {Bob sig} {Alice mediator sig} OP_FALSE OP_TRUE
335
- const signatureHash = tx.hashForSignature(
336
- 0,
337
- p2sh.redeem!.output!,
338
- hashType,
339
- );
340
- const redeemScriptSig = bitcoin.payments.p2sh({
341
- network: regtest,
342
- redeem: {
343
- network: regtest,
344
- output: p2sh.redeem!.output,
345
- input: bitcoin.script.compile([
346
- bitcoin.opcodes.OP_0,
347
- bitcoin.script.signature.encode(
348
- bob.sign(signatureHash),
349
- hashType,
350
- ),
351
- bitcoin.script.signature.encode(
352
- alice.sign(signatureHash),
353
- hashType,
354
- ),
355
- bitcoin.opcodes.OP_0,
356
- bitcoin.opcodes.OP_TRUE,
357
- ]),
358
- },
359
- }).input;
360
- tx.setInputScript(0, redeemScriptSig!);
361
-
362
- // Wait 2 blocks
363
- await regtestUtils.mine(2);
364
-
365
- await regtestUtils.broadcast(tx.toHex());
366
-
367
- await regtestUtils.verify({
368
- txId: tx.getId(),
369
- address: regtestUtils.RANDOM_ADDRESS,
370
- vout: 0,
371
- value: 7e4,
372
- });
373
- },
374
- );
375
-
376
- // Check first combination of complex CSV, mediator after 5 blocks
377
- it(
378
- 'can create (and broadcast via 3PBP) a Transaction where Alice (mediator) ' +
379
- 'can send after 5 blocks (complex CHECKSEQUENCEVERIFY)',
380
- async () => {
381
- // 2 blocks from now
382
- const sequence1 = bip68.encode({ blocks: 2 });
383
- // 5 blocks from now
384
- const sequence2 = bip68.encode({ blocks: 5 });
385
- const p2sh = bitcoin.payments.p2sh({
386
- redeem: {
387
- output: complexCsvOutput(
388
- alice,
389
- bob,
390
- charles,
391
- dave,
392
- sequence1,
393
- sequence2,
394
- ),
395
- },
396
- network: regtest,
397
- });
398
-
399
- // fund the P2SH(CCSV) address
400
- const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
401
-
402
- const tx = new bitcoin.Transaction();
403
- tx.version = 2;
404
- tx.addInput(idToHash(unspent.txId), unspent.vout, sequence2); // Set sequence2 for input
405
- tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 7e4);
406
-
407
- // {Alice mediator sig} OP_FALSE
408
- const signatureHash = tx.hashForSignature(
409
- 0,
410
- p2sh.redeem!.output!,
411
- hashType,
412
- );
413
- const redeemScriptSig = bitcoin.payments.p2sh({
414
- network: regtest,
415
- redeem: {
416
- network: regtest,
417
- output: p2sh.redeem!.output,
418
- input: bitcoin.script.compile([
419
- bitcoin.script.signature.encode(
420
- alice.sign(signatureHash),
421
- hashType,
422
- ),
423
- bitcoin.opcodes.OP_0,
424
- ]),
425
- },
426
- }).input;
427
- tx.setInputScript(0, redeemScriptSig!);
428
-
429
- // Wait 5 blocks
430
- await regtestUtils.mine(5);
431
-
432
- await regtestUtils.broadcast(tx.toHex());
433
-
434
- await regtestUtils.verify({
435
- txId: tx.getId(),
436
- address: regtestUtils.RANDOM_ADDRESS,
437
- vout: 0,
438
- value: 7e4,
439
- });
440
- },
441
- );
442
- });
443
-
444
- // This function is used to finalize a CSV transaction using PSBT.
445
- // See first test above.
446
- function csvGetFinalScripts(
447
- inputIndex: number,
448
- input: PsbtInput,
449
- script: Buffer,
450
- isSegwit: boolean,
451
- isP2SH: boolean,
452
- isP2WSH: boolean,
453
- ): {
454
- finalScriptSig: Buffer | undefined;
455
- finalScriptWitness: Buffer | undefined;
456
- } {
457
- // Step 1: Check to make sure the meaningful script matches what you expect.
458
- const decompiled = bitcoin.script.decompile(script);
459
- // Checking if first OP is OP_IF... should do better check in production!
460
- // You may even want to check the public keys in the script against a
461
- // whitelist depending on the circumstances!!!
462
- // You also want to check the contents of the input to see if you have enough
463
- // info to actually construct the scriptSig and Witnesses.
464
- if (!decompiled || decompiled[0] !== bitcoin.opcodes.OP_IF) {
465
- throw new Error(`Can not finalize input #${inputIndex}`);
466
- }
467
-
468
- // Step 2: Create final scripts
469
- let payment: bitcoin.Payment = {
470
- network: regtest,
471
- output: script,
472
- // This logic should be more strict and make sure the pubkeys in the
473
- // meaningful script are the ones signing in the PSBT etc.
474
- input: bitcoin.script.compile([
475
- input.partialSig![0].signature,
476
- bitcoin.opcodes.OP_TRUE,
477
- ]),
478
- };
479
- if (isP2WSH && isSegwit)
480
- payment = bitcoin.payments.p2wsh({
481
- network: regtest,
482
- redeem: payment,
483
- });
484
- if (isP2SH)
485
- payment = bitcoin.payments.p2sh({
486
- network: regtest,
487
- redeem: payment,
488
- });
489
-
490
- function witnessStackToScriptWitness(witness: Buffer[]): Buffer {
491
- let buffer = Buffer.allocUnsafe(0);
492
-
493
- function writeSlice(slice: Buffer): void {
494
- buffer = Buffer.concat([buffer, Buffer.from(slice)]);
495
- }
496
-
497
- function writeVarInt(i: number): void {
498
- const currentLen = buffer.length;
499
- const varintLen = varuint.encodingLength(i);
500
-
501
- buffer = Buffer.concat([buffer, Buffer.allocUnsafe(varintLen)]);
502
- varuint.encode(i, buffer, currentLen);
503
- }
504
-
505
- function writeVarSlice(slice: Buffer): void {
506
- writeVarInt(slice.length);
507
- writeSlice(slice);
508
- }
509
-
510
- function writeVector(vector: Buffer[]): void {
511
- writeVarInt(vector.length);
512
- vector.forEach(writeVarSlice);
513
- }
514
-
515
- writeVector(witness);
516
-
517
- return buffer;
518
- }
519
-
520
- return {
521
- finalScriptSig: payment.input,
522
- finalScriptWitness:
523
- payment.witness && payment.witness.length > 0
524
- ? witnessStackToScriptWitness(payment.witness)
525
- : undefined,
526
- };
527
- }
1
+ import assert from 'assert';
2
+ import { PsbtInput } from 'bip174/src/lib/interfaces.js';
3
+ import { ECPairFactory } from 'ecpair';
4
+ import * as ecc from 'tiny-secp256k1';
5
+ import { before, describe, it } from 'mocha';
6
+ import * as bitcoin from '../../src/index.js';
7
+ import { regtestUtils } from './_regtest.js';
8
+
9
+ // @ts-ignore
10
+ import bip68 from 'bip68';
11
+ import * as varuint from 'varuint-bitcoin';
12
+
13
+ const ECPair = ECPairFactory(ecc);
14
+ const regtest = regtestUtils.network;
15
+
16
+ function toOutputScript(address: string): Buffer {
17
+ return bitcoin.address.toOutputScript(address, regtest);
18
+ }
19
+
20
+ function idToHash(txid: string): Buffer {
21
+ return Buffer.from(txid, 'hex').reverse();
22
+ }
23
+
24
+ const alice = ECPair.fromWIF('cScfkGjbzzoeewVWmU2hYPUHeVGJRDdFt7WhmrVVGkxpmPP8BHWe', regtest);
25
+ const bob = ECPair.fromWIF('cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsLwjHXA9x', regtest);
26
+ const charles = ECPair.fromWIF('cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsMSb4Ubnf', regtest);
27
+ const dave = ECPair.fromWIF('cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsMwS4pqnx', regtest);
28
+
29
+ describe('bitcoinjs-lib (transactions w/ CSV)', () => {
30
+ // force update MTP
31
+ before(async () => {
32
+ await regtestUtils.mine(11);
33
+ });
34
+
35
+ const hashType = bitcoin.Transaction.SIGHASH_ALL;
36
+
37
+ interface KeyPair {
38
+ publicKey: Buffer;
39
+ }
40
+
41
+ // IF MTP (from when confirmed) > seconds, _alice can redeem
42
+ function csvCheckSigOutput(_alice: KeyPair, _bob: KeyPair, sequence: number): Buffer {
43
+ return bitcoin.script.fromASM(
44
+ `
45
+ OP_IF
46
+ ${bitcoin.script.number.encode(sequence).toString('hex')}
47
+ OP_CHECKSEQUENCEVERIFY
48
+ OP_DROP
49
+ OP_ELSE
50
+ ${_bob.publicKey.toString('hex')}
51
+ OP_CHECKSIGVERIFY
52
+ OP_ENDIF
53
+ ${_alice.publicKey.toString('hex')}
54
+ OP_CHECKSIG
55
+ `
56
+ .trim()
57
+ .replace(/\s+/g, ' '),
58
+ );
59
+ }
60
+
61
+ // 2 of 3 multisig of _bob, _charles, _dave,
62
+ // but after sequence1 time, _alice can allow the multisig to become 1 of 3.
63
+ // but after sequence2 time, _alice can sign for the output all by themself.
64
+
65
+ // Ref: https://github.com/bitcoinbook/bitcoinbook/blob/f8b883dcd4e3d1b9adf40fed59b7e898fbd9241f/ch07.asciidoc#complex-script-example
66
+
67
+ // Note: bitcoinjs-lib will not offer specific support for problems with
68
+ // advanced script usages such as below. Use at your own risk.
69
+ function complexCsvOutput(
70
+ _alice: KeyPair,
71
+ _bob: KeyPair,
72
+ _charles: KeyPair,
73
+ _dave: KeyPair,
74
+ sequence1: number,
75
+ sequence2: number,
76
+ ): Buffer {
77
+ return bitcoin.script.fromASM(
78
+ `
79
+ OP_IF
80
+ OP_IF
81
+ OP_2
82
+ OP_ELSE
83
+ ${bitcoin.script.number.encode(sequence1).toString('hex')}
84
+ OP_CHECKSEQUENCEVERIFY
85
+ OP_DROP
86
+ ${_alice.publicKey.toString('hex')}
87
+ OP_CHECKSIGVERIFY
88
+ OP_1
89
+ OP_ENDIF
90
+ ${_bob.publicKey.toString('hex')}
91
+ ${_charles.publicKey.toString('hex')}
92
+ ${_dave.publicKey.toString('hex')}
93
+ OP_3
94
+ OP_CHECKMULTISIG
95
+ OP_ELSE
96
+ ${bitcoin.script.number.encode(sequence2).toString('hex')}
97
+ OP_CHECKSEQUENCEVERIFY
98
+ OP_DROP
99
+ ${_alice.publicKey.toString('hex')}
100
+ OP_CHECKSIG
101
+ OP_ENDIF
102
+ `
103
+ .trim()
104
+ .replace(/\s+/g, ' '),
105
+ );
106
+ }
107
+
108
+ // expiry will pass, {Alice's signature} OP_TRUE
109
+ it(
110
+ 'can create (and broadcast via 3PBP) a Transaction where Alice can redeem ' +
111
+ 'the output after the expiry (in the future) (simple CHECKSEQUENCEVERIFY)',
112
+ async () => {
113
+ // 5 blocks from now
114
+ const sequence = bip68.encode({ blocks: 5 });
115
+ const p2sh = bitcoin.payments.p2sh({
116
+ redeem: {
117
+ output: csvCheckSigOutput(alice, bob, sequence),
118
+ },
119
+ network: regtest,
120
+ });
121
+
122
+ // fund the P2SH(CSV) address
123
+ const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
124
+ const utx = await regtestUtils.fetch(unspent.txId);
125
+ // for non segwit inputs, you must pass the full transaction buffer
126
+ const nonWitnessUtxo = Buffer.from(utx.txHex, 'hex');
127
+
128
+ // This is an example of using the finalizeInput second parameter to
129
+ // define how you finalize the inputs, allowing for any type of script.
130
+ const tx = new bitcoin.Psbt({ network: regtest })
131
+ .setVersion(2)
132
+ .addInput({
133
+ hash: unspent.txId,
134
+ index: unspent.vout,
135
+ sequence,
136
+ redeemScript: p2sh.redeem!.output!,
137
+ nonWitnessUtxo,
138
+ })
139
+ .addOutput({
140
+ address: regtestUtils.RANDOM_ADDRESS,
141
+ value: 7e4,
142
+ })
143
+ .signInput(0, alice)
144
+ .finalizeInput(0, csvGetFinalScripts) // See csvGetFinalScripts below
145
+ .extractTransaction();
146
+
147
+ // TODO: test that it failures _prior_ to expiry, unfortunately, race conditions when run concurrently
148
+ // ...
149
+ // into the future!
150
+ await regtestUtils.mine(10);
151
+
152
+ await regtestUtils.broadcast(tx.toHex());
153
+
154
+ await regtestUtils.verify({
155
+ txId: tx.getId(),
156
+ address: regtestUtils.RANDOM_ADDRESS,
157
+ vout: 0,
158
+ value: 7e4,
159
+ });
160
+ },
161
+ );
162
+
163
+ // expiry in the future, {Alice's signature} OP_TRUE
164
+ it(
165
+ 'can create (but fail to broadcast via 3PBP) a Transaction where Alice ' +
166
+ 'attempts to redeem before the expiry (simple CHECKSEQUENCEVERIFY)',
167
+ async () => {
168
+ // two hours after confirmation
169
+ const sequence = bip68.encode({ seconds: 7168 });
170
+ const p2sh = bitcoin.payments.p2sh({
171
+ network: regtest,
172
+ redeem: {
173
+ output: csvCheckSigOutput(alice, bob, sequence),
174
+ },
175
+ });
176
+
177
+ // fund the P2SH(CSV) address
178
+ const unspent = await regtestUtils.faucet(p2sh.address!, 2e4);
179
+
180
+ const tx = new bitcoin.Transaction();
181
+ tx.version = 2;
182
+ tx.addInput(idToHash(unspent.txId), unspent.vout, sequence);
183
+ tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 1e4);
184
+
185
+ // {Alice's signature} OP_TRUE
186
+ const signatureHash = tx.hashForSignature(0, p2sh.redeem!.output!, hashType);
187
+ const redeemScriptSig = bitcoin.payments.p2sh({
188
+ network: regtest,
189
+ redeem: {
190
+ network: regtest,
191
+ output: p2sh.redeem!.output,
192
+ input: bitcoin.script.compile([
193
+ bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
194
+ bitcoin.script.signature.encode(bob.sign(signatureHash), hashType),
195
+ bitcoin.opcodes.OP_TRUE,
196
+ ]),
197
+ },
198
+ }).input;
199
+ tx.setInputScript(0, redeemScriptSig!);
200
+
201
+ await regtestUtils.broadcast(tx.toHex()).catch((err: unknown) => {
202
+ assert.throws(() => {
203
+ if (err) throw err;
204
+ }, /Error: non-BIP68-final/);
205
+ });
206
+ },
207
+ );
208
+
209
+ // Check first combination of complex CSV, 2 of 3
210
+ it(
211
+ 'can create (and broadcast via 3PBP) a Transaction where Bob and Charles ' +
212
+ 'can send (complex CHECKSEQUENCEVERIFY)',
213
+ async () => {
214
+ // 2 blocks from now
215
+ const sequence1 = bip68.encode({ blocks: 2 });
216
+ // 5 blocks from now
217
+ const sequence2 = bip68.encode({ blocks: 5 });
218
+ const p2sh = bitcoin.payments.p2sh({
219
+ redeem: {
220
+ output: complexCsvOutput(alice, bob, charles, dave, sequence1, sequence2),
221
+ },
222
+ network: regtest,
223
+ });
224
+
225
+ // fund the P2SH(CCSV) address
226
+ const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
227
+
228
+ const tx = new bitcoin.Transaction();
229
+ tx.version = 2;
230
+ tx.addInput(idToHash(unspent.txId), unspent.vout);
231
+ tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 7e4);
232
+
233
+ // OP_0 {Bob sig} {Charles sig} OP_TRUE OP_TRUE
234
+ const signatureHash = tx.hashForSignature(0, p2sh.redeem!.output!, hashType);
235
+ const redeemScriptSig = bitcoin.payments.p2sh({
236
+ network: regtest,
237
+ redeem: {
238
+ network: regtest,
239
+ output: p2sh.redeem!.output,
240
+ input: bitcoin.script.compile([
241
+ bitcoin.opcodes.OP_0,
242
+ bitcoin.script.signature.encode(bob.sign(signatureHash), hashType),
243
+ bitcoin.script.signature.encode(charles.sign(signatureHash), hashType),
244
+ bitcoin.opcodes.OP_TRUE,
245
+ bitcoin.opcodes.OP_TRUE,
246
+ ]),
247
+ },
248
+ }).input;
249
+ tx.setInputScript(0, redeemScriptSig!);
250
+
251
+ await regtestUtils.broadcast(tx.toHex());
252
+
253
+ await regtestUtils.verify({
254
+ txId: tx.getId(),
255
+ address: regtestUtils.RANDOM_ADDRESS,
256
+ vout: 0,
257
+ value: 7e4,
258
+ });
259
+ },
260
+ );
261
+
262
+ // Check first combination of complex CSV, mediator + 1 of 3 after 2 blocks
263
+ it(
264
+ 'can create (and broadcast via 3PBP) a Transaction where Alice (mediator) ' +
265
+ 'and Bob can send after 2 blocks (complex CHECKSEQUENCEVERIFY)',
266
+ async () => {
267
+ // 2 blocks from now
268
+ const sequence1 = bip68.encode({ blocks: 2 });
269
+ // 5 blocks from now
270
+ const sequence2 = bip68.encode({ blocks: 5 });
271
+ const p2sh = bitcoin.payments.p2sh({
272
+ redeem: {
273
+ output: complexCsvOutput(alice, bob, charles, dave, sequence1, sequence2),
274
+ },
275
+ network: regtest,
276
+ });
277
+
278
+ // fund the P2SH(CCSV) address
279
+ const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
280
+
281
+ const tx = new bitcoin.Transaction();
282
+ tx.version = 2;
283
+ tx.addInput(idToHash(unspent.txId), unspent.vout, sequence1); // Set sequence1 for input
284
+ tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 7e4);
285
+
286
+ // OP_0 {Bob sig} {Alice mediator sig} OP_FALSE OP_TRUE
287
+ const signatureHash = tx.hashForSignature(0, p2sh.redeem!.output!, hashType);
288
+ const redeemScriptSig = bitcoin.payments.p2sh({
289
+ network: regtest,
290
+ redeem: {
291
+ network: regtest,
292
+ output: p2sh.redeem!.output,
293
+ input: bitcoin.script.compile([
294
+ bitcoin.opcodes.OP_0,
295
+ bitcoin.script.signature.encode(bob.sign(signatureHash), hashType),
296
+ bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
297
+ bitcoin.opcodes.OP_0,
298
+ bitcoin.opcodes.OP_TRUE,
299
+ ]),
300
+ },
301
+ }).input;
302
+ tx.setInputScript(0, redeemScriptSig!);
303
+
304
+ // Wait 2 blocks
305
+ await regtestUtils.mine(2);
306
+
307
+ await regtestUtils.broadcast(tx.toHex());
308
+
309
+ await regtestUtils.verify({
310
+ txId: tx.getId(),
311
+ address: regtestUtils.RANDOM_ADDRESS,
312
+ vout: 0,
313
+ value: 7e4,
314
+ });
315
+ },
316
+ );
317
+
318
+ // Check first combination of complex CSV, mediator after 5 blocks
319
+ it(
320
+ 'can create (and broadcast via 3PBP) a Transaction where Alice (mediator) ' +
321
+ 'can send after 5 blocks (complex CHECKSEQUENCEVERIFY)',
322
+ async () => {
323
+ // 2 blocks from now
324
+ const sequence1 = bip68.encode({ blocks: 2 });
325
+ // 5 blocks from now
326
+ const sequence2 = bip68.encode({ blocks: 5 });
327
+ const p2sh = bitcoin.payments.p2sh({
328
+ redeem: {
329
+ output: complexCsvOutput(alice, bob, charles, dave, sequence1, sequence2),
330
+ },
331
+ network: regtest,
332
+ });
333
+
334
+ // fund the P2SH(CCSV) address
335
+ const unspent = await regtestUtils.faucet(p2sh.address!, 1e5);
336
+
337
+ const tx = new bitcoin.Transaction();
338
+ tx.version = 2;
339
+ tx.addInput(idToHash(unspent.txId), unspent.vout, sequence2); // Set sequence2 for input
340
+ tx.addOutput(toOutputScript(regtestUtils.RANDOM_ADDRESS), 7e4);
341
+
342
+ // {Alice mediator sig} OP_FALSE
343
+ const signatureHash = tx.hashForSignature(0, p2sh.redeem!.output!, hashType);
344
+ const redeemScriptSig = bitcoin.payments.p2sh({
345
+ network: regtest,
346
+ redeem: {
347
+ network: regtest,
348
+ output: p2sh.redeem!.output,
349
+ input: bitcoin.script.compile([
350
+ bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
351
+ bitcoin.opcodes.OP_0,
352
+ ]),
353
+ },
354
+ }).input;
355
+ tx.setInputScript(0, redeemScriptSig!);
356
+
357
+ // Wait 5 blocks
358
+ await regtestUtils.mine(5);
359
+
360
+ await regtestUtils.broadcast(tx.toHex());
361
+
362
+ await regtestUtils.verify({
363
+ txId: tx.getId(),
364
+ address: regtestUtils.RANDOM_ADDRESS,
365
+ vout: 0,
366
+ value: 7e4,
367
+ });
368
+ },
369
+ );
370
+ });
371
+
372
+ // This function is used to finalize a CSV transaction using PSBT.
373
+ // See first test above.
374
+ function csvGetFinalScripts(
375
+ inputIndex: number,
376
+ input: PsbtInput,
377
+ script: Buffer,
378
+ isSegwit: boolean,
379
+ isP2SH: boolean,
380
+ isP2WSH: boolean,
381
+ ): {
382
+ finalScriptSig: Buffer | undefined;
383
+ finalScriptWitness: Buffer | undefined;
384
+ } {
385
+ // Step 1: Check to make sure the meaningful script matches what you expect.
386
+ const decompiled = bitcoin.script.decompile(script);
387
+ // Checking if first OP is OP_IF... should do better check in production!
388
+ // You may even want to check the public keys in the script against a
389
+ // whitelist depending on the circumstances!!!
390
+ // You also want to check the contents of the input to see if you have enough
391
+ // info to actually construct the scriptSig and Witnesses.
392
+ if (!decompiled || decompiled[0] !== bitcoin.opcodes.OP_IF) {
393
+ throw new Error(`Can not finalize input #${inputIndex}`);
394
+ }
395
+
396
+ // Step 2: Create final scripts
397
+ let payment: bitcoin.Payment = {
398
+ network: regtest,
399
+ output: script,
400
+ // This logic should be more strict and make sure the pubkeys in the
401
+ // meaningful script are the ones signing in the PSBT etc.
402
+ input: bitcoin.script.compile([input.partialSig![0].signature, bitcoin.opcodes.OP_TRUE]),
403
+ };
404
+ if (isP2WSH && isSegwit)
405
+ payment = bitcoin.payments.p2wsh({
406
+ network: regtest,
407
+ redeem: payment,
408
+ });
409
+ if (isP2SH)
410
+ payment = bitcoin.payments.p2sh({
411
+ network: regtest,
412
+ redeem: payment,
413
+ });
414
+
415
+ function witnessStackToScriptWitness(witness: Buffer[]): Buffer {
416
+ let buffer = Buffer.allocUnsafe(0);
417
+
418
+ function writeSlice(slice: Buffer): void {
419
+ buffer = Buffer.concat([buffer, Buffer.from(slice)]);
420
+ }
421
+
422
+ function writeVarInt(i: number): void {
423
+ const currentLen = buffer.length;
424
+ const varintLen = varuint.encodingLength(i);
425
+
426
+ buffer = Buffer.concat([buffer, Buffer.allocUnsafe(varintLen)]);
427
+ varuint.encode(i, buffer, currentLen);
428
+ }
429
+
430
+ function writeVarSlice(slice: Buffer): void {
431
+ writeVarInt(slice.length);
432
+ writeSlice(slice);
433
+ }
434
+
435
+ function writeVector(vector: Buffer[]): void {
436
+ writeVarInt(vector.length);
437
+ vector.forEach(writeVarSlice);
438
+ }
439
+
440
+ writeVector(witness);
441
+
442
+ return buffer;
443
+ }
444
+
445
+ return {
446
+ finalScriptSig: payment.input,
447
+ finalScriptWitness:
448
+ payment.witness && payment.witness.length > 0
449
+ ? witnessStackToScriptWitness(payment.witness)
450
+ : undefined,
451
+ };
452
+ }