Skip to content
A typed gRPC client for LND
JavaScript Shell
Branch: master
Clone or download
Latest commit acc6aa0 Jul 26, 2019


CircleCI Known Vulnerabilities NPM Version License

Maintained fork of lnrpc adding support for generating typescript type definitions.


  • Auto-generates lnd/lnrpc client and typescript definitons based on target release tag
  • Wraps requests in promises
  • Easily setup SSL and Macaroons
  • Instantiates all gRPC services
  • uint64/int64 types cast to string


npm install @radar/lnrpc
# OR
yarn add @radar/lnrpc

Install lnd before using this project and ensure you have an lnd instance running with --no-macaroons, unless you provide macaroon authentication to your lnrpc instance when created.

Change LND gRPC release version

To change the gRPC definitions used for all auto-generated types and RPC methods edit the config.lnd_release_tag value in package.json to the desired LND release tag and run the following:

npm run update-proto
# OR
yarn update-proto


npm run generate
# OR
yarn generate

Newly generated type definitions will be available in ./generated.


Connecting to an lnd instance at localhost:10001.

import createLnRpc, {
} from '@radar/lnrpc';

(async function() {
  const lnRpcClient = await createLnRpc();

  // All requests are promisified and typed
  const balanceResponse: WalletBalanceResponse = await lnRpcClient.walletBalance();

  // ...and you're off!

  // subscribe to LND server events
  const subscriber = await lnRpcClient.subscribeInvoices();
  subscriber.on('data', (invoice: Invoice) => {
    console.log(invoice); // do something with invoice event


import createLnRpc, {
} from '@radar/lnrpc';

(async function() {
  const lnRpcClient = await createLnRpc({
     By default lnrpc connects to `localhost:10001`,
     however we can point to any host.
    server: '',

     By default  lnrpc looks for your tls certificate at:
     `~/.lnd/tls.cert`, unless it detects you're using macOS and
     defaults to `~/Library/Application\ Support/Lnd/tls.cert`
     however you can configure your own SSL certificate path like:
    tls: './path/to/tls.cert',

     You can also provide a TLS certificate directly as a string
     (Just make sure you don't commit this to git).
     Overwrites: `tls`
    cert: process.env.MY_SSL_CERT,

     Optional path to configure macaroon authentication
     from LND generated macaroon file.
    macaroonPath: './path/to/data/admin.macaroon',

     Optional way to configure macaroon authentication by
     passing a hex encoded string of your macaroon file.
     Encoding: `xxd -ps -u -c 1000 ./path/to/data/admin.macaroon`
    macaroon: process.env.MY_MACAROON_HEX,

  try {
    const getInfoResponse: GetInfoResponse = await lnRpcClient.getInfo();
  } catch (error) {

API Reference

All lnrpc methods documentation can be found here.

Usage With BTCPayServer

By default lnrpc assumes SSl certificate pinning. In order to use lnrpc with a service (like BTCPayServer) which manages your certification, you'll have to opt to disable certificate pinning by passing { tls: false } within your lnrpc configuration.


To develop on the project please run:

git clone && cd $_

npm install
npm start
# OR
yarn start


This project is licensed under the MIT License.

You can’t perform that action at this time.