lightning 5.8.3 → 5.8.6

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 5.8.6
+
+- `getWalletInfo`, `payViaPaymentDetails`: Correct typescript fields
+
 ## 5.8.3
 
 - `getInvoice`: Add typescript timeout field on individual payment HTLCs

package/grpc/protos/lightning.proto

@@ -620,6 +620,38 @@ message Utxo {
     int64 confirmations = 6;
 }
 
+enum OutputScriptType {
+    SCRIPT_TYPE_PUBKEY_HASH = 0;
+    SCRIPT_TYPE_SCRIPT_HASH = 1;
+    SCRIPT_TYPE_WITNESS_V0_PUBKEY_HASH = 2;
+    SCRIPT_TYPE_WITNESS_V0_SCRIPT_HASH = 3;
+    SCRIPT_TYPE_PUBKEY = 4;
+    SCRIPT_TYPE_MULTISIG = 5;
+    SCRIPT_TYPE_NULLDATA = 6;
+    SCRIPT_TYPE_NON_STANDARD = 7;
+    SCRIPT_TYPE_WITNESS_UNKNOWN = 8;
+}
+
+message OutputDetail {
+    // The type of the output
+    OutputScriptType output_type = 1;
+
+    // The address
+    string address = 2;
+
+    // The pkscript in hex
+    string pk_script = 3;
+
+    // The output index used in the raw transaction
+    int64 output_index = 4;
+
+    // The value of the output coin in satoshis
+    int64 amount = 5;
+
+    // Denotes if the output is controlled by the internal wallet
+    bool is_our_address = 6;
+}
+
 message Transaction {
     // The transaction hash
     string tx_hash = 1;
@@ -642,8 +674,12 @@ message Transaction {
     // Fees paid for this transaction
     int64 total_fees = 7;
 
-    // Addresses that received funds for this transaction
-    repeated string dest_addresses = 8;
+    // Addresses that received funds for this transaction. Deprecated as it is
+    // now incorporated in the output_details field.
+    repeated string dest_addresses = 8 [deprecated = true];
+
+    // Outputs that received funds for this transaction
+    repeated OutputDetail output_details = 11;
 
     // The raw transaction hex.
     string raw_tx_hex = 9;
@@ -2502,6 +2538,10 @@ message WalletBalanceResponse {
     // The unconfirmed balance of a wallet(with 0 confirmations)
     int64 unconfirmed_balance = 3;
 
+    // The total amount of wallet UTXOs held in outputs that are locked for
+    // other usage.
+    int64 locked_balance = 5;
+
     // A mapping of each wallet account's name to its balance.
     map<string, WalletAccountBalance> account_balance = 4;
 }

package/grpc/protos/walletkit.proto

@@ -12,7 +12,9 @@ option go_package = "github.com/lightningnetwork/lnd/lnrpc/walletrpc";
 service WalletKit {
     /*
     ListUnspent returns a list of all utxos spendable by the wallet with a
-    number of confirmations between the specified minimum and maximum.
+    number of confirmations between the specified minimum and maximum. By
+    default, all utxos are listed. To list only the unconfirmed utxos, set
+    the unconfirmed_only to true.
     */
     rpc ListUnspent (ListUnspentRequest) returns (ListUnspentResponse);
 
@@ -240,6 +242,14 @@ message ListUnspentRequest {
 
     // An optional filter to only include outputs belonging to an account.
     string account = 3;
+
+    /*
+    When min_confs and max_confs are zero, setting false implicitly
+    overrides max_confs to be MaxInt32, otherwise max_confs remains
+    zero. An error is returned if the value is true and both min_confs
+    and max_confs are non-zero. (default: false)
+    */
+    bool unconfirmed_only = 4;
 }
 
 message ListUnspentResponse {

package/lnd_methods/info/get_wallet_info.d.ts

@@ -34,6 +34,8 @@ export type GetWalletInfoResult = {
   pending_channels_count: number;
   /** Public Key */
   public_key: string;
+  /** Version String */
+  version: string;
 };
 
 /**

package/lnd_methods/offchain/pay_via_payment_details.d.ts

@@ -42,7 +42,7 @@ export type PayViaPaymentDetailsArgs = AuthenticatedLightningArgs<{
   pathfinding_timeout?: number;
   /** Payment Identifier Hex String */
   payment?: string;
-  routes: {
+  routes?: {
     /** Base Routing Fee In Millitokens */
     base_fee_mtokens?: string;
     /** Standard Format Channel Id */

package/lnd_methods/offchain/pay_via_payment_details.js

@@ -42,7 +42,7 @@ const type = 'router';
     [outgoing_channels]: [<Pay Out of Outgoing Channel Ids String>]
     [pathfinding_timeout]: <Time to Spend Finding a Route Milliseconds Number>
     [payment]: <Payment Identifier Hex String>
-    routes: [[{
+    [routes]: [[{
       [base_fee_mtokens]: <Base Routing Fee In Millitokens String>
       [channel]: <Standard Format Channel Id String>
       [cltv_delta]: <CLTV Blocks Delta Number>

package/lnd_methods/onchain/subscribe_to_chain_address.js

@@ -113,7 +113,7 @@ module.exports = args => {
       return;
     }
 
-    eventEmitter.emit('error', new Error('UnexpectedErrInTxSubscription'));
+    eventEmitter.emit('error', err);
 
     return;
   });

package/package.json

@@ -7,12 +7,12 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.7",
+    "@grpc/grpc-js": "1.6.1",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.21",
+    "@types/node": "17.0.23",
     "@types/request": "2.48.8",
-    "@types/ws": "8.5.2",
+    "@types/ws": "8.5.3",
     "async": "3.2.3",
     "asyncjs-util": "1.2.8",
     "bitcoinjs-lib": "6.0.1",
@@ -26,14 +26,14 @@
     "invoices": "2.0.4",
     "psbt": "2.0.0",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "2.12.0"
+    "type-fest": "2.12.2"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
-    "@alexbosworth/tap": "15.0.10",
-    "tsd": "0.19.1",
-    "typescript": "4.6.2",
+    "@alexbosworth/tap": "15.0.11",
+    "tsd": "0.20.0",
+    "typescript": "4.6.3",
     "ws": "8.5.0"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.8.3"
+  "version": "5.8.6"
 }

package/test/lnd_methods/onchain/test_fund_pending_channels.js

@@ -3,6 +3,7 @@ const {test} = require('@alexbosworth/tap');
 const {fundPendingChannels} = require('./../../../lnd_methods');
 
 const id = Buffer.alloc(32).toString('hex');
+const id2 = Buffer.alloc(32, 1).toString('hex');
 
 const makeLnd = ({finalizeErr, verifyErr}) => {
   return {
@@ -75,6 +76,35 @@ const tests = [
     args: makeArgs({}),
     description: 'Channel funding is executed',
   },
+  {
+    args: makeArgs({
+      channels: [id, id2],
+      lnd: {
+        default: {
+          fundingStateStep: (args, cbk) => {
+            const finalize = args.psbt_finalize;
+
+            if (!finalize) {
+              return cbk();
+            }
+
+            const pendingId = finalize.pending_chan_id.toString('hex');
+
+            if (pendingId === id && finalize.no_publish !== true) {
+              return cbk('ExpectedFirstChannelIsNoPublish');
+            }
+
+            if (pendingId === id2 && finalize.no_publish !== false) {
+              return cbk('ExpectedLastChannelIsNotNoPublish');
+            }
+
+            return cbk();
+          },
+        },
+      },
+    }),
+    description: 'Channel funding across multiple channels is executed',
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

package/test/lnd_methods/onchain/test_open_channels.js

@@ -5,6 +5,8 @@ const {test} = require('@alexbosworth/tap');
 const {openChannels} = require('./../../../lnd_methods');
 
 const emitter = new EventEmitter();
+const nodeKey1 = Buffer.alloc(33).toString('hex');
+const nodeKey2 = Buffer.alloc(33, 2).toString('hex');
 
 const makeChannels = ({}) => {
   return [{
@@ -128,6 +130,57 @@ const tests = [
     description: 'Channels are pending',
     expected: {pending: {address: 'funding_address', tokens: 1}},
   },
+  {
+    args: {
+      channels: [
+        {capacity: 1, partner_public_key: nodeKey1},
+        {capacity: 2, partner_public_key: nodeKey2},
+      ],
+      lnd: {
+        default: {
+          fundingStateStep: ({}, cbk) => cbk(),
+          openChannel: args => {
+            const eventEmitter = new EventEmitter();
+
+            const key = args.node_pubkey.toString('hex');
+
+            if (key === nodeKey1 && !args.funding_shim.psbt_shim.no_publish) {
+              throw new Error('ExpectedFirstKeyIsNoPublish');
+            }
+
+            if (key === nodeKey2 && !!args.funding_shim.psbt_shim.no_publish) {
+              throw new Error('TheSecondChannelShouldPublish');
+            }
+
+            process.nextTick(() => {
+              eventEmitter.emit('data', {});
+
+              eventEmitter.emit('data', {
+                psbt_fund: {
+                  funding_address: 'funding_address',
+                  funding_amount: '1',
+                },
+                update: 'psbt_fund',
+              });
+
+              // Emit twice to make sure that cbk isn't called twice
+              eventEmitter.emit('data', {
+                psbt_fund: {
+                  funding_address: 'funding_address',
+                  funding_amount: '1',
+                },
+                update: 'psbt_fund',
+              });
+            });
+
+            return eventEmitter;
+          },
+        },
+      },
+    },
+    description: 'Multiple channels are pending',
+    expected: {pending: {address: 'funding_address', tokens: 1}},
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

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

@@ -44,7 +44,6 @@ expectError(payViaPaymentDetails({destination}));
 expectError(payViaPaymentDetails({destination, routes}));
 expectError(payViaPaymentDetails({routes}));
 expectError(payViaPaymentDetails({lnd}));
-expectError(payViaPaymentDetails({lnd, destination}));
 expectError(payViaPaymentDetails({lnd, routes}));
 
 expectType<PayViaPaymentDetailsResult>(