balanceofsatoshis 17.1.2 → 17.3.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 17.3.0
+
+- `open`: Add `commitment` flag to allow specifying a simplified_taproot type
+
+## 17.2.0
+
+- `telegram`: Add `--use-rounded-units` to format amounts as rounded amounts
+
 ## 17.1.2
 
 - `recover-p2pk`: Fix recovering funds not sent to index 0

package/bos

@@ -1241,9 +1241,11 @@ prog
   .help('Skip external option by specifying --internal-fund-at-fee-rate')
   .help('For trusted funding specify --type as private-trusted/public-trusted')
   .help('Trusted channel funding is not supported in LND 0.15.0 and below')
+  .help('Simplified Taproot channels are not supported in LND 0.17.0 & below')
   .argument('<peer_public_keys...>', 'With nodes with public keys')
   .option('--amount <channel_capacity>', 'Capacities to open', REPEATABLE)
   .option('--avoid-broadcast', 'Avoid broadcasting channel open transaction')
+  .option('--commitment <type>', 'default or simplified_taproot', REPEATABLE)
   .option('--coop-close-address <addr>', 'Coop-close address', REPEATABLE)
   .option('--external-funding', 'Use external funds for the channel open')
   .option('--give <give_amount>', 'Amount to gift to peer', REPEATABLE)
@@ -1260,6 +1262,7 @@ prog
           logger,
           ask: await commands.interrogate({}),
           capacities: collect(options.amount),
+          commitments: collect(options.commitment),
           cooperative_close_addresses: collect(options.coopCloseAddress),
           fs: {getFile: readFile},
           gives: collect(options.give),
@@ -1922,6 +1925,7 @@ prog
   .option('--node <node_name>', 'Node to connect to Telegram', REPEATABLE)
   .option('--reset-api-key', 'Reset the Telegram API key')
   .option('--use-proxy <path>', 'Proxy agent to connect to Telegram')
+  .option('--use-rounded-units', 'No leading zeros or fractions on amounts')
   .option('--use-small-units', 'Avoid showing leading zeros on amounts')
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
@@ -1937,6 +1941,7 @@ prog
             makeDirectory: mkdir,
           },
           id: options.connect,
+          is_rounded_units: options.useRoundedUnits || undefined,
           is_small_units: options.useSmallUnits || undefined,
           min_forward_tokens: options.ignoreForwardsBelow || undefined,
           min_rebalance_tokens: options.ignoreRebalancesBelow || undefined,

package/package.json

@@ -17,7 +17,7 @@
     "@alexbosworth/node-fetch": "2.6.2",
     "abort-controller": "3.0.0",
     "asciichart": "1.5.25",
-    "async": "3.2.4",
+    "async": "3.2.5",
     "asyncjs-util": "1.2.12",
     "bech32": "2.0.0",
     "bip66": "1.1.5",
@@ -37,9 +37,9 @@
     "ini": "4.1.1",
     "inquirer": "9.2.11",
     "ln-accounting": "7.0.2",
-    "ln-service": "57.0.1",
-    "ln-sync": "5.2.3",
-    "ln-telegram": "5.0.0",
+    "ln-service": "57.1.0",
+    "ln-sync": "6.0.0",
+    "ln-telegram": "6.0.0",
     "moment": "2.29.4",
     "paid-services": "5.0.5",
     "probing": "4.0.0",
@@ -54,7 +54,7 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "invoices": "3.0.0",
-    "ln-docker-daemons": "6.0.2",
+    "ln-docker-daemons": "6.0.3",
     "mock-lnd": "1.4.4"
   },
   "engines": {
@@ -82,5 +82,5 @@
     "postpublish": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t alexbosworth/balanceofsatoshis -t alexbosworth/balanceofsatoshis:$npm_package_version --push .",
     "test": "npx nyc@15.1.0 node --experimental-test-coverage --test test/arrays/*.js test/balances/*.js test/chain/*.js test/display/*.js test/encryption/*.js test/lnd/*.js test/network/*.js test/nodes/*.js test/peers/*.js test/responses/*.js test/routing/*.js test/services/*.js test/swaps/*.js test/tags/*.js test/telegram/*.js test/wallets/*.js"
   },
-  "version": "17.1.2"
+  "version": "17.3.0"
 }

package/peers/channels_from_arguments.js

@@ -1,5 +1,6 @@
 const defaultChannelCapacity = 5e6;
 const defaultChannelDescription = 'bos open';
+const isSimpleP2tr = (arr, i) => !!arr[i] && arr[i] === 'simplified_taproot';
 const isTrusted = type => ['private-trusted', 'public-trusted'].includes(type);
 const numericFeeRate = n => !!n && /^\d+$/.test(n) ? Number(n) : undefined;
 const privateTypes = ['private', 'private-trusted'];
@@ -11,6 +12,7 @@ const uniq = arr => Array.from(new Set(arr));
   {
     addresses: [<Address String>]
     capacities: [<Channel Capacity Tokens Number>]
+    commitments: [<Channel Commitment Types String>]
     gives: [<Give Tokens String>]
     nodes: [<Channel Partner Node Identity Public Key Hex String>]
     rates: [<Set Fee Rate String>]
@@ -27,6 +29,7 @@ const uniq = arr => Array.from(new Set(arr));
         description: <Channel Description String>
         [give_tokens]: <Give Tokens Number>
         is_private: <Channel Is Private Bool>
+        is_simplified_taproot: <Channel Is Taproot Bool>
         partner_public_key: <Channel Partner Identity Public Key Hex String>
         [rate]: <Set Fee Rate String>
       }]
@@ -43,6 +46,7 @@ module.exports = args => {
       fee_rate: numericFeeRate(args.rates[i]),
       give_tokens: !!args.gives[i] ? Number(args.gives[i]) : undefined,
       is_private: !!args.types[i] && privateTypes.includes(args.types[i]),
+      is_simplified_taproot: isSimpleP2tr(args.commitments, i),
       is_trusted_funding: !!args.types[i] && isTrusted(args.types[i]),
       node: args.saved[i] || undefined,
       partner_public_key: key,

package/peers/open_channels.js

@@ -48,6 +48,8 @@ const {fromHex} = Transaction;
 const interval = 1000;
 const {isArray} = Array;
 const isPublicKey = n => !!n && /^0[2-3][0-9A-F]{64}$/i.test(n);
+const isUnknown = (a1, a2) => a1.findIndex(n => !a2.includes(n)) !== -1;
+const knownCommits = ['default', 'simplified_taproot'];
 const knownTypes = ['private', 'private-trusted', 'public', 'public-trusted'];
 const lineBreak = '\n';
 const noInternalFundingVersions = ['0.11.0-beta', '0.11.1-beta'];
@@ -68,6 +70,7 @@ const utxoPollingTimes = 20;
   {
     ask: <Ask For Input Function>
     capacities: [<New Channel Capacity Tokens String>]
+    commitments: [<Channel Commitment Types String>]
     cooperative_close_addresses: [<Cooperative Close Address>]
     fs: {
       getFile: <Read File Contents Function> (path, cbk) => {}
@@ -103,6 +106,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedChannelCapacitiesToOpenChannels']);
         }
 
+        if (!isArray(args.commitments)) {
+          return cbk([400, 'ExpectedArrayOfChannelOutputTypesToOpenChannels']);
+        }
+
         if (!isArray(args.cooperative_close_addresses)) {
           return cbk([400, 'ExpectedCooperativeCloseAddressesArray']);
         }
@@ -133,6 +140,7 @@ module.exports = (args, cbk) => {
 
         const closeAddrCount = args.cooperative_close_addresses.length;
         const hasCapacities = !!args.capacities.length;
+        const hasCommitments = !!args.commitments.length;
         const hasGives = !!args.gives.length;
         const hasFeeRates = !!args.set_fee_rates.length;
         const hasNodes = !!args.opening_nodes.length;
@@ -142,6 +150,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'CapacitiesMustBeSpecifiedForEveryPublicKey']);
         }
 
+        if (!!hasCommitments && publicKeysLength !== args.commitments.length) {
+          return cbk([400, 'CommitmentTypesMustBeSpecifiedForEveryPublicKey']);
+        }
+
         if (!!closeAddrCount && publicKeysLength !== closeAddrCount) {
           return cbk([400, 'MustSetCoopClosingAddressForEveryPublicKey']);
         }
@@ -174,6 +186,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'UnknownChannelType', {channel_types: knownTypes}]);
         }
 
+        if (isUnknown(args.commitments, knownCommits)) {
+          return cbk([400, 'UnknownCommitment', {commitments: knownCommits}]);
+        }
+
         if (!!args.types.length && args.types.length !== publicKeysLength) {
           return cbk([400, 'ChannelTypesMustBeSpecifiedForEveryPublicKey']);
         }
@@ -263,6 +279,7 @@ module.exports = (args, cbk) => {
         const {opens} = channelsFromArguments({
           capacities,
           addresses: args.cooperative_close_addresses,
+          commitments: args.commitments,
           gives: args.gives,
           nodes: args.public_keys,
           rates: args.set_fee_rates,
@@ -445,6 +462,7 @@ module.exports = (args, cbk) => {
             cooperative_close_address: channel.cooperative_close_address,
             give_tokens: channel.give_tokens,
             is_private: channel.is_private,
+            is_simplified_taproot: channel.is_simplified_taproot,
             is_trusted_funding: channel.is_trusted_funding,
             lnd: getLnds.find(n => n.node === node).lnd,
             partner_public_key: channel.partner_public_key,
@@ -457,6 +475,7 @@ module.exports = (args, cbk) => {
             cooperative_close_address: test.cooperative_close_address,
             give_tokens: test.give_tokens,
             is_private: test.is_private,
+            is_simplified_taproot: test.is_simplified_taproot,
             is_trusted_funding: test.is_trusted_funding,
             lnd: test.lnd,
             partner_public_key: test.partner_public_key,

package/telegram/connect_to_telegram.js

@@ -12,6 +12,7 @@ const runTelegramBot = require('./run_telegram_bot');
 const defaultPaymentsBudget = 0;
 const isNumber = n => !isNaN(n);
 const restartDelayMs = 1000 * 60 * 3;
+const roundedUnitsType = 'rounded';
 const smallUnitsType = 'full';
 
 /** Connect nodes to Telegram
@@ -25,7 +26,8 @@ const smallUnitsType = 'full';
       writeFile: <Write File Function>
     }
     [id]: <Authorized User Id Number>
-    is_small_units: <Formatting Should Use Small Units Bool>
+    [is_rounded_units]: <Formatting Should Use Rounded Units Bool>
+    [is_small_units]: <Formatting Should Use Small Units Bool>
     logger: <Winston Logger Object>
     [min_forward_tokens]: <Minimum Forward Tokens Number>
     [min_rebalance_tokens]: <Minimum Rebalance Tokens Number>
@@ -103,12 +105,15 @@ module.exports = (args, cbk) => {
 
       // Set the units formatting
       setUnits: ['validate', ({}, cbk) => {
-        // Exit early when using default units formatting
-        if (!args.is_small_units) {
-          return cbk();
+        // Set rounded value formatting type
+        if (!!args.is_rounded_units) {
+          process.env.PREFERRED_TOKENS_TYPE = roundedUnitsType;
         }
 
-        process.env.PREFERRED_TOKENS_TYPE = smallUnitsType;
+        // Set small units value formatting type
+        if (!!args.is_small_units) {
+          process.env.PREFERRED_TOKENS_TYPE = smallUnitsType;
+        }
 
         return cbk();
       }],

package/test/integration/test_open_channels.js

@@ -79,6 +79,7 @@ test(`Open channels`, async () => {
               throw new Error('UnrecognizedParameter');
             },
             capacities: ['6*m'],
+            commitments: [],
             cooperative_close_addresses: [address],
             fs: {getFile: () => {}},
             gives: [1e5],

package/test/integration/test_taproot_channels.js

@@ -0,0 +1,132 @@
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const {addPeer} = require('ln-service');
+const asyncAuto = require('async/auto');
+const asyncEach = require('async/each');
+const asyncRetry = require('async/retry');
+const {createChainAddress} = require('ln-service');
+const {fundPsbt} = require('ln-service');
+const {getChannels} = require('ln-service');
+const {getPendingChannels} = require('ln-service');
+const {getWalletInfo} = require('ln-service');
+const {openChannel} = require('ln-service');
+const {signPsbt} = require('ln-service');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {Transaction} = require('bitcoinjs-lib');
+
+const {openChannels} = require('./../../peers');
+
+const count = 100;
+const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
+const interval = 200;
+const log = () => {};
+const size = 2;
+const times = 1000;
+
+// Opening taproot channels should open channels with specified nodes
+test(`Open taproot channels`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({
+    size,
+    lnd_configuration: [
+      '--maxpendingchannels=10',
+      '--protocol.option-scid-alias',
+      '--protocol.simple-taproot-chans',
+    ],
+  });
+
+  const [{generate, id, lnd}, target] = nodes;
+
+  try {
+    await generate({count});
+
+    await asyncRetry({interval, times}, async () => {
+      await addPeer({lnd, public_key: target.id, socket: target.socket});
+
+      await asyncEach(nodes, async ({lnd}) => {
+        const chain = await getWalletInfo({lnd});
+
+        if (!chain.is_synced_to_chain || !chain.is_synced_to_graph) {
+          throw new Error('WaitingForSync');
+        }
+      });
+    });
+
+    const {address} = await asyncRetry({interval, times}, async () => {
+      return await createChainAddress({lnd});
+    });
+
+    // Propose a taproot channel
+    await asyncAuto({
+      // Propose the taproot channel to target
+      propose: async () => {
+        return asyncRetry({interval, times}, async () => {
+          await addPeer({lnd, public_key: target.id, socket: target.socket});
+
+          await openChannels({
+            lnd,
+            ask: async (args, cbk) => {
+              if (args.name === 'internal') {
+                return cbk({internal: false});
+              }
+
+              if (args.name === 'fund') {
+                const address = args.message.split(' ')[9];
+                const amount = args.message.split(' ')[7];
+
+                // Provide funding
+                const {psbt} = await fundPsbt({
+                  lnd,
+                  outputs: [{address, tokens: amount * 1e8}],
+                });
+
+                const signed = await signPsbt({lnd, psbt});
+
+                return cbk({fund: signed.psbt});
+              }
+
+              throw new Error('UnrecognizedParameter');
+            },
+            capacities: [],
+            cooperative_close_addresses: [],
+            commitments: ['simplified_taproot'],
+            fs: {getFile: () => {}},
+            gives: [],
+            logger: {info: log, error: log},
+            opening_nodes: [],
+            public_keys: [target.id],
+            request: () => {},
+            set_fee_rates: [],
+            types: ['private'],
+          });
+        });
+      },
+
+      // Generate blocks until the channel confirms
+      generate: async () => {
+        return await asyncRetry({interval, times}, async () => {
+          await generate({});
+
+          const {channels} = await getChannels({lnd});
+
+          if (!channels.length) {
+            throw new Error('Expected Channels');
+          }
+
+          const [channel] = channels;
+
+          equal(channel.type, 'simplified_taproot', 'Taproot channel opened');
+        });
+      },
+
+      // Stop the target node
+      finish: ['generate', 'propose', async ({}) => {
+        await target.kill({});
+      }],
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  }
+
+  await kill({});
+});

package/test/integration/test_trusted_channels.js

@@ -106,6 +106,7 @@ test(`Open channels`, async () => {
             },
             capacities: [],
             cooperative_close_addresses: [],
+            commitments: [],
             fs: {getFile: () => {}},
             gives: [],
             logger: {info: log, error: log},

package/test/peers/test_channels_from_arguments.js

@@ -8,6 +8,7 @@ const makeArgs = overrides => {
   const args = {
     addresses: ['address'],
     capacities: [2],
+    commitments: [],
     gives: ['1'],
     nodes: [Buffer.alloc(33, 3).toString('hex')],
     rates: [],
@@ -33,6 +34,7 @@ const tests = [
           fee_rate: undefined,
           give_tokens: 1,
           is_private: true,
+          is_simplified_taproot: false,
           is_trusted_funding: false,
           node: undefined,
           partner_public_key: Buffer.alloc(33, 3).toString('hex'),
@@ -58,6 +60,7 @@ const tests = [
           fee_rate: undefined,
           give_tokens: undefined,
           is_private: false,
+          is_simplified_taproot: false,
           is_trusted_funding: false,
           node: undefined,
           partner_public_key: Buffer.alloc(33, 3).toString('hex'),
@@ -87,6 +90,7 @@ const tests = [
             fee_rate: 1,
             give_tokens: 3,
             is_private: true,
+            is_simplified_taproot: false,
             is_trusted_funding: false,
             node: 'savedA',
             partner_public_key: 'remoteNodeA',
@@ -102,6 +106,7 @@ const tests = [
             fee_rate: 2,
             give_tokens: 4,
             is_private: false,
+            is_simplified_taproot: false,
             is_trusted_funding: false,
             node: 'savedB',
             partner_public_key: 'remoteNodeB',