LNRPC
Maintained fork of lnrpc adding support for generating typescript type definitions.
Features
- 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
Installation
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 # AND npm run generate# OR yarn generate
Newly generated type definitions will be available in ./generated
.
Usage
Connecting to an lnd instance at localhost:10001
.
; ;
Options
; ;
API Reference
All lnrpc methods documentation can be found here.
Contributors
To develop on the project please run:
git clone git@github.com:RadarTech/lnrpc.git && cd $_ npm installnpm start# OR yarnyarn start
License
This project is licensed under the MIT License.