@btc-vision/bitcoin 6.4.0 → 6.4.1

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.
@@ -1,452 +1,452 @@
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
- }
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
+ }