lightning 4.11.0 → 4.12.2

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Versions
 
-## 4.11.0
+## 4.12.2
+
+- `probeForRoute`, `subscribeToProbeForRoute`, `subscribeToPayViaRoutes`,
+    `payViaRoutes`: When probing (no hash), delete the payment failure record after the probe
+
+## 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,47 @@ 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 {
@@ -834,6 +875,9 @@ message ChannelAcceptRequest {
     // A bit-field which the initiator uses to specify proposed channel
     // behavior.
     uint32 channel_flags = 13;
+
+    // The commitment type the initiator wishes to use for the proposed channel.
+    CommitmentType commitment_type = 14;
 }
 
 message ChannelAcceptResponse {
@@ -1188,6 +1232,15 @@ enum CommitmentType {
     been broadcast.
     */
     ANCHORS = 2;
+
+    /*
+    A channel that uses a commitment type that builds upon the anchors
+    commitment format, but in addition requires a CLTV clause to spend outputs
+    paying to the channel initiator. This is intended for use on leased channels
+    to guarantee that the channel initiator has no incentives to close a leased
+    channel before its maturity date.
+    */
+    SCRIPT_ENFORCED_LEASE = 4;
 }
 
 message ChannelConstraints {

package/grpc/protos/signer.proto

@@ -193,6 +193,12 @@ message SignMessageReq {
 
     // Double-SHA256 hash instead of just the default single round.
     bool double_hash = 3;
+
+    /*
+    Use the compact (pubkey recoverable) format instead of the raw lnwire
+    format.
+    */
+    bool compact_sig = 4;
 }
 message SignMessageResp {
     /*

package/grpc/protos/walletkit.proto

@@ -286,6 +286,16 @@ message AddrRequest {
     default wallet account is used.
     */
     string account = 1;
+
+    /*
+    The type of address to derive.
+    */
+    AddressType type = 2;
+
+    /*
+    Whether a change address should be derived.
+    */
+    bool change = 3;
 }
 message AddrResponse {
     /*

package/grpc/protos/walletunlocker.proto

@@ -176,6 +176,15 @@ message InitWalletRequest {
     mainnet).
     */
     uint64 extended_master_key_birthday_timestamp = 8;
+
+    /*
+    watch_only is the third option of initializing a wallet: by importing
+    account xpubs only and therefore creating a watch-only wallet that does not
+    contain any private keys. That means the wallet won't be able to sign for
+    any of the keys and _needs_ to be run with a remote signer that has the
+    corresponding private keys and can serve signing RPC requests.
+    */
+    WatchOnly watch_only = 9;
 }
 message InitWalletResponse {
     /*
@@ -188,6 +197,63 @@ message InitWalletResponse {
     bytes admin_macaroon = 1;
 }
 
+message WatchOnly {
+    /*
+    The unix timestamp in seconds of when the master key was created. lnd will
+    only start scanning for funds in blocks that are after the birthday which
+    can speed up the process significantly. If the birthday is not known, this
+    should be left at its default value of 0 in which case lnd will start
+    scanning from the first SegWit block (481824 on mainnet).
+    */
+    uint64 master_key_birthday_timestamp = 1;
+
+    /*
+    The fingerprint of the root key (also known as the key with derivation path
+    m/) from which the account public keys were derived from. This may be
+    required by some hardware wallets for proper identification and signing. The
+    bytes must be in big-endian order.
+    */
+    bytes master_key_fingerprint = 2;
+
+    /*
+    The list of accounts to import. There _must_ be an account for all of lnd's
+    main key scopes: BIP49/BIP84 (m/49'/0'/0', m/84'/0'/0', note that the
+    coin type is always 0, even for testnet/regtest) and lnd's internal key
+    scope (m/1017'/<coin_type>'/<account>'), where account is the key family as
+    defined in `keychain/derivation.go` (currently indices 0 to 9).
+     */
+    repeated WatchOnlyAccount accounts = 3;
+}
+
+message WatchOnlyAccount {
+    /*
+    Purpose is the first number in the derivation path, must be either 49, 84
+    or 1017.
+    */
+    uint32 purpose = 1;
+
+    /*
+    Coin type is the second number in the derivation path, this is _always_ 0
+    for purposes 49 and 84. It only needs to be set to 1 for purpose 1017 on
+    testnet or regtest.
+    */
+    uint32 coin_type = 2;
+
+    /*
+    Account is the third number in the derivation path. For purposes 49 and 84
+    at least the default account (index 0) needs to be created but optional
+    additional accounts are allowed. For purpose 1017 there needs to be exactly
+    one account for each of the key families defined in `keychain/derivation.go`
+    (currently indices 0 to 9)
+    */
+    uint32 account = 3;
+
+    /*
+    The extended public key at depth 3 for the given account.
+    */
+    string xpub = 4;
+}
+
 message UnlockWalletRequest {
     /*
     wallet_password should be the current valid passphrase for the daemon. This

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"
@@ -439,9 +443,14 @@
     "type": "router"
   },
   "subscribeToPayViaRoutes": {
+    "depends_on": ["deletePayment"],
     "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,75 @@
+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) {
+            return cbk([503, 'UnexpectedErrorSendingMessageToPeer', {err}]);
+          }
+
+          return cbk();
+        });
+      }],
+    },
+    returnResult({reject, resolve}, cbk));
+  });
+};

package/lnd_methods/offchain/subscribe_to_pay_via_routes.js

@@ -16,6 +16,7 @@ const {rpcRouteFromRoute} = require('./../../lnd_requests');
 const msAsISO = ms => new Date(ms).toISOString();
 const {isArray} = Array;
 const isHash = n => /^[0-9A-F]{64}$/i.test(n);
+const hexAsBytes = hex => Buffer.from(hex, 'hex');
 const method = 'sendToRouteV2';
 const notFoundIndex = -1;
 const {now} = Date;
@@ -292,6 +293,27 @@ module.exports = args => {
         return cbk(null, keys);
       }],
 
+      // Attempt to clean up failed probe state
+      deleteProbe: ['attempt', ({attempt}, cbk) => {
+        // Exit early when the payment didn't fail
+        if (!attempt.failure) {
+          return cbk();
+        }
+
+        // Exit early when this is a real payment
+        if (!!args.id) {
+          return cbk();
+        }
+
+        args.lnd.default.deletePayment({
+          payment_hash: hexAsBytes(id),
+        },
+        err => {
+          // Ignore errors trying to clean up probe data
+          return cbk();
+        });
+      }],
+
       // Parsed out failure
       failure: ['attempt', 'keys', ({attempt, keys}, cbk) => {
         if (!attempt.failure) {

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

@@ -7,22 +7,22 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.4.1",
-    "@grpc/proto-loader": "0.6.5",
+    "@grpc/grpc-js": "1.4.2",
+    "@grpc/proto-loader": "0.6.6",
     "@types/express": "4.17.13",
-    "@types/node": "16.11.1",
+    "@types/node": "16.11.6",
     "@types/request": "2.48.7",
     "@types/ws": "8.2.0",
-    "async": "3.2.1",
-    "asyncjs-util": "1.2.6",
+    "async": "3.2.2",
+    "asyncjs-util": "1.2.7",
     "bitcoinjs-lib": "5.2.0",
     "bn.js": "5.2.0",
     "body-parser": "1.19.0",
-    "bolt07": "1.7.3",
+    "bolt07": "1.7.4",
     "bolt09": "0.2.0",
     "cbor": "8.0.2",
     "express": "4.17.1",
-    "invoices": "2.0.0",
+    "invoices": "2.0.1",
     "psbt": "1.1.10"
   },
   "description": "Lightning Network client library",
@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.11.0"
+  "version": "4.12.2"
 }

package/test/lnd_methods/offchain/test_pay_via_routes.js

@@ -4,6 +4,8 @@ const {payViaRoutes} = require('./../../../');
 
 const preimage = Buffer.alloc(32);
 
+const deletePayment = ({}, cbk) => cbk();
+
 const getInfo = ({}, cbk) => {
   return cbk(null, {
     alias: '',
@@ -37,7 +39,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk(null, {})},
       },
     },
@@ -47,7 +49,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk(null, {})},
       },
       routes: [],
@@ -58,7 +60,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk(null, {})},
       },
       routes: [{
@@ -85,7 +87,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk('err')},
       },
       routes: [{
@@ -116,7 +118,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk(null, {})},
       },
       routes: [{
@@ -142,7 +144,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk(null, {})},
       },
       routes: [{
@@ -169,7 +171,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {
           sendToRouteV2: ({}, cbk) => {
             return cbk(null, {
@@ -223,7 +225,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {
           sendToRouteV2: ({}, cbk) => {
             return cbk(null, {
@@ -319,7 +321,7 @@ const tests = [
   {
     args: {
       lnd: {
-        default: {getInfo},
+        default: {deletePayment, getInfo},
         router: {sendToRouteV2: ({}, cbk) => cbk(null, {preimage})},
       },
       routes: [{

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_pay_via_routes.js

@@ -2,6 +2,8 @@ const {test} = require('@alexbosworth/tap');
 
 const {subscribeToPayViaRoutes} = require('./../../../');
 
+const deletePayment = ({}, cbk) => cbk();
+
 const route = {
   fee: 1,
   fee_mtokens: '1000',
@@ -27,28 +29,39 @@ const tests = [
     error: 'ExpectedAuthenticatedLndToPayViaRoutes',
   },
   {
-    args: {lnd: {router: {sendToRouteV2: ({}) => {}}}},
+    args: {
+      lnd: {default: {deletePayment}, router: {sendToRouteV2: ({}) => {}}},
+    },
     description: 'Routes are required',
     error: 'ExpectedArrayOfPaymentRoutesToPayViaRoutes',
   },
   {
-    args: {lnd: {router: {sendToRouteV2: ({}) => {}}}, routes: []},
+    args: {
+      lnd: {default: {deletePayment}, router: {sendToRouteV2: ({}) => {}}},
+      routes: [],
+    },
     description: 'Non empty routes are required',
     error: 'ExpectedArrayOfPaymentRoutesToPayViaRoutes',
   },
   {
-    args: {lnd: {router: {sendToRouteV2: ({}) => {}}}, routes: [{}]},
+    args: {
+      lnd: {default: {deletePayment}, router: {sendToRouteV2: ({}) => {}}},
+      routes: [{}],
+    },
     description: 'Route must have hops',
     error: 'ExpectedRouteHopsToPayViaRoutes',
   },
   {
-    args: {lnd: {router: {sendToRouteV2: ({}) => {}}}, routes: [{hops: [{}]}]},
+    args: {
+      lnd: {default: {deletePayment}, router: {sendToRouteV2: ({}) => {}}},
+      routes: [{hops: [{}]}],
+    },
     description: 'Hops must have public keys',
     error: 'ExpectedPublicKeyInPayViaRouteHops',
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}) => {}}},
+      lnd: {default: {deletePayment}, router: {sendToRouteV2: ({}) => {}}},
       routes: [{hops: [{public_key: 'public_key'}]}],
     },
     description: 'Hops must have channel ids',
@@ -56,7 +69,7 @@ const tests = [
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}) => {}}},
+      lnd: {default: {deletePayment}, router: {sendToRouteV2: ({}) => {}}},
       routes: [{hops: [{public_key: 'public_key'}]}],
     },
     description: 'Hops must have channel ids',
@@ -65,6 +78,7 @@ const tests = [
   {
     args: {
       lnd: {
+        default: {deletePayment},
         router: {
           sendToRouteV2: ({}, cbk) => cbk({details: 'unknown wire error'}),
         },
@@ -77,6 +91,7 @@ const tests = [
   {
     args: {
       lnd: {
+        default: {deletePayment},
         router: {
           sendToRouteV2: ({}, cbk) => cbk({
             details: 'payment attempt not completed before timeout',
@@ -90,7 +105,10 @@ const tests = [
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk('err')}},
+      lnd: {
+        default: {deletePayment},
+        router: {sendToRouteV2: ({}, cbk) => cbk('err')},
+      },
       routes: [route],
     },
     description: 'An unexpected payment error is passed back',
@@ -102,7 +120,10 @@ const tests = [
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk()}},
+      lnd: {
+        default: {deletePayment},
+        router: {sendToRouteV2: ({}, cbk) => cbk()},
+      },
       routes: [route],
     },
     description: 'A result is expected from sendToRoute',
@@ -115,9 +136,14 @@ const tests = [
   {
     args: {
       id: Buffer.alloc(32).toString('hex'),
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk(null, {
-        preimage: Buffer.alloc(32),
-      })}},
+      lnd: {
+        default: {deletePayment},
+        router: {
+          sendToRouteV2: ({}, cbk) => cbk(null, {
+            preimage: Buffer.alloc(32),
+          }),
+        },
+      },
       routes: [route, route],
     },
     description: 'A success is returned',
@@ -142,9 +168,14 @@ const tests = [
   {
     args: {
       id: Buffer.alloc(32).toString('hex'),
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk(null, {
-        preimage: 'preimage',
-      })}},
+      lnd: {
+        default: {deletePayment},
+        router: {
+          sendToRouteV2: ({}, cbk) => cbk(null, {
+            preimage: 'preimage',
+          }),
+        },
+      },
       routes: [route],
     },
     description: 'A success is returned',
@@ -156,13 +187,18 @@ const tests = [
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk(null, {
-        failure: {
-          chan_id: '1',
-          code: 'UNKNOWN_FAILURE',
+      lnd: {
+        default: {deletePayment},
+        router: {
+          sendToRouteV2: ({}, cbk) => cbk(null, {
+            failure: {
+              chan_id: '1',
+              code: 'UNKNOWN_FAILURE',
+            },
+            preimage: Buffer.alloc(Number()),
+          }),
         },
-        preimage: Buffer.alloc(Number()),
-      })}},
+      },
       routes: [route],
     },
     description: 'A routing failure is returned',
@@ -184,14 +220,19 @@ const tests = [
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk(null, {
-        failure: {
-          chan_id: '1',
-          code: 'UNKNOWN_FAILURE',
-          failure_source_index: 2,
+      lnd: {
+        default: {deletePayment},
+        router: {
+          sendToRouteV2: ({}, cbk) => cbk(null, {
+            failure: {
+              chan_id: '1',
+              code: 'UNKNOWN_FAILURE',
+              failure_source_index: 2,
+            },
+            preimage: Buffer.alloc(Number()),
+          }),
         },
-        preimage: Buffer.alloc(Number()),
-      })}},
+      },
       routes: [
         {
           fee: 1,
@@ -280,14 +321,19 @@ const tests = [
   },
   {
     args: {
-      lnd: {router: {sendToRouteV2: ({}, cbk) => cbk(null, {
-        failure: {
-          chan_id: '1',
-          code: 'UNKNOWN_FAILURE',
-          failure_source_index: 1,
+      lnd: {
+        default: {deletePayment},
+        router: {
+          sendToRouteV2: ({}, cbk) => cbk(null, {
+            failure: {
+              chan_id: '1',
+              code: 'UNKNOWN_FAILURE',
+              failure_source_index: 1,
+            },
+            preimage: Buffer.alloc(Number()),
+          }),
         },
-        preimage: Buffer.alloc(Number()),
-      })}},
+      },
       routes: [route],
     },
     description: 'A routing failure is returned from the destination',
@@ -310,6 +356,7 @@ const tests = [
   {
     args: {
       lnd: {
+        default: {deletePayment},
         router: {
           sendToRouteV2: ({}, cbk) => {
             return setTimeout(() => cbk({details: 'unknown wire error'}), 100);

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_methods/offchain/test_subscribe_to_probe_for_route.js

@@ -4,6 +4,8 @@ const {getInfoResponse} = require('./../fixtures');
 const {queryRoutesResponse} = require('./../fixtures');
 const {subscribeToProbeForRoute} = require('./../../../');
 
+const deletePayment = ({}, cbk) => cbk();
+
 const expectedRoute = {
   confidence: 1000000,
   fee: 0,
@@ -41,6 +43,7 @@ const makeLnd = ({count, getInfo, sendToRouteV2}) => {
 
   const lnd = {
     default: {
+      deletePayment,
       getInfo: getInfo || (({}, cbk) => cbk(null, getInfoResponse)),
       queryRoutes: ({}, cbk) => {
         if (returnedRoutes === (count || 1)) {

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

package/test/protos/protos.json

@@ -1,10 +1,10 @@
 {
   "overrides": [
-    ["lightning", 1168],
-    ["lightning", 1174],
-    ["lightning", 1182],
-    ["lightning", 1189],
-    ["lightning", 3378],
+    ["lightning", 1212],
+    ["lightning", 1218],
+    ["lightning", 1226],
+    ["lightning", 1233],
+    ["lightning", 3431],
     ["router", 100],
     ["walletkit", 3],
     ["walletunlocker", 2]