lightning 5.4.2 → 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 5.5.0
+
+- `partiallySignPsbt`: Add method to partially sign a PSBT
+
 ## 5.4.2
 
 - `deletePendingChannel`: Add method to delete a stuck pending channel

package/README.md

@@ -206,8 +206,10 @@ To access unauthenticated methods like the wallet unlocker, use
     chosen to be spent.
 - [openChannel](https://github.com/alexbosworth/ln-service#openchannel): Create a new channel
     to another node.
-- [openChannels](https://github.com/alexbosworth/ln-service#openchannels): Open multiple
-    channels in a single on-chain transaction batch.
+- [openChannels](https://github.com/alexbosworth/ln-service#openchannels): Open
+     multiple channels in a single on-chain transaction batch.
+- [partiallySignPsbt](https://github.com/alexbosworth/ln-service#partiallysignpsbt):
+    Add a partial signature to a PSBT
 - [pay](https://github.com/alexbosworth/ln-service#pay): Make an off-chain payment.
 - [payViaPaymentDetails](https://github.com/alexbosworth/ln-service#payviapaymentdetails): Pay
     off-chain using details about a destination invoice.

package/lnd_methods/onchain/index.d.ts

@@ -14,6 +14,7 @@ export * from './get_utxos';
 export * from './lock_utxo';
 export * from './open_channel';
 export * from './open_channels';
+export * from './partially_sign_psbt';
 export * from './prepare_for_channel_proposal';
 export * from './propose_channel';
 export * from './request_chain_fee_increase';

package/lnd_methods/onchain/partially_sign_psbt.d.ts

@@ -0,0 +1,28 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type PartiallySignPsbtArgs = AuthenticatedLightningArgs<{
+  /** Funded PSBT Hex String */
+  psbt: string;
+}>;
+
+export type PartiallySignPsbtResult = {
+  /** Partially Signed PSBT Hex String */
+  psbt: string;
+};
+
+/**
+ * Sign a PSBT to produce a partially signed PSBT
+ *
+ * Requires `onchain:write` permission
+ *
+ * Requires LND built with `walletrpc` tag
+ *
+ * This method is not supported in LND 0.14.1 and below
+ */
+export const partiallySignPsbt: AuthenticatedLightningMethod<
+  PartiallySignPsbtArgs,
+  PartiallySignPsbtResult
+>;

package/lnd_methods/unauthenticated/create_wallet.d.ts

@@ -12,9 +12,17 @@ export type CreateWalletArgs = UnauthenticatedLightningArgs<{
   seed: string;
 }>;
 
+export type CreateWalletResult = {
+  /** Base64 Encoded Admin Macaroon String */
+  macaroon: string;
+};
+
 /**
  * Create a wallet
  *
  * Requires unlocked lnd and unauthenticated LND
  */
-export const createWallet: UnauthenticatedLightningMethod<CreateWalletArgs>;
+export const createWallet: UnauthenticatedLightningMethod<
+  CreateWalletArgs,
+  CreateWalletResult
+>;

package/package.json

@@ -57,5 +57,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.4.2"
+  "version": "5.5.0"
 }

package/test/typescript/create_wallet.test-d.ts

@@ -1,6 +1,6 @@
 import {expectError, expectType} from 'tsd';
 import {UnauthenticatedLnd} from '../../lnd_grpc';
-import {createWallet} from '../../lnd_methods';
+import {createWallet, CreateWalletResult} from '../../lnd_methods';
 
 const lnd = {} as UnauthenticatedLnd;
 
@@ -20,8 +20,14 @@ expectError(createWallet({lnd, seed}));
 expectError(createWallet({lnd, passphrase, password}));
 expectError(createWallet({lnd, passphrase, seed}));
 
-expectType<void>(await createWallet({lnd, password, seed}));
-expectType<void>(await createWallet({lnd, passphrase, password, seed}));
+expectType<CreateWalletResult>(await createWallet({lnd, password, seed}));
+expectType<CreateWalletResult>(
+  await createWallet({lnd, passphrase, password, seed})
+);
 
-expectType<void>(createWallet({lnd, password, seed}, () => {}));
-expectType<void>(createWallet({lnd, passphrase, password, seed}, () => {}));
+createWallet({lnd, password, seed}, (err, res) => {
+  expectType<CreateWalletResult>(res);
+});
+createWallet({lnd, passphrase, password, seed}, (err, res) => {
+  expectType<CreateWalletResult>(res);
+});

package/test/typescript/partially_sign_psbt.test-d.ts

@@ -0,0 +1,18 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {partiallySignPsbt, PartiallySignPsbtResult} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const psbt = 'psbt';
+
+expectError(partiallySignPsbt());
+expectError(partiallySignPsbt({}));
+expectError(partiallySignPsbt({lnd}));
+
+expectType<PartiallySignPsbtResult>(await partiallySignPsbt({lnd, psbt}));
+
+expectType<void>(
+  partiallySignPsbt({lnd, psbt}, (error, result) => {
+    expectType<PartiallySignPsbtResult>(result);
+  })
+);