@btc-vision/bitcoin 6.4.0 → 6.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/browser/address.d.ts +1 -0
  2. package/browser/index.js +1 -1
  3. package/browser/payments/index.d.ts +4 -0
  4. package/browser/payments/p2op.d.ts +2 -0
  5. package/browser/psbt/psbtutils.d.ts +1 -0
  6. package/build/address.d.ts +1 -0
  7. package/build/address.js +56 -8
  8. package/build/networks.js +6 -6
  9. package/build/payments/index.d.ts +4 -0
  10. package/build/payments/index.js +1 -0
  11. package/build/payments/p2op.d.ts +2 -0
  12. package/build/payments/p2op.js +108 -0
  13. package/build/psbt/psbtutils.d.ts +1 -0
  14. package/build/psbt/psbtutils.js +2 -0
  15. package/package.json +1 -1
  16. package/src/address.ts +68 -9
  17. package/src/block.ts +233 -233
  18. package/src/bufferutils.ts +188 -188
  19. package/src/networks.ts +6 -6
  20. package/src/payments/index.ts +68 -62
  21. package/src/payments/p2op.ts +136 -0
  22. package/src/psbt/psbtutils.ts +2 -0
  23. package/src/psbt.ts +2187 -2187
  24. package/test/address.spec.ts +155 -155
  25. package/test/bitcoin.core.spec.ts +212 -212
  26. package/test/block.spec.ts +171 -171
  27. package/test/bufferutils.spec.ts +450 -450
  28. package/test/crypto.spec.ts +49 -49
  29. package/test/integration/addresses.spec.ts +142 -142
  30. package/test/integration/bip32.spec.ts +130 -130
  31. package/test/integration/blocks.spec.ts +28 -28
  32. package/test/integration/cltv.spec.ts +241 -241
  33. package/test/integration/csv.spec.ts +452 -452
  34. package/test/integration/payments.spec.ts +110 -110
  35. package/test/integration/taproot.spec.ts +663 -663
  36. package/test/integration/transactions.spec.ts +668 -668
  37. package/test/payments.spec.ts +114 -114
  38. package/test/payments.utils.ts +165 -165
  39. package/test/psbt.spec.ts +1285 -1285
  40. package/test/script.spec.ts +186 -186
  41. package/test/script_number.spec.ts +26 -26
  42. package/test/script_signature.spec.ts +66 -66
  43. package/test/transaction.spec.ts +337 -337
  44. package/test/ts-node-register.js +7 -7
  45. package/test/types.spec.ts +53 -53
@@ -1,450 +1,450 @@
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
- });
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
+ });