lightning 7.1.0 → 7.1.2

package/.github/workflows/unit-test.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: ['12', '14', '16']
+        node: ['14', '16', '18']
     steps:
     - uses: actions/checkout@v2
     - uses: actions/setup-node@v2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 7.1.0
+## 7.1.2
 
 - `signChainAddressMessage`: Add method to sign a message given a chain address
 - `verifyChainAddressMessage`: Add method to verify a chain address message

package/grpc/protos/lightning.proto

@@ -582,16 +582,22 @@ service Lightning {
     */
     rpc ListAliases (ListAliasesRequest) returns (ListAliasesResponse);
 
-    rpc LookupHtlc (LookupHtlcRequest) returns (LookupHtlcResponse);
+    /*
+    LookupHtlcResolution retrieves a final htlc resolution from the database.
+    If the htlc has no final resolution yet, a NotFound grpc status code is
+    returned.
+    */
+    rpc LookupHtlcResolution (LookupHtlcResolutionRequest)
+        returns (LookupHtlcResolutionResponse);
 }
 
-message LookupHtlcRequest {
+message LookupHtlcResolutionRequest {
     uint64 chan_id = 1;
 
     uint64 htlc_index = 2;
 }
 
-message LookupHtlcResponse {
+message LookupHtlcResolutionResponse {
     bool settled = 1;
 
     bool offchain = 2;
@@ -1531,6 +1537,9 @@ message Channel {
 
     // This is the confirmed / on-chain zero-conf SCID.
     uint64 zero_conf_confirmed_scid = 33;
+
+    // The configured alias name of our peer.
+    string peer_alias = 34;
 }
 
 message ListChannelsRequest {
@@ -1544,6 +1553,11 @@ message ListChannelsRequest {
     empty, all channels will be returned.
     */
     bytes peer = 5;
+
+    // Informs the server if the peer alias lookup per channel should be
+    // enabled. It is turned off by default in order to avoid degradation of
+    // performance for existing clients.
+    bool peer_alias_lookup = 6;
 }
 message ListChannelsResponse {
     // The list of active channels

package/lnd_methods/macaroon/methods.json

@@ -285,7 +285,7 @@
     "type": "default"
   },
   "getSettlementStatus": {
-    "method": "LookupHtlc",
+    "method": "LookupHtlcResolution",
     "type": "default"
   },
   "getSweepTransactions": {

package/lnd_methods/offchain/get_settlement_status.d.ts

@@ -22,6 +22,8 @@ export type GetSettlementStatusResult = {
  *
  * Note: this method is not supported in LND versions 0.15.5 and below
  *
+ * Requires LND running with `--store-final-htlc-resolutions` flag
+ *
  * Requires `offchain:read` permissions
  */
 export const getSettlementStatus: AuthenticatedLightningMethod<

package/lnd_methods/offchain/get_settlement_status.js

@@ -5,15 +5,18 @@ const {returnResult} = require('asyncjs-util');
 const {isLnd} = require('./../../lnd_requests');
 
 const errorNotFound = 'htlc unknown';
-const errorUnimplemented = 'unknown method LookupHtlc for service lnrpc.Lightning';
+const errorUninitiated = 'cannot lookup with flag --store-final-htlc-resolutions=false';
+const errorUnimplemented = 'unknown method LookupHtlcResolution for service lnrpc.Lightning';
 const isBoolean = n => n === false || n === true;
-const method = 'lookupHtlc';
+const method = 'lookupHtlcResolution';
 const type = 'default';
 
 /** Get the settlement status of a received HTLC
 
   Note: this method is not supported in LND versions 0.15.5 and below
 
+  Requires LND running with `--store-final-htlc-resolutions` flag
+
   Requires `offchain:read` permissions
 
   {
@@ -60,7 +63,11 @@ module.exports = ({channel, lnd, payment}, cbk) => {
           }
 
           if (!!err && err.details === errorUnimplemented) {
-            return cbk([501, 'LookupHtlcMethodUnsupported']);
+            return cbk([501, 'LookupHtlcResolutionMethodUnsupported']);
+          }
+
+          if (!!err && err.details == errorUninitiated) {
+            return cbk([404, 'LookupHtlcResolutionMethodUninitiated']);
           }
 
           if (!!err) {

package/lnd_methods/onchain/index.d.ts

@@ -24,6 +24,7 @@ export * from './request_chain_fee_increase';
 export * from './send_to_chain_address';
 export * from './send_to_chain_addresses';
 export * from './send_to_chain_output_scripts';
+export * from './sign_chain_address_message';
 export * from './set_autopilot';
 export * from './sign_psbt';
 export * from './subscribe_to_blocks';
@@ -32,3 +33,4 @@ export * from './subscribe_to_chain_spend';
 export * from './subscribe_to_transactions';
 export * from './unlock_utxo';
 export * from './update_chain_transaction';
+export * from './verify_chain_address_message';

package/lnd_methods/onchain/sign_chain_address_message.d.ts

@@ -0,0 +1,30 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type SignChainAddressMessageArgs = AuthenticatedLightningArgs<{
+  /** Chain Address String */
+  address: string;
+  /** Message To Sign String */
+  message: string;
+}>;
+
+export type SignChainAddressMessageResult = {
+  /** Hex Encoded Signature String */
+  signature: string;
+};
+
+/**
+ * Sign a chain address message using ECDSA
+ *
+ * Note: this method is not supported in LND versions 0.15.5 and below
+ *
+ * Requires LND built with `walletrpc` tag
+ *
+ * `onchain:write` permission is required
+ */
+export const signChainAddressMessage: AuthenticatedLightningMethod<
+  SignChainAddressMessageArgs,
+  SignChainAddressMessageResult
+>;

package/lnd_methods/onchain/verify_chain_address_message.d.ts

@@ -0,0 +1,32 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type VerifyChainAddressMessageArgs = AuthenticatedLightningArgs<{
+  /** Chain Address String */
+  address: string;
+  /** Message to Verify String */
+  message: string;
+  /** Hex Encoded Signature String */
+  signature: string;
+}>;
+
+export type VerifyChainAddressMessageResult = {
+  /** Public Key Hex String */
+  signed_by: string;
+};
+
+/**
+ * Verify a chain address message using ECDSA
+ *
+ * Note: this method is not supported in LND versions 0.15.5 and below
+ *
+ * Requires LND built with `walletrpc` tag
+ *
+ * `onchain:write` permission is required
+ */
+export const verifyChainAddressMessage: AuthenticatedLightningMethod<
+  VerifyChainAddressMessageArgs,
+  VerifyChainAddressMessageResult
+>;

package/package.json

@@ -7,17 +7,17 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.9",
+    "@grpc/grpc-js": "1.8.11",
     "@grpc/proto-loader": "0.7.5",
     "@types/express": "4.17.17",
-    "@types/node": "18.13.0",
+    "@types/node": "18.14.4",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.4",
     "async": "3.2.4",
     "asyncjs-util": "1.2.11",
     "bitcoinjs-lib": "6.1.0",
     "bn.js": "5.2.1",
-    "body-parser": "1.20.1",
+    "body-parser": "1.20.2",
     "bolt07": "1.8.3",
     "bolt09": "0.2.5",
     "cbor": "8.1.0",
@@ -26,7 +26,7 @@
     "invoices": "2.2.3",
     "psbt": "2.7.2",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "3.6.0"
+    "type-fest": "3.6.1"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "7.1.0"
+  "version": "7.1.2"
 }

package/test/lnd_methods/offchain/test_get_settlement_status.js

@@ -5,7 +5,7 @@ const {getSettlementStatus} = require('./../../../');
 const makeLnd = ({err, res}) => {
   const result = res === undefined ? {offchain: true, settled: true} : res;
 
-  return {default: {lookupHtlc: ({}, cbk) => cbk(err, result)}};
+  return {default: {lookupHtlcResolution: ({}, cbk) => cbk(err, result)}};
 };
 
 const makeArgs = overrides => {
@@ -38,9 +38,26 @@ const tests = [
     error: [404, 'PaymentNotFound'],
   },
   {
-    args: makeArgs({lnd: makeLnd({err: {details: 'unknown method LookupHtlc for service lnrpc.Lightning'}})}),
+    args: makeArgs({
+      lnd: makeLnd({
+        err: {
+          details: 'unknown method LookupHtlcResolution for service lnrpc.Lightning',
+        },
+      }),
+    }),
     description: 'A method not supported error is returned',
-    error: [501, 'LookupHtlcMethodUnsupported'],
+    error: [501, 'LookupHtlcResolutionMethodUnsupported'],
+  },
+  {
+    args: makeArgs({
+      lnd: makeLnd({
+        err: {
+          details: 'cannot lookup with flag --store-final-htlc-resolutions=false',
+        },
+      }),
+    }),
+    description: 'A method not supported error is returned',
+    error: [404, 'LookupHtlcResolutionMethodUninitiated'],
   },
   {
     args: makeArgs({lnd: makeLnd({err: 'err'})}),

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

@@ -0,0 +1,18 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+type TestArgs = AuthenticatedLightningArgs;
+type TestResult = unknown;
+type TestMethod = AuthenticatedLightningMethod<TestArgs, TestResult>;
+
+const authenticatedLightningMethod: TestMethod = async () => {};
+
+const lnd = {} as AuthenticatedLnd;
+
+expectError(authenticatedLightningMethod());
+expectError(authenticatedLightningMethod({}));
+expectType(authenticatedLightningMethod({lnd}));

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

@@ -0,0 +1,27 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {
+  signChainAddressMessage,
+  SignChainAddressMessageResult,
+} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const address = '';
+const message = '';
+
+expectError(signChainAddressMessage({lnd, address}));
+expectError(signChainAddressMessage({lnd, message}));
+
+expectType<SignChainAddressMessageResult>(
+  await signChainAddressMessage({
+    lnd,
+    address,
+    message,
+  }),
+);
+
+expectType<void>(
+  signChainAddressMessage({lnd, address, message}, (error, result) => {
+    expectType<SignChainAddressMessageResult>(result);
+  }),
+);

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

@@ -0,0 +1,32 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {
+  verifyChainAddressMessage,
+  VerifyChainAddressMessageResult,
+} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const address = '';
+const message = '';
+const signature = '';
+
+expectError(verifyChainAddressMessage({lnd, address}));
+expectError(verifyChainAddressMessage({lnd, message}));
+expectError(verifyChainAddressMessage({lnd, address, message}));
+expectError(verifyChainAddressMessage({lnd, address, signature}));
+expectError(verifyChainAddressMessage({lnd, message, signature}));
+
+expectType<VerifyChainAddressMessageResult>(
+  await verifyChainAddressMessage({
+    lnd,
+    address,
+    message,
+    signature,
+  }),
+);
+
+expectType<void>(
+  verifyChainAddressMessage({lnd, address, message, signature}, (error, result) => {
+    expectType<VerifyChainAddressMessageResult>(result);
+  }),
+);