bolt07 1.8.2 → 1.8.4

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 1.8.2
+## 1.8.4
 
 - `decodeSocket`: Decode a connection socket from hex data
 - `encodeSocket`: Encode a connection socket to hex data

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Alex Bosworth
+Copyright (c) 2018-2023 Alex Bosworth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -10,9 +10,6 @@
     "bn.js": "5.2.1"
   },
   "description": "Utilities for working with bolt07 data formats",
-  "devDependencies": {
-    "@alexbosworth/tap": "15.0.11"
-  },
   "keywords": [
     "bolt",
     "channel-id",
@@ -29,7 +26,7 @@
     "url": "https://github.com/alexbosworth/bolt07.git"
   },
   "scripts": {
-    "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 test/addresses/*.js test/ids/*.js test/routing/*.js"
+    "test": "npx nyc@15.1 node --experimental-test-coverage --test"
   },
-  "version": "1.8.2"
+  "version": "1.8.4"
 }

package/routing/route_from_hops.js

@@ -58,15 +58,13 @@ const minFee = 0;
   }
 */
 module.exports = args => {
-  const {height, hops, mtokens} = args;
-
   const finalCltvDelta = args.cltv_delta || defaultCltvBuffer;
 
-  if (height === undefined) {
+  if (args.height === undefined) {
     throw new Error('ExpectedChainHeightForRoute');
   }
 
-  if (!isArray(hops) || !hops.length) {
+  if (!isArray(args.hops) || !args.hops.length) {
     throw new Error('ExpectedHopsToConstructRouteFrom');
   }
 
@@ -74,12 +72,12 @@ module.exports = args => {
     throw new Error('ExpectedInitialCltvDeltaToConstructRouteFromHops');
   }
 
-  if (!mtokens) {
+  if (!args.mtokens) {
     throw new Error('ExpectedMillitokensToSendAcrossHops');
   }
 
   // Check hops for validity
-  hops.forEach((hop, i) => {
+  args.hops.forEach((hop, i) => {
     if (hop.base_fee_mtokens === undefined) {
       throw new Error('ExpectedHopBaseFeeMillitokensForRouteConstruction');
     }
@@ -103,12 +101,12 @@ module.exports = args => {
     return;
   });
 
-  let forwardMtokens = BigInt(mtokens);
-  const [firstHop] = hops.slice();
-  let timeoutHeight = height + finalCltvDelta;
+  let forwardMtokens = BigInt(args.mtokens);
+  const [firstHop] = args.hops.slice();
+  let timeoutHeight = args.height + finalCltvDelta;
 
   // To construct the route, we need to go backwards from the end
-  const backwardsPath = hops.slice().reverse().map((hop, i, hops) => {
+  const backwardsPath = args.hops.slice().reverse().map((hop, i, hops) => {
     let feeMtokens = BigInt(minFee);
 
     if (!!i) {
@@ -138,9 +136,9 @@ module.exports = args => {
     .map(n => BigInt(n.fee_mtokens))
     .reduce((sum, n) => sum + n, BigInt(minFee));
 
-  const totalMtokens = totalFeeMtokens + BigInt(mtokens);
+  const totalMtokens = totalFeeMtokens + BigInt(args.mtokens);
 
-  if (hops.length === 1) {
+  if (args.hops.length === 1) {
     timeoutHeight -= args.initial_cltv;
   }
 

package/test/addresses/test_decode_socket.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {decodeSocket} = require('./../../');
 
@@ -53,7 +55,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => decodeSocket(args), new Error(error), 'Got expected error');
     } else {

package/test/addresses/test_encode_base32.js

@@ -0,0 +1,41 @@
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
+
+const encodeBase32 = require('./../../addresses/encode_base32');
+
+const tests = [
+  {
+    args: {data: ''},
+    description: 'Encode nil data as base32',
+    expected: {base32: ''},
+  },
+  {
+    args: {data: '73'},
+    description: 'Encode short data as base32',
+    expected: {base32: 'om'},
+  },
+  {
+    args: {
+      data: 'f2fc2319bd29457ccd01e8e194ee9bd7e97298b6610df4ab0f3d5baa0b2d7ccf69829edb74edef',
+    },
+    description: 'Encode long data as base32',
+    expected: {
+      base32: '6l6cggn5ffcxztib5dqzj3u327uxfgfwmeg7jkyphvn2ucznpthwtau63n2o33y',
+    },
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, (t, end) => {
+    if (!!error) {
+      throws(() => encodeBase32(args), new Error(error), 'Got expected error');
+    } else {
+      const res = encodeBase32(args);
+
+      strictSame(res, expected, 'Got expected result');
+    }
+
+    return end();
+  });
+});

package/test/addresses/test_encode_socket.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {encodeSocket} = require('./../../');
 
@@ -40,7 +42,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => encodeSocket(args), new Error(error), 'Got expected error');
     } else {

package/test/ids/test_chan_format.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {chanFormat} = require('./../../');
 
@@ -23,6 +25,11 @@ const tests = [
     description: 'Standard bitcoin channel',
     expected: {channel: '537136x2080x1'},
   },
+  {
+    args: {number: '17592186044416000010'},
+    description: 'SCID alias type id',
+    expected: {channel: '16000000x0x10'},
+  },
   {
     args: {},
     description: 'An id or number is required',
@@ -31,7 +38,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, equal, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => chanFormat(args), new Error(error), 'Got expected error');
 
@@ -40,7 +47,7 @@ tests.forEach(({args, description, error, expected}) => {
 
     const {channel} = chanFormat(args);
 
-    equal(channel, expected.channel, 'Channel formatted returned');
+    strictSame(channel, expected.channel, 'Channel formatted returned');
 
     return end();
   });

package/test/ids/test_chan_number.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {chanNumber} = require('./../../');
 
@@ -23,6 +25,11 @@ const tests = [
     description: 'Standard bitcoin channel',
     expected: {number: '590587277833404417'},
   },
+  {
+    args: {channel: '16000000x0x10'},
+    description: 'SCID alias channel id',
+    expected: {number: '17592186044416000010'},
+  },
   {
     args: {},
     description: 'Channel or id is required',
@@ -31,7 +38,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, equal, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => chanNumber(args), new Error(error), 'Got expected error');
 
@@ -40,7 +47,7 @@ tests.forEach(({args, description, error, expected}) => {
 
     const {number} = chanNumber(args);
 
-    equal(number, expected.number, 'Channel id number returned');
+    strictSame(number, expected.number, 'Channel id number returned');
 
     return end();
   });

package/test/ids/test_components_from_buffer.js

@@ -1,4 +1,5 @@
-const {test} = require('@alexbosworth/tap');
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const componentsFromBuffer = require('./../../ids/components_from_buffer');
 
@@ -16,7 +17,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, equal, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => componentsFromBuffer(args), new Error(error), 'Got error');
 

package/test/ids/test_decode_chan_id.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {decodeChanId} = require('./../../');
 
@@ -33,6 +35,11 @@ const tests = [
     description: 'Standard bitcoin channel id',
     expected: {block_height: 537136, block_index: 2080, output_index: 1},
   },
+  {
+    args: {number: '17592186044416000010'},
+    description: 'SCID alias channel id',
+    expected: {block_height: 16000000, block_index: 0, output_index: 10},
+  },
   {
     args: {},
     description: 'Id or channel or number is required',
@@ -46,7 +53,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({equal, end, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => decodeChanId(args), new Error(error), 'Got expected err');
 
@@ -55,9 +62,9 @@ tests.forEach(({args, description, error, expected}) => {
 
     const decoded = decodeChanId(args);
 
-    equal(decoded.block_height, expected.block_height, 'Block height derived');
-    equal(decoded.block_index, expected.block_index, 'Block index derived');
-    equal(decoded.output_index, expected.output_index, 'Output index derived');
+    strictSame(decoded.block_height, expected.block_height, 'Block height');
+    strictSame(decoded.block_index, expected.block_index, 'Block index');
+    strictSame(decoded.output_index, expected.output_index, 'Output index');
 
     return end();
   });

package/test/ids/test_encode_chan_id.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {encodeChanId} = require('./../../');
 
@@ -21,6 +23,15 @@ const tests = [
       number: '590587277833404417',
     },
   },
+  {
+    args: {block_height: 16000000, block_index: 0, output_index: 10},
+    description: 'SCID alias channel id',
+    expected: {
+      channel: '16000000x0x10',
+      id: 'f42400000000000a',
+      number: '17592186044416000010',
+    },
+  },
   {
     args: {},
     description: 'Expected block height',
@@ -39,7 +50,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({equal, end, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => encodeChanId(args), new Error(error), 'Got expected err');
 
@@ -48,9 +59,9 @@ tests.forEach(({args, description, error, expected}) => {
 
     const encoded = encodeChanId(args);
 
-    equal(encoded.channel, expected.channel, 'Channel components returned');
-    equal(encoded.id, expected.id, 'Channel id returned');
-    equal(encoded.number, expected.number, 'Channel number returned');
+    strictSame(encoded.channel, expected.channel, 'Channel components');
+    strictSame(encoded.id, expected.id, 'Channel id returned');
+    strictSame(encoded.number, expected.number, 'Channel number returned');
 
     return end();
   });

package/test/ids/test_raw_chan_id.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {rawChanId} = require('./../../');
 
@@ -23,6 +25,11 @@ const tests = [
     description: 'Standard bitcoin channel id',
     expected: {id: '0832300008200001'},
   },
+  {
+    args: {number: '17592186044416000010'},
+    description: 'SCID alias channel id',
+    expected: {id: 'f42400000000000a'},
+  },
   {
     args: {},
     description: 'Number is required',
@@ -31,7 +38,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, equal, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => rawChanId(args), new Error(error), 'Got expected error');
 
@@ -40,7 +47,7 @@ tests.forEach(({args, description, error, expected}) => {
 
     const {id} = rawChanId(args);
 
-    equal(id, expected.id, 'Raw channel id returned');
+    strictSame(id, expected.id, 'Raw channel id returned');
 
     return end();
   });

package/test/routing/test_hops_from_channels.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const betaChannels = require('./../fixtures/graph_beta').channels;
 const charlieChannels = require('./../fixtures/graph_charlie').channels;
@@ -274,7 +276,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => hopsFromChannels(args), new Error(error), 'Got error');
     } else {

package/test/routing/test_policy_fee.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const policyFee = require('./../../routing/policy_fee');
 
@@ -31,11 +33,11 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, equal, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => policyFee(args), new Error(error), 'Got expected error');
     } else {
-      equal(policyFee(args).fee_mtokens, expected.fee_mtokens, 'Got fee');
+      strictSame(policyFee(args).fee_mtokens, expected.fee_mtokens, 'Fee');
     }
 
     return end();

package/test/routing/test_route_from_channels.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {routeFromChannels} = require('./../../');
 
@@ -938,7 +940,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => routeFromChannels(args), new Error(error), 'Got error');
     } else {

package/test/routing/test_route_from_hops.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const strictSame = require('node:assert').strict.deepStrictEqual;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {routeFromHops} = require('./../../');
 
@@ -340,7 +342,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => routeFromHops(args), new Error(error), 'Got expected err');
     } else {