lightning 9.0.0 → 9.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Versions
 
+## 9.2.0
+
+- `getChannels`: Add support for `type` to show channel type
+- `subscribeToChannels`: Add support for `channel_opened` `type` to show type
+
+## 9.1.0
+
+- `getWalletInfo`: Add support for LND 0.16.1
+- `subscribeToOpenRequests`: Add `type` for channel request commitment type
+
 ## 9.0.0
 
 ### Breaking Changes

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_channels.d.ts

@@ -114,6 +114,8 @@ export type GetChannelsResult = {
     transaction_id: string;
     /** Blockchain Transaction Vout */
     transaction_vout: number;
+    /** Channel Commitment Transaction Type */
+    type?: string;
     /** Unsettled Balance Tokens */
     unsettled_balance: number;
   }[];

package/lnd_methods/offchain/get_channels.js

@@ -78,6 +78,7 @@ const type = 'default';
       [time_online]: <Monitoring Uptime Channel Up Milliseconds Number>
       transaction_id: <Blockchain Transaction Id String>
       transaction_vout: <Blockchain Transaction Vout Number>
+      [type]: <Channel Commitment Transaction Type String>
       unsettled_balance: <Unsettled Balance Tokens Number>
     }]
   }

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/subscribe_to_channels.d.ts

@@ -127,6 +127,8 @@ export type SubscribeToChannelsChannelOpenedEvent = {
   transaction_id: string;
   /** Blockchain Transaction Vout */
   transaction_vout: number;
+  /** Channel Commitment Transaction Type */
+  type?: string;
   /** Unsettled Balance Tokens */
   unsettled_balance: number;
 };

package/lnd_methods/offchain/subscribe_to_channels.js

@@ -109,6 +109,7 @@ const updateOpening = 'pending_open_channel';
     sent: <Sent Tokens Number>
     transaction_id: <Blockchain Transaction Id String>
     transaction_vout: <Blockchain Transaction Vout Number>
+    [type]: <Channel Commitment Transaction Type String>
     unsettled_balance: <Unsettled Balance Tokens Number>
   }
 

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_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/lnd_responses/rpc_channel_as_channel.js

@@ -1,6 +1,6 @@
 const {chanFormat} = require('bolt07');
 
-const {commitmentTypes} = require('./constants');
+const {channelTypes} = require('./constants');
 const parseThawHeight = require('./parse_thaw_height');
 const rpcHtlcAsPayment = require('./rpc_htlc_as_payment');
 
@@ -118,6 +118,7 @@ const outpointDelimiter = ':';
     time_online: <Monitoring Uptime Channel Up Milliseconds Number>
     transaction_id: <Blockchain Transaction Id String>
     transaction_vout: <Blockchain Transaction Vout Number>
+    [type]: <Channel Commitment Transaction Type String>
     unsettled_balance: <Unsettled Balance Tokens Number>
   }
 */
@@ -150,6 +151,10 @@ module.exports = args => {
     throw new Error('ExpectedCommitWeightInChannelMessage');
   }
 
+  if (!args.commitment_type) {
+    throw new Error('ExpectedChannelCommitmentTypeInChannelMessage');
+  }
+
   if (args.fee_per_kw === undefined) {
     throw new Error('ExpectedFeePerKwInChannelMessage');
   }
@@ -210,7 +215,6 @@ module.exports = args => {
     throw new Error('ExpectedUnsettledBalanceInChannelMessage');
   }
 
-  const chanType = args.commitment_type;
   const commitWeight = Number(args.commit_weight);
   const {height} = parseThawHeight({id: args.chan_id, thaw: args.thaw_height});
   const own = args.local_constraints;
@@ -266,6 +270,7 @@ module.exports = args => {
     time_online: uptime,
     transaction_id: transactionId,
     transaction_vout: Number(vout),
+    type: channelTypes[args.commitment_type],
     unsettled_balance: Number(args.unsettled_balance),
   };
 };

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.13",
+    "@types/node": "18.16.2",
     "@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": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "9.0.0"
+  "version": "9.2.0"
 }

package/test/lnd_methods/offchain/test_get_channels.js

@@ -53,6 +53,7 @@ const makeExpected = overrides => {
     time_online: 1000,
     transaction_id: '00',
     transaction_vout: 1,
+    type: 'anchor',
     unsettled_balance: 1,
   };
 
@@ -71,7 +72,7 @@ const makeLnd = overrides => {
     close_address: 'cooperative_close_address',
     commit_fee: '1',
     commit_weight: '1',
-    commitment_type: 'LEGACY',
+    commitment_type: 'ANCHORS',
     fee_per_kw: '1',
     initiator: true,
     lifetime: 1,
@@ -174,6 +175,11 @@ const tests = [
     description: 'Channel commit weight is expected',
     error: [503, 'ExpectedCommitWeight'],
   },
+  {
+    args: {lnd: makeLnd({commitment_type: undefined})},
+    description: 'Channel commit type is expected',
+    error: [503, 'ExpectedChannelCommitmentTypeInChannelMessage'],
+  },
   {
     args: {lnd: makeLnd({fee_per_kw: undefined})},
     description: 'Channel fee per kw is expected',
@@ -242,7 +248,7 @@ const tests = [
   {
     args: {
       lnd: makeLnd({
-        commitment_type: 'STATIC_REMOTE_KEY',
+        commitment_type: 'ANCHORS',
         thaw_height: 1,
       }),
     },

package/test/lnd_methods/offchain/test_subscribe_to_channels.js

@@ -66,7 +66,7 @@ const makeLnd = ({data, err}) => {
               close_address: '',
               commit_fee: '1',
               commit_weight: '1',
-              commitment_type: 'LEGACY',
+              commitment_type: 'ANCHORS',
               csv_delay: 1,
               fee_per_kw: '1',
               initiator: true,
@@ -278,6 +278,7 @@ const tests = [
             time_online: 1000,
             transaction_id: '0000000000000000000000000000000000000000000000000000000000000000',
             transaction_vout: 0,
+            type: 'anchor',
             unsettled_balance: 1,
           },
         },

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_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_channel.js

@@ -13,7 +13,7 @@ const makeArgs = overrides => {
     close_address: undefined,
     commit_fee: '1',
     commit_weight: '1',
-    commitment_type: 'LEGACY',
+    commitment_type: 'ANCHORS',
     csv_delay: 1,
     fee_per_kw: '1',
     initiator: false,
@@ -112,6 +112,7 @@ const makeExpected = overrides => {
     time_online: 1000,
     transaction_id: '00',
     transaction_vout: 1,
+    type: 'anchor',
     unsettled_balance: 1,
   };
 
@@ -156,6 +157,11 @@ const tests = [
     description: 'Channel commit weight is expected',
     error: 'ExpectedCommitWeightInChannelMessage',
   },
+  {
+    args: makeArgs({commitment_type: undefined}),
+    description: 'Channel commit type is expected',
+    error: 'ExpectedChannelCommitmentTypeInChannelMessage',
+  },
   {
     args: makeArgs({fee_per_kw: undefined}),
     description: 'Channel fee per kw is expected',
@@ -242,7 +248,7 @@ const tests = [
     expected: makeExpected({id: '0x0x2', other_ids: ['0x0x3']}),
   },
   {
-    args: makeArgs({commitment_type: 'STATIC_REMOTE_KEY', initiator: true}),
+    args: makeArgs({commitment_type: 'ANCHORS', initiator: true}),
     description: 'Initiated RPC channel is mapped to channel',
     expected: makeExpected({
       is_partner_initiated: false,

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();
-  });
-});