@btc-vision/bitcoin 6.3.6 → 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 (71) 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/build/address.d.ts +1 -1
  7. package/build/address.js +12 -5
  8. package/build/block.js +2 -2
  9. package/build/bufferutils.js +5 -5
  10. package/build/networks.d.ts +1 -0
  11. package/build/networks.js +11 -0
  12. package/build/psbt/psbtutils.js +2 -2
  13. package/build/psbt.js +3 -7
  14. package/package.json +26 -26
  15. package/src/address.ts +20 -6
  16. package/src/block.ts +233 -233
  17. package/src/bufferutils.ts +188 -180
  18. package/src/index.ts +86 -86
  19. package/src/networks.ts +12 -0
  20. package/src/psbt/bip371.ts +441 -441
  21. package/src/psbt/psbtutils.ts +4 -3
  22. package/src/psbt.ts +2187 -2187
  23. package/test/address.spec.ts +155 -177
  24. package/test/bitcoin.core.spec.ts +212 -234
  25. package/test/block.spec.ts +171 -194
  26. package/test/bufferutils.spec.ts +450 -513
  27. package/test/crypto.spec.ts +49 -55
  28. package/test/fixtures/address.json +3 -3
  29. package/test/integration/addresses.spec.ts +142 -154
  30. package/test/integration/bip32.spec.ts +130 -151
  31. package/test/integration/blocks.spec.ts +28 -28
  32. package/test/integration/cltv.spec.ts +241 -283
  33. package/test/integration/csv.spec.ts +452 -527
  34. package/test/integration/payments.spec.ts +110 -135
  35. package/test/integration/taproot.spec.ts +663 -707
  36. package/test/integration/transactions.spec.ts +668 -769
  37. package/test/payments.spec.ts +114 -125
  38. package/test/payments.utils.ts +165 -208
  39. package/test/psbt.spec.ts +1285 -1414
  40. package/test/script.spec.ts +186 -210
  41. package/test/script_number.spec.ts +26 -29
  42. package/test/script_signature.spec.ts +66 -66
  43. package/test/transaction.spec.ts +337 -387
  44. package/test/ts-node-register.js +7 -5
  45. package/test/tsconfig.json +4 -1
  46. package/test/types.spec.ts +53 -58
  47. package/.nyc_output/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +0 -1
  48. package/.nyc_output/processinfo/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +0 -1
  49. package/.nyc_output/processinfo/index.json +0 -1
  50. package/test/address.spec.js +0 -124
  51. package/test/bitcoin.core.spec.js +0 -170
  52. package/test/block.spec.js +0 -141
  53. package/test/bufferutils.spec.js +0 -427
  54. package/test/crypto.spec.js +0 -41
  55. package/test/integration/_regtest.js +0 -7
  56. package/test/integration/addresses.spec.js +0 -116
  57. package/test/integration/bip32.spec.js +0 -85
  58. package/test/integration/blocks.spec.js +0 -26
  59. package/test/integration/cltv.spec.js +0 -199
  60. package/test/integration/csv.spec.js +0 -362
  61. package/test/integration/payments.spec.js +0 -98
  62. package/test/integration/taproot.spec.js +0 -532
  63. package/test/integration/transactions.spec.js +0 -561
  64. package/test/payments.spec.js +0 -97
  65. package/test/payments.utils.js +0 -190
  66. package/test/psbt.spec.js +0 -1044
  67. package/test/script.spec.js +0 -151
  68. package/test/script_number.spec.js +0 -24
  69. package/test/script_signature.spec.js +0 -52
  70. package/test/transaction.spec.js +0 -269
  71. package/test/types.spec.js +0 -46
@@ -1,513 +1,450 @@
1
- import * as assert from 'assert';
2
- import { describe, it } from 'mocha';
3
- import * as bufferutils from '../src/bufferutils';
4
- import { BufferReader, BufferWriter } from '../src/bufferutils';
5
-
6
- import * as fixtures from './fixtures/bufferutils.json';
7
-
8
- const varuint = require('varuint-bitcoin');
9
-
10
- describe('bufferutils', () => {
11
- function concatToBuffer(values: number[][]): Buffer {
12
- return Buffer.concat(values.map(data => Buffer.from(data)));
13
- }
14
-
15
- describe('readUInt64LE', () => {
16
- fixtures.valid.forEach(f => {
17
- it('decodes ' + f.hex, () => {
18
- const buffer = Buffer.from(f.hex, 'hex');
19
- const num = bufferutils.readUInt64LE(buffer, 0);
20
-
21
- assert.strictEqual(num, f.dec);
22
- });
23
- });
24
-
25
- fixtures.invalid.readUInt64LE.forEach(f => {
26
- it('throws on ' + f.description, () => {
27
- const buffer = Buffer.from(f.hex, 'hex');
28
-
29
- assert.throws(() => {
30
- bufferutils.readUInt64LE(buffer, 0);
31
- }, new RegExp(f.exception));
32
- });
33
- });
34
- });
35
-
36
- describe('writeUInt64LE', () => {
37
- fixtures.valid.forEach(f => {
38
- it('encodes ' + f.dec, () => {
39
- const buffer = Buffer.alloc(8, 0);
40
-
41
- bufferutils.writeUInt64LE(buffer, f.dec, 0);
42
- assert.strictEqual(buffer.toString('hex'), f.hex);
43
- });
44
- });
45
-
46
- fixtures.invalid.writeUInt64LE.forEach(f => {
47
- it('throws on ' + f.description, () => {
48
- const buffer = Buffer.alloc(8, 0);
49
-
50
- assert.throws(() => {
51
- bufferutils.writeUInt64LE(buffer, f.dec, 0);
52
- }, new RegExp(f.exception));
53
- });
54
- });
55
- });
56
-
57
- describe('BufferWriter', () => {
58
- function testBuffer(
59
- bufferWriter: BufferWriter,
60
- expectedBuffer: Buffer,
61
- expectedOffset: number = expectedBuffer.length,
62
- ): void {
63
- assert.strictEqual(bufferWriter.offset, expectedOffset);
64
- assert.deepStrictEqual(
65
- bufferWriter.buffer.slice(0, expectedOffset),
66
- expectedBuffer.slice(0, expectedOffset),
67
- );
68
- }
69
-
70
- it('withCapacity', () => {
71
- const expectedBuffer = Buffer.from('04030201', 'hex');
72
- const withCapacity = BufferWriter.withCapacity(4);
73
- withCapacity.writeInt32(0x01020304);
74
- testBuffer(withCapacity, expectedBuffer);
75
- });
76
-
77
- it('writeUint8', () => {
78
- const values = [0, 1, 254, 255];
79
- const expectedBuffer = Buffer.from([0, 1, 0xfe, 0xff]);
80
- const bufferWriter = new BufferWriter(
81
- Buffer.allocUnsafe(expectedBuffer.length),
82
- );
83
- values.forEach((v: number) => {
84
- const expectedOffset = bufferWriter.offset + 1;
85
- bufferWriter.writeUInt8(v);
86
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
87
- });
88
- testBuffer(bufferWriter, expectedBuffer);
89
- });
90
-
91
- it('writeInt32', () => {
92
- const values = [
93
- 0,
94
- 1,
95
- Math.pow(2, 31) - 2,
96
- Math.pow(2, 31) - 1,
97
- -1,
98
- -Math.pow(2, 31),
99
- ];
100
- const expectedBuffer = concatToBuffer([
101
- [0, 0, 0, 0],
102
- [1, 0, 0, 0],
103
- [0xfe, 0xff, 0xff, 0x7f],
104
- [0xff, 0xff, 0xff, 0x7f],
105
- [0xff, 0xff, 0xff, 0xff],
106
- [0x00, 0x00, 0x00, 0x80],
107
- ]);
108
- const bufferWriter = new BufferWriter(
109
- Buffer.allocUnsafe(expectedBuffer.length),
110
- );
111
- values.forEach((value: number) => {
112
- const expectedOffset = bufferWriter.offset + 4;
113
- bufferWriter.writeInt32(value);
114
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
115
- });
116
- testBuffer(bufferWriter, expectedBuffer);
117
- });
118
-
119
- it('writeUInt32', () => {
120
- const maxUInt32 = Math.pow(2, 32) - 1;
121
- const values = [0, 1, Math.pow(2, 16), maxUInt32];
122
- const expectedBuffer = concatToBuffer([
123
- [0, 0, 0, 0],
124
- [1, 0, 0, 0],
125
- [0, 0, 1, 0],
126
- [0xff, 0xff, 0xff, 0xff],
127
- ]);
128
- const bufferWriter = new BufferWriter(
129
- Buffer.allocUnsafe(expectedBuffer.length),
130
- );
131
- values.forEach((value: number) => {
132
- const expectedOffset = bufferWriter.offset + 4;
133
- bufferWriter.writeUInt32(value);
134
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
135
- });
136
- testBuffer(bufferWriter, expectedBuffer);
137
- });
138
-
139
- it('writeUInt64', () => {
140
- const values = [
141
- 0,
142
- 1,
143
- Math.pow(2, 32),
144
- Number.MAX_SAFE_INTEGER /* 2^53 - 1 */,
145
- ];
146
- const expectedBuffer = concatToBuffer([
147
- [0, 0, 0, 0, 0, 0, 0, 0],
148
- [1, 0, 0, 0, 0, 0, 0, 0],
149
- [0, 0, 0, 0, 1, 0, 0, 0],
150
- [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
151
- ]);
152
- const bufferWriter = new BufferWriter(
153
- Buffer.allocUnsafe(expectedBuffer.length),
154
- );
155
- values.forEach((value: number) => {
156
- const expectedOffset = bufferWriter.offset + 8;
157
- bufferWriter.writeUInt64(value);
158
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
159
- });
160
- testBuffer(bufferWriter, expectedBuffer);
161
- });
162
-
163
- it('writeVarInt', () => {
164
- const values = [
165
- 0,
166
- 1,
167
- 252,
168
- 253,
169
- 254,
170
- 255,
171
- 256,
172
- Math.pow(2, 16) - 2,
173
- Math.pow(2, 16) - 1,
174
- Math.pow(2, 16),
175
- Math.pow(2, 32) - 2,
176
- Math.pow(2, 32) - 1,
177
- Math.pow(2, 32),
178
- Number.MAX_SAFE_INTEGER,
179
- ];
180
- const expectedBuffer = concatToBuffer([
181
- [0x00],
182
- [0x01],
183
- [0xfc],
184
- [0xfd, 0xfd, 0x00],
185
- [0xfd, 0xfe, 0x00],
186
- [0xfd, 0xff, 0x00],
187
- [0xfd, 0x00, 0x01],
188
- [0xfd, 0xfe, 0xff],
189
- [0xfd, 0xff, 0xff],
190
- [0xfe, 0x00, 0x00, 0x01, 0x00],
191
- [0xfe, 0xfe, 0xff, 0xff, 0xff],
192
- [0xfe, 0xff, 0xff, 0xff, 0xff],
193
- [0xff, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00],
194
- [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
195
- ]);
196
- const bufferWriter = new BufferWriter(
197
- Buffer.allocUnsafe(expectedBuffer.length),
198
- );
199
- values.forEach((value: number) => {
200
- const expectedOffset =
201
- bufferWriter.offset + varuint.encodingLength(value);
202
- bufferWriter.writeVarInt(value);
203
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
204
- });
205
- testBuffer(bufferWriter, expectedBuffer);
206
- });
207
-
208
- it('writeSlice', () => {
209
- const values = [[], [1], [1, 2, 3, 4], [254, 255]];
210
- const expectedBuffer = concatToBuffer(values);
211
- const bufferWriter = new BufferWriter(
212
- Buffer.allocUnsafe(expectedBuffer.length),
213
- );
214
- values.forEach((v: number[]) => {
215
- const expectedOffset = bufferWriter.offset + v.length;
216
- bufferWriter.writeSlice(Buffer.from(v));
217
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
218
- });
219
- testBuffer(bufferWriter, expectedBuffer);
220
- assert.throws(() => {
221
- bufferWriter.writeSlice(Buffer.from([0, 0]));
222
- }, /^Error: Cannot write slice out of bounds$/);
223
- });
224
-
225
- it('writeVarSlice', () => {
226
- const values = [
227
- Buffer.alloc(1, 1),
228
- Buffer.alloc(252, 2),
229
- Buffer.alloc(253, 3),
230
- ];
231
- const expectedBuffer = Buffer.concat([
232
- Buffer.from([0x01, 0x01]),
233
- Buffer.from([0xfc]),
234
- Buffer.alloc(252, 0x02),
235
- Buffer.from([0xfd, 0xfd, 0x00]),
236
- Buffer.alloc(253, 0x03),
237
- ]);
238
- const bufferWriter = new BufferWriter(
239
- Buffer.allocUnsafe(expectedBuffer.length),
240
- );
241
- values.forEach((value: Buffer) => {
242
- const expectedOffset =
243
- bufferWriter.offset +
244
- varuint.encodingLength(value.length) +
245
- value.length;
246
- bufferWriter.writeVarSlice(value);
247
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
248
- });
249
- testBuffer(bufferWriter, expectedBuffer);
250
- });
251
-
252
- it('writeVector', () => {
253
- const values = [
254
- [Buffer.alloc(1, 4), Buffer.alloc(253, 5)],
255
- Array(253).fill(Buffer.alloc(1, 6)),
256
- ];
257
- const expectedBuffer = Buffer.concat([
258
- Buffer.from([0x02]),
259
- Buffer.from([0x01, 0x04]),
260
- Buffer.from([0xfd, 0xfd, 0x00]),
261
- Buffer.alloc(253, 5),
262
-
263
- Buffer.from([0xfd, 0xfd, 0x00]),
264
- Buffer.concat(
265
- Array(253)
266
- .fill(0)
267
- .map(() => Buffer.from([0x01, 0x06])),
268
- ),
269
- ]);
270
-
271
- const bufferWriter = new BufferWriter(
272
- Buffer.allocUnsafe(expectedBuffer.length),
273
- );
274
- values.forEach((value: Buffer[]) => {
275
- const expectedOffset =
276
- bufferWriter.offset +
277
- varuint.encodingLength(value.length) +
278
- value.reduce(
279
- (sum: number, v) =>
280
- sum + varuint.encodingLength(v.length) + v.length,
281
- 0,
282
- );
283
- bufferWriter.writeVector(value);
284
- testBuffer(bufferWriter, expectedBuffer, expectedOffset);
285
- });
286
- testBuffer(bufferWriter, expectedBuffer);
287
- });
288
-
289
- it('end', () => {
290
- const expected = Buffer.from('0403020108070605', 'hex');
291
- const bufferWriter = BufferWriter.withCapacity(8);
292
- bufferWriter.writeUInt32(0x01020304);
293
- bufferWriter.writeUInt32(0x05060708);
294
- const result = bufferWriter.end();
295
- testBuffer(bufferWriter, result);
296
- testBuffer(bufferWriter, expected);
297
- });
298
- });
299
-
300
- describe('BufferReader', () => {
301
- function testValue(
302
- bufferReader: BufferReader,
303
- value: Buffer | number,
304
- expectedValue: Buffer | number,
305
- expectedOffset: number = Buffer.isBuffer(expectedValue)
306
- ? expectedValue.length
307
- : 0,
308
- ): void {
309
- assert.strictEqual(bufferReader.offset, expectedOffset);
310
- if (Buffer.isBuffer(expectedValue)) {
311
- assert.deepStrictEqual(
312
- (value as Buffer).slice(0, expectedOffset),
313
- expectedValue.slice(0, expectedOffset),
314
- );
315
- } else {
316
- assert.strictEqual(value as number, expectedValue);
317
- }
318
- }
319
-
320
- it('readUInt8', () => {
321
- const values = [0, 1, 0xfe, 0xff];
322
- const buffer = Buffer.from([0, 1, 0xfe, 0xff]);
323
- const bufferReader = new BufferReader(buffer);
324
- values.forEach((v: number) => {
325
- const expectedOffset = bufferReader.offset + 1;
326
- const val = bufferReader.readUInt8();
327
- testValue(bufferReader, val, v, expectedOffset);
328
- });
329
- });
330
-
331
- it('readInt32', () => {
332
- const values = [
333
- 0,
334
- 1,
335
- Math.pow(2, 31) - 2,
336
- Math.pow(2, 31) - 1,
337
- -1,
338
- -Math.pow(2, 31),
339
- ];
340
- const buffer = concatToBuffer([
341
- [0, 0, 0, 0],
342
- [1, 0, 0, 0],
343
- [0xfe, 0xff, 0xff, 0x7f],
344
- [0xff, 0xff, 0xff, 0x7f],
345
- [0xff, 0xff, 0xff, 0xff],
346
- [0x00, 0x00, 0x00, 0x80],
347
- ]);
348
- const bufferReader = new BufferReader(buffer);
349
- values.forEach((value: number) => {
350
- const expectedOffset = bufferReader.offset + 4;
351
- const val = bufferReader.readInt32();
352
- testValue(bufferReader, val, value, expectedOffset);
353
- });
354
- });
355
-
356
- it('readUInt32', () => {
357
- const maxUInt32 = Math.pow(2, 32) - 1;
358
- const values = [0, 1, Math.pow(2, 16), maxUInt32];
359
- const buffer = concatToBuffer([
360
- [0, 0, 0, 0],
361
- [1, 0, 0, 0],
362
- [0, 0, 1, 0],
363
- [0xff, 0xff, 0xff, 0xff],
364
- ]);
365
- const bufferReader = new BufferReader(buffer);
366
- values.forEach((value: number) => {
367
- const expectedOffset = bufferReader.offset + 4;
368
- const val = bufferReader.readUInt32();
369
- testValue(bufferReader, val, value, expectedOffset);
370
- });
371
- });
372
-
373
- it('readUInt64', () => {
374
- const values = [
375
- 0,
376
- 1,
377
- Math.pow(2, 32),
378
- Number.MAX_SAFE_INTEGER /* 2^53 - 1 */,
379
- ];
380
- const buffer = concatToBuffer([
381
- [0, 0, 0, 0, 0, 0, 0, 0],
382
- [1, 0, 0, 0, 0, 0, 0, 0],
383
- [0, 0, 0, 0, 1, 0, 0, 0],
384
- [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
385
- ]);
386
- const bufferReader = new BufferReader(buffer);
387
- values.forEach((value: number) => {
388
- const expectedOffset = bufferReader.offset + 8;
389
- const val = bufferReader.readUInt64();
390
- testValue(bufferReader, val, value, expectedOffset);
391
- });
392
- });
393
-
394
- it('readVarInt', () => {
395
- const values = [
396
- 0,
397
- 1,
398
- 252,
399
- 253,
400
- 254,
401
- 255,
402
- 256,
403
- Math.pow(2, 16) - 2,
404
- Math.pow(2, 16) - 1,
405
- Math.pow(2, 16),
406
- Math.pow(2, 32) - 2,
407
- Math.pow(2, 32) - 1,
408
- Math.pow(2, 32),
409
- Number.MAX_SAFE_INTEGER,
410
- ];
411
- const buffer = concatToBuffer([
412
- [0x00],
413
- [0x01],
414
- [0xfc],
415
- [0xfd, 0xfd, 0x00],
416
- [0xfd, 0xfe, 0x00],
417
- [0xfd, 0xff, 0x00],
418
- [0xfd, 0x00, 0x01],
419
- [0xfd, 0xfe, 0xff],
420
- [0xfd, 0xff, 0xff],
421
- [0xfe, 0x00, 0x00, 0x01, 0x00],
422
- [0xfe, 0xfe, 0xff, 0xff, 0xff],
423
- [0xfe, 0xff, 0xff, 0xff, 0xff],
424
- [0xff, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00],
425
- [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
426
- ]);
427
- const bufferReader = new BufferReader(buffer);
428
- values.forEach((value: number) => {
429
- const expectedOffset =
430
- bufferReader.offset + varuint.encodingLength(value);
431
- const val = bufferReader.readVarInt();
432
- testValue(bufferReader, val, value, expectedOffset);
433
- });
434
- });
435
-
436
- it('readSlice', () => {
437
- const values = [[1], [1, 2, 3, 4], [254, 255]];
438
- const buffer = concatToBuffer(values);
439
- const bufferReader = new BufferReader(buffer);
440
- values.forEach((v: number[]) => {
441
- const expectedOffset = bufferReader.offset + v.length;
442
- const val = bufferReader.readSlice(v.length);
443
- testValue(bufferReader, val, Buffer.from(v), expectedOffset);
444
- });
445
- assert.throws(() => {
446
- bufferReader.readSlice(2);
447
- }, /^Error: Cannot read slice out of bounds$/);
448
- });
449
-
450
- it('readVarSlice', () => {
451
- const values = [
452
- Buffer.alloc(1, 1),
453
- Buffer.alloc(252, 2),
454
- Buffer.alloc(253, 3),
455
- ];
456
- const buffer = Buffer.concat([
457
- Buffer.from([0x01, 0x01]),
458
- Buffer.from([0xfc]),
459
- Buffer.alloc(252, 0x02),
460
- Buffer.from([0xfd, 0xfd, 0x00]),
461
- Buffer.alloc(253, 0x03),
462
- ]);
463
- const bufferReader = new BufferReader(buffer);
464
- values.forEach((value: Buffer) => {
465
- const expectedOffset =
466
- bufferReader.offset +
467
- varuint.encodingLength(value.length) +
468
- value.length;
469
- const val = bufferReader.readVarSlice();
470
- testValue(bufferReader, val, value, expectedOffset);
471
- });
472
- });
473
-
474
- it('readVector', () => {
475
- const values = [
476
- [Buffer.alloc(1, 4), Buffer.alloc(253, 5)],
477
- Array(253).fill(Buffer.alloc(1, 6)),
478
- ];
479
- const buffer = Buffer.concat([
480
- Buffer.from([0x02]),
481
- Buffer.from([0x01, 0x04]),
482
- Buffer.from([0xfd, 0xfd, 0x00]),
483
- Buffer.alloc(253, 5),
484
-
485
- Buffer.from([0xfd, 0xfd, 0x00]),
486
- Buffer.concat(
487
- Array(253)
488
- .fill(0)
489
- .map(() => Buffer.from([0x01, 0x06])),
490
- ),
491
- ]);
492
-
493
- const bufferReader = new BufferReader(buffer);
494
- values.forEach((value: Buffer[]) => {
495
- const expectedOffset =
496
- bufferReader.offset +
497
- varuint.encodingLength(value.length) +
498
- value.reduce(
499
- (sum: number, v) =>
500
- sum + varuint.encodingLength(v.length) + v.length,
501
- 0,
502
- );
503
- const val = bufferReader.readVector();
504
- testValue(
505
- bufferReader,
506
- Buffer.concat(val),
507
- Buffer.concat(value),
508
- expectedOffset,
509
- );
510
- });
511
- });
512
- });
513
- });
1
+ import assert from 'assert';
2
+ import { describe, it } from 'mocha';
3
+ import * as bufferutils from '../src/bufferutils.js';
4
+ import { BufferReader, BufferWriter } from '../src/bufferutils.js';
5
+
6
+ import fixtures from './fixtures/bufferutils.json' with { type: 'json' };
7
+
8
+ import * as varuint from 'varuint-bitcoin';
9
+
10
+ describe('bufferutils', () => {
11
+ function concatToBuffer(values: number[][]): Buffer {
12
+ return Buffer.concat(values.map((data) => Buffer.from(data)));
13
+ }
14
+
15
+ describe('readUInt64LE', () => {
16
+ fixtures.valid.forEach((f) => {
17
+ it('decodes ' + f.hex, () => {
18
+ const buffer = Buffer.from(f.hex, 'hex');
19
+ const num = bufferutils.readUInt64LE(buffer, 0);
20
+
21
+ assert.strictEqual(num, f.dec);
22
+ });
23
+ });
24
+
25
+ fixtures.invalid.readUInt64LE.forEach((f) => {
26
+ it('throws on ' + f.description, () => {
27
+ const buffer = Buffer.from(f.hex, 'hex');
28
+
29
+ assert.throws(() => {
30
+ bufferutils.readUInt64LE(buffer, 0);
31
+ }, new RegExp(f.exception));
32
+ });
33
+ });
34
+ });
35
+
36
+ describe('writeUInt64LE', () => {
37
+ fixtures.valid.forEach((f) => {
38
+ it('encodes ' + f.dec, () => {
39
+ const buffer = Buffer.alloc(8, 0);
40
+
41
+ bufferutils.writeUInt64LE(buffer, f.dec, 0);
42
+ assert.strictEqual(buffer.toString('hex'), f.hex);
43
+ });
44
+ });
45
+
46
+ fixtures.invalid.writeUInt64LE.forEach((f) => {
47
+ it('throws on ' + f.description, () => {
48
+ const buffer = Buffer.alloc(8, 0);
49
+
50
+ assert.throws(() => {
51
+ bufferutils.writeUInt64LE(buffer, f.dec, 0);
52
+ }, new RegExp(f.exception));
53
+ });
54
+ });
55
+ });
56
+
57
+ describe('BufferWriter', () => {
58
+ function testBuffer(
59
+ bufferWriter: BufferWriter,
60
+ expectedBuffer: Buffer,
61
+ expectedOffset: number = expectedBuffer.length,
62
+ ): void {
63
+ assert.strictEqual(bufferWriter.offset, expectedOffset);
64
+ assert.deepStrictEqual(
65
+ bufferWriter.buffer.slice(0, expectedOffset),
66
+ expectedBuffer.slice(0, expectedOffset),
67
+ );
68
+ }
69
+
70
+ it('withCapacity', () => {
71
+ const expectedBuffer = Buffer.from('04030201', 'hex');
72
+ const withCapacity = BufferWriter.withCapacity(4);
73
+ withCapacity.writeInt32(0x01020304);
74
+ testBuffer(withCapacity, expectedBuffer);
75
+ });
76
+
77
+ it('writeUint8', () => {
78
+ const values = [0, 1, 254, 255];
79
+ const expectedBuffer = Buffer.from([0, 1, 0xfe, 0xff]);
80
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
81
+ values.forEach((v: number) => {
82
+ const expectedOffset = bufferWriter.offset + 1;
83
+ bufferWriter.writeUInt8(v);
84
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
85
+ });
86
+ testBuffer(bufferWriter, expectedBuffer);
87
+ });
88
+
89
+ it('writeInt32', () => {
90
+ const values = [0, 1, Math.pow(2, 31) - 2, Math.pow(2, 31) - 1, -1, -Math.pow(2, 31)];
91
+ const expectedBuffer = concatToBuffer([
92
+ [0, 0, 0, 0],
93
+ [1, 0, 0, 0],
94
+ [0xfe, 0xff, 0xff, 0x7f],
95
+ [0xff, 0xff, 0xff, 0x7f],
96
+ [0xff, 0xff, 0xff, 0xff],
97
+ [0x00, 0x00, 0x00, 0x80],
98
+ ]);
99
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
100
+ values.forEach((value: number) => {
101
+ const expectedOffset = bufferWriter.offset + 4;
102
+ bufferWriter.writeInt32(value);
103
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
104
+ });
105
+ testBuffer(bufferWriter, expectedBuffer);
106
+ });
107
+
108
+ it('writeUInt32', () => {
109
+ const maxUInt32 = Math.pow(2, 32) - 1;
110
+ const values = [0, 1, Math.pow(2, 16), maxUInt32];
111
+ const expectedBuffer = concatToBuffer([
112
+ [0, 0, 0, 0],
113
+ [1, 0, 0, 0],
114
+ [0, 0, 1, 0],
115
+ [0xff, 0xff, 0xff, 0xff],
116
+ ]);
117
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
118
+ values.forEach((value: number) => {
119
+ const expectedOffset = bufferWriter.offset + 4;
120
+ bufferWriter.writeUInt32(value);
121
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
122
+ });
123
+ testBuffer(bufferWriter, expectedBuffer);
124
+ });
125
+
126
+ it('writeUInt64', () => {
127
+ const values = [0, 1, Math.pow(2, 32), Number.MAX_SAFE_INTEGER /* 2^53 - 1 */];
128
+ const expectedBuffer = concatToBuffer([
129
+ [0, 0, 0, 0, 0, 0, 0, 0],
130
+ [1, 0, 0, 0, 0, 0, 0, 0],
131
+ [0, 0, 0, 0, 1, 0, 0, 0],
132
+ [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
133
+ ]);
134
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
135
+ values.forEach((value: number) => {
136
+ const expectedOffset = bufferWriter.offset + 8;
137
+ bufferWriter.writeUInt64(value);
138
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
139
+ });
140
+ testBuffer(bufferWriter, expectedBuffer);
141
+ });
142
+
143
+ it('writeVarInt', () => {
144
+ const values = [
145
+ 0,
146
+ 1,
147
+ 252,
148
+ 253,
149
+ 254,
150
+ 255,
151
+ 256,
152
+ Math.pow(2, 16) - 2,
153
+ Math.pow(2, 16) - 1,
154
+ Math.pow(2, 16),
155
+ Math.pow(2, 32) - 2,
156
+ Math.pow(2, 32) - 1,
157
+ Math.pow(2, 32),
158
+ Number.MAX_SAFE_INTEGER,
159
+ ];
160
+ const expectedBuffer = concatToBuffer([
161
+ [0x00],
162
+ [0x01],
163
+ [0xfc],
164
+ [0xfd, 0xfd, 0x00],
165
+ [0xfd, 0xfe, 0x00],
166
+ [0xfd, 0xff, 0x00],
167
+ [0xfd, 0x00, 0x01],
168
+ [0xfd, 0xfe, 0xff],
169
+ [0xfd, 0xff, 0xff],
170
+ [0xfe, 0x00, 0x00, 0x01, 0x00],
171
+ [0xfe, 0xfe, 0xff, 0xff, 0xff],
172
+ [0xfe, 0xff, 0xff, 0xff, 0xff],
173
+ [0xff, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00],
174
+ [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
175
+ ]);
176
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
177
+ values.forEach((value: number) => {
178
+ const expectedOffset = bufferWriter.offset + varuint.encodingLength(value);
179
+ bufferWriter.writeVarInt(value);
180
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
181
+ });
182
+ testBuffer(bufferWriter, expectedBuffer);
183
+ });
184
+
185
+ it('writeSlice', () => {
186
+ const values = [[], [1], [1, 2, 3, 4], [254, 255]];
187
+ const expectedBuffer = concatToBuffer(values);
188
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
189
+ values.forEach((v: number[]) => {
190
+ const expectedOffset = bufferWriter.offset + v.length;
191
+ bufferWriter.writeSlice(Buffer.from(v));
192
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
193
+ });
194
+ testBuffer(bufferWriter, expectedBuffer);
195
+ assert.throws(() => {
196
+ bufferWriter.writeSlice(Buffer.from([0, 0]));
197
+ }, /^Error: Cannot write slice out of bounds$/);
198
+ });
199
+
200
+ it('writeVarSlice', () => {
201
+ const values = [Buffer.alloc(1, 1), Buffer.alloc(252, 2), Buffer.alloc(253, 3)];
202
+ const expectedBuffer = Buffer.concat([
203
+ Buffer.from([0x01, 0x01]),
204
+ Buffer.from([0xfc]),
205
+ Buffer.alloc(252, 0x02),
206
+ Buffer.from([0xfd, 0xfd, 0x00]),
207
+ Buffer.alloc(253, 0x03),
208
+ ]);
209
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
210
+ values.forEach((value: Buffer) => {
211
+ const expectedOffset =
212
+ bufferWriter.offset + varuint.encodingLength(value.length) + value.length;
213
+ bufferWriter.writeVarSlice(value);
214
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
215
+ });
216
+ testBuffer(bufferWriter, expectedBuffer);
217
+ });
218
+
219
+ it('writeVector', () => {
220
+ const values = [
221
+ [Buffer.alloc(1, 4), Buffer.alloc(253, 5)],
222
+ Array(253).fill(Buffer.alloc(1, 6)),
223
+ ];
224
+ const expectedBuffer = Buffer.concat([
225
+ Buffer.from([0x02]),
226
+ Buffer.from([0x01, 0x04]),
227
+ Buffer.from([0xfd, 0xfd, 0x00]),
228
+ Buffer.alloc(253, 5),
229
+
230
+ Buffer.from([0xfd, 0xfd, 0x00]),
231
+ Buffer.concat(
232
+ Array(253)
233
+ .fill(0)
234
+ .map(() => Buffer.from([0x01, 0x06])),
235
+ ),
236
+ ]);
237
+
238
+ const bufferWriter = new BufferWriter(Buffer.allocUnsafe(expectedBuffer.length));
239
+ values.forEach((value: Buffer[]) => {
240
+ const expectedOffset =
241
+ bufferWriter.offset +
242
+ varuint.encodingLength(value.length) +
243
+ value.reduce(
244
+ (sum: number, v) => sum + varuint.encodingLength(v.length) + v.length,
245
+ 0,
246
+ );
247
+ bufferWriter.writeVector(value);
248
+ testBuffer(bufferWriter, expectedBuffer, expectedOffset);
249
+ });
250
+ testBuffer(bufferWriter, expectedBuffer);
251
+ });
252
+
253
+ it('end', () => {
254
+ const expected = Buffer.from('0403020108070605', 'hex');
255
+ const bufferWriter = BufferWriter.withCapacity(8);
256
+ bufferWriter.writeUInt32(0x01020304);
257
+ bufferWriter.writeUInt32(0x05060708);
258
+ const result = bufferWriter.end();
259
+ testBuffer(bufferWriter, result);
260
+ testBuffer(bufferWriter, expected);
261
+ });
262
+ });
263
+
264
+ describe('BufferReader', () => {
265
+ function testValue(
266
+ bufferReader: BufferReader,
267
+ value: Buffer | number,
268
+ expectedValue: Buffer | number,
269
+ expectedOffset: number = Buffer.isBuffer(expectedValue) ? expectedValue.length : 0,
270
+ ): void {
271
+ assert.strictEqual(bufferReader.offset, expectedOffset);
272
+ if (Buffer.isBuffer(expectedValue)) {
273
+ assert.deepStrictEqual(
274
+ (value as Buffer).slice(0, expectedOffset),
275
+ expectedValue.slice(0, expectedOffset),
276
+ );
277
+ } else {
278
+ assert.strictEqual(value as number, expectedValue);
279
+ }
280
+ }
281
+
282
+ it('readUInt8', () => {
283
+ const values = [0, 1, 0xfe, 0xff];
284
+ const buffer = Buffer.from([0, 1, 0xfe, 0xff]);
285
+ const bufferReader = new BufferReader(buffer);
286
+ values.forEach((v: number) => {
287
+ const expectedOffset = bufferReader.offset + 1;
288
+ const val = bufferReader.readUInt8();
289
+ testValue(bufferReader, val, v, expectedOffset);
290
+ });
291
+ });
292
+
293
+ it('readInt32', () => {
294
+ const values = [0, 1, Math.pow(2, 31) - 2, Math.pow(2, 31) - 1, -1, -Math.pow(2, 31)];
295
+ const buffer = concatToBuffer([
296
+ [0, 0, 0, 0],
297
+ [1, 0, 0, 0],
298
+ [0xfe, 0xff, 0xff, 0x7f],
299
+ [0xff, 0xff, 0xff, 0x7f],
300
+ [0xff, 0xff, 0xff, 0xff],
301
+ [0x00, 0x00, 0x00, 0x80],
302
+ ]);
303
+ const bufferReader = new BufferReader(buffer);
304
+ values.forEach((value: number) => {
305
+ const expectedOffset = bufferReader.offset + 4;
306
+ const val = bufferReader.readInt32();
307
+ testValue(bufferReader, val, value, expectedOffset);
308
+ });
309
+ });
310
+
311
+ it('readUInt32', () => {
312
+ const maxUInt32 = Math.pow(2, 32) - 1;
313
+ const values = [0, 1, Math.pow(2, 16), maxUInt32];
314
+ const buffer = concatToBuffer([
315
+ [0, 0, 0, 0],
316
+ [1, 0, 0, 0],
317
+ [0, 0, 1, 0],
318
+ [0xff, 0xff, 0xff, 0xff],
319
+ ]);
320
+ const bufferReader = new BufferReader(buffer);
321
+ values.forEach((value: number) => {
322
+ const expectedOffset = bufferReader.offset + 4;
323
+ const val = bufferReader.readUInt32();
324
+ testValue(bufferReader, val, value, expectedOffset);
325
+ });
326
+ });
327
+
328
+ it('readUInt64', () => {
329
+ const values = [0, 1, Math.pow(2, 32), Number.MAX_SAFE_INTEGER /* 2^53 - 1 */];
330
+ const buffer = concatToBuffer([
331
+ [0, 0, 0, 0, 0, 0, 0, 0],
332
+ [1, 0, 0, 0, 0, 0, 0, 0],
333
+ [0, 0, 0, 0, 1, 0, 0, 0],
334
+ [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
335
+ ]);
336
+ const bufferReader = new BufferReader(buffer);
337
+ values.forEach((value: number) => {
338
+ const expectedOffset = bufferReader.offset + 8;
339
+ const val = bufferReader.readUInt64();
340
+ testValue(bufferReader, val, value, expectedOffset);
341
+ });
342
+ });
343
+
344
+ it('readVarInt', () => {
345
+ const values = [
346
+ 0,
347
+ 1,
348
+ 252,
349
+ 253,
350
+ 254,
351
+ 255,
352
+ 256,
353
+ Math.pow(2, 16) - 2,
354
+ Math.pow(2, 16) - 1,
355
+ Math.pow(2, 16),
356
+ Math.pow(2, 32) - 2,
357
+ Math.pow(2, 32) - 1,
358
+ Math.pow(2, 32),
359
+ Number.MAX_SAFE_INTEGER,
360
+ ];
361
+ const buffer = concatToBuffer([
362
+ [0x00],
363
+ [0x01],
364
+ [0xfc],
365
+ [0xfd, 0xfd, 0x00],
366
+ [0xfd, 0xfe, 0x00],
367
+ [0xfd, 0xff, 0x00],
368
+ [0xfd, 0x00, 0x01],
369
+ [0xfd, 0xfe, 0xff],
370
+ [0xfd, 0xff, 0xff],
371
+ [0xfe, 0x00, 0x00, 0x01, 0x00],
372
+ [0xfe, 0xfe, 0xff, 0xff, 0xff],
373
+ [0xfe, 0xff, 0xff, 0xff, 0xff],
374
+ [0xff, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00],
375
+ [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x00],
376
+ ]);
377
+ const bufferReader = new BufferReader(buffer);
378
+ values.forEach((value: number) => {
379
+ const expectedOffset = bufferReader.offset + varuint.encodingLength(value);
380
+ const val = bufferReader.readVarInt();
381
+ testValue(bufferReader, val, value, expectedOffset);
382
+ });
383
+ });
384
+
385
+ it('readSlice', () => {
386
+ const values = [[1], [1, 2, 3, 4], [254, 255]];
387
+ const buffer = concatToBuffer(values);
388
+ const bufferReader = new BufferReader(buffer);
389
+ values.forEach((v: number[]) => {
390
+ const expectedOffset = bufferReader.offset + v.length;
391
+ const val = bufferReader.readSlice(v.length);
392
+ testValue(bufferReader, val, Buffer.from(v), expectedOffset);
393
+ });
394
+ assert.throws(() => {
395
+ bufferReader.readSlice(2);
396
+ }, /^Error: Cannot read slice out of bounds$/);
397
+ });
398
+
399
+ it('readVarSlice', () => {
400
+ const values = [Buffer.alloc(1, 1), Buffer.alloc(252, 2), Buffer.alloc(253, 3)];
401
+ const buffer = Buffer.concat([
402
+ Buffer.from([0x01, 0x01]),
403
+ Buffer.from([0xfc]),
404
+ Buffer.alloc(252, 0x02),
405
+ Buffer.from([0xfd, 0xfd, 0x00]),
406
+ Buffer.alloc(253, 0x03),
407
+ ]);
408
+ const bufferReader = new BufferReader(buffer);
409
+ values.forEach((value: Buffer) => {
410
+ const expectedOffset =
411
+ bufferReader.offset + varuint.encodingLength(value.length) + value.length;
412
+ const val = bufferReader.readVarSlice();
413
+ testValue(bufferReader, val, value, expectedOffset);
414
+ });
415
+ });
416
+
417
+ it('readVector', () => {
418
+ const values = [
419
+ [Buffer.alloc(1, 4), Buffer.alloc(253, 5)],
420
+ Array(253).fill(Buffer.alloc(1, 6)),
421
+ ];
422
+ const buffer = Buffer.concat([
423
+ Buffer.from([0x02]),
424
+ Buffer.from([0x01, 0x04]),
425
+ Buffer.from([0xfd, 0xfd, 0x00]),
426
+ Buffer.alloc(253, 5),
427
+
428
+ Buffer.from([0xfd, 0xfd, 0x00]),
429
+ Buffer.concat(
430
+ Array(253)
431
+ .fill(0)
432
+ .map(() => Buffer.from([0x01, 0x06])),
433
+ ),
434
+ ]);
435
+
436
+ const bufferReader = new BufferReader(buffer);
437
+ values.forEach((value: Buffer[]) => {
438
+ const expectedOffset =
439
+ bufferReader.offset +
440
+ varuint.encodingLength(value.length) +
441
+ value.reduce(
442
+ (sum: number, v) => sum + varuint.encodingLength(v.length) + v.length,
443
+ 0,
444
+ );
445
+ const val = bufferReader.readVector();
446
+ testValue(bufferReader, Buffer.concat(val), Buffer.concat(value), expectedOffset);
447
+ });
448
+ });
449
+ });
450
+ });