lightning 4.10.7 → 4.11.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 4.11.0
+
+- `getFailedPayments`: Add method to get past failed payments
+- `subscribeToRpcRequests`: Add method to listen to and interact with RPC requests
+
 ## 4.10.7
 
 - `getPayment`: Expand type definitions to match result data

package/README.md

@@ -131,6 +131,8 @@ Methods exported by this library support typescript, but ln-service includes add
     channels on the node.
 - [getConnectedWatchtowers](https://github.com/alexbosworth/ln-service#getconnectedwatchtowers):
     List watchtowers that were added
+- [getFailedPayments](https://github.com/alexbosworth/ln-service#getfailedpayments): List out
+    past payments that failed.
 - [getFeeRates](https://github.com/alexbosworth/ln-service#getfeerates): List routing fee rates
     and routing policies of channels on the node.
 - [getForwardingConfidence](https://github.com/alexbosworth/ln-service#getforwardingconfidence):

package/index.js

@@ -37,6 +37,7 @@ const {getChannelBalance} = require('./lnd_methods');
 const {getChannels} = require('./lnd_methods');
 const {getClosedChannels} = require('./lnd_methods');
 const {getConnectedWatchtowers} = require('./lnd_methods');
+const {getFailedPayments} = require('./lnd_methods');
 const {getFeeRates} = require('./lnd_methods');
 const {getForwardingConfidence} = require('./lnd_methods');
 const {getForwardingReputations} = require('./lnd_methods');
@@ -114,6 +115,7 @@ const {subscribeToPayViaRequest} = require('./lnd_methods');
 const {subscribeToPayViaRoutes} = require('./lnd_methods');
 const {subscribeToPeers} = require('./lnd_methods');
 const {subscribeToProbeForRoute} = require('./lnd_methods');
+const {subscribeToRpcRequests} = require('./lnd_methods');
 const {subscribeToTransactions} = require('./lnd_methods');
 const {subscribeToWalletStatus} = require('./lnd_methods');
 const {unauthenticatedLndGrpc} = require('./lnd_grpc');
@@ -169,6 +171,7 @@ module.exports = {
   getChannels,
   getClosedChannels,
   getConnectedWatchtowers,
+  getFailedPayments,
   getFeeRates,
   getForwardingConfidence,
   getForwardingReputations,
@@ -246,6 +249,7 @@ module.exports = {
   subscribeToPayViaRoutes,
   subscribeToPeers,
   subscribeToProbeForRoute,
+  subscribeToRpcRequests,
   subscribeToTransactions,
   subscribeToWalletStatus,
   unauthenticatedLndGrpc,

package/lnd_methods/macaroon/index.d.ts

@@ -1,4 +1,5 @@
 export * from './get_access_ids';
 export * from './grant_access';
 export * from './revoke_access';
+export * from './subscribe_to_rpc_requests';
 export * from './verify_access';

package/lnd_methods/macaroon/subscribe_to_rpc_requests.d.ts

@@ -0,0 +1,143 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+  LightningMethod,
+} from '../../typescript';
+
+export type SubscribeToRpcRequestsArgs = AuthenticatedLightningArgs<{
+  /** RPC Middleware Interception Name String */
+  id?: string;
+  /** Intercept Channel Closes Bool */
+  is_intercepting_close_channel_requests?: boolean;
+  /** Intercept Channel Opens Bool */
+  is_intercepting_open_channel_requests?: boolean;
+  /** Intercept Pay Via Route Bool */
+  is_intercepting_pay_via_routes_requests?: boolean;
+}>;
+
+export type SubscribeToRpcRequestsResult = {
+  /** RPC Request Subscription EventEmitter Object */
+  subscription: NodeJS.EventEmitter;
+};
+
+export type SubscribeToRpcRequestsCommonEvent = {
+  /** Request Id Number */
+  id: number;
+  /** Base64 Encoded Macaroon String */
+  macaroon?: string;
+  /** RPC URI String */
+  uri?: string;
+};
+
+export type SubscribeToRpcRequestsEvent<TRequest> =
+  Required<SubscribeToRpcRequestsCommonEvent> & {
+    accept: LightningMethod;
+    reject: LightningMethod<{
+      /** Rejection String */
+      message: string;
+    }>;
+    request: TRequest;
+  };
+
+/** A channel close request was intercepted: by default it will be rejected */
+export type SubscribeToRpcRequestsCloseChannelRequestEvent =
+  SubscribeToRpcRequestsEvent<{
+    /** Request Sending Local Channel Funds To Address String */
+    address?: string;
+    /** Is Force Close Bool */
+    is_force_close?: boolean;
+    /** Confirmation Target Number */
+    target_confirmations?: number;
+    /** Tokens Per Virtual Byte Number */
+    tokens_per_vbyte?: number;
+    /** Transaction Id Hex String */
+    transaction_id: string;
+    /** Transaction Output Index Number */
+    transaction_vout: number;
+  }>;
+
+/** A channel open request was intercepted: by default it will be rejected */
+export type SubscribeToRpcRequestsOpenChannelRequestEvent =
+  SubscribeToRpcRequestsEvent<{
+    /** Chain Fee Tokens Per VByte Number */
+    chain_fee_tokens_per_vbyte?: number;
+    /** Prefer Cooperative Close To Address String */
+    cooperative_close_address?: string;
+    /** Tokens to Gift To Partner Number */
+    give_tokens?: number;
+    /** Channel is Private Bool */
+    is_private?: boolean;
+    /** Local Tokens Number */
+    local_tokens: number;
+    /** Spend UTXOs With Minimum Confirmations Number */
+    min_confirmations?: number;
+    /** Minimum HTLC Millitokens String */
+    min_htlc_mtokens?: string;
+    /** Public Key Hex String */
+    partner_public_key: string;
+    /** Peer Output CSV Delay Number */
+    partner_csv_delay?: number;
+  }>;
+
+/** A pay to route request was intercepted: by default it will be rejected */
+export type SubscribeToRpcRequestsPayViaRouteRequestEvent =
+  SubscribeToRpcRequestsEvent<{
+    /** Payment Hash Hex String */
+    id: string;
+    route: {
+      /** Route Fee Tokens Number */
+      fee: number;
+      /** Route Fee Millitokens String */
+      fee_mtokens: string;
+      hops: {
+        /** Standard Format Channel Id String */
+        channel: string;
+        /** Channel Capacity Tokens Number */
+        channel_capacity: number;
+        /** Fee Tokens Number */
+        fee: number;
+        /** Fee Millitokens String */
+        fee_mtokens: string;
+        /** Forward Tokens Number */
+        forward: number;
+        /** Forward Millitokens String */
+        forward_mtokens: string;
+        /** Forward Edge Public Key Hex String */
+        public_key: string;
+        /** Timeout Block Height Number */
+        timeout?: number;
+      }[];
+      /** Total Fee-Inclusive Millitokens String */
+      mtokens: string;
+      /** Payment Identifier Hex String */
+      payment?: string;
+      /** Timeout Block Height Number */
+      timeout?: number;
+      /** Total Fee-Inclusive Tokens Number */
+      tokens: number;
+      /** Total Payment Millitokens String */
+      total_mtokens?: string;
+    };
+  }>;
+
+export type SubscribeToRpcRequestsRequestEvent =
+  SubscribeToRpcRequestsCommonEvent;
+
+export type SubscribeToRpcRequestsResponseEvent =
+  SubscribeToRpcRequestsCommonEvent;
+
+/**
+ * Subscribe to RPC requests and their responses
+ *
+ * `accept` and `reject` methods can be used with cbk or Promise syntax
+ *
+ * Requires `macaroon:write` permission
+ *
+ * LND must be running with "RPC middleware" enabled: `rpcmiddleware.enable=1`
+ *
+ * This method is not supported in LND 0.13.3 and below
+ */
+export const subscribeToRpcRequests: AuthenticatedLightningMethod<
+  SubscribeToRpcRequestsArgs,
+  SubscribeToRpcRequestsResult
+>;

package/lnd_methods/offchain/get_failed_payments.d.ts

@@ -0,0 +1,136 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+  PaginationArgs,
+} from '../../typescript';
+
+export type GetFailedPaymentsArgs = AuthenticatedLightningArgs<PaginationArgs>;
+
+export type GetFailedPaymentsResult = {
+  payments: {
+    attempts: {
+      failure?: {
+        /** Error Type Code Number */
+        code: number;
+        details?: {
+          /** Standard Format Channel Id String */
+          channel?: string;
+          /** Error Associated Block Height Number */
+          height?: number;
+          /** Failed Hop Index Number */
+          index?: number;
+          /** Error Millitokens String */
+          mtokens?: string;
+          policy?: {
+            /** Base Fee Millitokens String */
+            base_fee_mtokens: string;
+            /** Locktime Delta Number */
+            cltv_delta: number;
+            /** Fees Charged in Millitokens Per Million Number */
+            fee_rate: number;
+            /** Channel is Disabled Bool */
+            is_disabled?: boolean;
+            /** Maximum HLTC Millitokens Value String */
+            max_htlc_mtokens: string;
+            /** Minimum HTLC Millitokens Value String */
+            min_htlc_mtokens: string;
+            /** Updated At ISO 8601 Date String */
+            updated_at: string;
+          };
+          /** Error CLTV Timeout Height Number */
+          timeout_height?: number;
+          update?: {
+            /** Chain Id Hex String */
+            chain: string;
+            /** Channel Flags Number */
+            channel_flags: number;
+            /** Extra Opaque Data Hex String */
+            extra_opaque_data: string;
+            /** Message Flags Number */
+            message_flags: number;
+            /** Channel Update Signature Hex String */
+            signature: string;
+          };
+        };
+        /** Error Message String */
+        message: string;
+      };
+      /** Payment Add Index Number */
+      index?: number;
+      /** Payment Confirmed At ISO 8601 Date String */
+      confirmed_at?: string;
+      /** Payment Attempt Succeeded Bool */
+      is_confirmed: boolean;
+      /** Payment Attempt Failed Bool */
+      is_failed: boolean;
+      /** Payment Attempt is Waiting For Resolution Bool */
+      is_pending: boolean;
+      route: {
+        /** Route Fee Tokens Number */
+        fee: number;
+        /** Route Fee Millitokens String */
+        fee_mtokens: string;
+        hops: {
+          /** Standard Format Channel Id String */
+          channel: string;
+          /** Channel Capacity Tokens Number */
+          channel_capacity: number;
+          /** Fee Number */
+          fee: number;
+          /** Fee Millitokens String */
+          fee_mtokens: string;
+          /** Forward Tokens Number */
+          forward: number;
+          /** Forward Millitokens String */
+          forward_mtokens: string;
+          /** Forward Edge Public Key Hex String */
+          public_key?: string;
+          /** Timeout Block Height Number */
+          timeout?: number;
+        }[];
+        /** Total Fee-Inclusive Millitokens String */
+        mtokens: string;
+        /** Payment Identifier Hex String */
+        payment?: string;
+        /** Timeout Block Height Number */
+        timeout: number;
+        /** Total Fee-Inclusive Tokens Number */
+        tokens: number;
+        /** Total Millitokens String */
+        total_mtokens?: string;
+      };
+    }[];
+    /** Payment at ISO-8601 Date String */
+    created_at: string;
+    /** Destination Node Public Key Hex String */
+    destination?: string;
+    /** Payment Preimage Hash String */
+    id: string;
+    /** Payment Add Index Number */
+    index?: number;
+    /** Payment is Confirmed Bool */
+    is_confirmed: boolean;
+    /** Transaction Is Outgoing Bool */
+    is_outgoing: boolean;
+    /** Millitokens Attempted to Pay to Destination String */
+    mtokens: string;
+    /** BOLT 11 Payment Request String */
+    request?: string;
+    /** Payment Tokens Attempted to Pay Rounded Up Number */
+    safe_tokens: number;
+    /** Rounded Down Tokens Attempted to Pay to Destination Number */
+    tokens: number;
+  }[];
+  /** Next Opaque Paging Token String */
+  next?: string;
+};
+
+/**
+ * Get failed payments made through channels.
+ *
+ * Requires `offchain:read` permission
+ */
+export const getFailedPayments: AuthenticatedLightningMethod<
+  GetFailedPaymentsArgs,
+  GetFailedPaymentsResult
+>;

package/lnd_methods/offchain/index.d.ts

@@ -14,6 +14,7 @@ export * from './get_channel_balance';
 export * from './get_channels';
 export * from './get_closed_channels';
 export * from './get_connected_watchtowers';
+export * from './get_failed_payments';
 export * from './get_fee_rates';
 export * from './get_forwarding_confidence';
 export * from './get_forwarding_reputations';

package/lnd_methods/offchain/probe_for_route.d.ts

@@ -118,6 +118,10 @@ export type ProbeForRouteResult = {
 /**
  * Probe to find a successful route
  *
+ * When probing to a payment request, make sure to specify the fields encoded in the payment request such as `cltv_delta`.
+ *
+ * If `total_mtokens` are specified, a `payment` nonce is required.
+ *
  * Requires `offchain:write` permission
  */
 export const probeForRoute: AuthenticatedLightningMethod<

package/lnd_methods/onchain/propose_channel.d.ts

@@ -34,7 +34,7 @@ export type ProposeChannelArgs = AuthenticatedLightningArgs<{
  * Channel proposals can allow for cooperative close delays or external funding
 flows.
  *
- * Requires `offchain:write`, `onchain:write` permissions
+ * Requires `address:read`, `offchain:write`, `onchain:write` permissions
  *
  * Requires LND compiled with `walletrpc` build tag
  */

package/lnd_methods/unauthenticated/get_wallet_status.d.ts

@@ -24,7 +24,9 @@ export type GetWalletStatusResult = {
 /**
  * Get wallet status.
  *
- * Requires `info:read` permission
+ * This method is not supported on LND 0.12.1 and below
+ *
+ * `is_ready` is not supported on LND 0.13.3 and below
  */
 export const getWalletStatus: UnauthenticatedLightningMethod<
   {lnd: UnauthenticatedLnd},

package/lnd_methods/unauthenticated/subscribe_to_wallet_status.d.ts

@@ -24,5 +24,7 @@ export type SubscribeToWalletStatusStartingEvent = EmptyObject;
  * Subscribe to wallet status events
  *
  * This method is not supported on LND 0.12.1 and below
+ *
+ * `ready` is not supported on LND 0.13.3 and below
  */
 export const subscribeToWalletStatus: UnauthenticatedLightningSubscription;

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.3.7",
+    "@grpc/grpc-js": "1.4.1",
     "@grpc/proto-loader": "0.6.5",
     "@types/express": "4.17.13",
-    "@types/node": "16.10.4",
+    "@types/node": "16.11.1",
     "@types/request": "2.48.7",
     "@types/ws": "8.2.0",
     "async": "3.2.1",
@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.10.7"
+  "version": "4.11.0"
 }

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

@@ -0,0 +1,31 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {getFailedPayments, GetFailedPaymentsResult} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const limit = 1;
+const token = 'token';
+
+expectError(getFailedPayments());
+expectError(getFailedPayments({}));
+expectError(getFailedPayments({lnd, limit, token})); // ExpectedNoLimitWhenPagingPayFailuresWithToken
+
+expectType<GetFailedPaymentsResult>(await getFailedPayments({lnd}));
+expectType<GetFailedPaymentsResult>(await getFailedPayments({lnd, limit}));
+expectType<GetFailedPaymentsResult>(await getFailedPayments({lnd, token}));
+
+expectType<void>(
+  getFailedPayments({lnd}, (error, result) => {
+    expectType<GetFailedPaymentsResult>(result);
+  })
+);
+expectType<void>(
+  getFailedPayments({lnd, limit}, (error, result) => {
+    expectType<GetFailedPaymentsResult>(result);
+  })
+);
+expectType<void>(
+  getFailedPayments({lnd, token}, (error, result) => {
+    expectType<GetFailedPaymentsResult>(result);
+  })
+);

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

@@ -0,0 +1,46 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {
+  subscribeToRpcRequests,
+  SubscribeToRpcRequestsResult,
+} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const id = 'id';
+const is_intercepting_close_channel_requests = true;
+const is_intercepting_open_channel_requests = true;
+const is_intercepting_pay_via_routes_requests = true;
+
+expectError(subscribeToRpcRequests());
+expectError(subscribeToRpcRequests({}));
+
+expectType<SubscribeToRpcRequestsResult>(await subscribeToRpcRequests({lnd}));
+expectType<SubscribeToRpcRequestsResult>(
+  await subscribeToRpcRequests({
+    lnd,
+    id,
+    is_intercepting_close_channel_requests,
+    is_intercepting_open_channel_requests,
+    is_intercepting_pay_via_routes_requests,
+  })
+);
+
+expectType<void>(
+  subscribeToRpcRequests({lnd}, (err, res) => {
+    expectType<SubscribeToRpcRequestsResult>(res);
+  })
+);
+expectType<void>(
+  subscribeToRpcRequests(
+    {
+      lnd,
+      id,
+      is_intercepting_close_channel_requests,
+      is_intercepting_open_channel_requests,
+      is_intercepting_pay_via_routes_requests,
+    },
+    (err, res) => {
+      expectType<SubscribeToRpcRequestsResult>(res);
+    }
+  )
+);