Nitrate Processed Mincemeat
Miss any of our Open RFC calls?Watch the recordings here! »

lightning

3.0.11 • Public • Published

Lightning

npm version Coverage Status Build Status

Methods for working with the Lightning Network

LND Authentication

To connect to an LND node, authentication details are required.

Export credentials via CLI: balanceofsatoshis: npm install -g balanceofsatoshis and export via bos credentials --cleartext

Or export them manually:

Run base64 on the tls.cert and admin.macaroon files to get the encoded authentication data to create the LND connection. You can find these files in the LND directory. (~/.lnd or ~/Library/Application Support/Lnd)

base64 ~/.lnd/tls.cert | tr -d '\n'
base64 ~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon | tr -d '\n'

You can then use these to interact with your LND node directly:

const {authenticatedLndGrpc} = require('lightning');
 
const {lnd} = authenticatedLndGrpc({
  cert: 'base64 encoded tls.cert file',
  macaroon: 'base64 encoded admin.macaroon file',
  socket: '127.0.0.1:10009',
});

To access unauthenticated methods like the wallet unlocker, use unauthenticatedLndGrpc instead.

Methods

authenticatedLndGrpc

Initiate an gRPC API Methods Object for LND authenticated methods.

{
  [cert]: <Base64 or Hex Serialized LND TLS Cert>
  macaroon: <Base64 or Hex Serialized Macaroon String>
  [socket]: <Host:Port 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>
    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>
  }
}

Example:

const {authenticatedLndGrpc} = require('lightning');
 
const {lnd} = authenticatedLndGrpc({
  cert: 'base64 encoded tls.cert',
  macaroon: 'base64 encoded admin.macaroon',
  socket: '127.0.0.1:10009',
});

emitGrpcEvents

Emit events from a gRPC call

{
  [cert]: <Base64 or Hex Serialized LND TLS Cert String>
  [socket]: <Host:Port Network Address String>
  ws: {
    on: <Add Event Listener Function>
    send: <Send Data Function>
  }
}

Example:

const {emitGrpcEvents} = require('lightning');
const {Server} = require('ws');
 
const app = express();
 
const server = app.listen(port);
 
const wss = new Server({server});
 
wss.on('listening', () => {});
wss.on('connection', ws => emitGrpcEvents({cert, socket, ws}));

grpcRouter

Get a gRPC gateway router

{
  [cert]: <Base64 or Hex Serialized LND TLS Cert String>
  [socket]: <Host:Port Network Address String>
}

@returns
<Router Object>

Example:

const {grpcRouter, lndGateway} = require('lightning');
 
const app = express();
 
// Start an Express server
app.listen(port);
 
// Attach grpc as a router
app.use('/grpc/', grpcRouter({}));

lndGateway

Interface to an LND gateway server.

{
  [cert]: <Base64 or Hex Serialized Gateway TLS Cert String>
  [macaroon]: <Use Base 64 Encoded Macaroon String>
  request: <Request Function>
  url: <LND Gateway URL String>
}

@throws
<Error>

@returns
{
  lnd: <LND gRPC Gateway Object>
}

Example:

const {lndGateway} = require('lightning');
const request = require('request');
 
// Set request to npm request package, macaroon to base64, url to Express server
const {lnd} = lndGateway({request, macaroon, url});
 
// Use lnd to make API calls proxied through the grpcRouter gateway server

unauthenticatedLndGrpc

Unauthenticated gRPC interface to the Lightning Network Daemon (LND).

Make sure to provide a cert when using LND with its default self-signed cert

{
  [cert]: <Base64 or Hex Serialized LND TLS Cert String>
  [socket]: <Host:Port String>
}

@throws
<Error>

@returns
{
  lnd: {
    unlocker: <Unlocker LND GRPC Api Object>
  }
}

Example:

const {unauthenticatedLndGrpc} = require('lightning');
const {lnd} = unauthenticatedLndGrpc({});

Install

npm i lightning

DownloadsWeekly Downloads

1,627

Version

3.0.11

License

MIT

Unpacked Size

1.16 MB

Total Files

334

Last publish

Collaborators

  • avatar