lightning 9.7.1 → 9.8.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 9.8.1
+
+- `getPendingChannels`: Add `blocks_until_expiry` for opening funding expiry
+
 ## 9.7.1
 
 - `isDestinationPayable`: Correct behavior for passing variations of amounts

package/grpc/protos/chainnotifier.proto

@@ -91,7 +91,7 @@ message ConfDetails {
     // in.
     uint32 block_height = 3;
 
-    // The index of the confirmed transaction within the transaction.
+    // The index of the confirmed transaction within the block.
     uint32 tx_index = 4;
 
     /*

package/grpc/protos/invoices.proto

@@ -84,7 +84,7 @@ message AddHoldInvoiceRequest {
     */
     bytes description_hash = 4;
 
-    // Payment request expiry time in seconds. Default is 3600 (1 hour).
+    // Payment request expiry time in seconds. Default is 86400 (24 hours).
     int64 expiry = 5;
 
     // Fallback on-chain address.

package/grpc/protos/lightning.proto

@@ -101,8 +101,10 @@ service Lightning {
     rpc SignMessage (SignMessageRequest) returns (SignMessageResponse);
 
     /* lncli: `verifymessage`
-    VerifyMessage verifies a signature over a msg. The signature must be
-    zbase32 encoded and signed by an active node in the resident node's
+    VerifyMessage verifies a signature over a message and recovers the signer's
+    public key. The signature is only deemed valid if the recovered public key
+    corresponds to a node key in the public Lightning network. The signature
+    must be zbase32 encoded and signed by an active node in the resident node's
     channel database. In addition to returning the validity of the signature,
     VerifyMessage also returns the recovered pubkey from the signature.
     */
@@ -598,8 +600,10 @@ message LookupHtlcResolutionRequest {
 }
 
 message LookupHtlcResolutionResponse {
+    // Settled is true is the htlc was settled. If false, the htlc was failed.
     bool settled = 1;
 
+    // Offchain indicates whether the htlc was resolved off-chain or on-chain.
     bool offchain = 2;
 }
 
@@ -2586,6 +2590,17 @@ message PendingChannelsResponse {
 
         // Previously used for confirmation_height. Do not reuse.
         reserved 2;
+
+        // The number of blocks until the funding transaction is considered
+        // expired. If this value gets close to zero, there is a risk that the
+        // channel funding will be canceled by the channel responder. The
+        // channel should be fee bumped using CPFP (see walletrpc.BumpFee) to
+        // ensure that the channel confirms in time. Otherwise a force-close
+        // will be necessary if the channel confirms after the funding
+        // transaction expires. A negative value means the channel responder has
+        // very likely canceled the funding and the channel will never become
+        // fully operational.
+        int32 funding_expiry_blocks = 3;
     }
 
     message WaitingCloseChannel {
@@ -3485,22 +3500,22 @@ message Invoice {
 
     /*
     The amount that was accepted for this invoice, in satoshis. This will ONLY
-    be set if this invoice has been settled. We provide this field as if the
-    invoice was created with a zero value, then we need to record what amount
-    was ultimately accepted. Additionally, it's possible that the sender paid
-    MORE that was specified in the original invoice. So we'll record that here
-    as well.
+    be set if this invoice has been settled or accepted. We provide this field
+    as if the invoice was created with a zero value, then we need to record what
+    amount was ultimately accepted. Additionally, it's possible that the sender
+    paid MORE that was specified in the original invoice. So we'll record that
+    here as well.
     Note: Output only, don't specify for creating an invoice.
     */
     int64 amt_paid_sat = 19;
 
     /*
     The amount that was accepted for this invoice, in millisatoshis. This will
-    ONLY be set if this invoice has been settled. We provide this field as if
-    the invoice was created with a zero value, then we need to record what
-    amount was ultimately accepted. Additionally, it's possible that the sender
-    paid MORE that was specified in the original invoice. So we'll record that
-    here as well.
+    ONLY be set if this invoice has been settled or accepted. We provide this
+    field as if the invoice was created with a zero value, then we need to
+    record what amount was ultimately accepted. Additionally, it's possible that
+    the sender paid MORE that was specified in the original invoice. So we'll
+    record that here as well.
     Note: Output only, don't specify for creating an invoice.
     */
     int64 amt_paid_msat = 20;

package/grpc/protos/walletkit.proto

@@ -712,7 +712,9 @@ message ImportTapscriptResponse {
 
 message Transaction {
     /*
-    The raw serialized transaction.
+    The raw serialized transaction. Despite the field name, this does need to be
+    specified in raw bytes (or base64 encoded when using REST) and not in hex.
+    To not break existing software, the field can't simply be renamed.
     */
     bytes tx_hex = 1;
 

package/grpc/protos/wtclient.proto

@@ -68,6 +68,10 @@ message GetTowerInfoRequest {
 
     // Whether we should include sessions with the watchtower in the response.
     bool include_sessions = 2;
+
+    // Whether to exclude exhausted sessions in the response info. This option
+    // is only meaningful if include_sessions is true.
+    bool exclude_exhausted_sessions = 3;
 }
 
 message TowerSession {
@@ -107,19 +111,46 @@ message Tower {
     // The list of addresses the watchtower is reachable over.
     repeated string addresses = 2;
 
+    // Deprecated, use the active_session_candidate field under the
+    // correct identifier in the client_type map.
     // Whether the watchtower is currently a candidate for new sessions.
-    bool active_session_candidate = 3;
+    bool active_session_candidate = 3 [deprecated = true];
 
+    // Deprecated, use the num_sessions field under the correct identifier
+    // in the client_type map.
     // The number of sessions that have been negotiated with the watchtower.
-    uint32 num_sessions = 4;
+    uint32 num_sessions = 4 [deprecated = true];
 
+    // Deprecated, use the sessions field under the correct identifier in the
+    // client_type map.
     // The list of sessions that have been negotiated with the watchtower.
-    repeated TowerSession sessions = 5;
+    repeated TowerSession sessions = 5 [deprecated = true];
+
+    // A list sessions held with the tower.
+    repeated TowerSessionInfo session_info = 6;
+}
+
+message TowerSessionInfo {
+    // Whether the watchtower is currently a candidate for new sessions.
+    bool active_session_candidate = 1;
+
+    // The number of sessions that have been negotiated with the watchtower.
+    uint32 num_sessions = 2;
+
+    // The list of sessions that have been negotiated with the watchtower.
+    repeated TowerSession sessions = 3;
+
+    // The session's policy type.
+    PolicyType policy_type = 4;
 }
 
 message ListTowersRequest {
     // Whether we should include sessions with the watchtower in the response.
     bool include_sessions = 1;
+
+    // Whether to exclude exhausted sessions in the response info. This option
+    // is only meaningful if include_sessions is true.
+    bool exclude_exhausted_sessions = 2;
 }
 
 message ListTowersResponse {

package/lnd_methods/info/constants.json

@@ -31,6 +31,7 @@
     "5c36d96c9cbe8b27c29f9682dcbdab7928ae870f": "0.15.0-beta",
     "6042004edaaa5b3cad0a0808ff23dba4716f7178": "0.14.1-beta",
     "61c34683058f2cc8dc10f49392a0057440d831c4": "0.13.4-beta",
+    "6bd30047c1b1188029e8af6ee8a135cf86e7dc4b": "0.16.4-beta",
     "725ff104808f49f0a5247bfdb4b6b5da7f488d38": "0.13.0-beta",
     "7f34774529fa0964d47fc418d4d2965435cbfdc0": "0.11.1-beta",
     "86d3dec7b939b21bb10f2cd1ff56970c392a1c69": "0.13.2-beta",

package/lnd_methods/offchain/get_pending_channels.d.ts

@@ -3,6 +3,8 @@ import {AuthenticatedLnd} from '../../lnd_grpc';
 
 export type GetPendingChannelsResult = {
   pending_channels: {
+    /** Blocks Until Funding Expires */
+    blocks_until_expiry?: number;
     /** Channel Capacity Tokens */
     capacity: number;
     /** Channel Closing Transaction Id */

package/lnd_methods/offchain/get_pending_channels.js

@@ -21,6 +21,8 @@ const type = 'default';
 
   `description` is not supported in LND 0.16.4 or before
 
+  `blocks_until_expiry` is not supported in LND 0.16.4 or before
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -28,6 +30,7 @@ const type = 'default';
   @returns via cbk or Promise
   {
     pending_channels: [{
+      [blocks_until_expiry]: <Blocks Until Open Channel Expires Number>
       capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       [description]: <Channel Description String>

package/lnd_responses/pending_as_pending_channels.js

@@ -48,10 +48,10 @@ const outpointSeparator = ':';
         remote_chan_reserve_sat: <Remote Side Channel Reserve Tokens String>
         remote_node_pub: <Remote Node Public Key Hex String>
       }
-      confirmation_height: <Future Confirmation Height Number>
       commit_fee: <Commitment Transaction Fee Tokens String>
       commit_weight: <Commitment Transaction Weight Units String>
       fee_per_kw: <Fee Tokens Per Thousand Weight Units String>
+      funding_expiry_blocks: <Blocks Until Open Expired Number>
     }]
     waiting_close_channels: [{
       channel: {
@@ -84,6 +84,7 @@ const outpointSeparator = ':';
   @returns
   {
     pending_channels: [{
+      [blocks_until_expiry]: <Blocks Until Open Channel Expires Number>
       capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       [description]: <Channel Description String>
@@ -243,6 +244,7 @@ module.exports = args => {
     }
 
     sum[pending.channel.channel_point] = {
+      funding_expiry: Number(pending.funding_expiry_blocks) || undefined,
       transaction_fee: Number(pending.commit_fee),
       transaction_weight: Number(pending.commit_weight),
     };
@@ -293,6 +295,7 @@ module.exports = args => {
     const pendingTokens = wait.pending_balance || forced.pending_balance;
 
     return {
+      blocks_until_expiry: !!chanOpen ? chanOpen.funding_expiry : undefined,
       capacity: Number(channel.capacity),
       close_transaction_id: endTx || undefined,
       description: channel.memo || undefined,

package/package.json

@@ -7,33 +7,32 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.16",
+    "@grpc/grpc-js": "1.8.17",
     "@grpc/proto-loader": "0.7.7",
     "@types/express": "4.17.17",
-    "@types/node": "20.3.1",
+    "@types/node": "20.4.1",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.5",
     "async": "3.2.4",
-    "asyncjs-util": "1.2.11",
+    "asyncjs-util": "1.2.12",
     "bitcoinjs-lib": "6.1.3",
     "bn.js": "5.2.1",
     "body-parser": "1.20.2",
-    "bolt07": "1.8.3",
-    "bolt09": "0.2.5",
+    "bolt07": "1.8.4",
+    "bolt09": "1.0.0",
     "cbor": "9.0.0",
     "ecpair": "2.1.0",
     "express": "4.18.2",
-    "invoices": "2.2.3",
-    "psbt": "2.7.2",
-    "tiny-secp256k1": "2.2.2",
+    "invoices": "3.0.0",
+    "psbt": "3.0.0",
+    "tiny-secp256k1": "2.2.3",
     "type-fest": "3.12.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
-    "@alexbosworth/tap": "15.0.12",
     "tsd": "0.28.1",
-    "typescript": "5.1.3",
+    "typescript": "5.1.6",
     "ws": "8.13.0"
   },
   "engines": {
@@ -52,12 +51,12 @@
     "url": "https://github.com/alexbosworth/lightning.git"
   },
   "scripts": {
-    "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 120 test/arrays/*.js test/bolt00/*.js test/bolt02/*.js test/grpc/*.js test/lnd_gateway/*.js test/lnd_grpc/*.js test/lnd_messages/*.js test/lnd_methods/address/*.js test/lnd_methods/generic/*.js test/lnd_methods/info/*.js test/lnd_methods/invoices/*.js test/lnd_methods/macaroon/*.js test/lnd_methods/message/*.js test/lnd_methods/offchain/*.js test/lnd_methods/onchain/*.js test/lnd_methods/peers/*.js test/lnd_methods/signer/*.js test/lnd_methods/unauthenticated/*.js test/lnd_requests/*.js test/lnd_responses/*.js && npm run test:types",
+    "test": "npx nyc@15.1.0 node --experimental-test-coverage --test && npm run test:types",
     "test:types": "tsd"
   },
   "tsd": {
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "9.7.1"
+  "version": "9.8.1"
 }

package/test/arrays/test_sort_by.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const {deepEqual} = require('node:assert').strict;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {sortBy} = require('./../../arrays');
 
@@ -31,13 +33,13 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => sortBy(args), new Error(error), 'Got expected error');
     } else {
       const {sorted} = sortBy(args);
 
-      strictSame(sorted, expected.sorted, 'Array is sorted as expected');
+      deepEqual(sorted, expected.sorted, 'Array is sorted as expected');
     }
 
     return end();

package/test/bolt00/test_mtokens_amount.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const {deepEqual} = require('node:assert').strict;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {mtokensAmount} = require('./../../bolt00');
 
@@ -41,13 +43,13 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({equal, end, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => mtokensAmount(args), new Error(error), 'Got expected err');
     } else {
       const {mtokens} = mtokensAmount(args);
 
-      equal(mtokens, expected.mtokens, 'Got expected output');
+      deepEqual(mtokens, expected.mtokens, 'Got expected output');
     }
 
     return end();

package/test/bolt00/test_payment_amounts.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {paymentAmounts} = require('./../../bolt00');
 
@@ -66,7 +68,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({equal, end, throws}) => {
+  return test(description, (t, end) => {
     if (!!error) {
       throws(() => paymentAmounts(args), new Error(error), 'Got expected err');
     } else {

package/test/bolt00/test_safe_tokens.js

@@ -1,4 +1,5 @@
-const {test} = require('@alexbosworth/tap');
+const {deepEqual} = require('node:assert').strict;
+const test = require('node:test');
 
 const {safeTokens} = require('./../../bolt00');
 
@@ -26,11 +27,11 @@ const tests = [
 ];
 
 tests.forEach(({args, description, expected}) => {
-  return test(description, ({equal, end}) => {
+  return test(description, (t, end) => {
     const {safe, tokens} = safeTokens(args);
 
-    equal(safe, expected.safe, 'Got expected safe tokens');
-    equal(tokens, expected.tokens, 'Got expected tokens');
+    deepEqual(safe, expected.safe, 'Got expected safe tokens');
+    deepEqual(tokens, expected.tokens, 'Got expected tokens');
 
     return end();
   });

package/test/bolt02/test_chain_id.js

@@ -1,4 +1,5 @@
-const {test} = require('@alexbosworth/tap');
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
 
 const {chainId} = require('./../../bolt02');
 
@@ -14,7 +15,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, expected}) => {
-  return test(description, ({end, equal}) => {
+  return test(description, (t, end) => {
     const {chain} = chainId(args);
 
     equal(chain, expected, 'Chain id derived from chain and network');

package/test/grpc/test_emit_subscription_error.js

@@ -1,4 +1,4 @@
-const {test} = require('@alexbosworth/tap');
+const test = require('node:test');
 
 const {emitSubscriptionError} = require('./../../grpc');
 
@@ -54,7 +54,6 @@ const tests = [
           }
 
           throw new Error('ExpectedNoErrorEmitted');
-            
         },
         listenerCount: () => Number(),
       },
@@ -68,7 +67,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, expected}) => {
-  return test(description, ({end, equal}) => {
+  return test(description, (t, end) => {
     const emitErr = emitSubscriptionError(args);
 
     emitErr('error');

package/test/grpc/test_handle_remove_listener.js

@@ -1,4 +1,4 @@
-const {test} = require('@alexbosworth/tap');
+const test = require('node:test');
 
 const {handleRemoveListener} = require('./../../grpc');
 
@@ -26,7 +26,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, expected}) => {
-  return test(description, ({end, equal}) => {
+  return test(description, (t, end) => {
     handleRemoveListener(args);
 
     return end();

package/test/lnd_gateway/test_bearer_token.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const {deepStrictEqual} = require('node:assert').strict;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const bearerToken = require('./../../lnd_gateway/bearer_token');
 
@@ -16,12 +18,12 @@ const tests = [
 ];
 
 tests.forEach(({args, description, expected}) => {
-  return test(description, ({end, strictSame}) => {
+  return test(description, (t, end) => {
     const {middleware} = bearerToken({});
     const res = {locals: {}};
 
     return middleware({get: key => args.header}, res, () => {
-      strictSame(res.locals, expected.locals, 'Got expected locals');
+      deepStrictEqual(res.locals, expected.locals, 'Got expected locals');
 
       return end();
     });

package/test/lnd_gateway/test_decode_cbor_body.js

@@ -1,5 +1,8 @@
+const {deepStrictEqual} = require('node:assert').strict;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
+
 const {encode} = require('cbor');
-const {test} = require('@alexbosworth/tap');
 
 const decodeCborBody = require('./../../lnd_gateway/decode_cbor_body');
 
@@ -17,15 +20,15 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame}) => {
+  return test(description, (t, end) => {
     const {middleware} = decodeCborBody({});
     const req = {body: args.body};
 
     return middleware(req, null, err => {
       if (!!error) {
-        strictSame(err, error, 'Got expected error');
+        deepStrictEqual(err, error, 'Got expected error');
       } else {
-        strictSame(req.body, expected.body, 'Got expected body');
+        deepStrictEqual(req.body, expected.body, 'Got expected body');
       }
 
       return end();

package/test/lnd_gateway/test_emit_event.js

@@ -1,8 +1,10 @@
 const EventEmitter = require('events');
+const {deepStrictEqual} = require('node:assert').strict;
 const {once} = require('events');
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
 
 const {encode} = require('cbor');
-const {test} = require('@alexbosworth/tap');
 
 const emitEvent = require('./../../lnd_gateway/emit_event');
 
@@ -22,7 +24,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, async ({end, rejects, strictSame}) => {
+  return test(description, async () => {
     const emitter = new EventEmitter();
     const message = args.message;
 
@@ -41,9 +43,9 @@ tests.forEach(({args, description, error, expected}) => {
     } else {
       const [, [emitted]] = await all([emit, once(emitter, expected.event)]);
 
-      strictSame(emitted, expected.emitted, 'Got expected emitted data');
+      deepStrictEqual(emitted, expected.emitted, 'Got expected emitted data');
     }
 
-    return end();
+    return;
   });
 });

package/test/lnd_gateway/test_emit_grpc_events.js

@@ -1,13 +1,13 @@
+const {equal} = require('node:assert').strict;
 const EventEmitter = require('events');
-
-const {test} = require('@alexbosworth/tap');
+const test = require('node:test');
 
 const {emitGrpcEvents} = require('./../../');
 
 const tests = [
   {
     args: {message: Buffer.alloc(3)},
-    description: 'When ',
+    description: 'Event is emitted',
     expected: {
       message: 'a26464617461a16764657461696c73781a457870656374656456616c696443626f7257734d657373616765656576656e74656572726f72',
     },
@@ -15,7 +15,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, expected}) => {
-  return test(description, ({equal, end}) => {
+  return test(description, (t, end) => {
     const ws = new EventEmitter();
 
     ws.send = message => {

package/test/lnd_gateway/test_encode_response.js

@@ -1,4 +1,6 @@
-const {test} = require('@alexbosworth/tap');
+const {equal} = require('node:assert').strict;
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
 
 const encodeResponse = require('./../../lnd_gateway/encode_response');
 
@@ -21,7 +23,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, async ({end, equal, rejects}) => {
+  return test(description, async () => {
     if (!!error) {
       await rejects(encodeResponse(args), error, 'Got expected error');
     } else {
@@ -30,6 +32,6 @@ tests.forEach(({args, description, error, expected}) => {
       equal(response.toString('hex'), expected.response, 'Encoded response');
     }
 
-    return end();
+    return;
   });
 });

package/test/lnd_gateway/test_gateway_request.js

@@ -1,5 +1,8 @@
+const {equal} = require('node:assert').strict;
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
+
 const {encode} = require('cbor');
-const {test} = require('@alexbosworth/tap');
 
 const gatewayRequest = require('./../../lnd_gateway/gateway_request');
 
@@ -122,7 +125,7 @@ const tests = [
 ];
 
 tests.forEach(({args, description, error, expected}) => {
-  return test(description, async ({end, equal, rejects}) => {
+  return test(description, async () => {
     if (!!error) {
       await rejects(gatewayRequest(args), error, 'Got expected error');
     } else {
@@ -131,6 +134,6 @@ tests.forEach(({args, description, error, expected}) => {
       equal(res, expected.res, 'Got expected result');
     }
 
-    return end();
+    return;
   });
 });