lightning 7.0.4 → 7.0.6

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 7.0.4
+## 7.0.6
 
 - `getChainAddresses`: Add method to get the list of chain addresses
 

package/README.md

@@ -8,6 +8,8 @@ Methods for working with the Lightning Network
 
 - [bitpay.com crypto-rpc](https://bitpay.com/) -
     https://github.com/bitpay/crypto-rpc
+- [channel.ninja](https://channel.ninja/) -
+    https://github.com/channelninja/channel.ninja
 - [coinos.io](https://coinos.io/) - https://github.com/coinos/coinos-server
 - [Galoy](https://galoy.io/) - https://github.com/GaloyMoney/galoy
 - [Lightning Poker](https://lightning-poker.com/) -
@@ -18,8 +20,8 @@ Methods for working with the Lightning Network
     https://github.com/ibz/lightning-shell
 - [LNMarkets](https://twitter.com/lnmarkets) -
     https://github.com/lnmarkets/umbrel
-- [LNPingBot](https://github.com/swissrouting/lnpingbot) - https://github.com/swissrouting/lnpingbot
-- [mempool.space](https://mempool.space/) - https://github.com/mempool/mempool
+- [LNPingBot](https://github.com/swissrouting/lnpingbot) -
+    https://github.com/swissrouting/lnpingbot
 - [p2plnbot](https://telegram.me/lnp2pbot) - https://github.com/grunch/p2plnbot
 - [rekr](https://rekr.app/) - https://github.com/ryan-lingle/rekr
 - [stackernews](https://stacker.news/) -

package/grpc/protos/lightning.proto

@@ -567,6 +567,10 @@ service Lightning {
     /* lncli: `subscribecustom`
     SubscribeCustomMessages subscribes to a stream of incoming custom peer
     messages.
+
+    To include messages with type outside of the custom range (>= 32768) lnd
+    needs to be compiled with  the `dev` build tag, and the message type to
+    override should be specified in lnd's experimental protocol configuration.
     */
     rpc SubscribeCustomMessages (SubscribeCustomMessagesRequest)
         returns (stream CustomMessage);
@@ -612,6 +616,9 @@ message SendCustomMessageRequest {
     bytes peer = 1;
 
     // Message type. This value needs to be in the custom range (>= 32768).
+    // To send a type < custom range, lnd needs to be compiled with the `dev`
+    // build tag, and the message type to override should be specified in lnd's
+    // experimental protocol configuration.
     uint32 type = 2;
 
     // Raw message data.
@@ -1905,6 +1912,9 @@ message GetInfoResponse {
     Indicates whether the HTLC interceptor API is in always-on mode.
     */
     bool require_htlc_interceptor = 21;
+
+    // Indicates whether final htlc resolutions are stored on disk.
+    bool store_final_htlc_resolutions = 22;
 }
 
 message GetRecoveryInfoRequest {
@@ -3387,7 +3397,7 @@ message Invoice {
     */
     bytes description_hash = 10;
 
-    // Payment request expiry time in seconds. Default is 3600 (1 hour).
+    // Payment request expiry time in seconds. Default is 86400 (24 hours).
     int64 expiry = 11;
 
     // Fallback on-chain address.

package/grpc/protos/signer.proto

@@ -22,8 +22,8 @@ service Signer {
     /*
     ComputeInputScript generates a complete InputIndex for the passed
     transaction with the signature as defined within the passed SignDescriptor.
-    This method should be capable of generating the proper input script for
-    both regular p2wkh output and p2wkh outputs nested within a regular p2sh
+    This method should be capable of generating the proper input script for both
+    regular p2wkh/p2tr outputs and p2wkh outputs nested within a regular p2sh
     output.
 
     Note that when using this method to sign inputs belonging to the wallet,
@@ -381,6 +381,7 @@ message VerifyMessageReq {
     */
     bool is_schnorr_sig = 4;
 }
+
 message VerifyMessageResp {
     // Whether the signature was valid over the given message.
     bool valid = 1;
@@ -443,12 +444,33 @@ message TaprootTweakDesc {
     bool key_spend_only = 2;
 }
 
+enum MuSig2Version {
+    /*
+    The default value on the RPC is zero for enums so we need to represent an
+    invalid/undefined version by default to make sure clients upgrade their
+    software to set the version explicitly.
+    */
+    MUSIG2_VERSION_UNDEFINED = 0;
+
+    /*
+    The version of MuSig2 that lnd 0.15.x shipped with, which corresponds to the
+    version v0.4.0 of the MuSig2 BIP draft.
+    */
+    MUSIG2_VERSION_V040 = 1;
+
+    /*
+    The current version of MuSig2 which corresponds to the version v1.0.0rc2 of
+    the MuSig2 BIP draft.
+    */
+    MUSIG2_VERSION_V100RC2 = 2;
+}
+
 message MuSig2CombineKeysRequest {
     /*
-    A list of all public keys (serialized in 32-byte x-only format!)
-    participating in the signing session. The list will always be sorted
-    lexicographically internally. This must include the local key which is
-    described by the above key_loc.
+    A list of all public keys (serialized in 32-byte x-only format for v0.4.0
+    and 33-byte compressed format for v1.0.0rc2!) participating in the signing
+    session. The list will always be sorted lexicographically internally. This
+    must include the local key which is described by the above key_loc.
     */
     repeated bytes all_signer_pubkeys = 1;
 
@@ -464,6 +486,14 @@ message MuSig2CombineKeysRequest {
     on-chain.
     */
     TaprootTweakDesc taproot_tweak = 3;
+
+    /*
+    The mandatory version of the MuSig2 BIP draft to use. This is necessary to
+    differentiate between the changes that were made to the BIP while this
+    experimental RPC was already released. Some of those changes affect how the
+    combined key and nonces are created.
+    */
+    MuSig2Version version = 4;
 }
 
 message MuSig2CombineKeysResponse {
@@ -481,6 +511,11 @@ message MuSig2CombineKeysResponse {
     is used.
     */
     bytes taproot_internal_key = 2;
+
+    /*
+    The version of the MuSig2 BIP that was used to combine the keys.
+    */
+    MuSig2Version version = 4;
 }
 
 message MuSig2SessionRequest {
@@ -490,10 +525,10 @@ message MuSig2SessionRequest {
     KeyLocator key_loc = 1;
 
     /*
-    A list of all public keys (serialized in 32-byte x-only format!)
-    participating in the signing session. The list will always be sorted
-    lexicographically internally. This must include the local key which is
-    described by the above key_loc.
+    A list of all public keys (serialized in 32-byte x-only format for v0.4.0
+    and 33-byte compressed format for v1.0.0rc2!) participating in the signing
+    session. The list will always be sorted lexicographically internally. This
+    must include the local key which is described by the above key_loc.
     */
     repeated bytes all_signer_pubkeys = 2;
 
@@ -515,6 +550,14 @@ message MuSig2SessionRequest {
     on-chain.
     */
     TaprootTweakDesc taproot_tweak = 5;
+
+    /*
+    The mandatory version of the MuSig2 BIP draft to use. This is necessary to
+    differentiate between the changes that were made to the BIP while this
+    experimental RPC was already released. Some of those changes affect how the
+    combined key and nonces are created.
+    */
+    MuSig2Version version = 6;
 }
 
 message MuSig2SessionResponse {
@@ -552,6 +595,11 @@ message MuSig2SessionResponse {
     now.
     */
     bool have_all_nonces = 5;
+
+    /*
+    The version of the MuSig2 BIP that was used to create the session.
+    */
+    MuSig2Version version = 6;
 }
 
 message MuSig2RegisterNoncesRequest {

package/grpc/protos/walletkit.proto

@@ -79,6 +79,47 @@ service WalletKit {
     */
     rpc ListAddresses (ListAddressesRequest) returns (ListAddressesResponse);
 
+    /*
+    SignMessageWithAddr returns the compact signature (base64 encoded) created
+    with the private key of the provided address. This requires the address
+    to be solely based on a public key lock (no scripts). Obviously the internal
+    lnd wallet has to possess the private key of the address otherwise
+    an error is returned.
+
+    This method aims to provide full compatibility with the bitcoin-core and
+    btcd implementation. Bitcoin-core's algorithm is not specified in a
+    BIP and only applicable for legacy addresses. This method enhances the
+    signing for additional address types: P2WKH, NP2WKH, P2TR.
+    For P2TR addresses this represents a special case. ECDSA is used to create
+    a compact signature which makes the public key of the signature recoverable.
+    */
+    rpc SignMessageWithAddr (SignMessageWithAddrRequest)
+        returns (SignMessageWithAddrResponse);
+
+    /*
+    VerifyMessageWithAddr returns the validity and the recovered public key of
+    the provided compact signature (base64 encoded). The verification is
+    twofold. First the validity of the signature itself is checked and then
+    it is verified that the recovered public key of the signature equals
+    the public key of the provided address. There is no dependence on the
+    private key of the address therefore also external addresses are allowed
+    to verify signatures.
+    Supported address types are P2PKH, P2WKH, NP2WKH, P2TR.
+
+    This method is the counterpart of the related signing method
+    (SignMessageWithAddr) and aims to provide full compatibility to
+    bitcoin-core's implementation. Although bitcoin-core/btcd only provide
+    this functionality for legacy addresses this function enhances it to
+    the address types: P2PKH, P2WKH, NP2WKH, P2TR.
+
+    The verification for P2TR addresses is a special case and requires the
+    ECDSA compact signature to compare the reovered public key to the internal
+    taproot key. The compact ECDSA signature format was used because there
+    are still no known compact signature schemes for schnorr signatures.
+    */
+    rpc VerifyMessageWithAddr (VerifyMessageWithAddrRequest)
+        returns (VerifyMessageWithAddrResponse);
+
     /*
     ImportAccount imports an account backed by an account extended public key.
     The master key fingerprint denotes the fingerprint of the root key
@@ -497,6 +538,43 @@ message ListAddressesResponse {
     repeated AccountWithAddresses account_with_addresses = 1;
 }
 
+message SignMessageWithAddrRequest {
+    // The message to be signed. When using REST, this field must be encoded as
+    // base64.
+    bytes msg = 1;
+
+    // The address which will be used to look up the private key and sign the
+    // corresponding message.
+    string addr = 2;
+}
+
+message SignMessageWithAddrResponse {
+    // The compact ECDSA signature for the given message encoded in base64.
+    string signature = 1;
+}
+
+message VerifyMessageWithAddrRequest {
+    // The message to be signed. When using REST, this field must be encoded as
+    // base64.
+    bytes msg = 1;
+
+    // The compact ECDSA signature to be verified over the given message
+    // ecoded in base64.
+    string signature = 2;
+
+    // The address which will be used to look up the public key and verify the
+    // the signature.
+    string addr = 3;
+}
+
+message VerifyMessageWithAddrResponse {
+    // Whether the signature was valid over the given message.
+    bool valid = 1;
+
+    // The pubkey recovered from the signature.
+    bytes pubkey = 2;
+}
+
 message ImportAccountRequest {
     // A name to identify the account with.
     string name = 1;
@@ -917,6 +995,23 @@ message LabelTransactionRequest {
 message LabelTransactionResponse {
 }
 
+// The possible change address types for default accounts and single imported
+// public keys. By default, P2WPKH will be used. We don't provide the
+// possibility to choose P2PKH as it is a legacy key scope, nor NP2WPKH as
+// no key scope permits to do so. For custom accounts, no change type should
+// be provided as the coin selection key scope will always be used to generate
+// the change address.
+enum ChangeAddressType {
+    // CHANGE_ADDRESS_TYPE_UNSPECIFIED indicates that no change address type is
+    // provided. We will then use P2WPKH address type for change (BIP0084 key
+    // scope).
+    CHANGE_ADDRESS_TYPE_UNSPECIFIED = 0;
+
+    // CHANGE_ADDRESS_TYPE_P2TR indicates to use P2TR address for change output
+    // (BIP0086 key scope).
+    CHANGE_ADDRESS_TYPE_P2TR = 1;
+}
+
 message FundPsbtRequest {
     oneof template {
         /*
@@ -962,6 +1057,12 @@ message FundPsbtRequest {
 
     // Whether unconfirmed outputs should be used as inputs for the transaction.
     bool spend_unconfirmed = 7;
+
+    // The address type for the change. If empty, P2WPKH addresses will be used
+    // for default accounts and single imported public keys. For custom
+    // accounts, no change type should be provided as the coin selection key
+    // scope will always be used to generate the change address.
+    ChangeAddressType change_type = 8;
 }
 message FundPsbtResponse {
     /*

package/lnd_methods/onchain/fund_psbt.js

@@ -7,6 +7,7 @@ const {Transaction} = require('bitcoinjs-lib');
 const {isLnd} = require('./../../lnd_requests');
 
 const asOutpoint = n => `${n.transaction_id}:${n.transaction_vout}`;
+const defaultChangeType = 'CHANGE_ADDRESS_TYPE_P2TR';
 const defaultConfirmationTarget = 6;
 const expirationAsDate = epoch => new Date(Number(epoch) * 1e3).toISOString();
 const {fromHex} = Transaction;
@@ -156,6 +157,7 @@ module.exports = (args, cbk) => {
       // Fund the PSBT
       fund: ['fee', 'funding', 'minConfs', ({fee, funding, minConfs}, cbk) => {
         return args.lnd[type][method]({
+          change_type: defaultChangeType,
           min_confs: minConfs !== undefined ? minConfs : undefined,
           psbt: !!args.psbt ? Buffer.from(args.psbt, 'hex') : undefined,
           raw: funding || undefined,

package/lnd_methods/signer/begin_group_signing_session.js

@@ -1,17 +1,21 @@
 const asyncAuto = require('async/auto');
+const asyncReflect = require('async/reflect');
 const {returnResult} = require('asyncjs-util');
 
 const getPublicKey = require('./../address/get_public_key');
 const {isLnd} = require('./../../lnd_requests');
 const {rpcGroupSessionAsSession} = require('./../../lnd_responses');
 
+const defaultVersion = 'MUSIG2_VERSION_V100RC2';
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const {isArray} = Array;
 const isHash = n => /^[0-9A-F]{64}$/i.test(n);
+const messageErrorLegacyVersion = 'error parsing all signer public keys: error parsing signer public key 0 for v1.0.0rc2 (compressed format): malformed public key: invalid length: 32';
 const method = 'muSig2CreateSession';
 const type = 'signer';
 const uniq = arr => Array.from(new Set(arr));
 const unsupportedMessage = 'unknown method MuSig2CreateSession for service signrpc.Signer';
+const versionLegacy = 'MUSIG2_VERSION_V040';
 const xOnlyPublicKeyHexLength = 64;
 const xOnlyPublicKey = hexKey => hexKey.slice(2);
 
@@ -97,6 +101,41 @@ module.exports = (args, cbk) => {
         return cbk();
       }],
 
+      // Create the signing session
+      create: [
+        'getKey',
+        'taprootTweak',
+        asyncReflect(({getKey, taprootTweak}, cbk) =>
+      {
+        const keys = [getKey.public_key].concat(args.public_keys);
+
+        return args.lnd[type][method]({
+          all_signer_pubkeys: keys.map(hexAsBuffer),
+          key_loc: {key_family: args.key_family, key_index: args.key_index},
+          taproot_tweak: taprootTweak,
+          version: defaultVersion,
+        },
+        (err, res) => {
+          if (!!err && err.details === messageErrorLegacyVersion) {
+            return cbk(messageErrorLegacyVersion);
+          }
+
+          if (!!err && err.details === unsupportedMessage) {
+            return cbk([501, 'MuSig2BeginSigningSessionNotSupported']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorCreatingMuSig2Session', {err}]);
+          }
+
+          try {
+            return cbk(null, rpcGroupSessionAsSession(res));
+          } catch (err) {
+            return cbk([503, err.message]);
+          }
+        });
+      })],
+
       // Collect all public keys taking part in the signing session
       publicKeys: ['getKey', ({getKey}, cbk) => {
         // Trim public keys as necessary
@@ -111,16 +150,23 @@ module.exports = (args, cbk) => {
         return cbk(null, uniq(keys));
       }],
 
-      // Create the signing session
-      create: [
+      // Create the signing session with the legacy create if necessary
+      finalCreate: [
+        'create',
         'publicKeys',
         'taprootTweak',
-        ({publicKeys, taprootTweak}, cbk) =>
+        ({create, publicKeys, taprootTweak}, cbk) =>
       {
+        // Exit early when there is no need to use the legacy API
+        if (!create.error || create.error !== messageErrorLegacyVersion) {
+          return cbk(create.error, create.value);
+        }
+
         return args.lnd[type][method]({
           all_signer_pubkeys: publicKeys.map(hexAsBuffer),
           key_loc: {key_family: args.key_family, key_index: args.key_index},
           taproot_tweak: taprootTweak,
+          version: versionLegacy,
         },
         (err, res) => {
           if (!!err && err.details === unsupportedMessage) {
@@ -139,6 +185,6 @@ module.exports = (args, cbk) => {
         });
       }],
     },
-    returnResult({reject, resolve, of: 'create'}, cbk));
+    returnResult({reject, resolve, of: 'finalCreate'}, cbk));
   });
 };

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.2",
-    "@grpc/proto-loader": "0.7.4",
-    "@types/express": "4.17.15",
-    "@types/node": "18.11.18",
+    "@grpc/grpc-js": "1.8.8",
+    "@grpc/proto-loader": "0.7.5",
+    "@types/express": "4.17.17",
+    "@types/node": "18.13.0",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.4",
     "async": "3.2.4",
@@ -26,15 +26,15 @@
     "invoices": "2.2.3",
     "psbt": "2.7.2",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "3.5.1"
+    "type-fest": "3.5.7"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.12",
     "tsd": "0.25.0",
-    "typescript": "4.9.4",
-    "ws": "8.12.0"
+    "typescript": "4.9.5",
+    "ws": "8.12.1"
   },
   "engines": {
     "node": ">=14"
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "7.0.4"
+  "version": "7.0.6"
 }