lnd-grpc

Repository of lnd rpc protocol files and utilities for working with them ⚡️

This package provides utilities for locating and selecting lnd rpc protocol files.

Table of Contents

• Install
• Usage
• Maintainers
• Contribute
• License

Install

npm install lnd-grpc --save

Usage

getProtoDir():

Get the directory where rpc.proto files are stored.

async getProtoFiles():

Get a list of all rpc.proto files that we provide.

async getProtoVersions():

Get a list of all rpc.proto versions that we provide.

async getLatestProtoVersion():

Get the latest rpc.proto version that we provide.

async getLatestProtoFile():

Get the path to the latest rpc.proto version that we provide.

async getClosestProtoVersion(version):

Find the closest matching rpc.proto version based on an lnd version string.

const version = await getClosestProtoVersion('0.5.1-beta commit=v0.5.2-beta-rc3')
expect(version).to.equal('0.5.2-beta.rc3')

Testing

Run the tests suite:

  npm test

Maintainers

@Tom Kirkpatrick (mrfelton).

Contribute

Feel free to dive in! Open an issue or submit PRs.

lnd-grpc follows the Contributor Covenant Code of Conduct.

License

MIT © Tom Kirkpatrick