lightning 4.13.1 → 4.13.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 4.13.1
+## 4.13.2
 
 - Add `sendMessageToPeer` to send a peer to peer message to a connected peer
 - Add `subscribeToPeerMessages` to listen to messages from connected peers

package/grpc/protos/lightning.proto

@@ -4175,8 +4175,10 @@ message CheckMacPermResponse {
 
 message RPCMiddlewareRequest {
     /*
-    The unique ID of the intercepted request. Useful for mapping request to
-    response when implementing full duplex message interception.
+    The unique ID of the intercepted original gRPC request. Useful for mapping
+    request to response when implementing full duplex message interception. For
+    streaming requests, this will be the same ID for all incoming and outgoing
+    middleware intercept messages of the _same_ stream.
     */
     uint64 request_id = 1;
 
@@ -4231,6 +4233,16 @@ message RPCMiddlewareRequest {
         */
         RPCMessage response = 6;
     }
+
+    /*
+    The unique message ID of this middleware intercept message. There can be
+    multiple middleware intercept messages per single gRPC request (one for the
+    incoming request and one for the outgoing response) or gRPC stream (one for
+    each incoming message and one for each outgoing response). This message ID
+    must be referenced when responding (accepting/rejecting/modifying) to an
+    intercept message.
+    */
+    uint64 msg_id = 7;
 }
 
 message StreamAuth {
@@ -4270,11 +4282,11 @@ message RPCMessage {
 
 message RPCMiddlewareResponse {
     /*
-    The unique ID of the intercepted request that this response refers to. Must
-    always be set when giving feedback to an intercept but is ignored for the
-    initial registration message.
+    The request message ID this response refers to. Must always be set when
+    giving feedback to an intercept but is ignored for the initial registration
+    message.
     */
-    uint64 request_id = 1;
+    uint64 ref_msg_id = 1;
 
     /*
     The middleware can only send two types of messages to lnd: The initial

package/lnd_methods/macaroon/accept_rpc_request.js

@@ -30,7 +30,7 @@ module.exports = ({id, subscription}, cbk) => {
 
       // Send accept feedback to the stream
       accept: ['validate', ({}, cbk) => {
-        return subscription.write({feedback, request_id: id}, err => {
+        return subscription.write({feedback, ref_msg_id: id}, err => {
           if (!!err) {
             return cbk([503, 'UnexpectedErrorAcceptingRpcRequest', {err}]);
           }

package/lnd_methods/macaroon/handle_rpc_request_update.js

@@ -17,6 +17,7 @@ const isPayViaRoute = n => !!n && n === '/routerrpc.Router/SendToRouteV2';
     [is_intercepting_pay_via_routes_requests]: <Is Handling Route Reqs Bool>
     subscription: <Stream Subscription Object>
     update: {
+      msg_id: <Message Id Number String>
       request_id: <Request Id Number String>
       raw_macaroon: <Raw Macaroon Buffer Object>
       custom_caveat_condition: <Custom Caveat Condition String>
@@ -47,12 +48,13 @@ const isPayViaRoute = n => !!n && n === '/routerrpc.Router/SendToRouteV2';
     [accept]: ({}, cbk) => {}
     data: {
       [accept]: ({}, cbk) => {}
-      id: <Request Id Number>
+      call: <Call Id Number>
+      id: <Message Id Number>
       [macaroon]: <Base64 Encoded Macaroon String>
       [reject]: ({}, cbk) => {}
       [request]: {
         [chain_fee_tokens_per_vbyte]: <Chain Fee Tokens Per VByte Number>
-        [cooperative_close_address]: <Prefer Cooperative Close To Address String>
+        [cooperative_close_address]: <Prefer Cooperative Close Address String>
         [give_tokens]: <Tokens to Gift To Partner Number>
         [is_private]: <Channel is Private Bool>
         local_tokens: <Local Tokens Number>
@@ -72,6 +74,7 @@ module.exports = args => {
   const isInterceptOpenChans = !!args.is_intercepting_open_channel_requests;
   const isInterceptPayOnRoute = !!args.is_intercepting_pay_via_routes_requests;
 
+  const {call} = details;
   const {event} = details;
   const {id} = details;
   const {macaroon} = details;
@@ -144,5 +147,5 @@ module.exports = args => {
     };
   }
 
-  return {accept, event, data: {id, macaroon, uri}};
+  return {accept, event, data: {call, id, macaroon, uri}};
 };

package/lnd_methods/macaroon/reject_rpc_request.js

@@ -36,7 +36,7 @@ module.exports = ({id, message, subscription}, cbk) => {
             error: message || defaultRejectMessage,
             replace_response: false,
           },
-          request_id: id,
+          ref_msg_id: id,
         },
         err => {
           if (!!err) {

package/lnd_methods/macaroon/subscribe_to_rpc_requests.d.ts

@@ -21,7 +21,9 @@ export type SubscribeToRpcRequestsResult = {
 };
 
 export type SubscribeToRpcRequestsCommonEvent = {
-  /** Request Id Number */
+  /** Call Id Number */
+  call: number;
+  /** Message Id Number */
   id: number;
   /** Base64 Encoded Macaroon String */
   macaroon?: string;
@@ -135,7 +137,7 @@ export type SubscribeToRpcRequestsResponseEvent =
  *
  * LND must be running with "RPC middleware" enabled: `rpcmiddleware.enable=1`
  *
- * This method is not supported in LND 0.13.3 and below
+ * This method is not supported in LND 0.13.4 and below
  */
 export const subscribeToRpcRequests: AuthenticatedLightningMethod<
   SubscribeToRpcRequestsArgs,

package/lnd_methods/macaroon/subscribe_to_rpc_requests.js

@@ -22,7 +22,7 @@ const type = 'default';
 
   LND must be running with "RPC middleware" enabled: `rpcmiddleware.enable=1`
 
-  This method is not supported in LND 0.13.3 and below
+  This method is not supported in LND 0.13.4 and below
 
   {
     [id]: <RPC Middleware Interception Name String>
@@ -41,7 +41,7 @@ const type = 'default';
   @event 'close_channel_request'
   {
     accept: ({}, [cbk]) => {}
-    id: <Request Id Number>
+    id: <Message Id Number>
     macaroon: <Base64 Encoded Macaroon String>
     reject: ({message: <Rejection String>}, [cbk]) => {}
     request: {
@@ -59,7 +59,7 @@ const type = 'default';
   @event 'open_channel_request'
   {
     accept: ({}, [cbk]) => {}
-    id: <Request Id Number>
+    id: <Message Id Number>
     macaroon: <Base64 Encoded Macaroon String>
     reject: ({message: <Rejection String>}, [cbk]) => {}
     request: {
@@ -80,7 +80,7 @@ const type = 'default';
   @event 'pay_via_route_request'
   {
     accept: ({}, [cbk]) => {}
-    id: <Request Id Number>
+    id: <Message Id Number>
     macaroon: <Base64 Encoded Macaroon String>
     reject: ({message: <Rejection String>}, [cbk]) => {}
     request: {
@@ -110,14 +110,16 @@ const type = 'default';
 
   @event 'request'
   {
-    id: <Request Id Number>
+    call: <Call Identifier Number>
+    id: <Message Id Number>
     [macaroon]: <Base64 Encoded Macaroon String>
     [uri]: <RPC URI String>
   }
 
   @event 'response'
   {
-    id: <Request Id Number>
+    call: <Call Identifier Number>
+    id: <Message Id Number>
     [macaroon]: <Base64 Encoded Macaroon String>
     [uri]: <RPC URI String>
   }

package/lnd_methods/offchain/delete_failed_pay_attempts.js

@@ -16,7 +16,7 @@ const type = 'default';
 
   Method not supported on LND 0.12.1 or below
 
-  `id` is not supported on LND 0.13.3 or below
+  `id` is not supported on LND 0.13.4 or below
 
   {
     [id]: <Delete Only Failed Attempt Records For Payment With Hash Hex String>

package/lnd_methods/offchain/delete_payment.d.ts

@@ -13,6 +13,6 @@ export type DeletePaymentArgs = AuthenticatedLightningArgs<{
  *
  * Requires `offchain:write` permission
  *
- * Note: this method is not supported on LND 0.13.3 and below
+ * Note: this method is not supported on LND 0.13.4 and below
  */
 export const deletePayment: AuthenticatedLightningMethod<DeletePaymentArgs>;

package/lnd_methods/offchain/delete_payment.js

@@ -13,7 +13,7 @@ const type = 'default';
 
   Requires `offchain:write` permission
 
-  Note: this method is not supported on LND 0.13.3 and below
+  Note: this method is not supported on LND 0.13.4 and below
 
   {
     id: <Payment Preimage Hash Hex String>

package/lnd_methods/offchain/subscribe_to_forwards.js

@@ -16,7 +16,7 @@ const unknownFailureMessage = '2 UNKNOWN: unknown failure detail type: <nil>';
 
   Requires `offchain:read` permission
 
-  Note: LND 0.13.3 and below do not return `secret` for forwards
+  Note: LND 0.13.4 and below do not return `secret` for forwards
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/offchain/subscribe_to_past_payments.d.ts

@@ -69,6 +69,6 @@ export type SubscribeToPastPaymentsPaymentEvent = {
  *
  * Requires `offchain:read` permission
  *
- * Note: Method not supported on LND 0.13.3 and below
+ * Note: Method not supported on LND 0.13.4 and below
  */
 export const subscribeToPastPayments: AuthenticatedLightningSubscription<SubscribeToPastPaymentsArgs>;

package/lnd_methods/offchain/subscribe_to_past_payments.js

@@ -23,7 +23,7 @@ const unknownFailureMessage = '2 UNKNOWN: unknown failure detail type: <nil>';
 
   Requires `offchain:read` permission
 
-  Note: Method not supported on LND 0.13.3 and below
+  Note: Method not supported on LND 0.13.4 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/offchain/subscribe_to_peer_messages.d.ts

@@ -13,6 +13,6 @@ export type SubscribeToPeerMessagesMessageReceivedEvent =
  *
  * Requires `offchain:read` permission
  *
- * This method is not supported in LND 0.13.3 and below
+ * This method is not supported in LND 0.13.4 and below
  */
 export const subscribeToPeerMessages: AuthenticatedLightningSubscription;

package/lnd_methods/offchain/subscribe_to_peer_messages.js

@@ -16,7 +16,7 @@ const type = 'default';
 
   Requires `offchain:read` permission
 
-  This method is not supported in LND 0.13.3 and below
+  This method is not supported in LND 0.13.4 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/offchain/update_routing_fees.d.ts

@@ -67,7 +67,7 @@ export type UpdateRoutingFeesResult = {
  *
  * Setting both `base_fee_tokens` and `base_fee_mtokens` is not supported
  *
- * `failures` are not returned on LND 0.13.3 and below
+ * `failures` are not returned on LND 0.13.4 and below
  *
  * Requires `offchain:write` permission
  */

package/lnd_methods/offchain/update_routing_fees.js

@@ -20,7 +20,7 @@ const type = 'default';
 
   Setting both `base_fee_tokens` and `base_fee_mtokens` is not supported
 
-  `failures` are not returned on LND 0.13.3 and below
+  `failures` are not returned on LND 0.13.4 and below
 
   Requires `offchain:write` permission
 

package/lnd_methods/unauthenticated/get_wallet_status.d.ts

@@ -26,7 +26,7 @@ export type GetWalletStatusResult = {
  *
  * This method is not supported on LND 0.12.1 and below
  *
- * `is_ready` is not supported on LND 0.13.3 and below
+ * `is_ready` is not supported on LND 0.13.4 and below
  */
 export const getWalletStatus: UnauthenticatedLightningMethod<
   {lnd: UnauthenticatedLnd},

package/lnd_methods/unauthenticated/get_wallet_status.js

@@ -14,7 +14,7 @@ const unsupportedMessage = 'unknown service lnrpc.State';
 
   This method is not supported on LND 0.12.1 and below
 
-  `is_ready` is not supported on LND 0.13.3 and below
+  `is_ready` is not supported on LND 0.13.4 and below
 
   {
     lnd: <Unauthenticated LND API Object>

package/lnd_methods/unauthenticated/subscribe_to_wallet_status.d.ts

@@ -25,6 +25,6 @@ export type SubscribeToWalletStatusStartingEvent = EmptyObject;
  *
  * This method is not supported on LND 0.12.1 and below
  *
- * `ready` is not supported on LND 0.13.3 and below
+ * `ready` is not supported on LND 0.13.4 and below
  */
 export const subscribeToWalletStatus: UnauthenticatedLightningSubscription;

package/lnd_methods/unauthenticated/subscribe_to_wallet_status.js

@@ -18,7 +18,7 @@ const type = 'status';
 
   This method is not supported on LND 0.12.1 and below
 
-  `ready` is not supported on LND 0.13.3 and below
+  `ready` is not supported on LND 0.13.4 and below
 
   {
     lnd: <Unauthenticated LND API Object>

package/lnd_responses/rpc_channel_as_old_rpc_channel.js

@@ -23,6 +23,6 @@ module.exports = ({channel, version}) => {
 
   const type = adjustedChannelTypes[channel.commitment_type];
 
-  // Versions of LND 0.13.3 and before use a different channel type value
+  // Versions of LND 0.13.4 and before use a different channel type value
   return assign(channel, {commitment_type: type || defaultChannelType});
 };

package/lnd_responses/rpc_request_update_as_event.js

@@ -7,6 +7,7 @@ const streamAuth = 'stream_auth';
 /** Derive request details from an RPC request update
 
   {
+    msg_id: <Message Id Number String>
     request_id: <Request Id Number String>
     raw_macaroon: <Raw Macaroon Buffer Object>
     custom_caveat_condition: <Custom Caveat Condition String>
@@ -33,6 +34,7 @@ const streamAuth = 'stream_auth';
 
   @returns
   {
+    call: <Call Id Number>
     [event]: <Event Type String>
     id: <Request Id Number>
     [macaroon]: <Base64 Encoded Macaroon String>
@@ -52,6 +54,10 @@ module.exports = args => {
     throw new Error('ExpectedInterceptTypeInRpcRequestUpdate');
   }
 
+  if (args.msg_id === undefined) {
+    throw new Error('ExpectedMessageIdInRpcRequestUpdate');
+  }
+
   if (!isBuffer(args.raw_macaroon)) {
     throw new Error('ExpectedCompleteMacaroonCredentialsInRequestUpdate');
   }
@@ -60,7 +66,8 @@ module.exports = args => {
     throw new Error('ExpectedRequestIdInRpcRequestUpdate');
   }
 
-  const id = Number(args.request_id);
+  const call = Number(args.request_id);
+  const id = Number(args.msg_id);
 
   switch (args.intercept_type) {
   // New subscription
@@ -74,6 +81,7 @@ module.exports = args => {
     }
 
     return {
+      call,
       id,
       event: request,
       macaroon: bufferAsBase64(args.raw_macaroon),
@@ -91,6 +99,7 @@ module.exports = args => {
     }
 
     return {
+      call,
       id,
       event: request,
       macaroon: bufferAsBase64(args.raw_macaroon),
@@ -108,6 +117,7 @@ module.exports = args => {
     }
 
     return {
+      call,
       id,
       event: response,
       macaroon: bufferAsBase64(args.raw_macaroon),
@@ -116,6 +126,6 @@ module.exports = args => {
 
   // Unknown update
   default:
-    return {id, macaroon: bufferAsBase64(args.raw_macaroon)};
+    return {call, id, macaroon: bufferAsBase64(args.raw_macaroon)};
   }
 };

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.4.2",
+    "@grpc/grpc-js": "1.4.4",
     "@grpc/proto-loader": "0.6.6",
     "@types/express": "4.17.13",
-    "@types/node": "16.11.6",
+    "@types/node": "16.11.7",
     "@types/request": "2.48.7",
     "@types/ws": "8.2.0",
     "async": "3.2.2",
@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.13.1"
+  "version": "4.13.2"
 }

package/test/lnd_methods/macaroon/test_handle_rpc_request_update.js

@@ -24,6 +24,7 @@ const tests = [
       },
       subscription: {},
       update: {
+        msg_id: '1',
         request_id: '1',
         raw_macaroon: Buffer.alloc(0),
         custom_caveat_condition: '',
@@ -79,6 +80,7 @@ const tests = [
       },
       subscription: {},
       update: {
+        msg_id: '1',
         request_id: '1',
         raw_macaroon: Buffer.alloc(0),
         custom_caveat_condition: '',
@@ -141,6 +143,7 @@ const tests = [
       },
       subscription: {},
       update: {
+        msg_id: '1',
         request_id: '1',
         raw_macaroon: Buffer.alloc(0),
         custom_caveat_condition: '',
@@ -189,6 +192,7 @@ const tests = [
     args: {
       subscription: {},
       update: {
+        msg_id: '1',
         request_id: '1',
         raw_macaroon: Buffer.alloc(0),
         custom_caveat_condition: '',

package/test/lnd_methods/macaroon/test_subscribe_to_rpc_requests.js

@@ -18,6 +18,7 @@ const makeArgs = overrides => {
 
           process.nextTick(() => {
             emitter.emit('data', {
+              msg_id: '1',
               request_id: '1',
               raw_macaroon: Buffer.alloc(0),
               custom_caveat_condition: '',
@@ -86,6 +87,7 @@ const tests = [
 
             process.nextTick(() => {
               emitter.emit('data', {
+                msg_id: '1',
                 request_id: '1',
                 raw_macaroon: Buffer.alloc(0),
                 custom_caveat_condition: '',
@@ -102,7 +104,7 @@ const tests = [
     description: 'RPC write errors are passed back',
     expected: {
       events: [
-        {id: 1, macaroon: undefined, uri: 'method_full_uri'},
+        {call: 1, id: 1, macaroon: undefined, uri: 'method_full_uri'},
         [503, 'UnexpectedErrorAcceptingRpcRequest', {err: 'err'}],
       ],
     },
@@ -112,7 +114,7 @@ const tests = [
     description: 'RPC request subscription is returned',
     expected: {
       events: [
-        {id: 1, macaroon: undefined, uri: 'method_full_uri'},
+        {call: 1, id: 1, macaroon: undefined, uri: 'method_full_uri'},
         [503, 'ExpectedCustomCaveatConditionInRpcRequestUpdate'],
         {details: 'Cancelled on client'},
       ],
@@ -161,6 +163,7 @@ const tests = [
 
             process.nextTick(() => {
               emitter.emit('data', {
+                msg_id: '1',
                 request_id: '1',
                 raw_macaroon: Buffer.alloc(0),
                 custom_caveat_condition: '',

package/test/lnd_responses/test_rpc_request_update_as_event.js

@@ -4,6 +4,7 @@ const method = require('./../../lnd_responses/rpc_request_update_as_event');
 
 const makeArgs = overrides => {
   const args = {
+    msg_id: '1',
     request_id: '1',
     raw_macaroon: Buffer.alloc(0),
     custom_caveat_condition: '',
@@ -16,7 +17,7 @@ const makeArgs = overrides => {
 };
 
 const makeExpected = overrides => {
-  const expected = {id: 1, macaroon: undefined};
+  const expected = {call: 1, id: 1, macaroon: undefined};
 
   Object.keys(overrides).forEach(k => expected[k] = overrides[k]);
 
@@ -39,6 +40,11 @@ const tests = [
     description: 'An intercept type is expected',
     error: 'ExpectedInterceptTypeInRpcRequestUpdate',
   },
+  {
+    args: makeArgs({msg_id: undefined}),
+    description: 'A message id is expected',
+    error: 'ExpectedMessageIdInRpcRequestUpdate',
+  },
   {
     args: makeArgs({raw_macaroon: undefined}),
     description: 'A raw macaroon is expected',