lightning 4.12.2 → 4.13.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 4.13.0
+
+- Add `sendMessageToPeer` to send a peer to peer message to a connected peer
+- Add `subscribeToPeerMessages` to listen to messages from connected peers
+
 ## 4.12.2
 
 - `probeForRoute`, `subscribeToProbeForRoute`, `subscribeToPayViaRoutes`,

package/README.md

@@ -225,6 +225,8 @@ Methods exported by this library support typescript, but ln-service includes add
     Ask for a CPFP chain fee rate increase on a pending confirm UTXO.
 - [revokeAccess](https://github.com/alexbosworth/ln-service#revokeaccess): Remove the access
     privileges of a previously issued access token macaroon credential.
+- [sendMessageToPeer](https://github.com/alexbosworth/ln-service#sendmessagetopeer): Send
+    message to a connected peer.
 - [sendToChainAddress](https://github.com/alexbosworth/ln-service#sendtochainaddress): Send
     funds on-chain to an address.
 - [sendToChainAddresses](https://github.com/alexbosworth/ln-service#sendtochainaddresses):
@@ -277,6 +279,8 @@ Methods exported by this library support typescript, but ln-service includes add
     Make an off-chain payment using a payment request and subscribe to the payment status.
 - [subscribeToPayViaRoutes](https://github.com/alexbosworth/ln-service#subscribetopayviaroutes):
     Start an off-chain payment using specific payment routes and subscribe to the payment result.
+- [subscribeToPeerMessages](https://github.com/alexbosworth/ln-service#subscribetopeermessages):
+    Listen for incoming peer messages.
 - [subscribeToPeers](https://github.com/alexbosworth/ln-service#subscribetopeers): Listen to peer
     disconnect and connect events.
 - [subscribeToProbeForRoute](https://github.com/alexbosworth/ln-service#subscribetoprobeforroute):

package/index.js

@@ -87,6 +87,7 @@ const {recoverFundsFromChannels} = require('./lnd_methods');
 const {removePeer} = require('./lnd_methods');
 const {requestChainFeeIncrease} = require('./lnd_methods');
 const {revokeAccess} = require('./lnd_methods');
+const {sendMessageToPeer} = require('./lnd_methods');
 const {sendToChainAddress} = require('./lnd_methods');
 const {sendToChainAddresses} = require('./lnd_methods');
 const {sendToChainOutputScripts} = require('./lnd_methods');
@@ -113,6 +114,7 @@ const {subscribeToPastPayments} = require('./lnd_methods');
 const {subscribeToPayViaDetails} = require('./lnd_methods');
 const {subscribeToPayViaRequest} = require('./lnd_methods');
 const {subscribeToPayViaRoutes} = require('./lnd_methods');
+const {subscribeToPeerMessages} = require('./lnd_methods');
 const {subscribeToPeers} = require('./lnd_methods');
 const {subscribeToProbeForRoute} = require('./lnd_methods');
 const {subscribeToRpcRequests} = require('./lnd_methods');
@@ -221,6 +223,7 @@ module.exports = {
   removePeer,
   requestChainFeeIncrease,
   revokeAccess,
+  sendMessageToPeer,
   sendToChainAddress,
   sendToChainAddresses,
   sendToChainOutputScripts,
@@ -247,6 +250,7 @@ module.exports = {
   subscribeToPayViaDetails,
   subscribeToPayViaRequest,
   subscribeToPayViaRoutes,
+  subscribeToPeerMessages,
   subscribeToPeers,
   subscribeToProbeForRoute,
   subscribeToRpcRequests,

package/lnd_methods/offchain/index.d.ts

@@ -32,6 +32,7 @@ export * from './pay';
 export * from './probe_for_route';
 export * from './recover_funds_from_channel';
 export * from './recover_funds_from_channels';
+export * from './send_message_to_peer';
 export * from './subscribe_to_backups';
 export * from './subscribe_to_channels';
 export * from './subscribe_to_forward_requests';
@@ -42,6 +43,7 @@ export * from './subscribe_to_past_payments';
 export * from './subscribe_to_pay_via_details';
 export * from './subscribe_to_pay_via_request';
 export * from './subscribe_to_pay_via_routes';
+export * from './subscribe_to_peer_messages';
 export * from './subscribe_to_probe_for_route';
 export * from './update_connected_watchtower';
 export * from './update_pathfinding_settings';

package/lnd_methods/offchain/send_message_to_peer.d.ts

@@ -0,0 +1,28 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type LightningMessage = {
+  /** Message Hex String */
+  message: string;
+  /** To Peer Public Key Hex String */
+  public_key: string;
+  /** Message Type Number */
+  type?: number;
+};
+
+export type SendMessageToPeerArgs =
+  AuthenticatedLightningArgs<LightningMessage>;
+
+/**
+ * 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
+ */
+export const sendMessageToPeer: AuthenticatedLightningMethod<SendMessageToPeerArgs>;

package/lnd_methods/offchain/subscribe_to_peer_messages.d.ts

@@ -0,0 +1,18 @@
+import {LightningMessage} from '.';
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningSubscription,
+  LightningError,
+} from '../../typescript';
+
+export type SubscribeToPeerMessagesMessageReceivedEvent =
+  Required<LightningMessage>;
+
+/**
+ * Subscribe to incoming peer messages
+ *
+ * Requires `offchain:read` permission
+ *
+ * This method is not supported in LND 0.13.3 and below
+ */
+export const subscribeToPeerMessages: AuthenticatedLightningSubscription;

package/package.json

@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.12.2"
+  "version": "4.13.0"
 }

package/test/typescript/send_message_to_peer.test-d.ts

@@ -0,0 +1,24 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {sendMessageToPeer} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const message = 'msg';
+const public_key = 'pubkey';
+const type = 2;
+
+expectError(sendMessageToPeer());
+expectError(sendMessageToPeer({}));
+expectError(sendMessageToPeer({lnd}));
+expectError(sendMessageToPeer({lnd, message}));
+expectError(sendMessageToPeer({lnd, public_key}));
+
+expectType<void>(await sendMessageToPeer({lnd, message, public_key}));
+expectType<void>(await sendMessageToPeer({lnd, message, public_key, type}));
+
+expectType<void>(
+  sendMessageToPeer({lnd, message, public_key}, (error, result) => {})
+);
+expectType<void>(
+  sendMessageToPeer({lnd, message, public_key, type}, (error, result) => {})
+);

package/test/typescript/subscribe_to_peer_messages.test-d.ts

@@ -0,0 +1,11 @@
+import * as events from 'events';
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {subscribeToPeerMessages} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+
+expectError(subscribeToPeerMessages());
+expectError(subscribeToPeerMessages({}));
+
+expectType<events.EventEmitter>(subscribeToPeerMessages({lnd}));