lightning 10.21.0 → 10.22.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 10.22.1
+
+- `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.d.ts

@@ -4,6 +4,8 @@ import type {
 } from '../../typescript';
 
 export type CreateFundedPsbtArgs = AuthenticatedLightningArgs<{
+  /** Change Address Address Format String */
+  change_format?: 'p2tr';
   /** Chain Fee Tokens Per Virtual Byte Number */
   fee_tokens_per_vbyte?: number;
   inputs?: Array<{
@@ -29,7 +31,7 @@ export type CreateFundedPsbtArgs = AuthenticatedLightningArgs<{
   /** Spendable Lock Time on Transaction Number */
   timelock?: number;
   /** Select Inputs Using Selection Methodology Type String */
-  utxo_selection?: string;
+  utxo_selection?: 'largest' | 'random';
   /** Transaction Version Number */
   version?: number;
 }>;
@@ -46,6 +48,8 @@ export interface CreateFundedPsbtResult {
  *
  * `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

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';
@@ -20,6 +21,8 @@ const unconfirmedConfirmationsCount = 0;
 
   When specifying local inputs, they must be locked before using
 
+  `change_format` options: `p2tr` (only one change type is supported)
+
   `utxo_selection` methods: 'largest', 'random'
 
   Requires `onchain:write` permission
@@ -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.d.ts

@@ -7,6 +7,8 @@ import {MergeExclusive} from 'type-fest';
 
 export type FundPsbtArgs = AuthenticatedLightningArgs<
   {
+    /** Change Address Address Format String */
+    change_format?: 'p2tr';
     /** Chain Fee Tokens Per Virtual Byte */
     fee_tokens_per_vbyte?: number;
     inputs?: {
@@ -15,12 +17,12 @@ export type FundPsbtArgs = AuthenticatedLightningArgs<
       /** Unspent Transaction Output Index */
       transaction_vout: number;
     }[];
-
     /** Spend UTXOs With Minimum Confirmations */
     min_confirmations?: number;
-
     /** Confirmations To Wait */
     target_confirmations?: number;
+    /** Select UTXOs Using Method String */
+    utxo_selection?: 'largest' | 'random';
   } & MergeExclusive<
     {
       /** Existing PSBT Hex */
@@ -58,8 +60,6 @@ export type FundPsbtResult = {
   }[];
   /** Unsigned PSBT Hex */
   psbt: string;
-  /** Select UTXOs Using Method String */
-  utxo_selection?: UtxoSelection;
 };
 
 /**
@@ -69,6 +69,10 @@ export type FundPsbtResult = {
  *
  * If there are no inputs passed, internal UTXOs will be selected and locked
  *
+ * `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

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.12.0",
+    "@grpc/grpc-js": "1.12.2",
     "@grpc/proto-loader": "0.7.13",
     "@types/node": "22.7.5",
     "@types/request": "2.48.12",
@@ -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.1"
 }

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',