lightning 5.16.0 → 5.16.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 5.16.0
+## 5.16.1
 
 - `signTransaction`: Add `root_hash` to support Taproot signatures with scripts
 

package/lnd_methods/address/create_chain_address.js

@@ -6,7 +6,11 @@ const {isLnd} = require('./../../lnd_requests');
 
 const connectFailMessage = '14 UNAVAILABLE: Connect Failed';
 const defaultAddressFormat = 'p2wpkh';
+const {isArray} = Array;
+const isNeedingDerivationsCheck = format => format === 'p2tr';
+const isTrSupported = n => !!n.find(n => n.address_type === 'TAPROOT_PUBKEY');
 const method = 'newAddress';
+const notSupported = /unknown.*walletrpc.WalletKit/;
 const type = 'default';
 
 /** Create a new receive address.
@@ -42,6 +46,38 @@ module.exports = (args, cbk) => {
         return cbk();
       },
 
+      // Get account derivations to confirm P2TR support
+      checkFormat: ['validate', ({}, cbk) => {
+        // Exit early when there is no need to check the derivations
+        if (!isNeedingDerivationsCheck(args.format)) {
+          return cbk();
+        }
+
+        return args.lnd.wallet.listAccounts({}, (err, res) => {
+          if (!!err && notSupported.test(err.details)) {
+            return cbk([501, 'CreationOfTaprootAddressesUnsupported']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorCheckingTaprootSupport', {err}]);
+          }
+
+          if (!res) {
+            return cbk([503, 'ExpectedResultForDerivationPathsRequest']);
+          }
+
+          if (!isArray(res.accounts)) {
+            return cbk([503, 'ExpectedAccountsInDerivationPathsResult']);
+          }
+
+          if (!isTrSupported(res.accounts)) {
+            return cbk([501, 'ExpectedTaprootSupportingLndToCreateAddress']);
+          }
+
+          return cbk();
+        });
+      }],
+
       // Type
       type: ['validate', ({}, cbk) => {
         const format = args.format || defaultAddressFormat;
@@ -54,7 +90,7 @@ module.exports = (args, cbk) => {
       }],
 
       // Get the address
-      createAddress: ['type', ({type}, cbk) => {
+      createAddress: ['checkFormat', 'type', ({type}, cbk) => {
         return args.lnd.default.newAddress({type}, (err, res) => {
           if (!!err && err.message === connectFailMessage) {
             return cbk([503, 'FailedToConnectToDaemonToCreateChainAddress']);

package/lnd_methods/macaroon/methods.json

@@ -34,6 +34,7 @@
     "type": "tower_client"
   },
   "createChainAddress": {
+    "depends_on": ["getMasterPublicKeys"],
     "method": "NewAddress",
     "type": "default"
   },

package/lnd_methods/signer/sign_transaction.d.ts

@@ -13,12 +13,14 @@ export type SignTransactionArgs = AuthenticatedLightningArgs<{
     output_script: string;
     /** Output Tokens */
     output_tokens: number;
+    /** Taproot Root Hash Hex String */
+    root_hash?: string;
     /** Sighash Type */
     sighash: number;
     /** Input Index To Sign */
     vin: number;
     /** Witness Script Hex String */
-    witness_script: string;
+    witness_script?: string;
   }[];
   spending?: {
     /** Non-Internal Spend Output Script Hex String */

package/lnd_methods/signer/sign_transaction.js

@@ -21,6 +21,7 @@ const unimplementedError = '12 UNIMPLEMENTED: unknown service signrpc.Signer';
 
   Requires `signer:generate` permission
 
+  `root_hash` is not supported in LND 0.14.3 and below
   `spending` is not supported in LND 0.14.3 and below
 
   {

package/package.json

@@ -10,13 +10,13 @@
     "@grpc/grpc-js": "1.6.7",
     "@grpc/proto-loader": "0.6.12",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.33",
+    "@types/node": "17.0.38",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.3",
     "asyncjs-util": "1.2.9",
     "bitcoinjs-lib": "6.0.1",
-    "bn.js": "5.2.0",
+    "bn.js": "5.2.1",
     "body-parser": "1.20.0",
     "bolt07": "1.8.1",
     "bolt09": "0.2.3",
@@ -24,17 +24,17 @@
     "ecpair": "2.0.1",
     "express": "4.18.1",
     "invoices": "2.0.6",
-    "psbt": "2.0.1",
+    "psbt": "2.3.0",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "2.12.2"
+    "type-fest": "2.13.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.11",
     "tsd": "0.20.0",
-    "typescript": "4.6.4",
-    "ws": "8.6.0"
+    "typescript": "4.7.2",
+    "ws": "8.7.0"
   },
   "engines": {
     "node": ">=12.20"
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.16.0"
+  "version": "5.16.1"
 }

package/test/lnd_methods/address/test_create_chain_address.js

@@ -66,6 +66,93 @@ const tests = [
     description: 'An address is required',
     expected: {address: 'addr'},
   },
+  {
+    args: {
+      lnd: {default: {newAddress: ({}, cbk) => cbk(null, {address: 'addr'})}},
+    },
+    description: 'The default address is p2wpkh',
+    expected: {address: 'addr'},
+  },
+  {
+    args: {
+      format: 'p2tr',
+      lnd: {
+        default: {
+          newAddress: ({}, cbk) => cbk(null, {address: 'addr'}),
+        },
+        wallet: {
+          listAccounts: ({}, cbk) => cbk({
+            details: 'unknown.service.walletrpc.WalletKit',
+          }),
+        },
+      },
+    },
+    description: 'Taproot requires TR account',
+    error: [501, 'CreationOfTaprootAddressesUnsupported'],
+  },
+  {
+    args: {
+      format: 'p2tr',
+      lnd: {
+        default: {newAddress: ({}, cbk) => cbk(null, {address: 'addr'})},
+        wallet: {listAccounts: ({}, cbk) => cbk('err')},
+      },
+    },
+    description: 'Taproot check errors are passed back',
+    error: [503, 'UnexpectedErrorCheckingTaprootSupport'],
+  },
+  {
+    args: {
+      format: 'p2tr',
+      lnd: {
+        default: {newAddress: ({}, cbk) => cbk(null, {address: 'addr'})},
+        wallet: {listAccounts: ({}, cbk) => cbk()},
+      },
+    },
+    description: 'Taproot requires account result',
+    error: [503, 'ExpectedResultForDerivationPathsRequest'],
+  },
+  {
+    args: {
+      format: 'p2tr',
+      lnd: {
+        default: {newAddress: ({}, cbk) => cbk(null, {address: 'addr'})},
+        wallet: {listAccounts: ({}, cbk) => cbk(null, {})},
+      },
+    },
+    description: 'Taproot accounts are expected',
+    error: [503, 'ExpectedAccountsInDerivationPathsResult'],
+  },
+  {
+    args: {
+      format: 'p2tr',
+      lnd: {
+        default: {newAddress: ({}, cbk) => cbk(null, {address: 'addr'})},
+        wallet: {listAccounts: ({}, cbk) => cbk(null, {accounts: []})},
+      },
+    },
+    description: 'Taproot supporting account is expected',
+    error: [501, 'ExpectedTaprootSupportingLndToCreateAddress'],
+  },
+  {
+    args: {
+      format: 'p2tr',
+      lnd: {
+        default: {
+          newAddress: ({}, cbk) => cbk(null, {
+            address: 'taproot_address',
+          }),
+        },
+        wallet: {
+          listAccounts: ({}, cbk) => cbk(null, {
+            accounts: [{address_type: 'TAPROOT_PUBKEY'}],
+          }),
+        },
+      },
+    },
+    description: 'Taproot supporting account',
+    expected: {address: 'taproot_address'},
+  },
   {
     args: {
       format: 'p2wpkh',

package/test/typescript/sign_transaction.test-d.ts

@@ -11,7 +11,6 @@ const inputs = [
     output_tokens: 1,
     sighash: 1,
     vin: 0,
-    witness_script: '00',
   },
 ];
 const spending = [