lightning 10.13.2 → 10.14.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 10.14.0
+
+- `getChannel`: Add support for specifying `transaction_id` and
+    `transaction_vout` instead of `id`
+
 ## 10.13.2
 
 - `getWalletInfo`: Add support for LND 0.18.0

package/grpc/protos/lightning.proto

@@ -3443,6 +3443,10 @@ message ChanInfoRequest {
     output index for the channel.
     */
     uint64 chan_id = 1 [jstype = JS_STRING];
+
+    // The channel point of the channel in format funding_txid:output_index. If
+    // chan_id is specified, this field is ignored.
+    string chan_point = 2;
 }
 
 message NetworkInfoRequest {

package/lnd_methods/info/get_channel.js

@@ -7,17 +7,28 @@ const {isLnd} = require('./../../lnd_requests');
 
 const edgeIsZombieErrorMessage = 'edge marked as zombie';
 const edgeNotFoundErrorMessage = 'edge not found';
+const method = 'getChanInfo';
+const type = 'default';
 
 /** Get graph information about a channel on the network
 
+  Either channel `id` or a `transaction_id` and `transaction_vout` is required
+
   Requires `info:read` permission
 
   `inbound_base_discount_mtokens` is not supported on LND 0.17.5 and below
+
   `inbound_rate_discount` is not supported on LND 0.17.5 and below
 
+  `transaction_id` is not supported on LND 0.18.0 and below
+
+  `transaction_vout` is not supported on LND 0.18.0 and below
+
   {
-    id: <Standard Format Channel Id String>
+    [id]: <Standard Format Channel Id String>
     lnd: <Authenticated LND API Object>
+    [transaction_id]: <Funding Outpoint Transaction Id Hex String>
+    [transaction_vout]: <Funding Outpoint Transaction Output Index Number>
   }
 
   @returns via cbk or Promise
@@ -41,30 +52,45 @@ const edgeNotFoundErrorMessage = 'edge not found';
     [updated_at]: <Channel Last Updated At ISO 8601 Date String>
   }
 */
-module.exports = ({id, lnd}, cbk) => {
+module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        try {
-          chanNumber({channel: id}).number
-        } catch (err) {
-          return cbk([400, 'ExpectedValidChannelIdToGetChannel', {err}]);
+        if (!!args.id && !!args.transaction_id) {
+          return cbk([400, 'ExpectedEitherChannelIdOrOutpointToGetChannel']);
+        }
+
+        if (!args.id && !args.transaction_id) {
+          return cbk([400, 'ExpectedChannelIdOrFundingOutpointToGetChannel']);
         }
 
-        if (!isLnd({lnd, method: 'getChanInfo', type: 'default'})) {
+        if (!isLnd({lnd: args.lnd, method: 'getChanInfo', type: 'default'})) {
           return cbk([400, 'ExpectedLndToGetChannelDetails']);
         }
 
+        if (!!args.transaction_id && args.transaction_vout === undefined) {
+          return cbk([400, 'ExpectedChannelFundingOutputIndexToGetChannel']);
+        }
+
         return cbk();
       },
 
+      // Channel arguments
+      request: ['validate', ({}, cbk) => {
+        // Exit early when a channel id is specified
+        if (!!args.id) {
+          return cbk(null, {chan_id: chanNumber({channel: args.id}).number});
+        }
+
+        return cbk(null, {
+          chan_point: `${args.transaction_id}:${args.transaction_vout}`,
+        });
+      }],
+
       // Get channel
-      getChannel: ['validate', ({}, cbk) => {
-        return lnd.default.getChanInfo({
-          chan_id: chanNumber({channel: id}).number,
-        },
-        (err, response) => {
+      getChannel: ['request', ({request}, cbk) => {
+        return args.lnd[type][method](request, (err, response) => {
           if (!!err && err.details === edgeIsZombieErrorMessage) {
             return cbk([404, 'FullChannelDetailsNotFound']);
           }

package/package.json

@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.13.2"
+  "version": "10.14.0"
 }

package/test/lnd_methods/info/test_get_channel.js

@@ -8,13 +8,30 @@ const tests = [
   {
     args: {},
     description: 'An id for a channel is required',
-    error: [400, 'ExpectedValidChannelIdToGetChannel'],
+    error: [400, 'ExpectedChannelIdOrFundingOutpointToGetChannel'],
   },
   {
     args: {id: 'id'},
     description: 'LND is required to get the channel',
     error: [400, 'ExpectedLndToGetChannelDetails'],
   },
+  {
+    args: {id: 'id', transaction_id: '00'},
+    description: 'Only one identifier is required to get channel',
+    error: [400, 'ExpectedEitherChannelIdOrOutpointToGetChannel'],
+  },
+  {
+    args: {
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => cbk({details: 'edge marked as zombie'}),
+        },
+      },
+      transaction_id: '00',
+    },
+    description: 'A transaction output index is required',
+    error: [400, 'ExpectedChannelFundingOutputIndexToGetChannel'],
+  },
   {
     args: {
       id: 'id',
@@ -154,6 +171,77 @@ const tests = [
       updated_at: new Date(1000).toISOString(),
     },
   },
+  {
+    args: {
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => {
+            return cbk(null, {
+              capacity: '1',
+              chan_point: `${Buffer.alloc(32).toString('hex')}:0`,
+              channel_id: '000000000',
+              node1_policy: {
+                disabled: true,
+                fee_base_msat: '1',
+                fee_rate_milli_msat: '1',
+                last_update: 1,
+                max_htlc_msat: '1',
+                min_htlc: '1',
+                time_lock_delta: 1,
+              },
+              node1_pub: Buffer.alloc(33).toString('hex'),
+              node2_policy: {
+                disabled: false,
+                fee_base_msat: '2',
+                fee_rate_milli_msat: '2',
+                last_update: 1,
+                max_htlc_msat: '2',
+                min_htlc: '2',
+                time_lock_delta: 2,
+              },
+              node2_pub: Buffer.alloc(33, 1).toString('hex'),
+            });
+          },
+        },
+      },
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+    },
+    description: 'Gets graph channel details',
+    expected: {
+      capacity: 1,
+      id: '0x0x0',
+      policies: [
+        {
+          base_fee_mtokens: '1',
+          cltv_delta: 1,
+          fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
+          is_disabled: true,
+          max_htlc_mtokens: '1',
+          min_htlc_mtokens: '1',
+          public_key: Buffer.alloc(33).toString('hex'),
+          updated_at: new Date(1000).toISOString(),
+        },
+        {
+          base_fee_mtokens: '2',
+          cltv_delta: 2,
+          fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
+          is_disabled: false,
+          max_htlc_mtokens: '2',
+          min_htlc_mtokens: '2',
+          public_key: Buffer.alloc(33, 1).toString('hex'),
+          updated_at: new Date(1000).toISOString(),
+        },
+      ],
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+      updated_at: new Date(1000).toISOString(),
+    },
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {