lightning 5.15.1 → 5.15.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 5.15.1
+## 5.15.2
 
 - `getFailedPayments`, `getPayments`, `getPendingPayments`: Remove
     `confirmed_at` date when a payment is not confirmed, add `created_at` and

package/README.md

@@ -66,9 +66,13 @@ To access unauthenticated methods like the wallet unlocker, use
 
 ## Methods
 
+- [addExternalSocket](https://github.com/alexbosworth/ln-service#addexternalsocket):
+    Add a new LN p2p network socket to node advertisement
 - [addPeer](https://github.com/alexbosworth/ln-service#addpeer): Connect to a new peer
 - [authenticatedLndGrpc](https://github.com/alexbosworth/ln-service#authenticatedlndgrpc): 
     Instantiate connection to authenticated lnd methods.
+- [beginGroupSigningSession](https://github.com/alexbosworth/ln-service#begingroupsigningsession):
+    Start a new MuSig2 signing session
 - [broadcastChainTransaction](https://github.com/alexbosworth/ln-service#broadcastchaintransaction):
     Publish an on-chain transaction to the network.
 - [cancelHodlInvoice](https://github.com/alexbosworth/ln-service#cancelhodlinvoice): Cancel an
@@ -111,6 +115,8 @@ To access unauthenticated methods like the wallet unlocker, use
     Remove a connected watchtower
 - [enableChannel](https://github.com/alexbosworth/ln-service#enablechannel): Signal forwarding
     enabled towards a peer.
+- [endGroupSigningSession](https://github.com/alexbosworth/ln-service#endgroupsigningsession):
+    End a MuSig2 signing session
 - [fundPendingChannels](https://github.com/alexbosworth/ln-service#fundpendingchannels):
     Provide a signed funding source for opening channels.
 - [fundPsbt](https://github.com/alexbosworth/ln-service#fundpsbt): Make a PSBT with funds and
@@ -235,6 +241,8 @@ To access unauthenticated methods like the wallet unlocker, use
     Attempt to recover channel funds from a specific channel backup.
 - [recoverFundsFromChannels](https://github.com/alexbosworth/ln-service#recoverfundsfromchannels):
     Attempt to recover funds from multiple channels using a multiple channel backup.
+- [removeExternalSocket](https://github.com/alexbosworth/ln-service#removeexternalsocket):
+    Remove a LN p2p network socket from the node advertisement
 - [removePeer](https://github.com/alexbosworth/ln-service#removepeer): Disconnect from a
     connected peer.
 - [requestChainFeeIncrease](https://github.com/alexbosworth/ln-service#requestchainfeeincrease):
@@ -313,10 +321,16 @@ To access unauthenticated methods like the wallet unlocker, use
     UTXO to allow it to be selected for spending again.
 - [unlockWallet](https://github.com/alexbosworth/ln-service#unlockwallet): Decrypt the wallet and
     start the daemon
+- [updateAlias](https://github.com/alexbosworth/ln-service#updatealias):
+    Update the advertised node alias
 - [updateChainTransaction](https://github.com/alexbosworth/ln-service#updatechaintransaction):
     Edit the metadata of an on-chain transaction record.
+- [updateColor](https://github.com/alexbosworth/ln-service#updatecolor):
+    Update the advertised node color
 - [updateConnectedWatchtower](https://github.com/alexbosworth/ln-service#updateconnectedwatchtower):
     Edit the settings on an added watchtower
+- [updateGroupSigningSession](https://github.com/alexbosworth/ln-service#updategroupsigningsession):
+    Update a MuSig2 signing session with nonces and get a partial signature
 - [updatePathfindingSettings](https://github.com/alexbosworth/ln-service#updatepathfindingsettings):
     Edit the configuration for routing calculations
 - [updateRoutingFees](https://github.com/alexbosworth/ln-service#updateroutingfees): Set the

package/lnd_methods/info/get_route_to_destination.js

@@ -129,6 +129,14 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedLndApiObjectToGetRouteToDestination']);
         }
 
+        if (!!args.outgoing_channel) {
+          try {
+            chanNumber({channel: args.outgoing_channel});
+          } catch (err) {
+            return cbk([400, 'ExpectedStandardFormatChannelIdForOutChannel']);
+          }
+        }
+
         if (!!args.total_mtokens && !args.payment) {
           return cbk([400, 'ExpectedTotalMtokensWithPaymentIdentifier']);
         }

package/lnd_methods/peers/add_external_socket.d.ts

@@ -0,0 +1,20 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type AddExternalSocketArgs = AuthenticatedLightningArgs<{
+  /** Add Socket Address String */
+  socket: string;
+}>;
+
+/**
+ * Add a new advertised p2p socket address
+ *
+ * Note: this method is not supported in LND versions 0.14.3 and below
+ *
+ * Requires LND built with `peersrpc` build tag
+ *
+ * Requires `peers:write` permissions
+ */
+export const addExternalSocket: AuthenticatedLightningMethod<AddExternalSocketArgs>;

package/lnd_methods/peers/index.d.ts

@@ -1,4 +1,8 @@
+export * from './add_external_socket';
 export * from './add_peer';
 export * from './get_peers';
+export * from './remove_external_socket';
 export * from './remove_peer';
 export * from './subscribe_to_peers';
+export * from './update_alias';
+export * from './update_color';

package/lnd_methods/peers/remove_external_socket.d.ts

@@ -0,0 +1,20 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type RemoveExternalSocketArgs = AuthenticatedLightningArgs<{
+  /** Remove Socket Address String */
+  socket: string;
+}>;
+
+/**
+ * Remove an existing advertised p2p socket address
+ *
+ * Note: this method is not supported in LND versions 0.14.3 and below
+ *
+ * Requires LND built with `peersrpc` build tag
+ *
+ * Requires `peers:write` permissions
+ */
+export const removeExternalSocket: AuthenticatedLightningMethod<RemoveExternalSocketArgs>;

package/lnd_methods/peers/update_alias.d.ts

@@ -0,0 +1,11 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type UpdateAliasArgs = AuthenticatedLightningArgs<{
+  /** Node Alias String */
+  node: string;
+}>;
+
+export const updateAlias: AuthenticatedLightningMethod<UpdateAliasArgs>;

package/lnd_methods/peers/update_color.d.ts

@@ -0,0 +1,11 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type UpdateColorArgs = AuthenticatedLightningArgs<{
+  /** Node Color String */
+  color: string;
+}>;
+
+export const updateColor: AuthenticatedLightningMethod<UpdateColorArgs>;

package/lnd_methods/signer/begin_group_signing_session.d.ts

@@ -0,0 +1,33 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type BeginGroupSigningSessionArgs = AuthenticatedLightningArgs<{
+  /** Key Is BIP 86 Key Spend Key Bool */
+  is_key_spend?: boolean;
+  /** HD Seed Key Family Number */
+  key_family: number;
+  /** Key Index Number */
+  key_index: number;
+  /** External Public Key Hex String */
+  public_keys: string[];
+  /** Taproot Script Root Hash Hex String */
+  root_hash?: string;
+}>;
+
+export type BeginGroupSigningSessionResult = {
+  /** Final Script or Top Level Public Key Hex String */
+  external_key: string;
+  /** Session Id Hex String */
+  id: string;
+  /** Internal Top Level Public Key Hex String */
+  internal_key?: string;
+  /** Session Compound Nonces Hex String */
+  nonce: string;
+};
+
+export const beginGroupSigningSession: AuthenticatedLightningMethod<
+  BeginGroupSigningSessionArgs,
+  BeginGroupSigningSessionResult
+>;

package/lnd_methods/signer/end_group_signing_session.d.ts

@@ -0,0 +1,21 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type EndGroupSigningSessionArgs = AuthenticatedLightningArgs<{
+  /** Session Id Hex String */
+  id: string;
+  /** Combine External Partial Signature Hex Strings */
+  signatures?: string[];
+}>;
+
+export type EndGroupSigningSessionResult = {
+  /** Combined Signature Hex String */
+  signature?: string;
+};
+
+export const endGroupSigningSession: AuthenticatedLightningMethod<
+  EndGroupSigningSessionArgs,
+  EndGroupSigningSessionResult
+>;

package/lnd_methods/signer/index.d.ts

@@ -1,4 +1,7 @@
+export * from './begin_group_signing_session';
 export * from './diffie_hellman_compute_secret';
+export * from './end_group_signing_session';
 export * from './sign_bytes';
 export * from './sign_transaction';
+export * from './update_group_signing_session';
 export * from './verify_bytes_signature';

package/lnd_methods/signer/update_group_signing_session.d.ts

@@ -0,0 +1,23 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type UpdateGroupSigningSessionArgs = AuthenticatedLightningArgs<{
+  /** Hash to Sign Hex String */
+  hash: string;
+  /** MuSig2 Session Id Hex String */
+  id: string;
+  /** Nonce Hex Strings */
+  nonces: string[];
+}>;
+
+export type UpdateGroupSigningSessionResult = {
+  /** Partial Signature Hex String */
+  signature: string;
+};
+
+export const updateGroupSigningSession: AuthenticatedLightningMethod<
+  UpdateGroupSigningSessionArgs,
+  UpdateGroupSigningSessionResult
+>;

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.6.7",
     "@grpc/proto-loader": "0.6.12",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.31",
+    "@types/node": "17.0.32",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.3",
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.15.1"
+  "version": "5.15.2"
 }

package/test/lnd_methods/info/test_get_route_to_destination.js

@@ -70,6 +70,11 @@ const makeArgs = override => {
 };
 
 const tests = [
+  {
+    args: makeArgs({confidence: NaN}),
+    description: 'Valid confidence is required',
+    error: [400, 'ExpectedConfidenceInPartsPerMillionForQuery'],
+  },
   {
     args: makeArgs({destination: undefined}),
     description: 'A destination is required',
@@ -85,6 +90,11 @@ const tests = [
     description: 'LND is required',
     error: [400, 'ExpectedLndApiObjectToGetRouteToDestination'],
   },
+  {
+    args: makeArgs({outgoing_channel: 12345}),
+    description: 'Outgoing channel is expected in standard format',
+    error: [400, 'ExpectedStandardFormatChannelIdForOutChannel'],
+  },
   {
     args: makeArgs({payment: undefined}),
     description: 'Total mtokens requires linking payment identifier',
@@ -132,6 +142,11 @@ const tests = [
     description: 'No route is found with error',
     expected: {},
   },
+  {
+    args: makeArgs({lnd: makeLnd({err: {details: 'is too large'}})}),
+    description: 'Payment cannot exceed maximum size',
+    error: [400, 'PaymentTooLargeToFindRoute'],
+  },
   {
     args: makeArgs({lnd: makeLnd({res: {routes: []}})}),
     description: 'No route is found',

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

@@ -0,0 +1,14 @@
+import {expectError, expectType} from 'tsd';
+import {addExternalSocket} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const socket = 'socket';
+
+expectError(addExternalSocket());
+expectError(addExternalSocket({}));
+expectError(addExternalSocket({lnd}));
+expectError(addExternalSocket({socket}));
+
+expectType<void>(await addExternalSocket({lnd, socket}));
+expectType<void>(addExternalSocket({lnd, socket}, () => {}));

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

@@ -0,0 +1,60 @@
+import {expectError, expectType} from 'tsd';
+import {
+  beginGroupSigningSession,
+  BeginGroupSigningSessionResult,
+} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const is_key_spend = true;
+const key_family = 0;
+const key_index = 0;
+const public_keys = ['pubkey'];
+const root_hash = 'root hash';
+
+expectError(beginGroupSigningSession());
+expectError(beginGroupSigningSession({}));
+expectError(beginGroupSigningSession({lnd}));
+expectError(beginGroupSigningSession({key_family}));
+expectError(beginGroupSigningSession({key_index}));
+expectError(beginGroupSigningSession({public_keys}));
+expectError(beginGroupSigningSession({lnd, key_family}));
+expectError(beginGroupSigningSession({lnd, key_index}));
+expectError(beginGroupSigningSession({lnd, public_keys}));
+expectError(beginGroupSigningSession({key_family, key_index}));
+expectError(beginGroupSigningSession({key_family, public_keys}));
+expectError(beginGroupSigningSession({key_index, public_keys}));
+expectError(beginGroupSigningSession({lnd, key_family, key_index}));
+expectError(beginGroupSigningSession({lnd, key_family, public_keys}));
+expectError(beginGroupSigningSession({lnd, key_index, public_keys}));
+expectError(beginGroupSigningSession({key_family, key_index, public_keys}));
+
+expectType<BeginGroupSigningSessionResult>(
+  await beginGroupSigningSession({lnd, key_family, key_index, public_keys})
+);
+expectType<BeginGroupSigningSessionResult>(
+  await beginGroupSigningSession({
+    lnd,
+    key_family,
+    key_index,
+    public_keys,
+    is_key_spend,
+    root_hash,
+  })
+);
+expectType<void>(
+  beginGroupSigningSession(
+    {lnd, key_family, key_index, public_keys},
+    (err, res) => {
+      expectType<BeginGroupSigningSessionResult>(res);
+    }
+  )
+);
+expectType<void>(
+  beginGroupSigningSession(
+    {lnd, key_family, key_index, public_keys, is_key_spend, root_hash},
+    (err, res) => {
+      expectType<BeginGroupSigningSessionResult>(res);
+    }
+  )
+);

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

@@ -0,0 +1,32 @@
+import {expectError, expectType} from 'tsd';
+import {
+  endGroupSigningSession,
+  EndGroupSigningSessionResult,
+} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const id = 'id';
+const signatures = ['signature'];
+
+expectError(endGroupSigningSession());
+expectError(endGroupSigningSession({}));
+expectError(endGroupSigningSession({lnd}));
+expectError(endGroupSigningSession({id}));
+
+expectType<EndGroupSigningSessionResult>(
+  await endGroupSigningSession({lnd, id})
+);
+expectType<EndGroupSigningSessionResult>(
+  await endGroupSigningSession({lnd, id, signatures})
+);
+expectType<void>(
+  endGroupSigningSession({lnd, id}, (err, res) => {
+    expectType<EndGroupSigningSessionResult>(res);
+  })
+);
+expectType<void>(
+  endGroupSigningSession({lnd, id, signatures}, (err, res) => {
+    expectType<EndGroupSigningSessionResult>(res);
+  })
+);

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

@@ -0,0 +1,14 @@
+import {expectError, expectType} from 'tsd';
+import {removeExternalSocket} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const socket = 'socket';
+
+expectError(removeExternalSocket());
+expectError(removeExternalSocket({}));
+expectError(removeExternalSocket({lnd}));
+expectError(removeExternalSocket({socket}));
+
+expectType<void>(await removeExternalSocket({lnd, socket}));
+expectType<void>(removeExternalSocket({lnd, socket}, () => {}));

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

@@ -0,0 +1,14 @@
+import {expectError, expectType} from 'tsd';
+import {updateAlias} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const node = 'node';
+
+expectError(updateAlias());
+expectError(updateAlias({}));
+expectError(updateAlias({lnd}));
+expectError(updateAlias({node}));
+
+expectType<void>(await updateAlias({lnd, node}));
+expectType<void>(updateAlias({lnd, node}, () => {}));

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

@@ -0,0 +1,14 @@
+import {expectError, expectType} from 'tsd';
+import {updateColor} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const color = 'color';
+
+expectError(updateColor());
+expectError(updateColor({}));
+expectError(updateColor({lnd}));
+expectError(updateColor({color}));
+
+expectType<void>(await updateColor({lnd, color}));
+expectType<void>(updateColor({lnd, color}, () => {}));

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

@@ -0,0 +1,29 @@
+import {expectError, expectType} from 'tsd';
+import {
+  updateGroupSigningSession,
+  UpdateGroupSigningSessionResult,
+} from '../../lnd_methods';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+
+const lnd = {} as AuthenticatedLnd;
+const hash = 'hash';
+const id = 'id';
+const nonces = ['nonce'];
+
+expectError(updateGroupSigningSession());
+expectError(updateGroupSigningSession({}));
+expectError(updateGroupSigningSession({lnd}));
+expectError(updateGroupSigningSession({hash}));
+expectError(updateGroupSigningSession({id}));
+expectError(updateGroupSigningSession({nonces}));
+expectError(updateGroupSigningSession({lnd, hash}));
+expectError(updateGroupSigningSession({lnd, id}));
+expectError(updateGroupSigningSession({lnd, nonces}));
+expectError(updateGroupSigningSession({lnd, hash, id}));
+expectError(updateGroupSigningSession({lnd, hash, nonces}));
+expectError(updateGroupSigningSession({lnd, id, nonces}));
+
+expectType<UpdateGroupSigningSessionResult>(
+  await updateGroupSigningSession({lnd, hash, id, nonces})
+);
+expectType<void>(updateGroupSigningSession({lnd, hash, id, nonces}, () => {}));