lightning 7.1.0 → 7.1.1

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.1
 
 - `signChainAddressMessage`: Add method to sign a message given a chain address
 - `verifyChainAddressMessage`: Add method to verify a chain address message

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.1",
     "@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.1"
 }

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