lightning 5.8.6 → 5.10.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 5.10.0
+
+- `signTransaction`: Add `spending` attribute for specifying external inputs
+
+## 5.9.1
+
+- `createChainAddress`: Add support for creating P2TR addresses
+- `getUtxos`: Add support for showing P2TR address types
+
 ## 5.8.6
 
 - `getWalletInfo`, `payViaPaymentDetails`: Correct typescript fields

package/grpc/protos/chainnotifier.proto

@@ -119,7 +119,11 @@ message SpendRequest {
     /*
     The outpoint for which we should request a spend notification for. If set to
     a zero outpoint, then the spend notification will be requested for the
-    script instead.
+    script instead. A zero or nil outpoint is not supported for Taproot spends
+    because the output script cannot reliably be computed from the witness alone
+    and the spent output script is not always available in the rescan context.
+    So an outpoint must _always_ be specified when registering a spend
+    notification for a Taproot output.
     */
     Outpoint outpoint = 1;
 

package/grpc/protos/lightning.proto

@@ -1138,12 +1138,15 @@ message ListUnspentResponse {
 
 - `p2wkh`: Pay to witness key hash (`WITNESS_PUBKEY_HASH` = 0)
 - `np2wkh`: Pay to nested witness key hash (`NESTED_PUBKEY_HASH` = 1)
+- `p2tr`: Pay to taproot pubkey (`TAPROOT_PUBKEY` = 4)
 */
 enum AddressType {
     WITNESS_PUBKEY_HASH = 0;
     NESTED_PUBKEY_HASH = 1;
     UNUSED_WITNESS_PUBKEY_HASH = 2;
     UNUSED_NESTED_PUBKEY_HASH = 3;
+    TAPROOT_PUBKEY = 4;
+    UNUSED_TAPROOT_PUBKEY = 5;
 }
 
 message NewAddressRequest {

package/grpc/protos/signer.proto

@@ -129,8 +129,11 @@ message SignDescriptor {
     bytes double_tweak = 3;
 
     /*
-    The full script required to properly redeem the output.  This field will
-    only be populated if a p2wsh or a p2sh output is being signed.
+    The full script required to properly redeem the output. This field will
+    only be populated if a p2tr, p2wsh or a p2sh output is being signed. In case
+    taproot_key_spend is set to true then this value must correspond to the
+    taproot root hash (in case of a tapscript output) or the tap hashed internal
+    public key (in case of a BIP-0086 output).
     */
     bytes witness_script = 4;
 
@@ -150,6 +153,14 @@ message SignDescriptor {
     The target input within the transaction that should be signed.
     */
     int32 input_index = 8;
+
+    /*
+    Indicates that this should produce a signature that can be used for the key
+    spend path of a taproot input. This requires the witness_script field to be
+    set to the taproot root hash (in case of a tapscript output) or the tap
+    hashed internal public key (in case of a BIP-0086 output).
+    */
+    bool taproot_key_spend = 9;
 }
 
 message SignReq {
@@ -158,6 +169,12 @@ message SignReq {
 
     // A set of sign descriptors, for each input to be signed.
     repeated SignDescriptor sign_descs = 2;
+
+    /*
+    The full list of UTXO information for each of the inputs being spent. This
+    is required when spending one or more taproot (SegWit v1) outputs.
+    */
+    repeated TxOut prev_outputs = 3;
 }
 
 message SignResp {

package/grpc/protos/walletkit.proto

@@ -334,6 +334,7 @@ enum AddressType {
     WITNESS_PUBKEY_HASH = 1;
     NESTED_WITNESS_PUBKEY_HASH = 2;
     HYBRID_NESTED_WITNESS_PUBKEY_HASH = 3;
+    TAPROOT_PUBKEY = 4;
 }
 message Account {
     // The name used to identify the account.

package/lnd_methods/address/address_formats.json

@@ -1,6 +1,8 @@
 {
   "np2wpkh": 1,
+  "p2tr": 4,
   "p2wpkh": 0,
-  "unused_p2wpkh": 2,
-  "unused_np2wpkh": 3
+  "unused_np2wpkh": 3,
+  "unused_p2tr": 5,
+  "unused_p2wpkh": 2
 }

package/lnd_methods/address/create_chain_address.d.ts

@@ -5,7 +5,7 @@ import {
 
 export type CreateChainAddressArgs = AuthenticatedLightningArgs<{
   /** Receive Address Type */
-  format?: 'np2wpkh' | 'p2wpkh';
+  format?: 'np2wpkh' | 'p2tr' | 'p2wpkh';
   /** Get As-Yet Unused Address */
   is_unused?: boolean;
 }>;

package/lnd_methods/address/create_chain_address.js

@@ -13,8 +13,10 @@ const type = 'default';
 
   Requires `address:write` permission
 
+  LND 0.14.3 and below do not support p2tr addresses
+
   {
-    [format]: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
+    [format]: <Receive Address Type String> // "np2wpkh" || "p2tr" || "p2wpkh"
     [is_unused]: <Get As-Yet Unused Address Bool>
     lnd: <Authenticated LND API Object>
   }

package/lnd_methods/onchain/partially_sign_psbt.d.ts

@@ -20,7 +20,7 @@ export type PartiallySignPsbtResult = {
  *
  * Requires LND built with `walletrpc` tag
  *
- * This method is not supported in LND 0.14.2 and below
+ * This method is not supported in LND 0.14.3 and below
  */
 export const partiallySignPsbt: AuthenticatedLightningMethod<
   PartiallySignPsbtArgs,

package/lnd_methods/onchain/partially_sign_psbt.js

@@ -16,7 +16,7 @@ const type = 'wallet';
 
   Requires LND built with `walletrpc` tag
 
-  This method is not supported in LND 0.14.2 and below
+  This method is not supported in LND 0.14.3 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/onchain/subscribe_to_chain_address.js

@@ -25,7 +25,7 @@ const type = 'chain';
 
   {
     [bech32_address]: <Address String>
-    lnd: <Chain RPC LND API Object>
+    lnd: <Authenticated LND API Object>
     [min_confirmations]: <Minimum Confirmations Number>
     min_height: <Minimum Transaction Inclusion Blockchain Height Number>
     [output_script]: <Output Script Hex String>

package/lnd_methods/onchain/subscribe_to_chain_spend.js

@@ -5,19 +5,27 @@ const scriptFromChainAddress = require('./script_from_chain_address');
 
 const bufferAsHex = buffer => buffer.toString('hex');
 const dummyTxId = Buffer.alloc(32).toString('hex');
+const events = ['confirmation', 'reorg'];
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const {isBuffer} = Buffer;
 const method = 'registerSpendNtfn';
+const shutDownMessage = 'chain notifier shutting down';
+const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
 const type = 'chain';
 
 /** Subscribe to confirmations of a spend
 
   A chain address or raw output script is required
 
+  When specifying a P2TR output script, `transaction_id` and `transaction_vout`
+  are required.
+
   Requires LND built with `chainrpc` build tag
 
   Requires `onchain:read` permission
 
+  Subscribing to P2TR outputs is not supported in LND 0.14.3 and below
+
   {
     [bech32_address]: <Bech32 P2WPKH or P2WSH Address String>
     lnd: <Authenticated LND API Object>
@@ -74,11 +82,33 @@ module.exports = args => {
     script: hexAsBuffer(script || args.output_script),
   });
 
+  // Cancel the subscription when all listeners are removed
+  eventEmitter.on('removeListener', () => {
+    const listenerCounts = events.map(n => eventEmitter.listenerCount(n));
+
+    // Exit early when there are still listeners
+    if (!!sumOf(listenerCounts)) {
+      return;
+    }
+
+    subscription.cancel();
+
+    return;
+  });
+
   subscription.on('end', () => eventEmitter.emit('end'));
   subscription.on('status', n => eventEmitter.emit('status', n));
 
   subscription.on('error', err => {
-    eventEmitter.emit('error', new Error('UnexpectedErrInSpendSubscription'));
+    if (err.details === shutDownMessage) {
+      subscription.removeAllListeners();
+    }
+
+    if (!eventEmitter.listenerCount('error')) {
+      return;
+    }
+
+    eventEmitter.emit('error', err);
 
     return;
   });

package/lnd_methods/signer/sign_transaction.js

@@ -3,16 +3,24 @@ const {returnResult} = require('asyncjs-util');
 
 const {isLnd} = require('./../../lnd_requests');
 
+const bufferAsHex = buffer => buffer.toString('hex');
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const {isArray} = Array;
+const method = 'signOutputRaw';
 const notFound = -1;
+const type = 'signer';
 const unimplementedError = '12 UNIMPLEMENTED: unknown service signrpc.Signer';
 
 /** Sign transaction
 
+  `spending` is required for non-internal inputs for a Taproot signature
+
   Requires LND built with `signrpc` build tag
 
   Requires `signer:generate` permission
 
+  `spending` is not supported in LND 0.14.3 and below
+
   {
     inputs: [{
       key_family: <Key Family Number>
@@ -24,6 +32,10 @@ const unimplementedError = '12 UNIMPLEMENTED: unknown service signrpc.Signer';
       witness_script: <Witness Script Hex String>
     }]
     lnd: <Authenticated LND API Object>
+    [spending]: [{
+      output_script: <Non-Internal Spend Output Script Hex String>
+      output_tokens: <Non-Internal Spend Output Tokens Number>
+    }]
     transaction: <Unsigned Transaction Hex String>
   }
 
@@ -32,7 +44,7 @@ const unimplementedError = '12 UNIMPLEMENTED: unknown service signrpc.Signer';
     signatures: [<Signature Hex String>]
   }
 */
-module.exports = ({inputs, lnd, transaction}, cbk) => {
+module.exports = ({inputs, lnd, spending, transaction}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -41,7 +53,7 @@ module.exports = ({inputs, lnd, transaction}, cbk) => {
           return cbk([400, 'ExpectedInputsToSignTransaction']);
         }
 
-        if (!isLnd({lnd, method: 'signOutputRaw', type: 'signer'})) {
+        if (!isLnd({lnd, method, type})) {
           return cbk([400, 'ExpectedAuthenticatedLndToSignTransaction']);
         }
 
@@ -54,8 +66,12 @@ module.exports = ({inputs, lnd, transaction}, cbk) => {
 
       // Get signatures
       signTransaction: ['validate', ({}, cbk) => {
-        return lnd.signer.signOutputRaw({
-          raw_tx_bytes: Buffer.from(transaction, 'hex'),
+        return lnd[type][method]({
+          prev_outputs: [].concat(inputs).concat(spending || []).map(utxo => ({
+            pk_script: hexAsBuffer(utxo.output_script),
+            value: utxo.output_tokens,
+          })),
+          raw_tx_bytes: hexAsBuffer(transaction),
           sign_descs: inputs.map(input => ({
             input_index: input.vin,
             key_desc: {
@@ -65,11 +81,11 @@ module.exports = ({inputs, lnd, transaction}, cbk) => {
               },
             },
             output: {
-              pk_script: Buffer.from(input.output_script, 'hex'),
+              pk_script: hexAsBuffer(input.output_script),
               value: input.output_tokens,
             },
             sighash: input.sighash,
-            witness_script: Buffer.from(input.witness_script, 'hex'),
+            witness_script: hexAsBuffer(input.witness_script),
           })),
         },
         (err, res) => {
@@ -93,9 +109,7 @@ module.exports = ({inputs, lnd, transaction}, cbk) => {
             return cbk([503, 'ExpectedSignatureBuffersInSignResponse']);
           }
 
-          return cbk(null, {
-            signatures: res.raw_sigs.map(n => n.toString('hex'))
-          });
+          return cbk(null, {signatures: res.raw_sigs.map(bufferAsHex)});
         });
       }],
     },

package/lnd_responses/constants.json

@@ -1,4 +1,9 @@
 {
+  "addressFormats": {
+    "np2wpkh": "NESTED_PUBKEY_HASH",
+    "p2tr": "TAPROOT_PUBKEY",
+    "p2wpkh": "WITNESS_PUBKEY_HASH"
+  },
   "adjustedChannelTypes": {
     "LEGACY": "STATIC_REMOTE_KEY",
     "STATIC_REMOTE_KEY": "ANCHORS",

package/lnd_responses/rpc_utxo_as_utxo.js

@@ -1,4 +1,6 @@
-const formats = {np2wpkh: 'NESTED_PUBKEY_HASH', p2wpkh: 'WITNESS_PUBKEY_HASH'};
+const constants = require('./constants');
+
+const formats = constants.addressFormats;
 const {keys} = Object;
 
 /** Derive UTXO details from RPC UTXO details

package/package.json

@@ -7,24 +7,24 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.6.1",
+    "@grpc/grpc-js": "1.6.2",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
     "@types/node": "17.0.23",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.3",
-    "asyncjs-util": "1.2.8",
+    "asyncjs-util": "1.2.9",
     "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
-    "body-parser": "1.19.2",
-    "bolt07": "1.8.0",
-    "bolt09": "0.2.2",
+    "body-parser": "1.20.0",
+    "bolt07": "1.8.1",
+    "bolt09": "0.2.3",
     "cbor": "8.1.0",
     "ecpair": "2.0.1",
     "express": "4.17.3",
-    "invoices": "2.0.4",
-    "psbt": "2.0.0",
+    "invoices": "2.0.5",
+    "psbt": "2.0.1",
     "tiny-secp256k1": "2.2.1",
     "type-fest": "2.12.2"
   },
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.8.6"
+  "version": "5.10.0"
 }

package/test/lnd_methods/invoices/test_subscribe_to_invoices.js

@@ -82,6 +82,8 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
+  args.restart_delay_ms = 1;
+
   return test(description, async ({end, equal, match, strictSame, throws}) => {
     if (!!error) {
       throws(() => subscribeToInvoices(args), new Error(error), 'Got error');