lightning 8.0.0 → 9.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Versions
 
+## 9.1.0
+
+- `getWalletInfo`: Add support for LND 0.16.1
+- `subscribeToOpenRequests`: Add `type` for channel request commitment type
+
+## 9.0.0
+
+### Breaking Changes
+
+- node.js version 14 is no longer supported, 16 or higher is required
+
 ## 8.0.0
 
 - `openChannel`: Add `is_max_funding` to fund a channel maximally

package/grpc/protos/walletkit.proto

@@ -863,6 +863,76 @@ enum WitnessType {
     transaction.
     */
     COMMITMENT_ANCHOR = 13;
+
+    /*
+    A witness type that is similar to the COMMITMENT_NO_DELAY type,
+    but it omits the tweak that randomizes the key we need to
+    spend with a channel peer supplied set of randomness.
+    */
+    COMMITMENT_NO_DELAY_TWEAKLESS = 14;
+
+    /*
+    A witness type that allows us to spend our output on the counterparty's
+    commitment transaction after a confirmation.
+    */
+    COMMITMENT_TO_REMOTE_CONFIRMED = 15;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that we extended
+    to a party, but was never fulfilled. This _is_ the HTLC output directly
+    on our commitment transaction, and the input to the second-level HTLC
+    timeout transaction. It can only be spent after CLTV expiry, and
+    commitment confirmation.
+    */
+    HTLC_OFFERED_TIMEOUT_SECOND_LEVEL_INPUT_CONFIRMED = 16;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that was offered
+    to us, and for which we have a payment preimage. This _is_ the HTLC
+    output directly on our commitment transaction, and the input to the
+    second-level HTLC success transaction. It can only be spent after the
+    commitment has confirmed.
+    */
+    HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL_INPUT_CONFIRMED = 17;
+
+    /*
+    A witness type that allows us to spend our output on our local
+    commitment transaction after a relative and absolute lock-time lockout as
+    part of the script enforced lease commitment type.
+    */
+    LEASE_COMMITMENT_TIME_LOCK = 18;
+
+    /*
+    A witness type that allows us to spend our output on the counterparty's
+    commitment transaction after a confirmation and absolute locktime as part
+    of the script enforced lease commitment type.
+    */
+    LEASE_COMMITMENT_TO_REMOTE_CONFIRMED = 19;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that we extended
+    to a party, but was never fulfilled. This HTLC output isn't directly on
+    the commitment transaction, but is the result of a confirmed second-level
+    HTLC transaction. As a result, we can only spend this after a CSV delay
+    and CLTV locktime as part of the script enforced lease commitment type.
+    */
+    LEASE_HTLC_OFFERED_TIMEOUT_SECOND_LEVEL = 20;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that was offered
+    to us, and for which we have a payment preimage. This HTLC output isn't
+    directly on our commitment transaction, but is the result of confirmed
+    second-level HTLC transaction. As a result, we can only spend this after
+    a CSV delay and CLTV locktime as part of the script enforced lease
+    commitment type.
+    */
+    LEASE_HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL = 21;
+
+    /*
+    A witness type that allows us to spend a regular p2tr output that's sent
+    to an output which is under complete control of the backing wallet.
+    */
+    TAPROOT_PUB_KEY_SPEND = 22;
 }
 
 message PendingSweep {

package/lnd_methods/info/constants.json

@@ -44,6 +44,7 @@
     "d62c575f8499a314eb27f12462d20500b6bda2c7": "0.10.3-beta",
     "df0b82f0165f19bde8832bacd1e35544b0a2990d": "0.14.0-beta",
     "eecbe99d68384c734b2c91fd0800484e69c5cab2": "0.14.4-beta",
+    "fb765fdb1daf1c1db08ab9b6aa0c442af431bc82": "0.16.1-beta",
     "fd1a95bf322cdd1c743a1554f8e470fbf9a5e564": "0.15.1-beta"
   },
   "weightedType": "weightedcomb",

package/lnd_methods/offchain/get_pending_channels.js

@@ -4,7 +4,6 @@ const {returnResult} = require('asyncjs-util');
 
 const {isLnd} = require('./../../lnd_requests');
 const {pendingAsPendingChannels} = require('./../../lnd_responses');
-const {rpcChannelAsOldRpcChannel} = require('./../../lnd_responses');
 
 const {isArray} = Array;
 const method = 'pendingChannels';

package/lnd_methods/offchain/get_route_through_hops.js

@@ -4,7 +4,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {routesFromQueryRoutes} = require('../../lnd_responses');
 
-const defaultFinalCltvDelta = 40;
+const defaultFinalCltvDelta = 144;
 const defaultMtokens = '1000000';
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const {isArray} = Array;

package/lnd_methods/offchain/subscribe_to_open_requests.d.ts

@@ -53,6 +53,8 @@ export type SubscribeToOpenRequestsChannelRequestEvent = {
     /** 500 Character Limited Rejection Reason */
     reason?: string;
   }) => void;
+  /** Channel Commitment Transaction Type */
+  type?: string;
 };
 
 /**

package/lnd_methods/offchain/subscribe_to_open_requests.js

@@ -60,6 +60,7 @@ const type = 'default';
     reject: <Reject Request Function> ({
       [reason]: <500 Character Limited Rejection Reason String>
     }) -> {}
+    [type]: <Channel Commitment Transaction Type String>
   }
 
   @event 'error'
@@ -132,6 +133,7 @@ module.exports = ({lnd}) => {
             pending_chan_id: id,
           });
         },
+        type: request.type,
       }));
     } catch (err) {
       return emitError([503, err.message]);

package/lnd_methods/offchain/subscribe_to_pay_via_details.js

@@ -3,7 +3,7 @@ const {randomBytes} = require('crypto');
 const {isLnd} = require('./../../lnd_requests');
 const subscribeToPay = require('./subscribe_to_pay');
 
-const defaultCltvDelta = 40;
+const defaultCltvDelta = 144;
 const isPublicKey = n => !!n && /^[0-9A-F]{66}$/i.test(n);
 const method = 'sendPaymentV2';
 const randomId = () => randomBytes(32).toString('hex');

package/lnd_methods/offchain/update_routing_fees.js

@@ -5,7 +5,7 @@ const {isLnd} = require('./../../lnd_requests');
 const {rpcFailedPolicyAsFail} = require('./../../lnd_responses');
 
 const defaultBaseFee = 1;
-const defaultCltvDelta = 40;
+const defaultCltvDelta = 144;
 const defaultRate = 1;
 const feeRatio = 1e6;
 const {floor} = Math;

package/lnd_responses/channel_accept_as_open_request.js

@@ -1,3 +1,5 @@
+const {channelTypes} = require('./constants');
+
 const bufferAsHex = buffer => buffer.toString('hex');
 const compressedPublicKeyLength = 33;
 const hashAsId = hash => hash.reverse().toString('hex');
@@ -13,6 +15,7 @@ const weightPerVByte = 4;
     chain_hash: <Blockchain Genesis Block Hash Bytes Buffer Object>
     channel_flags: <Bit-field Channel Type Flags Number>
     channel_reserve: <Reserve Tokens Requirement String>
+    commitment_type: <Channel Commitment Transaction Type String>
     csv_delay: <Relative Time Lock Blocks Count Number>
     dust_limit: <Dust Limit Tokens of Peer's Commitment Transaction String>
     fee_per_kw: <Commitment Transaction Fee Rate String>
@@ -45,6 +48,7 @@ const weightPerVByte = 4;
     min_chain_output: <Minimum Chain Output Tokens Number>
     min_htlc_mtokens: <Minimum HTLC Millitokens String>
     partner_public_key: <Peer Public Key Hex String>
+    [type]: <Channel Commitment Transaction Type String>
   }
 */
 module.exports = data => {
@@ -64,6 +68,10 @@ module.exports = data => {
     throw new Error('ExpectedChannelReserveForChannelRequest');
   }
 
+  if (!data.commitment_type) {
+    throw new Error('ExpectedCommitmentTypeForChannelRequest');
+  }
+
   if (data.csv_delay === undefined) {
     throw new Error('ExpectedCsvDelayInChannelOpenRequest');
   }
@@ -125,5 +133,6 @@ module.exports = data => {
     min_chain_output: Number(data.dust_limit),
     min_htlc_mtokens: data.min_htlc,
     partner_public_key: bufferAsHex(data.node_pubkey),
+    type: channelTypes[data.commitment_type],
   };
 };

package/lnd_responses/constants.json

@@ -14,6 +14,12 @@
     "failed": "FAILED",
     "pending": "IN_FLIGHT"
   },
+  "channelTypes": {
+    "ANCHORS": "anchor",
+    "LEGACY": "original",
+    "SCRIPT_ENFORCED_LEASE": "anchor_with_lease_constraint",
+    "STATIC_REMOTE_KEY": "original_with_static_to_remote"
+  },
   "commitmentTypes": {
     "anchor": "ANCHORS",
     "static_remote_key": "STATIC_REMOTE_KEY",

package/lnd_responses/index.js

@@ -18,7 +18,6 @@ const routingFailureFromHtlc = require('./routing_failure_from_htlc');
 const rpcAddressesAsAddresses = require('./rpc_addresses_as_addresses');
 const rpcAttemptHtlcAsAttempt = require('./rpc_attempt_htlc_as_attempt');
 const rpcChannelAsChannel = require('./rpc_channel_as_channel');
-const rpcChannelAsOldRpcChannel = require('./rpc_channel_as_old_rpc_channel');
 const rpcChannelClosedAsClosed = require('./rpc_channel_closed_as_closed');
 const rpcChannelUpdateAsUpdate = require('./rpc_channel_update_as_update');
 const rpcClosedChannelAsClosed = require('./rpc_closed_channel_as_closed');
@@ -64,7 +63,6 @@ module.exports = {
   rpcAddressesAsAddresses,
   rpcAttemptHtlcAsAttempt,
   rpcChannelAsChannel,
-  rpcChannelAsOldRpcChannel,
   rpcChannelClosedAsClosed,
   rpcChannelUpdateAsUpdate,
   rpcClosedChannelAsClosed,

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.8.14",
     "@grpc/proto-loader": "0.7.6",
     "@types/express": "4.17.17",
-    "@types/node": "18.15.11",
+    "@types/node": "18.16.1",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.4",
     "async": "3.2.4",
@@ -26,7 +26,7 @@
     "invoices": "2.2.3",
     "psbt": "2.7.2",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "3.8.0"
+    "type-fest": "3.9.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -37,7 +37,7 @@
     "ws": "8.13.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "keywords": [
     "grpc",
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "8.0.0"
+  "version": "9.1.0"
 }

package/test/lnd_methods/offchain/test_subscribe_to_open_requests.js

@@ -21,6 +21,7 @@ const makeLnd = ({data, err}) => {
             chain_hash: Buffer.alloc(32),
             channel_flags: 34,
             channel_reserve: '1',
+            commitment_type: 'LEGACY',
             csv_delay: 1,
             dust_limit: '1',
             fee_per_kw: '1000',
@@ -90,6 +91,7 @@ const tests = [
             min_chain_output: 1,
             min_htlc_mtokens: '1000',
             partner_public_key: '030303030303030303030303030303030303030303030303030303030303030303',
+            type: 'original',
           }
         },
         {event: 'error', data: {details: 'Cancelled on client'}},

package/test/lnd_methods/offchain/test_update_routing_fees.js

@@ -119,7 +119,7 @@ const tests = [
           fee_rate: 0.000001,
           global: true,
           max_htlc_msat: undefined,
-          time_lock_delta: 40,
+          time_lock_delta: 144,
         },
       }),
       description: 'The global channel policy is updated',
@@ -135,7 +135,7 @@ const tests = [
           fee_rate: 0.000001,
           global: true,
           max_htlc_msat: undefined,
-          time_lock_delta: 40,
+          time_lock_delta: 144,
         },
       }),
       description: 'The global channel policy base fee mtokens is updated',

package/test/lnd_responses/test_channel_accept_as_open_request.js

@@ -7,6 +7,7 @@ const makeArgs = overrides => {
     chain_hash: Buffer.alloc(32),
     channel_flags: 34,
     channel_reserve: '1',
+    commitment_type: 'LEGACY',
     csv_delay: 1,
     dust_limit: '1',
     fee_per_kw: '1000',
@@ -43,6 +44,7 @@ const tests = [
       min_chain_output: 1,
       min_htlc_mtokens: '1000',
       partner_public_key: Buffer.alloc(33, 3).toString('hex'),
+      type: 'original',
     },
   },
   {

package/test/lnd_responses/test_rpc_channel_as_old_rpc_channel.js

@@ -1,64 +0,0 @@
-const {test} = require('@alexbosworth/tap');
-
-const {rpcChannelAsOldRpcChannel} = require('./../../lnd_responses');
-
-const makeArgs = overrides => {
-  const args = {
-    channel: {
-      commitment_type: undefined,
-      uptime: 1,
-    },
-    version: undefined,
-  };
-
-  Object.keys(overrides).forEach(k => args[k] = overrides[k]);
-
-  return args;
-};
-
-const makeExpected = overrides => {
-  const expected = {
-  };
-
-  Object.keys(overrides).forEach(k => expected[k] = overrides[k]);
-
-  return expected;
-};
-
-const tests = [
-  {
-    args: makeArgs({}),
-    description: 'Initiated RPC channel is mapped to channel',
-    expected: {commitment_type: undefined, uptime: 1},
-  },
-  {
-    args: makeArgs({
-      channel: {commitment_type: undefined, uptime: 1},
-      version: '0.11.1-beta',
-    }),
-    description: 'Old RPC channel is mapped to channel',
-    expected: {commitment_type: 'UNKNOWN_COMMITMENT_TYPE', uptime: 1},
-  },
-  {
-    args: makeArgs({
-      channel: {commitment_type: 'LEGACY', uptime: 1},
-      version: '0.11.1-beta',
-    }),
-    description: 'Legacy was 0 but it is updated to 1, so 1 means 2',
-    expected: {commitment_type: 'STATIC_REMOTE_KEY', uptime: 1},
-  },
-];
-
-tests.forEach(({args, description, error, expected}) => {
-  return test(description, ({end, strictSame, throws}) => {
-    if (!!error) {
-      throws(() => rpcChannelAsOldRpcChannel(args), new Error(error), 'Error');
-    } else {
-      const channel = rpcChannelAsOldRpcChannel(args);
-
-      strictSame(channel, expected, 'Channel cast as old channel');
-    }
-
-    return end();
-  });
-});