lightning 10.21.0 → 10.22.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

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/package.json

@@ -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.21.0"
+  "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',