lightning 10.20.2 → 10.22.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 10.22.0
+
+- `createFundedPsbt`: Add support for `change_format` for change address type
+
+## 10.21.0
+
+- `fundPsbt`: Add support for `change_format` to specify change address type
+
 ## 10.20.2
 
 - `payViaPaymentRequest`, `subscribeToPayViaRequest`: Add `index` to response

package/bolt02/ids.json

@@ -2,6 +2,7 @@
   "chains": {
     "bitcoinmainnet": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
     "bitcoinregtest": "0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206",
+    "bitcoinsignet": "00000008819873e925422c1ff0f99f7cc9bbb232af63a077a480a3633bee1ef6",
     "bitcointestnet": "000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943",
     "litecoinmainnet": "12a765e31ffd4059bada1e25190f6e98c99d9714d334efa41a195a7e7e04bfe2",
     "litecoinregtest": "530827f38f93b43ed12af0b3ad25a288dc02ed74d6d7857862df51fc56c416f9",

package/lnd_methods/onchain/create_funded_psbt.js

@@ -5,12 +5,13 @@ const {returnResult} = require('asyncjs-util');
 const {isLnd} = require('./../../lnd_requests');
 
 const bufferAsHex = buffer => buffer.toString('hex');
-const defaultChangeType = 'CHANGE_ADDRESS_TYPE_P2TR';
+const defaultChangeType = () => 'CHANGE_ADDRESS_TYPE_P2TR';
 const defaultConfirmationTarget = 6;
 const errorUnsupported = 'transaction template missing, need to specify either PSBT or raw TX template';
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const indexNotFound = -1;
 const {isBuffer} = Buffer;
+const isKnownChangeFormat = format => !format || format === 'p2tr';
 const method = 'fundPsbt';
 const strategy = type => !type ? undefined : `STRATEGY_${type.toUpperCase()}`;
 const type = 'wallet';
@@ -22,6 +23,8 @@ const unconfirmedConfirmationsCount = 0;
 
   `utxo_selection` methods: 'largest', 'random'
 
+  `change_format` options: `p2tr` (only one change type is supported)
+
   Requires `onchain:write` permission
 
   Requires LND built with `walletrpc` tag
@@ -29,6 +32,7 @@ const unconfirmedConfirmationsCount = 0;
   This method is not supported on LND 0.17.5 or below
 
   {
+    [change_format]: <Change Address Address Format String>
     [fee_tokens_per_vbyte]: <Chain Fee Tokens Per Virtual Byte Number>
     [inputs]: [{
       [sequence]: <Sequence Number>
@@ -58,6 +62,10 @@ module.exports = (args, cbk) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
+        if (!isKnownChangeFormat(args.change_format)) {
+          return cbk([400, 'ExpectedKnownChangeFormatToFundPsbt']);
+        }
+
         if (!isLnd({method, type, lnd: args.lnd})) {
           return cbk([400, 'ExpectedAuthenticatedLndToCreateFundedPsbt']);
         }
@@ -97,6 +105,7 @@ module.exports = (args, cbk) => {
       // Construct the PSBT that is needed for coin select type funding
       funding: ['validate', ({}, cbk) => {
         const {psbt} = createPsbt({
+          change_type: defaultChangeType(args.change_type),
           outputs: args.outputs || [],
           timelock: args.timelock,
           utxos: (args.inputs || []).map(input => ({

package/lnd_methods/onchain/fund_psbt.js

@@ -7,13 +7,14 @@ 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 defaultChangeType = () => 'CHANGE_ADDRESS_TYPE_P2TR';
 const defaultConfirmationTarget = 6;
 const expirationAsDate = epoch => new Date(Number(epoch) * 1e3).toISOString();
 const {fromHex} = Transaction;
 const hexFromBuffer = buffer => buffer.toString('hex');
 const {isArray} = Array;
 const {isBuffer} = Buffer;
+const isKnownChangeFormat = format => !format || format === 'p2tr';
 const method = 'fundPsbt';
 const notSupported = /unknown.*walletrpc.WalletKit/;
 const strategy = type => !type ? undefined : `STRATEGY_${type.toUpperCase()}`;
@@ -29,6 +30,8 @@ const txIdFromHash = hash => hash.reverse().toString('hex');
 
   `utxo_selection` methods: 'largest', 'random'
 
+  `change_format` options: `p2tr` (only one change type is supported)
+
   Requires `onchain:write` permission
 
   Requires LND built with `walletrpc` tag
@@ -40,6 +43,7 @@ const txIdFromHash = hash => hash.reverse().toString('hex');
   `utxo_selection` is not supported in LND 0.17.5 and below
 
   {
+    [change_format]: <Change Address Address Format String>
     [fee_tokens_per_vbyte]: <Chain Fee Tokens Per Virtual Byte Number>
     [inputs]: [{
       transaction_id: <Unspent Transaction Id Hex String>
@@ -80,6 +84,10 @@ module.exports = (args, cbk) => {
 
       // Check arguments
       validate: cbk => {
+        if (!isKnownChangeFormat(args.change_format)) {
+          return cbk([400, 'ExpectedKnownChangeFormatToFundPsbt']);
+        }
+
         if (!isLnd({method, type, lnd: args.lnd})) {
           return cbk([400, 'ExpectedAuthenticatedLndToFundPsbt']);
         }
@@ -163,7 +171,7 @@ module.exports = (args, cbk) => {
       // Fund the PSBT
       fund: ['fee', 'funding', 'minConfs', ({fee, funding, minConfs}, cbk) => {
         return args.lnd[type][method]({
-          change_type: defaultChangeType,
+          change_type: defaultChangeType(args.change_type),
           coin_selection_strategy: strategy(args.utxo_selection),
           min_confs: minConfs !== undefined ? minConfs : undefined,
           psbt: !!args.psbt ? Buffer.from(args.psbt, 'hex') : undefined,

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.11.2",
+    "@grpc/grpc-js": "1.12.0",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "22.5.4",
+    "@types/node": "22.7.5",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.12",
     "async": "3.2.6",
@@ -27,7 +27,7 @@
   "description": "Lightning Network client library",
   "devDependencies": {
     "tsd": "0.31.2",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   },
   "engines": {
     "node": ">=18"
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.20.2"
+  "version": "10.22.0"
 }

package/test/lnd_methods/onchain/test_create_funded_psbt.js

@@ -48,6 +48,11 @@ const makeExpected = overrides => {
 };
 
 const tests = [
+  {
+    args: makeArgs({change_format: 'change_format'}),
+    description: 'A valid change format is required',
+    error: [400, 'ExpectedKnownChangeFormatToFundPsbt'],
+  },
   {
     args: makeArgs({lnd: undefined}),
     description: 'An LND object is required',

package/test/lnd_methods/onchain/test_fund_psbt.js

@@ -74,6 +74,11 @@ const makeExpected = overrides => {
 };
 
 const tests = [
+  {
+    args: makeArgs({change_format: 'change_format'}),
+    description: 'A valid change format is required',
+    error: [400, 'ExpectedKnownChangeFormatToFundPsbt'],
+  },
   {
     args: makeArgs({lnd: undefined}),
     description: 'An LND object is required',