lightning 5.19.0 → 5.20.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 5.20.0
+
+- `getLockedUtxos`: Add support for returning script, value of locked utxos
+
 ## 5.19.0
 
 - `closeChannel`: Add support for `max_tokens_per_vbyte` to set max fee rate

package/grpc/protos/chainnotifier.proto

@@ -72,6 +72,12 @@ message ConfRequest {
     broadcast height of the transaction/output script.
     */
     uint32 height_hint = 4;
+
+    /*
+    If true, then the block that mines the specified txid/script will be
+    included in eventual the notification event.
+    */
+    bool include_block = 5;
 }
 
 message ConfDetails {
@@ -87,6 +93,12 @@ message ConfDetails {
 
     // The index of the confirmed transaction within the transaction.
     uint32 tx_index = 4;
+
+    /*
+    The raw bytes of the block that mined the transaction. Only included if
+    include_block was set in the request.
+    */
+    bytes raw_block = 5;
 }
 
 message Reorg {

package/grpc/protos/router.proto

@@ -336,6 +336,14 @@ message SendToRouteRequest {
 
     // Route that should be used to attempt to complete the payment.
     lnrpc.Route route = 2;
+
+    /*
+    Whether the payment should be marked as failed when a temporary error is
+    returned from the given route. Set it to true so the payment won't be
+    failed unless a terminal error is occurred, such as payment timeout, no
+    routes, incorrect payment details, or insufficient funds.
+    */
+    bool skip_temp_err = 3;
 }
 
 message SendToRouteResponse {

package/grpc/protos/walletkit.proto

@@ -844,6 +844,16 @@ message UtxoLease {
     The absolute expiration of the output lease represented as a unix timestamp.
     */
     uint64 expiration = 3;
+
+    /*
+    The public key script of the leased output.
+    */
+    bytes pk_script = 4;
+
+    /*
+    The value of the leased output in satoshis.
+    */
+    uint64 value = 5;
 }
 
 message SignPsbtRequest {

package/grpc/protos/walletunlocker.proto

@@ -185,6 +185,13 @@ message InitWalletRequest {
     corresponding private keys and can serve signing RPC requests.
     */
     WatchOnly watch_only = 9;
+
+    /*
+    macaroon_root_key is an optional 32 byte macaroon root key that can be
+    provided when initializing the wallet rather than letting lnd generate one
+    on its own.
+    */
+    bytes macaroon_root_key = 10;
 }
 message InitWalletResponse {
     /*

package/lnd_methods/onchain/get_locked_utxos.js

@@ -6,6 +6,7 @@ const {isLnd} = require('./../../lnd_requests');
 const asMs = sec => Number(sec) * 1e3;
 const bufferAsHex = buffer => buffer.toString('hex');
 const {isArray} = Array;
+const {isBuffer} = Buffer;
 const method = 'listLeases';
 const type = 'wallet';
 const unsuppportedErr = /unknown/;
@@ -18,6 +19,8 @@ const unsuppportedErr = /unknown/;
 
   This method is not supported on LND 0.12.1 and below
 
+  `output_script`, `tokens` are not supported on LND 0.15.0 and below
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -27,6 +30,8 @@ const unsuppportedErr = /unknown/;
     utxos: [{
       lock_expires_at: <Lock Expires At ISO 8601 Date String>
       lock_id: <Locking Id Hex String>
+      [output_script]: <Outpoint Output Script Hex String>
+      [tokens]: <Token Value of Outpoint Number>
       transaction_id: <Transaction Id Hex String>
       transaction_vout: <Transaction Output Index Number>
     }]
@@ -64,10 +69,16 @@ module.exports = ({lnd}, cbk) => {
             return cbk([503, 'ExpectedExpirationDateForLockedUtxo']);
           }
 
+          if (!!res.locked_utxos.filter(n => !isBuffer(n.pk_script)).length) {
+            return cbk([503, 'ExpectedPkScriptForLockedUtxosInResponse']);
+          }
+
           try {
             const utxos = res.locked_utxos.map(lock => ({
               lock_expires_at: new Date(asMs(lock.expiration)).toISOString(),
               lock_id: bufferAsHex(lock.id),
+              output_script: bufferAsHex(lock.pk_script) || undefined,
+              tokens: Number(lock.value) || undefined,
               transaction_id: lock.outpoint.txid_str,
               transaction_vout: lock.outpoint.output_index,
             }));

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.6.10",
     "@grpc/proto-loader": "0.7.2",
     "@types/express": "4.17.13",
-    "@types/node": "18.7.9",
+    "@types/node": "18.7.13",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
@@ -26,7 +26,7 @@
     "invoices": "2.1.0",
     "psbt": "2.7.1",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "2.18.1"
+    "type-fest": "2.19.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.19.0"
+  "version": "5.20.0"
 }

package/test/lnd_methods/onchain/test_get_locked_utxos.js

@@ -13,6 +13,8 @@ const makeLnd = overrides => {
             output_index: 0,
             txid_str: Buffer.alloc(32).toString('hex'),
           },
+          pk_script: Buffer.alloc(1),
+          value: '1',
         };
 
         Object.keys(overrides).forEach(k => utxo[k] = overrides[k]);
@@ -56,12 +58,31 @@ const tests = [
     description: 'An outpoint is expected in a locked utxo',
     error: [503, 'UnexpectedErrorParsingLockedUtxosResponse'],
   },
+  {
+    args: {lnd: makeLnd({pk_script: undefined})},
+    description: 'An output script is expected in a locked utxo',
+    error: [503, 'ExpectedPkScriptForLockedUtxosInResponse'],
+  },
+  {
+    args: {lnd: makeLnd({pk_script: Buffer.alloc(0), value: '0'})},
+    description: 'Get legacy tx and map them to normalized transactions',
+    expected: [{
+      lock_expires_at: '1970-01-01T00:00:01.000Z',
+      lock_id: '0000000000000000000000000000000000000000000000000000000000000000',
+      output_script: undefined,
+      tokens: undefined,
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+    }],
+  },
   {
     args: {lnd: makeLnd({})},
     description: 'Get transactions and map them to normalized transactions',
     expected: [{
       lock_expires_at: '1970-01-01T00:00:01.000Z',
       lock_id: '0000000000000000000000000000000000000000000000000000000000000000',
+      output_script: '00',
+      tokens: 1,
       transaction_id: Buffer.alloc(32).toString('hex'),
       transaction_vout: 0,
     }],