lightning 4.11.0 → 4.11.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 4.11.0
+## 4.11.1
 
 - `getFailedPayments`: Add method to get past failed payments
 - `subscribeToRpcRequests`: Add method to listen to and interact with RPC requests

package/grpc/protos/lightning.proto

@@ -557,6 +557,44 @@ service Lightning {
     */
     rpc RegisterRPCMiddleware (stream RPCMiddlewareResponse)
         returns (stream RPCMiddlewareRequest);
+
+    /* lncli: `sendcustom`
+    SendCustomMessage sends a custom peer message.
+    */
+    rpc SendCustomMessage (SendCustomMessageRequest)
+        returns (SendCustomMessageResponse);
+
+    /* lncli: `subscribecustom`
+    SubscribeCustomMessages subscribes to a stream of incoming custom peer
+    messages.
+    */
+    rpc SubscribeCustomMessages (SubscribeCustomMessagesRequest)
+        returns (stream CustomMessage);
+}
+
+message SubscribeCustomMessagesRequest {
+}
+
+message CustomMessage {
+    // Peer from which the message originates
+    bytes peer = 1;
+
+    // Message type. This value will be in the custom range (>= 32768).
+    uint32 type = 2;
+
+    // Raw message data
+    bytes data = 3;
+}
+
+message SendCustomMessageRequest {
+    // Peer to send the message to
+    bytes peer = 1;
+    // Message type. This value needs to be in the custom range (>= 32768).
+    uint32 type = 2;
+    // Raw message data.
+    bytes data = 3;
+}
+message SendCustomMessageResponse {
 }
 
 message Utxo {

package/lnd_methods/index.js

@@ -84,6 +84,7 @@ const {recoverFundsFromChannels} = require('./offchain');
 const {removePeer} = require('./peers');
 const {requestChainFeeIncrease} = require('./onchain');
 const {revokeAccess} = require('./macaroon');
+const {sendMessageToPeer} = require('./offchain');
 const {sendToChainAddress} = require('./onchain');
 const {sendToChainAddresses} = require('./onchain');
 const {sendToChainOutputScripts} = require('./onchain');
@@ -110,6 +111,7 @@ const {subscribeToPastPayments} = require('./offchain');
 const {subscribeToPayViaDetails} = require('./offchain');
 const {subscribeToPayViaRequest} = require('./offchain');
 const {subscribeToPayViaRoutes} = require('./offchain');
+const {subscribeToPeerMessages} = require('./offchain');
 const {subscribeToPeers} = require('./peers');
 const {subscribeToProbeForRoute} = require('./offchain');
 const {subscribeToRpcRequests} = require('./macaroon');
@@ -214,6 +216,7 @@ module.exports = {
   removePeer,
   requestChainFeeIncrease,
   revokeAccess,
+  sendMessageToPeer,
   sendToChainAddress,
   sendToChainAddresses,
   sendToChainOutputScripts,
@@ -240,6 +243,7 @@ module.exports = {
   subscribeToPayViaDetails,
   subscribeToPayViaRequest,
   subscribeToPayViaRoutes,
+  subscribeToPeerMessages,
   subscribeToPeers,
   subscribeToProbeForRoute,
   subscribeToRpcRequests,

package/lnd_methods/macaroon/methods.json

@@ -334,6 +334,10 @@
     "method": "DeleteMacaroonId",
     "type": "default"
   },
+  "sendMessageToPeer": {
+    "method": "SendCustomMessage",
+    "type": "default"
+  },
   "sendToChainAddress": {
     "method": "SendCoins",
     "type": "default"
@@ -442,6 +446,10 @@
     "method": "SendToRouteV2",
     "type": "router"
   },
+  "subscribeToPeerMessages": {
+    "method": "SubscribeCustomMessages",
+    "type": "default"
+  },
   "subscribeToPeers": {
     "method": "SubscribePeerEvents",
     "type": "default"

package/lnd_methods/offchain/index.js

@@ -32,6 +32,7 @@ const payViaRoutes = require('./pay_via_routes');
 const probeForRoute = require('./probe_for_route');
 const recoverFundsFromChannel = require('./recover_funds_from_channel');
 const recoverFundsFromChannels = require('./recover_funds_from_channels');
+const sendMessageToPeer = require('./send_message_to_peer');
 const subscribeToBackups = require('./subscribe_to_backups');
 const subscribeToChannels = require('./subscribe_to_channels');
 const subscribeToForwardRequests = require('./subscribe_to_forward_requests');
@@ -42,6 +43,7 @@ const subscribeToPastPayments = require('./subscribe_to_past_payments');
 const subscribeToPayViaDetails = require('./subscribe_to_pay_via_details');
 const subscribeToPayViaRequest = require('./subscribe_to_pay_via_request');
 const subscribeToPayViaRoutes = require('./subscribe_to_pay_via_routes');
+const subscribeToPeerMessages = require('./subscribe_to_peer_messages');
 const subscribeToProbeForRoute = require('./subscribe_to_probe_for_route');
 const updateConnectedWatchtower = require('./update_connected_watchtower');
 const updatePathfindingSettings = require('./update_pathfinding_settings');
@@ -84,6 +86,7 @@ module.exports = {
   probeForRoute,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  sendMessageToPeer,
   subscribeToBackups,
   subscribeToChannels,
   subscribeToForwardRequests,
@@ -94,6 +97,7 @@ module.exports = {
   subscribeToPayViaDetails,
   subscribeToPayViaRequest,
   subscribeToPayViaRoutes,
+  subscribeToPeerMessages,
   subscribeToProbeForRoute,
   updateConnectedWatchtower,
   updatePathfindingSettings,

package/lnd_methods/offchain/send_message_to_peer.js

@@ -0,0 +1,76 @@
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {isLnd} = require('./../../lnd_requests');
+
+const bufferFromHex = hex => Buffer.from(hex, 'hex');
+const defaultMessageType = 32768;
+const isHex = n => !!n && !(n.length % 2) && /^[0-9A-F]*$/i.test(n);
+const isPublicKey = n => !!n && /^[0-9A-F]{66}$/i.test(n);
+const method = 'sendCustomMessage';
+const notSupported = /unknown/;
+const type = 'default';
+
+/** Send a custom message to a connected peer
+
+  If specified, message type is expected to be between 32768 and 65535
+
+  Message data should not be larger than 65533 bytes
+
+  Note: this method is not supported in LND versions 0.13.3 and below
+
+  Requires `offchain:write` permission
+
+  {
+    lnd: <Authenticated LND API Object>
+    message: <Message Hex String>
+    public_key: <To Peer Public Key Hex String>
+    [type]: <Message Type Number>
+  }
+
+  @returns via cbk or Promise
+*/
+module.exports = (args, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!isLnd({method, type, lnd: args.lnd})) {
+          return cbk([400, 'ExpectedAuthenticatedLndToSendMessageToPeer']);
+        }
+
+        if (!isHex(args.message)) {
+          return cbk([400, 'ExpectedCustomMessageDataToSendToPeer']);
+        }
+
+        if (!isPublicKey(args.public_key)) {
+          return cbk([400, 'ExpectedPeerPublicKeyToSendMessageTo']);
+        }
+
+        return cbk();
+      },
+
+      // Send the message to the peer
+      send: ['validate', ({}, cbk) => {
+        return args.lnd[type][method]({
+          data: bufferFromHex(args.message),
+          peer: bufferFromHex(args.public_key),
+          type: args.type || defaultMessageType,
+        },
+        err => {
+          if (!!err && notSupported.test(err.details)) {
+            return cbk([501, 'SendMessageToPeerMethodNotSupported']);
+          }
+
+          if (!!err) {
+            console.log("ERR", err)
+            return cbk([503, 'UnexpectedErrorSendingMessageToPeer', {err}]);
+          }
+
+          return cbk();
+        });
+      }],
+    },
+    returnResult({reject, resolve}, cbk));
+  });
+};

package/lnd_methods/offchain/subscribe_to_peer_messages.js

@@ -0,0 +1,63 @@
+const EventEmitter = require('events');
+
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {emitSubscriptionError} = require('./../../grpc');
+const {handleRemoveListener} = require('./../../grpc');
+const {isLnd} = require('./../../lnd_requests');
+const {rpcPeerMessageAsMessage} = require('./../../lnd_responses');
+
+const events = ['message_received'];
+const method = 'SubscribeCustomMessages';
+const type = 'default';
+
+/** Subscribe to incoming peer messages
+
+  Requires `offchain:read` permission
+
+  This method is not supported in LND 0.13.3 and below
+
+  {
+    lnd: <Authenticated LND API Object>
+  }
+
+  @returns
+  <EventEmitter Object>
+
+  // A message was received from a peer
+  @event 'message_received'
+  {
+    message: <Message Hex String>
+    public_key: <From Peer Public Key Hex String>
+    type: <Message Type Number>
+  }
+*/
+module.exports = ({lnd}) => {
+  if (!isLnd({lnd, method, type})) {
+    throw new Error('ExpectedLndToSubscribeToPeerMessages');
+  }
+
+  const emitter = new EventEmitter();
+  const subscription = lnd[type][method]({});
+
+  const errored = emitSubscriptionError({emitter, subscription});
+
+  // Terminate subscription when all listeners are removed
+  handleRemoveListener({subscription, emitter, events});
+
+  subscription.on('end', () => emitter.emit('end'));
+  subscription.on('error', err => errored(err));
+  subscription.on('status', n => emitter.emit('status', n));
+
+  subscription.on('data', message => {
+    try {
+      // Notify listeners of the message
+      emitter.emit('message_received', rpcPeerMessageAsMessage(message));
+    } catch (err) {
+      return errored([503, err.message]);
+    }
+  });
+
+  return emitter;
+};

package/lnd_responses/index.js

@@ -31,6 +31,7 @@ const rpcNodeAsNode = require('./rpc_node_as_node');
 const rpcOutpointAsUpdate = require('./rpc_outpoint_as_update');
 const rpcPaymentAsPayment = require('./rpc_payment_as_payment');
 const rpcPeerAsPeer = require('./rpc_peer_as_peer');
+const rpcPeerMessageAsMessage = require('./rpc_peer_message_as_message');
 const rpcRequestUpdateAsEvent = require('./rpc_request_update_as_event');
 const rpcResolutionAsResolution = require('./rpc_resolution_as_resolution');
 const rpcRouteAsRoute = require('./rpc_route_as_route');
@@ -72,6 +73,7 @@ module.exports = {
   rpcOutpointAsUpdate,
   rpcPaymentAsPayment,
   rpcPeerAsPeer,
+  rpcPeerMessageAsMessage,
   rpcRequestUpdateAsEvent,
   rpcResolutionAsResolution,
   rpcRouteAsRoute,

package/lnd_responses/rpc_peer_message_as_message.js

@@ -0,0 +1,44 @@
+const bufferAsHex = buffer => buffer.toString('hex');
+const {isBuffer} = Buffer;
+
+/** Map an RPC peer message to message details
+
+  {
+    data: <Message Data Buffer Object>
+    peer: <Peer Public Key Buffer Object>
+    type: <Message Type Number>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    message: <Message Data Hex String>
+    public_key: <Peer Public Key Hex String>
+    type: <Message Type Number>
+  }
+*/
+module.exports = args => {
+  if (!args) {
+    throw new Error('ExpectedRpcMessageToDerivePeerMessage');
+  }
+
+  if (!isBuffer(args.data)) {
+    throw new Error('ExpectedPeerMessageDataToDerivePeerMessage');
+  }
+
+  if (!isBuffer(args.peer)) {
+    throw new Error('ExpectedPeerPublicKeyBytesToDerivePeerMessage');
+  }
+
+  if (!args.type) {
+    throw new Error('ExpectedCustomMessageTypeNumberToDeriveMessage');
+  }
+
+  return {
+    message: bufferAsHex(args.data),
+    public_key: bufferAsHex(args.peer),
+    type: args.type,
+  };
+};

package/package.json

@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "1.4.1",
-    "@grpc/proto-loader": "0.6.5",
+    "@grpc/proto-loader": "0.6.6",
     "@types/express": "4.17.13",
     "@types/node": "16.11.1",
     "@types/request": "2.48.7",
@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.11.0"
+  "version": "4.11.1"
 }

package/test/lnd_methods/offchain/test_send_message_to_peer.js

@@ -0,0 +1,68 @@
+const {test} = require('@alexbosworth/tap');
+
+const {sendMessageToPeer} = require('./../../../lnd_methods');
+
+const makeLnd = ({err}) => {
+  return {default: {sendCustomMessage: ({}, cbk) => cbk(err)}};
+};
+
+const makeArgs = override => {
+  const args = {
+    lnd: makeLnd({}),
+    message: Buffer.from('message').toString('hex'),
+    public_key: Buffer.alloc(33, 3).toString('hex'),
+    type: 40000,
+  };
+
+  Object.keys(override || {}).forEach(key => args[key] = override[key]);
+
+  return args;
+};
+
+const tests = [
+  {
+    args: makeArgs({lnd: undefined}),
+    description: 'LND is required',
+    error: [400, 'ExpectedAuthenticatedLndToSendMessageToPeer'],
+  },
+  {
+    args: makeArgs({message: undefined}),
+    description: 'A message is required',
+    error: [400, 'ExpectedCustomMessageDataToSendToPeer'],
+  },
+  {
+    args: makeArgs({public_key: undefined}),
+    description: 'A public key is required',
+    error: [400, 'ExpectedPeerPublicKeyToSendMessageTo'],
+  },
+  {
+    args: makeArgs({lnd: makeLnd({err: {details: 'unknown service'}})}),
+    description: 'Unimplemented error is returned',
+    error: [501, 'SendMessageToPeerMethodNotSupported'],
+  },
+  {
+    args: makeArgs({lnd: makeLnd({err: 'err'})}),
+    description: 'Server error is returned',
+    error: [503, 'UnexpectedErrorSendingMessageToPeer', {err: 'err'}],
+  },
+  {
+    args: makeArgs({}),
+    description: 'Message is sent to peer',
+  },
+  {
+    args: makeArgs({type: undefined}),
+    description: 'Message with default type is sent to peer',
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async ({end, equal, rejects}) => {
+    if (!!error) {
+      await rejects(sendMessageToPeer(args), error, 'Got expected error');
+    } else {
+      await sendMessageToPeer(args);
+    }
+
+    return end();
+  });
+});

package/test/lnd_methods/offchain/test_subscribe_to_peer_messages.js

@@ -0,0 +1,132 @@
+const EventEmitter = require('events');
+
+const {test} = require('@alexbosworth/tap');
+
+const {subscribeToPeerMessages} = require('./../../../lnd_methods');
+
+const makeLnd = overrides => {
+  const data = {
+    data: Buffer.alloc(1),
+    peer: Buffer.alloc(33, 3),
+    type: 44444,
+  };
+
+  Object.keys(overrides).forEach(k => data[k] = overrides[k]);
+
+  return {
+    default: {
+      SubscribeCustomMessages: ({}) => {
+        const emitter = new EventEmitter();
+
+        emitter.cancel = () => {};
+
+        if (overrides.data === undefined) {
+          process.nextTick(() => emitter.emit('data', data));
+        } else {
+          process.nextTick(() => emitter.emit('data', overrides.data));
+        }
+
+        return emitter;
+      },
+    },
+  };
+};
+
+const tests = [
+  {
+    args: {
+      lnd: {
+        default: {
+          SubscribeCustomMessages: ({}) => {
+            const emitter = new EventEmitter();
+
+            emitter.cancel = () => {};
+
+            process.nextTick(() => emitter.emit('end'));
+            process.nextTick(() => emitter.emit('status'));
+            process.nextTick(() => emitter.emit('error', 'err'));
+
+            return emitter;
+          },
+        },
+      },
+    },
+    description: 'Errors are returned',
+    error: 'err',
+  },
+  {
+    args: {
+      lnd: {
+        default: {
+          SubscribeCustomMessages: ({}) => {
+            const emitter = new EventEmitter();
+
+            emitter.cancel = () => {};
+
+            process.nextTick(() => emitter.emit('error', {
+              details: 'Cancelled on client',
+            }));
+
+            return emitter;
+          },
+        },
+      },
+    },
+    description: 'Errors are returned',
+    error: {details: 'Cancelled on client'},
+  },
+  {
+    args: {lnd: makeLnd({peer: null})},
+    description: 'A peer is expected',
+    error: [503, 'ExpectedPeerPublicKeyBytesToDerivePeerMessage'],
+  },
+  {
+    args: {lnd: makeLnd({})},
+    description: 'Peer message event emitted',
+    expected: {
+      message: '00',
+      public_key: Buffer.alloc(33, 3).toString('hex'),
+      type: 44444,
+    },
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, equal, strictSame, throws}) => {
+    try {
+      subscribeToPeerMessages({});
+    } catch (err) {
+      strictSame(
+        err,
+        new Error('ExpectedLndToSubscribeToPeerMessages'), 'Needs lnd');
+    }
+
+    const sub = subscribeToPeerMessages(args);
+
+    if (!!error) {
+      sub.once('error', err => {
+        strictSame(err, error, 'Got expected error');
+
+        subscribeToPeerMessages(args);
+
+        process.nextTick(() => {
+          sub.removeAllListeners();
+
+          return end();
+        });
+      });
+    } else {
+      if (!expected) {
+        return end();
+      }
+
+      sub.once('message_received', message => {
+        strictSame(message, expected, 'Got message received');
+
+        return end();
+      });
+    }
+
+    return;
+  });
+});

package/test/lnd_responses/test_rpc_peer_message_as_message.js

@@ -0,0 +1,67 @@
+const {test} = require('@alexbosworth/tap');
+
+const {rpcPeerMessageAsMessage} = require('./../../lnd_responses');
+
+const makeArgs = overrides => {
+  const response = {
+    data: Buffer.alloc(1),
+    peer: Buffer.alloc(33, 3),
+    type: 44444,
+  };
+
+  Object.keys(overrides || {}).forEach(key => response[key] = overrides[key]);
+
+  return response;
+};
+
+
+const makeExpected = overrides => {
+  const expected = {
+    message: '00',
+    public_key: '030303030303030303030303030303030303030303030303030303030303030303',
+    type: 44444,
+  };
+
+  Object.keys(overrides || {}).forEach(key => expected[key] = overrides[key]);
+
+  return expected;
+};
+
+const tests = [
+  {
+    description: 'RPC peer message is expected',
+    error: 'ExpectedRpcMessageToDerivePeerMessage',
+  },
+  {
+    args: makeArgs({data: undefined}),
+    description: 'data is expected',
+    error: 'ExpectedPeerMessageDataToDerivePeerMessage',
+  },
+  {
+    args: makeArgs({peer: undefined}),
+    description: 'peer public key is expected',
+    error: 'ExpectedPeerPublicKeyBytesToDerivePeerMessage',
+  },
+  {
+    args: makeArgs({type: undefined}),
+    description: 'type is expected',
+    error: 'ExpectedCustomMessageTypeNumberToDeriveMessage',
+  },
+  {
+    args: makeArgs({}),
+    description: 'RPC peer message is mapped to message',
+    expected: makeExpected({}),
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, strictSame, throws}) => {
+    if (!!error) {
+      throws(() => rpcPeerMessageAsMessage(args), new Error(error), 'Got err');
+    } else {
+      strictSame(rpcPeerMessageAsMessage(args), expected, 'Mapped to message');
+    }
+
+    return end();
+  });
+});