astra-lightning 1.0.0

package/index.js

@@ -0,0 +1,321 @@
+const {addAdvertisedFeature} = require('./lnd_methods');
+const {addExternalSocket} = require('./lnd_methods');
+const {addPeer} = require('./lnd_methods');
+const {authenticatedLndGrpc} = require('./lnd_grpc');
+const {beginGroupSigningSession} = require('./lnd_methods');
+const {broadcastChainTransaction} = require('./lnd_methods');
+const {cancelHodlInvoice} = require('./lnd_methods');
+const {cancelPendingChannel} = require('./lnd_methods');
+const {changePassword} = require('./lnd_methods');
+const {closeChannel} = require('./lnd_methods');
+const {connectWatchtower} = require('./lnd_methods');
+const {createChainAddress} = require('./lnd_methods');
+const {createFundedPsbt} = require('./lnd_methods');
+const {createHodlInvoice} = require('./lnd_methods');
+const {createInvoice} = require('./lnd_methods');
+const {createSeed} = require('./lnd_methods');
+const {createWallet} = require('./lnd_methods');
+const {decodePaymentRequest} = require('./lnd_methods');
+const {deleteChainTransaction} = require('./lnd_methods');
+const {deleteFailedPayAttempts} = require('./lnd_methods');
+const {deleteFailedPayments} = require('./lnd_methods');
+const {deleteForwardingReputations} = require('./lnd_methods');
+const {deletePayment} = require('./lnd_methods');
+const {deletePayments} = require('./lnd_methods');
+const {deletePendingChannel} = require('./lnd_methods');
+const {diffieHellmanComputeSecret} = require('./lnd_methods');
+const {disableChannel} = require('./lnd_methods');
+const {disconnectWatchtower} = require('./lnd_methods');
+const {enableChannel} = require('./lnd_methods');
+const {endGroupSigningSession} = require('./lnd_methods');
+const {fundPendingChannels} = require('./lnd_methods');
+const {fundPsbt} = require('./lnd_methods');
+const {getAccessIds} = require('./lnd_methods');
+const {getAutopilot} = require('./lnd_methods');
+const {getBackup} = require('./lnd_methods');
+const {getBackups} = require('./lnd_methods');
+const {getBlock} = require('./lnd_methods');
+const {getBlockHeader} = require('./lnd_methods');
+const {getChainAddresses} = require('./lnd_methods');
+const {getChainBalance} = require('./lnd_methods');
+const {getChainFeeEstimate} = require('./lnd_methods');
+const {getChainFeeRate} = require('./lnd_methods');
+const {getChainTransaction} = require('./lnd_methods');
+const {getChainTransactions} = require('./lnd_methods');
+const {getChannel} = require('./lnd_methods');
+const {getChannelBalance} = require('./lnd_methods');
+const {getChannels} = require('./lnd_methods');
+const {getClosedChannels} = require('./lnd_methods');
+const {getConfiguration} = require('./lnd_methods');
+const {getConnectedWatchtowers} = require('./lnd_methods');
+const {getEphemeralChannelIds} = require('./lnd_methods');
+const {getFailedPayments} = require('./lnd_methods');
+const {getFeeRates} = require('./lnd_methods');
+const {getForwardingConfidence} = require('./lnd_methods');
+const {getForwardingReputations} = require('./lnd_methods');
+const {getForwards} = require('./lnd_methods');
+const {getHeight} = require('./lnd_methods');
+const {getIdentity} = require('./lnd_methods');
+const {getInvoice} = require('./lnd_methods');
+const {getInvoices} = require('./lnd_methods');
+const {getLockedUtxos} = require('./lnd_methods');
+const {getMasterPublicKeys} = require('./lnd_methods');
+const {getMethods} = require('./lnd_methods');
+const {getMinimumRelayFee} = require('./lnd_methods');
+const {getNetworkCentrality} = require('./lnd_methods');
+const {getNetworkGraph} = require('./lnd_methods');
+const {getNetworkInfo} = require('./lnd_methods');
+const {getNode} = require('./lnd_methods');
+const {getPathfindingSettings} = require('./lnd_methods');
+const {getPayment} = require('./lnd_methods');
+const {getPayments} = require('./lnd_methods');
+const {getPeers} = require('./lnd_methods');
+const {getPendingChainBalance} = require('./lnd_methods');
+const {getPendingChannels} = require('./lnd_methods');
+const {getPendingPayments} = require('./lnd_methods');
+const {getPendingSweeps} = require('./lnd_methods');
+const {getPublicKey} = require('./lnd_methods');
+const {getRouteConfidence} = require('./lnd_methods');
+const {getRouteThroughHops} = require('./lnd_methods');
+const {getRouteToDestination} = require('./lnd_methods');
+const {getSettlementStatus} = require('./lnd_methods');
+const {getSweepTransactions} = require('./lnd_methods');
+const {getTowerServerInfo} = require('./lnd_methods');
+const {getUtxos} = require('./lnd_methods');
+const {getWalletInfo} = require('./lnd_methods');
+const {getWalletStatus} = require('./lnd_methods');
+const {getWalletVersion} = require('./lnd_methods');
+const {grantAccess} = require('./lnd_methods');
+const {isDestinationPayable} = require('./lnd_methods');
+const {lockUtxo} = require('./lnd_methods');
+const {openChannel} = require('./lnd_methods');
+const {openChannels} = require('./lnd_methods');
+const {partiallySignPsbt} = require('./lnd_methods');
+const {pay} = require('./lnd_methods');
+const {payViaPaymentDetails} = require('./lnd_methods');
+const {payViaPaymentRequest} = require('./lnd_methods');
+const {payViaRoutes} = require('./lnd_methods');
+const {prepareForChannelProposal} = require('./lnd_methods');
+const {probeForRoute} = require('./lnd_methods');
+const {proposeChannel} = require('./lnd_methods');
+const {recoverFundsFromChannel} = require('./lnd_methods');
+const {recoverFundsFromChannels} = require('./lnd_methods');
+const {removeAdvertisedFeature} = require('./lnd_methods');
+const {removeExternalSocket} = require('./lnd_methods');
+const {removePeer} = require('./lnd_methods');
+const {requestBatchedFeeIncrease} = require('./lnd_methods');
+const {requestChainFeeIncrease} = require('./lnd_methods');
+const {revokeAccess} = require('./lnd_methods');
+const {sendMessageToPeer} = require('./lnd_methods');
+const {sendToChainAddress} = require('./lnd_methods');
+const {sendToChainAddresses} = require('./lnd_methods');
+const {sendToChainOutputScripts} = require('./lnd_methods');
+const {setAutopilot} = require('./lnd_methods');
+const {settleHodlInvoice} = require('./lnd_methods');
+const {signBytes} = require('./lnd_methods');
+const {signChainAddressMessage} = require('./lnd_methods');
+const {signMessage} = require('./lnd_methods');
+const {signPsbt} = require('./lnd_methods');
+const {signTransaction} = require('./lnd_methods');
+const {stopDaemon} = require('./lnd_methods');
+const {subscribeToBackups} = require('./lnd_methods');
+const {subscribeToBlocks} = require('./lnd_methods');
+const {subscribeToChainAddress} = require('./lnd_methods');
+const {subscribeToChainSpend} = require('./lnd_methods');
+const {subscribeToChannels} = require('./lnd_methods');
+const {subscribeToForwardRequests} = require('./lnd_methods');
+const {subscribeToForwards} = require('./lnd_methods');
+const {subscribeToGraph} = require('./lnd_methods');
+const {subscribeToInvoice} = require('./lnd_methods');
+const {subscribeToInvoices} = require('./lnd_methods');
+const {subscribeToOpenRequests} = require('./lnd_methods');
+const {subscribeToPastPayment} = require('./lnd_methods');
+const {subscribeToPastPayments} = require('./lnd_methods');
+const {subscribeToPayViaDetails} = require('./lnd_methods');
+const {subscribeToPayViaRequest} = require('./lnd_methods');
+const {subscribeToPayViaRoutes} = require('./lnd_methods');
+const {subscribeToPayments} = require('./lnd_methods');
+const {subscribeToPeerMessages} = require('./lnd_methods');
+const {subscribeToPeers} = require('./lnd_methods');
+const {subscribeToProbeForRoute} = require('./lnd_methods');
+const {subscribeToRpcRequests} = require('./lnd_methods');
+const {subscribeToTransactions} = require('./lnd_methods');
+const {subscribeToWalletStatus} = require('./lnd_methods');
+const {unauthenticatedLndGrpc} = require('./lnd_grpc');
+const {unlockUtxo} = require('./lnd_methods');
+const {unlockWallet} = require('./lnd_methods');
+const {updateAlias} = require('./lnd_methods');
+const {updateChainTransaction} = require('./lnd_methods');
+const {updateColor} = require('./lnd_methods');
+const {updateConnectedWatchtower} = require('./lnd_methods');
+const {updateGroupSigningSession} = require('./lnd_methods');
+const {updatePathfindingSettings} = require('./lnd_methods');
+const {updateRoutingFees} = require('./lnd_methods');
+const {verifyAccess} = require('./lnd_methods');
+const {verifyBackup} = require('./lnd_methods');
+const {verifyBackups} = require('./lnd_methods');
+const {verifyBytesSignature} = require('./lnd_methods');
+const {verifyChainAddressMessage} = require('./lnd_methods');
+const {verifyMessage} = require('./lnd_methods');
+
+module.exports = {
+  addAdvertisedFeature,
+  addExternalSocket,
+  addPeer,
+  authenticatedLndGrpc,
+  beginGroupSigningSession,
+  broadcastChainTransaction,
+  cancelHodlInvoice,
+  cancelPendingChannel,
+  changePassword,
+  closeChannel,
+  connectWatchtower,
+  createChainAddress,
+  createFundedPsbt,
+  createHodlInvoice,
+  createInvoice,
+  createSeed,
+  createWallet,
+  decodePaymentRequest,
+  deleteChainTransaction,
+  deleteFailedPayAttempts,
+  deleteFailedPayments,
+  deleteForwardingReputations,
+  deletePayment,
+  deletePayments,
+  deletePendingChannel,
+  disableChannel,
+  disconnectWatchtower,
+  enableChannel,
+  endGroupSigningSession,
+  diffieHellmanComputeSecret,
+  fundPendingChannels,
+  fundPsbt,
+  getAccessIds,
+  getAutopilot,
+  getBackup,
+  getBackups,
+  getBlock,
+  getBlockHeader,
+  getChainAddresses,
+  getChainBalance,
+  getChainFeeEstimate,
+  getChainFeeRate,
+  getChainTransaction,
+  getChainTransactions,
+  getChannel,
+  getChannelBalance,
+  getChannels,
+  getClosedChannels,
+  getConfiguration,
+  getConnectedWatchtowers,
+  getEphemeralChannelIds,
+  getFailedPayments,
+  getFeeRates,
+  getForwardingConfidence,
+  getForwardingReputations,
+  getForwards,
+  getHeight,
+  getIdentity,
+  getInvoice,
+  getInvoices,
+  getLockedUtxos,
+  getMasterPublicKeys,
+  getMethods,
+  getMinimumRelayFee,
+  getNetworkCentrality,
+  getNetworkGraph,
+  getNetworkInfo,
+  getNode,
+  getPathfindingSettings,
+  getPayment,
+  getPayments,
+  getPeers,
+  getPendingChainBalance,
+  getPendingChannels,
+  getPendingPayments,
+  getPendingSweeps,
+  getPublicKey,
+  getRouteConfidence,
+  getRouteThroughHops,
+  getRouteToDestination,
+  getSettlementStatus,
+  getSweepTransactions,
+  getTowerServerInfo,
+  getUtxos,
+  getWalletInfo,
+  getWalletStatus,
+  getWalletVersion,
+  grantAccess,
+  isDestinationPayable,
+  lockUtxo,
+  openChannel,
+  openChannels,
+  partiallySignPsbt,
+  pay,
+  payViaPaymentDetails,
+  payViaPaymentRequest,
+  payViaRoutes,
+  prepareForChannelProposal,
+  probeForRoute,
+  proposeChannel,
+  recoverFundsFromChannel,
+  recoverFundsFromChannels,
+  removeAdvertisedFeature,
+  removeExternalSocket,
+  removePeer,
+  requestBatchedFeeIncrease,
+  requestChainFeeIncrease,
+  revokeAccess,
+  sendMessageToPeer,
+  sendToChainAddress,
+  sendToChainAddresses,
+  sendToChainOutputScripts,
+  setAutopilot,
+  settleHodlInvoice,
+  signBytes,
+  signChainAddressMessage,
+  signMessage,
+  signPsbt,
+  signTransaction,
+  stopDaemon,
+  subscribeToBackups,
+  subscribeToBlocks,
+  subscribeToChainAddress,
+  subscribeToChainSpend,
+  subscribeToChannels,
+  subscribeToForwardRequests,
+  subscribeToForwards,
+  subscribeToGraph,
+  subscribeToInvoice,
+  subscribeToInvoices,
+  subscribeToOpenRequests,
+  subscribeToPastPayment,
+  subscribeToPastPayments,
+  subscribeToPayViaDetails,
+  subscribeToPayViaRequest,
+  subscribeToPayViaRoutes,
+  subscribeToPayments,
+  subscribeToPeerMessages,
+  subscribeToPeers,
+  subscribeToProbeForRoute,
+  subscribeToRpcRequests,
+  subscribeToTransactions,
+  subscribeToWalletStatus,
+  unauthenticatedLndGrpc,
+  unlockUtxo,
+  unlockWallet,
+  updateAlias,
+  updateColor,
+  updateChainTransaction,
+  updateConnectedWatchtower,
+  updateGroupSigningSession,
+  updatePathfindingSettings,
+  updateRoutingFees,
+  verifyAccess,
+  verifyBackup,
+  verifyBackups,
+  verifyBytesSignature,
+  verifyChainAddressMessage,
+  verifyMessage,
+};

package/lnd_grpc/api_for_proto.js

@@ -0,0 +1,21 @@
+const grpc = require('@grpc/grpc-js');
+const {loadSync} = require('@grpc/proto-loader');
+
+const grpcOptions = require('./grpc_options');
+
+/** Get an api for a proto file
+
+  {
+    path: <Proto File Path String>
+    service: <Service Name String>
+    type: <RPC Type String>
+  }
+
+  @returns
+  <API Object>
+*/
+module.exports = ({credentials, params, path, service, socket, type}) => {
+  const rpc = grpc.loadPackageDefinition(loadSync(path, grpcOptions));
+
+  return new rpc[type][service](socket, credentials, params);
+};

package/lnd_grpc/authenticated_lnd_grpc.d.ts

@@ -0,0 +1,30 @@
+import {LndAuthentication} from './unauthenticated_lnd_grpc';
+
+export type AuthenticatedLnd = {
+  autopilot: any;
+  chain: any;
+  default: any;
+  invoices: any;
+  router: any;
+  signer: any;
+  tower_client: any;
+  tower_server: any;
+  wallet: any;
+  version: any;
+};
+
+export type LndAuthenticationWithMacaroon = LndAuthentication & {
+  /** Base64 or Hex Serialized Macaroon String */
+  macaroon?: string;
+};
+
+/**
+ * Initiate a gRPC API Methods Object for authenticated methods
+ *
+ * Both the `cert` and `macaroon` expect the entire serialized LND generated file
+ */
+export function authenticatedLndGrpc(
+  auth: LndAuthenticationWithMacaroon
+): {
+  lnd: AuthenticatedLnd;
+};

package/lnd_grpc/authenticated_lnd_grpc.js

@@ -0,0 +1,84 @@
+const {join} = require('path');
+
+const {loadSync} = require('@grpc/proto-loader');
+
+const apiForProto = require('./api_for_proto');
+const {defaultSocket} = require('./../grpc');
+const grpcCredentials = require('./grpc_credentials');
+const grpcOptions = require('./grpc_options');
+const {grpcSslCipherSuites} = require('./../grpc');
+const {maxReceiveMessageLength} = require('./../grpc');
+const {packageTypes} = require('./../grpc');
+const {protoFiles} = require('./../grpc');
+const {protosDir} = require('./../grpc');
+const {serviceTypes} = require('./../grpc');
+
+const {GRPC_SSL_CIPHER_SUITES} = process.env;
+const {keys} = Object;
+const pathForProto = proto => join(__dirname, protosDir, proto);
+
+/** Initiate a gRPC API Methods Object for authenticated methods
+
+  Both the cert and macaroon expect the entire serialized LND generated file
+
+  {
+    [cert]: <Base64 or Hex Serialized LND TLS Cert>
+    [macaroon]: <Base64 or Hex Serialized Macaroon String>
+    [path]: <Path to Proto Files Directory String>
+    [socket]: <Host:Port Network Address String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    lnd: {
+      autopilot: <Autopilot API Methods Object>
+      chain: <ChainNotifier API Methods Object>
+      default: <Default API Methods Object>
+      invoices: <Invoices API Methods Object>
+      peers: <Peers API Methods Object>
+      router: <Router API Methods Object>
+      signer: <Signer Methods API Object>
+      tower_client: <Watchtower Client Methods Object>
+      tower_server: <Watchtower Server Methods API Object>
+      wallet: <WalletKit gRPC Methods API Object>
+      version: <Version Methods API Object>
+    }
+  }
+*/
+module.exports = ({cert, macaroon, path, socket}) => {
+  const {credentials} = grpcCredentials({cert, macaroon});
+  const lndSocket = socket || defaultSocket;
+
+  if (!!cert && GRPC_SSL_CIPHER_SUITES !== grpcSslCipherSuites) {
+    process.env.GRPC_SSL_CIPHER_SUITES = grpcSslCipherSuites;
+  }
+
+  const params = {
+    'grpc.max_receive_message_length': -1,
+    'grpc.max_send_message_length': -1,
+  };
+
+  // Assemble different services from their proto files
+  return {
+    lnd: keys(serviceTypes).reduce((services, type) => {
+      const service = serviceTypes[type];
+
+      const file = protoFiles[service];
+
+      services[type] = apiForProto({
+        credentials,
+        params,
+        service,
+        path: !!path ? join(path, file) : pathForProto(file),
+        socket: lndSocket,
+        type: packageTypes[service],
+      });
+
+      return services;
+    },
+    {}),
+  };
+};

package/lnd_grpc/decode_serialized.js

@@ -0,0 +1,25 @@
+const {from} = Buffer;
+const isHex = n => !(n.length % 2) && /^[0-9A-F]*$/i.test(n);
+
+/** Get decoded Base64 or Hex encoded data
+
+  {
+    [serialized]: <Serialized Data String>
+  }
+
+  @returns
+  {
+    [decoded]: <Deserialized Data Buffer>
+  }
+*/
+module.exports = ({serialized}) => {
+  if (!!serialized && !isHex(serialized)) {
+    return {decoded: from(serialized, 'base64')};
+  }
+
+  if (!!serialized && isHex(serialized)) {
+    return {decoded: from(serialized, 'hex')};
+  }
+
+  return {};
+};

package/lnd_grpc/grpc_credentials.js

@@ -0,0 +1,50 @@
+const grpc = require('@grpc/grpc-js');
+
+const decodeSerialized = require('./decode_serialized');
+const grpcSsl = require('./grpc_ssl');
+
+const {combineChannelCredentials} = grpc.credentials;
+const {createFromMetadataGenerator} = grpc.credentials;
+const {Metadata} = grpc;
+
+const generate = macaroon => {
+  const metadata = new Metadata();
+
+  try { metadata.add('macaroon', macaroon.toString('hex')); } catch (err) {}
+
+  return metadata;
+};
+
+/** Credentials for gRPC
+
+  {
+    [cert]: <Base64 or Hex Serialized LND TLS Cert>
+    [macaroon]: <Base64 or Hex Serialized Macaroon String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    credentials: <gRPC Credentials Object>
+  }
+*/
+module.exports = ({cert, macaroon}) => {
+  if (!macaroon) {
+    return {credentials: grpcSsl({cert}).ssl};
+  }
+
+  const mac = decodeSerialized({serialized: macaroon}).decoded;
+
+  if (!mac) {
+    generate(mac);
+
+    throw new Error('ExpectedBase64OrHexEncodedMacaroonToCreateCredentials');
+  }
+
+  const creds = createFromMetadataGenerator((_, c) => c(null, generate(mac)));
+  const {ssl} = grpcSsl({cert});
+
+  return {credentials: combineChannelCredentials(ssl, creds)};
+};

package/lnd_grpc/grpc_options.js

@@ -0,0 +1,7 @@
+module.exports = {
+  defaults: true,
+  enums: String,
+  keepCase: true,
+  longs: String,
+  oneofs: true,
+};

package/lnd_grpc/grpc_ssl.js

@@ -0,0 +1,20 @@
+const grpc = require('@grpc/grpc-js');
+
+const decodeSerialized = require('./decode_serialized');
+
+const {createSsl} = grpc.credentials;
+
+/** Get SSL for gRPC
+
+  {
+    [cert]: <Cert Hex or Base64 String>
+  }
+
+  @returns
+  {
+    ssl: <SSL gRPC Object>
+  }
+*/
+module.exports = ({cert}) => {
+  return {ssl: createSsl(decodeSerialized({serialized: cert}).decoded)};
+};

package/lnd_grpc/index.d.ts

@@ -0,0 +1,2 @@
+export * from './authenticated_lnd_grpc';
+export * from './unauthenticated_lnd_grpc';

package/lnd_grpc/index.js

@@ -0,0 +1,5 @@
+const authenticatedLndGrpc = require('./authenticated_lnd_grpc');
+const isLnd = require('./is_lnd');
+const unauthenticatedLndGrpc = require('./unauthenticated_lnd_grpc');
+
+module.exports = {authenticatedLndGrpc, isLnd, unauthenticatedLndGrpc};

package/lnd_grpc/is_lnd.js

@@ -0,0 +1,14 @@
+/** Determine if object is an expected LND Object
+
+  {
+    [lnd]: <LND Object>
+    [method]: <Method Name String>
+    [type]: <Method Type String>
+  }
+
+  @returns
+  <Is Expected LND Object Bool>
+*/
+module.exports = ({lnd, method, type}) => {
+  return !!lnd && !!lnd[type] && !!lnd[type][method];
+};

package/lnd_grpc/make_metadata.js

@@ -0,0 +1,21 @@
+const grpc = require('@grpc/grpc-js');
+// const grpc = require('grpc');
+
+/** Make metadata
+
+  {
+    macaroon: <Macaroon Buffer Object>
+  }
+
+  @returns
+  {
+    metadata: <Metadata Object>
+  }
+*/
+module.exports = ({macaroon}) => {
+  const metadata = new grpc.Metadata();
+
+  metadata.add('macaroon', macaroon);
+
+  return {metadata};
+};

package/lnd_grpc/unauthenticated_lnd_grpc.d.ts

@@ -0,0 +1,19 @@
+export type LndAuthentication = {
+  /** Base64 or Hex Serialized LND TLS Cert String */
+  cert?: string;
+  /** Path to proto files */
+  path?: string;
+  /** Host:Port String */
+  socket?: string;
+};
+
+export type UnauthenticatedLnd = {
+  unlocker: any;
+};
+
+/**
+ * Unauthenticated gRPC interface to the Lightning Network Daemon (lnd).
+ */
+export function unauthenticatedLndGrpc(
+  auth: LndAuthentication
+): {lnd: UnauthenticatedLnd};