ln-service 54.9.2 → 54.10.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 54.10.1
+
+- `signChainAddressMessage`: Add method to sign a message given a chain address
+- `verifyChainAddressMessage`: Add method to verify a chain address message
+
 ## 54.9.2
 
 - `getChainAddresses`: Add method to get the list of chain addresses

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2021 Alex Bosworth
+Copyright (c) 2017-2023 Alex Bosworth
 Copyright (c) 2017 BitcoinJS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

package/README.md

@@ -220,6 +220,7 @@ for `unlocker` methods.
 - [setAutopilot](#setautopilot) - Turn autopilot on and set autopilot scores
 - [settleHodlInvoice](#settlehodlinvoice) - Accept a HODL HTLC invoice
 - [signBytes](#signbytes) -  Sign over arbitrary bytes with node keys
+- [signChainAddressMessage](#signchainaddressmessage) - Sign with chain address
 - [signMessage](#signmessage) - Sign a message with the node identity key
 - [signPsbt](#signpsbt) - Sign and finalize an unsigned PSBT using internal keys
 - [signTransaction](#signtransaction) - Sign an on-chain transaction
@@ -268,6 +269,7 @@ for `unlocker` methods.
 - [verifyBackup](#verifybackup) - Verify a channel backup
 - [verifyBackups](#verifybackups) - Verify a set of channel backups
 - [verifyBytesSignature](#verifybytessignature) - Verify a signature over bytes
+- [verifyChainAddressMessage](#verifychainaddressmessage) - Check chain message
 - [verifyMessage](#verifymessage) - Verify a message signed by a node identity
 
 ## Additional Libraries
@@ -4918,6 +4920,40 @@ const {signature} = await signBytes({
 });
 ```
 
+### signChainAddressMessage
+
+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
+
+    {
+      address: <Chain Address String>
+      lnd: <Authenticated LND API Object>
+      message: <Message To Sign String>
+    }
+
+    @returns via cbk or Promise
+    {
+      signature: <Hex Encoded Signature String>
+    }
+
+```node
+const {createChainAddress} = require('ln-service');
+const {signChainAddressMessage} = require('ln-service');
+
+const {address} = await createChainAddress({lnd});
+
+const {signature} = await signChainAddressMessage({
+  address,
+  lnd,
+  message: 'hello world',
+});
+```
+
 ### signMessage
 
 Sign a message
@@ -7401,6 +7437,45 @@ const validity = await verifyBytesSignature({
 });
 ```
 
+### verifyChainAddressMessage
+
+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
+
+    {
+      address: <Chain Address String>
+      lnd: <Authenticated LND API Object>
+      message: <Message to Verify String>
+      signature: <Hex Encoded Signature String>
+    }
+
+    @returns via cbk or Promise
+    {
+      signed_by: <Public Key Hex String>
+    }
+
+```node
+const {createChainAddress} = require('ln-service');
+const {signChainAddressMessage} = require('ln-service');
+
+const {address} = await createChainAddress({lnd});
+
+const message = 'hello world';
+
+const {signature} = await signChainAddressMessage({address, lnd, message});
+
+try {
+  await verifyChainAddressMessage({address, lnd, message, signature});
+} catch (err) {
+  // Signature failed to vaildate
+}
+```
+
 ### verifyMessage
 
 Verify a message was signed by a known pubkey

package/index.js

@@ -108,6 +108,7 @@ const {sendToChainOutputScripts} = require('lightning');
 const {setAutopilot} = require('lightning');
 const {settleHodlInvoice} = require('lightning');
 const {signBytes} = require('lightning');
+const {signChainAddressMessage} = require('lightning');
 const {signMessage} = require('lightning');
 const {signPsbt} = require('lightning');
 const {signTransaction} = require('lightning');
@@ -149,6 +150,7 @@ const {verifyAccess} = require('lightning');
 const {verifyBackup} = require('lightning');
 const {verifyBackups} = require('lightning');
 const {verifyBytesSignature} = require('lightning');
+const {verifyChainAddressMessage} = require('lightning');
 const {verifyMessage} = require('lightning');
 
 module.exports = {
@@ -262,6 +264,7 @@ module.exports = {
   setAutopilot,
   settleHodlInvoice,
   signBytes,
+  signChainAddressMessage,
   signMessage,
   signPsbt,
   signTransaction,
@@ -303,5 +306,6 @@ module.exports = {
   verifyBackup,
   verifyBackups,
   verifyBytesSignature,
+  verifyChainAddressMessage,
   verifyMessage,
 };

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.18.2",
     "invoices": "2.2.3",
-    "lightning": "7.0.8",
+    "lightning": "7.1.1",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.12.1"
@@ -22,11 +22,11 @@
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.4",
     "asyncjs-util": "1.2.11",
-    "bip32": "3.1.0",
+    "bip32": "4.0.0",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "6.1.0",
     "bn.js": "5.2.1",
-    "bs58check": "2.1.2",
+    "bs58check": "3.0.1",
     "ecpair": "2.1.0",
     "ln-docker-daemons": "4.1.1",
     "p2tr": "1.3.3",
@@ -64,5 +64,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "test": "echo $DOCKER_LND_VERSION && tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/peersrpc-integration/*.js test/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "54.9.2"
+  "version": "54.10.1"
 }

package/test/integration/test_get_settlement_status.js

@@ -15,30 +15,39 @@ const tokens = 100;
 
 // Get the settlement status of an HTLC
 test(`Get settlement status`, async ({end, equal, strictSame}) => {
-  const {kill, nodes} = await spawnLightningCluster({size});
+  // LND 0.15.5 and below do not support settlement status lookups
+  {
+    const {kill, nodes} = await spawnLightningCluster({size});
 
-  const [{generate, lnd}, target] = nodes;
+    const [{generate, lnd}, target] = nodes;
 
-  // LND 0.15.5 and below do not support settlement status lookups
-  try {
-    await getSettlementStatus({
-      lnd: target.lnd,
-      channel: fakeChannelId,
-      payment: Number(),
-    });
-  } catch (err) {
-    const [code, message] = err;
+    try {
+      await getSettlementStatus({
+        lnd: target.lnd,
+        channel: fakeChannelId,
+        payment: Number(),
+      });
+    } catch (err) {
+      const [code, message] = err;
 
-    if (code !== 404) {
-      equal(code, 501, 'Method unsupported');
-      equal(message, 'LookupHtlcMethodUnsupported', 'Got unsupported message');
+      if (code !== 404) {
+        equal(code, 501, 'Method unsupported');
+        equal(message, 'LookupHtlcMethodUnsupported', 'Got unsupported message');
 
-      await kill({});
+        await kill({});
 
-      return end();
+        return end();
+      }
     }
   }
 
+  const {kill, nodes} = await spawnLightningCluster({
+    size,
+    lnd_configuration: ['--store-final-htlc-resolutions'],
+  });
+
+  const [{generate, lnd}, target] = nodes;
+
   try {
     const channel = await setupChannel({generate, lnd, to: target});
 

package/test/integration/test_trusted_funding.js

@@ -164,6 +164,17 @@ test(`Open unconfirmed channels`, async ({end, equal, match, strictSame}) => {
 
     match(otherId, /16000000x0/, 'Got ephemeral id');
 
+    // Make sure the channel is really active
+    await asyncRetry({interval, times}, async () => {
+      const {channels} = await getChannels({lnd});
+
+      const [channel] = channels;
+
+      if (!channel.time_online) {
+        throw new Error('ExpectedChannelOnline');
+      }
+    });
+
     await asyncRetry({interval, times}, async () => {
       await closeChannel({lnd, id: confirmed.id});
     });

package/test/walletrpc-integration/test_get_master_public_keys.js

@@ -59,8 +59,8 @@ test(`Get master public keys`, async ({end, equal, strictSame}) => {
     // Convert the key from base58 into its raw form
     const rawKey = bs58check.decode(masterIdentityKey.extended_public_key);
 
-    const chainCode = chainCodeFromMasterPublicKey(rawKey);
-    const publicKey = publicKeyFromMasterPublicKey(rawKey);
+    const chainCode = Buffer.from(chainCodeFromMasterPublicKey(rawKey));
+    const publicKey = Buffer.from(publicKeyFromMasterPublicKey(rawKey));
 
     // Make a bip32 object to derive from
     const masterKey = fromPublicKey(publicKey, chainCode);

package/test/walletrpc-integration/test_sign_chain_address_message.js

@@ -0,0 +1,32 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {createChainAddress} = require('./../../');
+const {signChainAddressMessage} = require('./../../');
+
+const message = 'message';
+
+// Signing a chain address message should result in a signature
+test(`Sign chain address message`, async ({end, equal}) => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [control] = nodes;
+
+  const {lnd} = control;
+
+  const {address} = await createChainAddress({lnd});
+
+  try {
+    const {signature} = await signChainAddressMessage({address, lnd, message});
+
+    equal(!!signature, true, 'Got a signature for a chain address');
+  } catch (err) {
+    const [code, message] = err;
+
+    equal(message, 'BackingLndDoesNotSupportSigningChainMessages', 'missing');
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/walletrpc-integration/test_verify_chain_address_message.js

@@ -0,0 +1,58 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {createChainAddress} = require('./../../');
+const {signChainAddressMessage} = require('./../../');
+const {verifyChainAddressMessage} = require('./../../');
+
+const message = 'message';
+
+// Verifying a chain address message signature should result in verification
+test(`Verify chain address message`, async ({end, equal}) => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [control] = nodes;
+
+  const {lnd} = control;
+
+  const {address} = await createChainAddress({lnd});
+
+  try {
+    const {signature} = await signChainAddressMessage({address, lnd, message});
+
+    const verify = await verifyChainAddressMessage({
+      address,
+      lnd,
+      message,
+      signature,
+    });
+
+    equal(verify.signed_by.length, 66, 'Got public key');
+  } catch (err) {
+    const [code, message] = err;
+
+    equal(message, 'BackingLndDoesNotSupportSigningChainMessages', 'missing');
+
+    await kill({});
+
+    return end();
+  }
+
+  try {
+    const verify = await verifyChainAddressMessage({
+      address,
+      lnd,
+      message,
+      signature: '1f54fe4a1332633d3c625cf8de41004f3ce3978f7e6e9845dea944e46fab878ec5676e08d44b505ede70fa2e693192405e16baf3e18de44987db6d9e82d4f14907',
+    });
+  } catch (err) {
+    const [code, message] = err;
+
+    equal(code, 400, 'Invalid signature code');
+    equal(message, 'InvalidSignatureReceivedForChainAddress', 'invalid sig');
+  }
+
+  await kill({});
+
+  return end();
+});