balanceofsatoshis 11.47.2 → 11.49.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 11.49.1
+
+- `telegram`: Add support for notifying of new opening channels
+
+## 11.48.1
+
+- `fund`: Support sending to P2TR addresses
+
 ## 11.47.2
 
 - `telegram`: Correct open and close channel messages not posting

package/CONTRIBUTING.md

@@ -17,6 +17,8 @@ If you want to help with style, here are some rough guidelines on style ideas:
 - Minimize function nesting, make new files if nesting is required
 - No extraneous whitespace
 - A single newline should appear at the end of a file
+- A single line should contain max 80 characters including the newline
+- If a top level scalar would go over 80 characters in a line, that's ok
 - Don't bother with () in functions when not needed: `const a = b => c`
 - If there are multiple things together, alphabetize them
 - Don't split up long strings over multiple lines
@@ -27,11 +29,14 @@ If you want to help with style, here are some rough guidelines on style ideas:
 - Use single '' quotes not double "" quotes, except when `` is required
 - If conditions should avoid spanning multiple lines
 - Avoid double specifying an attribute and value, `{type: type}` vs `{type}`
+- Always use {} with if, else, etc statements
+- Document the top of methods with what the arguments are and what is returned
 
 ### Control Flow
 
 - Async functions should support both cbk and Promise style
 - Use async.js methods for asynchronous control flow
+- Use async auto and returnResult for all non-event async functions
 - Try to exit early from functions when possible, and note this exit in comment
 - Prefer cbk over Promise style, aside from in tests or in Promise libs
 - Use `asyncAuto` for asynchronous control flow dependency management
@@ -49,6 +54,8 @@ If you want to help with style, here are some rough guidelines on style ideas:
 - Short properties always go first in objects: `{short, longer: type}`
 - If a statement relies on a statement above it, it should have a newline above
 - Avoid including scalar values such as strings or numbers in the code itself
+- Prefer hex serialization over base64 or Buffers in arguments or output
+- Avoid any function arguments that are multiple data types
 
 ### JS Features
 
@@ -60,6 +67,9 @@ If you want to help with style, here are some rough guidelines on style ideas:
 - Try to avoid passing objects in arguments as much as possible
 - Prefer using function iteration like map and forEach over for and while
 - Use arrow functions and not `function` functions whenever possible
+- Functions should only take and return a single object as argument, result
+- Use the || flags to select between truthy variable options
+- Use !! to explicitly coerce non Bool variables to Boolean
 
 ### Errors
 
@@ -70,3 +80,5 @@ If you want to help with style, here are some rough guidelines on style ideas:
 - Use HTTP status codes as a guideline: 4** is a local issue, 5** is remote
 - Return async errors as arrays: `[typeNumber, errorMsgString, extraDetails]`
 - Try to be very specific with error messages and try to not repeat one
+- Callbacks should always be called as (err, result)
+- Try and catch should not be used unless an error is expected

package/chain/fund_transaction.js

@@ -1,10 +1,15 @@
+const {address} = require('bitcoinjs-lib');
 const asyncAuto = require('async/auto');
 const asyncEach = require('async/each');
+const {createPsbt} = require('psbt');
 const {formatTokens} = require('ln-sync');
+const {fromBech32} = address;
 const {fundPsbt} = require('ln-service');
 const {getChainFeeRate} = require('ln-service');
 const {getMaxFundAmount} = require('ln-sync');
+const {getNetwork} = require('ln-sync');
 const {getUtxos} = require('ln-service');
+const {networks} = require('bitcoinjs-lib');
 const {returnResult} = require('asyncjs-util');
 const {signPsbt} = require('ln-service');
 const {Transaction} = require('bitcoinjs-lib');
@@ -16,6 +21,7 @@ const asBigUnit = n => (n / 1e8).toFixed(8);
 const asOutpoint = utxo => `${utxo.transaction_id}:${utxo.transaction_vout}`;
 const asInput = n => ({transaction_id: n.id, transaction_vout: n.vout});
 const asUtxo = n => ({id: n.slice(0, 64), vout: Number(n.slice(65))});
+const bufferAsHex = buffer => buffer.toString('hex');
 const dustValue = 293;
 const formattedFeeRate = n => n.toFixed(2);
 const {fromHex} = Transaction;
@@ -25,6 +31,8 @@ const isOutpoint = n => !!n && /^[0-9A-F]{64}:[0-9]{1,6}$/i.test(n);
 const isPublicKey = n => !!n && /^0[2-3][0-9A-F]{64}$/i.test(n);
 const minConfs = 1;
 const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
+const taprootAddressVersion = 1;
+const {toOutputScript} = address;
 const txHashAsTxId = hash => hash.reverse().toString('hex');
 
 /** Fund and sign a transaction
@@ -98,6 +106,9 @@ module.exports = (args, cbk) => {
       // Get the current fee rate
       getFee: ['validate', ({}, cbk) => getChainFeeRate({lnd: args.lnd}, cbk)],
 
+      // Get the network name
+      getNetwork: ['validate', ({}, cbk) => getNetwork({lnd: args.lnd}, cbk)],
+
       // Derive a list of outputs to guide input selection
       outputs: ['validate', ({}, cbk) => {
         // Exit early when the amount is open ended and thus depends on inputs
@@ -241,8 +252,9 @@ module.exports = (args, cbk) => {
       fund: [
         'finalOutputs',
         'getFee',
+        'getNetwork',
         'utxos',
-        ({finalOutputs, getFee, utxos}, cbk) =>
+        ({finalOutputs, getFee, getNetwork, utxos}, cbk) =>
       {
         const inputs = utxos.map(asUtxo).map(asInput);
         const feeRate = args.fee_tokens_per_vbyte || getFee.tokens_per_vbyte;
@@ -258,11 +270,50 @@ module.exports = (args, cbk) => {
           requested_fee_rate: feeRate,
         });
 
+        const hasTaprootOutput = !!finalOutputs.find(n => {
+          try {
+            return fromBech32(n.address).version === taprootAddressVersion;
+          } catch (err) {
+            return false;
+          }
+        });
+
+        // Exit early when there is no taproot output
+        if (!hasTaprootOutput) {
+          return fundPsbt({
+            fee_tokens_per_vbyte: feeRate,
+            inputs: !!inputs.length ? inputs : undefined,
+            lnd: args.lnd,
+            outputs: finalOutputs,
+          },
+          cbk);
+        }
+
+        const network = networks[getNetwork.bitcoinjs];
+
+        if (!network) {
+          return cbk([400, 'UnsupportedNetworkForFundingOutputs']);
+        }
+
+        const warn = console.warn;
+
+        console.warn = () => {};
+
+        const {psbt} = createPsbt({
+          outputs: finalOutputs.map(({address, tokens}) => ({
+            tokens,
+            script: bufferAsHex(toOutputScript(address, network)),
+          })),
+          utxos: inputs.map(input => ({
+            id: input.transaction_id,
+            vout: input.transaction_vout,
+          })),
+        });
+
         return fundPsbt({
+          psbt,
           fee_tokens_per_vbyte: feeRate,
-          inputs: !!inputs.length ? inputs : undefined,
           lnd: args.lnd,
-          outputs: finalOutputs,
         },
         cbk);
       }],

package/package.json

@@ -27,21 +27,21 @@
     "colorette": "2.0.16",
     "crypto-js": "4.1.1",
     "csv-parse": "5.0.4",
-    "goldengate": "11.0.0",
+    "goldengate": "11.0.1",
     "grammy": "1.7.0",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "2.0.0",
     "inquirer": "8.2.0",
-    "invoices": "2.0.3",
+    "invoices": "2.0.4",
     "ln-accounting": "5.0.5",
-    "ln-service": "53.7.1",
-    "ln-sync": "3.9.0",
-    "ln-telegram": "3.14.1",
+    "ln-service": "53.7.3",
+    "ln-sync": "3.10.0",
+    "ln-telegram": "3.15.1",
     "moment": "2.29.1",
     "paid-services": "3.11.0",
-    "probing": "2.0.2",
-    "psbt": "1.1.11",
+    "probing": "2.0.3",
+    "psbt": "2.0.0",
     "qrcode-terminal": "0.12.0",
     "sanitize-filename": "1.6.3",
     "socks-proxy-agent": "6.1.1",
@@ -52,9 +52,9 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
-    "ln-docker-daemons": "2.2.3",
+    "ln-docker-daemons": "2.2.4",
     "mock-lnd": "1.4.1",
-    "secp256k1": "4.0.3"
+    "tiny-secp256k1": "2.2.0"
   },
   "engines": {
     "node": ">=12.20"
@@ -81,5 +81,5 @@
     "postpublish": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t alexbosworth/balanceofsatoshis --push .",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 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/wallets/*.js"
   },
-  "version": "11.47.2"
+  "version": "11.49.1"
 }

package/peers/open_channels.js

@@ -11,7 +11,6 @@ const asyncMap = require('async/map');
 const asyncReflect = require('async/reflect');
 const asyncRetry = require('async/retry');
 const {cancelPendingChannel} = require('ln-service');
-const {decodePsbt} = require('psbt');
 const {fundPendingChannels} = require('ln-service');
 const {getFundedTransaction} = require('ln-sync');
 const {getNetwork} = require('ln-sync');
@@ -24,7 +23,6 @@ const {maintainUtxoLocks} = require('ln-sync');
 const moment = require('moment');
 const {returnResult} = require('asyncjs-util');
 const {Transaction} = require('bitcoinjs-lib');
-const {transactionAsPsbt} = require('psbt');
 const {unlockUtxo} = require('ln-service');
 
 const adjustFees = require('./../routing/adjust_fees');
@@ -657,19 +655,7 @@ module.exports = (args, cbk) => {
         'setFeeRates',
         ({getFunding, fundingPsbt}, cbk) =>
       {
-        try {
-          const tx = getFunding.value.transaction;
-
-          const decoded = decodePsbt({psbt: fundingPsbt.value.psbt});
-
-          const transaction = tx || decoded.unsigned_transaction;
-
-          return cbk(null, {
-            transaction_id: Transaction.fromHex(transaction).getId(),
-          });
-        } catch (err) {
-          return cbk([503, 'UnexpectedErrorGettingTransactionId', {err}]);
-        }
+        return cbk(null, {transaction_id: getFunding.value.id});
       }],
     },
     returnResult({reject, resolve, of: 'completed'}, cbk));

package/telegram/start_telegram_bot.js

@@ -36,6 +36,7 @@ const {postChainTransaction} = require('ln-telegram');
 const {postClosedMessage} = require('ln-telegram');
 const {postCreatedTrade} = require('ln-telegram');
 const {postOpenMessage} = require('ln-telegram');
+const {postOpeningMessage} = require('ln-telegram');
 const {postSettledInvoice} = require('ln-telegram');
 const {postSettledPayment} = require('ln-telegram');
 const {postSettledTrade} = require('ln-telegram');
@@ -49,6 +50,7 @@ const {subscribeToBlocks} = require('goldengate');
 const {subscribeToChannels} = require('ln-service');
 const {subscribeToInvoices} = require('ln-service');
 const {subscribeToPastPayments} = require('ln-service');
+const {subscribeToPendingChannels} = require('ln-sync');
 const {subscribeToTransactions} = require('ln-service');
 
 const interaction = require('./interaction');
@@ -299,7 +301,7 @@ module.exports = (args, cbk) => {
             key: apiKey.key,
             nodes: allNodes,
             reply: ctx.reply,
-            send: file => ctx.replyWithDocument(fileAsDoc(file)),
+            send: (file, opts) => ctx.replyWithDocument(fileAsDoc(file), opts),
           },
           err => !!err && !!err[0] >= 500 ? logger.error({err}) : null);
 
@@ -675,6 +677,36 @@ module.exports = (args, cbk) => {
         cbk);
       }],
 
+      // Pending channels changes
+      pending: ['apiKey', 'getNodes', 'userId', ({getNodes, userId}, cbk) => {
+        return asyncEach(getNodes, ({from, lnd}, cbk) => {
+          const sub = subscribeToPendingChannels({lnd});
+
+          subscriptions.push(sub);
+
+          sub.on('opening', update => {
+            return postOpeningMessage({
+              from,
+              lnd,
+              id: connectedId,
+              opening: update.channels,
+              send: (id, msg, opt) => bot.api.sendMessage(id, msg, opt),
+            },
+            err => !!err ? logger.error({node: from, pend_err: err}) : null);
+          });
+
+          sub.once('error', err => {
+            // Terminate subscription and restart after a delay
+            sub.removeAllListeners();
+
+            return cbk([503, 'UnexpectedErrorInPendingSubscription', {err}]);
+          });
+
+          return;
+        },
+        cbk);
+      }],
+
       // Send connected message
       connected: [
         'apiKey',
@@ -748,16 +780,14 @@ module.exports = (args, cbk) => {
 
       // Subscribe to invoices
       invoices: ['apiKey', 'getNodes', 'userId', ({apiKey, getNodes}, cbk) => {
-        return asyncEach(getNodes, ({from, lnd}, cbk) => {
-          const sub = subscribeToInvoices({lnd});
+        return asyncEach(getNodes, (node, cbk) => {
+          const sub = subscribeToInvoices({lnd: node.lnd});
 
           subscriptions.push(sub);
 
           sub.on('invoice_updated', invoice => {
             return postSettledInvoice({
-              from,
-              lnd,
-              request,
+              from: node.from,
               id: connectedId,
               invoice: {
                 description: invoice.description,
@@ -766,7 +796,9 @@ module.exports = (args, cbk) => {
                 payments: invoice.payments,
                 received: invoice.received,
               },
-              key: apiKey.key,
+              key: node.public_key,
+              lnd: node.lnd,
+              nodes: getNodes,
               quiz: ({answers, correct, question}) => {
                 return bot.api.sendQuiz(
                   connectedId,
@@ -775,6 +807,7 @@ module.exports = (args, cbk) => {
                   {correct_option_id: correct},
                 );
               },
+              send: (id, msg, opts) => bot.api.sendMessage(id, msg, opts),
             },
             err => !!err ? logger.error({settled_err: err}) : null);
           });

package/test/integration/test_fund_transaction.js

@@ -0,0 +1,61 @@
+const {address} = require('bitcoinjs-lib');
+const {crypto} = require('bitcoinjs-lib');
+const {networks} = require('bitcoinjs-lib');
+const {script} = require('bitcoinjs-lib');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+const tinysecp = require('tiny-secp256k1');
+
+const {fundTransaction} = require('./../../chain');
+
+const {compile} = script;
+const count = 100;
+const {fromOutputScript} = address;
+const makeTaprootKey = (k, h) => tinysecp.xOnlyPointAddTweak(k, h).xOnlyPubkey;
+const OP_1 = 81;
+const shortKey = keyPair =>  keyPair.publicKey.slice(1, 33);
+const tapHash = k => crypto.taggedHash('TapTweak', k.publicKey.slice(1, 33));
+const tokens = 1e6;
+
+// Funding a transaction should result in a funded tx
+test(`Fund transaction`, async ({end, equal, strictSame}) => {
+  const ecp = (await import('ecpair')).ECPairFactory(tinysecp);
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{generate, lnd}] = nodes;
+
+  await generate({count});
+
+  const keyPair = ecp.makeRandom({network: networks.regtest});
+
+  const outputKey = makeTaprootKey(shortKey(keyPair), tapHash(keyPair));
+  const tweakHash = tapHash(keyPair);
+
+  const outputScript = compile([OP_1, Buffer.from(outputKey)]);
+
+  // Suppress fromOutputScript warning on Taproot address
+  const warn = console.warn;
+  console.warn = () => {};
+
+  const address = fromOutputScript(outputScript, networks.regtest);
+
+  // Restore warnings
+  console.warn = warn;
+
+  try {
+    await fundTransaction({
+      lnd,
+      addresses: [address],
+      amounts: [tokens.toString()],
+      ask: () => {},
+      spend: [],
+      is_dry_run: false,
+      logger: {error: () => {}, info: () => {}},
+      utxos: [],
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  }
+
+  await kill({});
+});

package/test/services/test_get_balanced_opens.js

@@ -2,11 +2,13 @@ const EventEmitter = require('events');
 
 const {createSignedRequest} = require('invoices');
 const {createUnsignedRequest} = require('invoices');
-const sign = require('secp256k1').ecdsaSign;
+const secp256k1 = require('tiny-secp256k1');
 const {test} = require('@alexbosworth/tap');
 
 const getBalancedOpens = require('./../../services/get_balanced_opens');
 
+const sign = (h, k) => Buffer.from(secp256k1.sign(h, k));
+
 const createRequest = () => {
   const {hash, hrp, tags} = createUnsignedRequest({
     created_at: '2017-06-01T10:57:38.000Z',
@@ -32,7 +34,7 @@ const createRequest = () => {
   const bufFromHex = hex => Buffer.from(hex, 'hex');
   const privateKey = 'e126f68f7eafcc8b74f54d269fe206be715000f94dac067d1c04a8ca3b2db734';
 
-  const {signature} = sign(bufFromHex(hash), bufFromHex(privateKey));
+  const signature = sign(bufFromHex(hash), bufFromHex(privateKey));
 
   const {request} = createSignedRequest({
     hrp,