lightning 5.8.4 → 5.9.0

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Versions
 
-## 5.8.4
+## 5.9.0
+
+- `createChainAddress`: Add support for creating P2TR addresses
+- `getUtxos`: Add support for showing P2TR address types
+
+## 5.8.6
 
 - `getWalletInfo`, `payViaPaymentDetails`: Correct typescript fields
 

package/grpc/protos/lightning.proto

@@ -620,6 +620,38 @@ message Utxo {
     int64 confirmations = 6;
 }
 
+enum OutputScriptType {
+    SCRIPT_TYPE_PUBKEY_HASH = 0;
+    SCRIPT_TYPE_SCRIPT_HASH = 1;
+    SCRIPT_TYPE_WITNESS_V0_PUBKEY_HASH = 2;
+    SCRIPT_TYPE_WITNESS_V0_SCRIPT_HASH = 3;
+    SCRIPT_TYPE_PUBKEY = 4;
+    SCRIPT_TYPE_MULTISIG = 5;
+    SCRIPT_TYPE_NULLDATA = 6;
+    SCRIPT_TYPE_NON_STANDARD = 7;
+    SCRIPT_TYPE_WITNESS_UNKNOWN = 8;
+}
+
+message OutputDetail {
+    // The type of the output
+    OutputScriptType output_type = 1;
+
+    // The address
+    string address = 2;
+
+    // The pkscript in hex
+    string pk_script = 3;
+
+    // The output index used in the raw transaction
+    int64 output_index = 4;
+
+    // The value of the output coin in satoshis
+    int64 amount = 5;
+
+    // Denotes if the output is controlled by the internal wallet
+    bool is_our_address = 6;
+}
+
 message Transaction {
     // The transaction hash
     string tx_hash = 1;
@@ -642,8 +674,12 @@ message Transaction {
     // Fees paid for this transaction
     int64 total_fees = 7;
 
-    // Addresses that received funds for this transaction
-    repeated string dest_addresses = 8;
+    // Addresses that received funds for this transaction. Deprecated as it is
+    // now incorporated in the output_details field.
+    repeated string dest_addresses = 8 [deprecated = true];
+
+    // Outputs that received funds for this transaction
+    repeated OutputDetail output_details = 11;
 
     // The raw transaction hex.
     string raw_tx_hex = 9;
@@ -1102,12 +1138,15 @@ message ListUnspentResponse {
 
 - `p2wkh`: Pay to witness key hash (`WITNESS_PUBKEY_HASH` = 0)
 - `np2wkh`: Pay to nested witness key hash (`NESTED_PUBKEY_HASH` = 1)
+- `p2tr`: Pay to taproot pubkey (`TAPROOT_PUBKEY` = 4)
 */
 enum AddressType {
     WITNESS_PUBKEY_HASH = 0;
     NESTED_PUBKEY_HASH = 1;
     UNUSED_WITNESS_PUBKEY_HASH = 2;
     UNUSED_NESTED_PUBKEY_HASH = 3;
+    TAPROOT_PUBKEY = 4;
+    UNUSED_TAPROOT_PUBKEY = 5;
 }
 
 message NewAddressRequest {
@@ -2502,6 +2541,10 @@ message WalletBalanceResponse {
     // The unconfirmed balance of a wallet(with 0 confirmations)
     int64 unconfirmed_balance = 3;
 
+    // The total amount of wallet UTXOs held in outputs that are locked for
+    // other usage.
+    int64 locked_balance = 5;
+
     // A mapping of each wallet account's name to its balance.
     map<string, WalletAccountBalance> account_balance = 4;
 }

package/grpc/protos/walletkit.proto

@@ -12,7 +12,9 @@ option go_package = "github.com/lightningnetwork/lnd/lnrpc/walletrpc";
 service WalletKit {
     /*
     ListUnspent returns a list of all utxos spendable by the wallet with a
-    number of confirmations between the specified minimum and maximum.
+    number of confirmations between the specified minimum and maximum. By
+    default, all utxos are listed. To list only the unconfirmed utxos, set
+    the unconfirmed_only to true.
     */
     rpc ListUnspent (ListUnspentRequest) returns (ListUnspentResponse);
 
@@ -240,6 +242,14 @@ message ListUnspentRequest {
 
     // An optional filter to only include outputs belonging to an account.
     string account = 3;
+
+    /*
+    When min_confs and max_confs are zero, setting false implicitly
+    overrides max_confs to be MaxInt32, otherwise max_confs remains
+    zero. An error is returned if the value is true and both min_confs
+    and max_confs are non-zero. (default: false)
+    */
+    bool unconfirmed_only = 4;
 }
 
 message ListUnspentResponse {

package/lnd_methods/address/address_formats.json

@@ -1,6 +1,8 @@
 {
   "np2wpkh": 1,
+  "p2tr": 4,
   "p2wpkh": 0,
-  "unused_p2wpkh": 2,
-  "unused_np2wpkh": 3
+  "unused_np2wpkh": 3,
+  "unused_p2tr": 5,
+  "unused_p2wpkh": 2
 }

package/lnd_methods/address/create_chain_address.d.ts

@@ -5,7 +5,7 @@ import {
 
 export type CreateChainAddressArgs = AuthenticatedLightningArgs<{
   /** Receive Address Type */
-  format?: 'np2wpkh' | 'p2wpkh';
+  format?: 'np2wpkh' | 'p2tr' | 'p2wpkh';
   /** Get As-Yet Unused Address */
   is_unused?: boolean;
 }>;

package/lnd_methods/address/create_chain_address.js

@@ -13,8 +13,10 @@ const type = 'default';
 
   Requires `address:write` permission
 
+  LND 0.14.3 below do not support p2tr addresses
+
   {
-    [format]: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
+    [format]: <Receive Address Type String> // "np2wpkh" || "p2tr" || "p2wpkh"
     [is_unused]: <Get As-Yet Unused Address Bool>
     lnd: <Authenticated LND API Object>
   }

package/lnd_methods/onchain/partially_sign_psbt.d.ts

@@ -20,7 +20,7 @@ export type PartiallySignPsbtResult = {
  *
  * Requires LND built with `walletrpc` tag
  *
- * This method is not supported in LND 0.14.2 and below
+ * This method is not supported in LND 0.14.3 and below
  */
 export const partiallySignPsbt: AuthenticatedLightningMethod<
   PartiallySignPsbtArgs,

package/lnd_methods/onchain/partially_sign_psbt.js

@@ -16,7 +16,7 @@ const type = 'wallet';
 
   Requires LND built with `walletrpc` tag
 
-  This method is not supported in LND 0.14.2 and below
+  This method is not supported in LND 0.14.3 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_responses/constants.json

@@ -1,4 +1,9 @@
 {
+  "addressFormats": {
+    "np2wpkh": "NESTED_PUBKEY_HASH",
+    "p2tr": "TAPROOT_PUBKEY",
+    "p2wpkh": "WITNESS_PUBKEY_HASH"
+  },
   "adjustedChannelTypes": {
     "LEGACY": "STATIC_REMOTE_KEY",
     "STATIC_REMOTE_KEY": "ANCHORS",

package/lnd_responses/rpc_utxo_as_utxo.js

@@ -1,4 +1,6 @@
-const formats = {np2wpkh: 'NESTED_PUBKEY_HASH', p2wpkh: 'WITNESS_PUBKEY_HASH'};
+const constants = require('./constants');
+
+const formats = constants.addressFormats;
 const {keys} = Object;
 
 /** Derive UTXO details from RPC UTXO details

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.9",
+    "@grpc/grpc-js": "1.6.1",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.22",
+    "@types/node": "17.0.23",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.3",
@@ -26,14 +26,14 @@
     "invoices": "2.0.4",
     "psbt": "2.0.0",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "2.12.1"
+    "type-fest": "2.12.2"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
-    "@alexbosworth/tap": "15.0.10",
-    "tsd": "0.19.1",
-    "typescript": "4.6.2",
+    "@alexbosworth/tap": "15.0.11",
+    "tsd": "0.20.0",
+    "typescript": "4.6.3",
     "ws": "8.5.0"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.8.4"
+  "version": "5.9.0"
 }