lndconnect
Generate and parse lndconnect uris https://github.com/LN-Zap/lndconnect ⚡️
This package provides utilities for generating and parsing lndconnect uris.
For more information take a look at the specification of the uri format.
Table of Contents
Install
npm install lndconnect --save
Usage
format({ host, cert, macaroon }):
Formats a host / cert / macaroon combo into an lndconnect link.
const connectionString =
encode({ host, cert, macaroon }):
Encodes a host / cert / macaroon combo and formats into an lndconnect link.
const connectionString =
decode(lndconnectUri):
Decodes an lndconnect link into it's component parts (host / cert as utf8 / macaroon as hex)
const host cert macaroon =
Certificate
encodeCert(cert, format):
Encodes a certificate (String or Buffer) to base64url encoded DER format.
const certPath = pathconst cert = // returns base64url encoded DER cert.
decodeCert(encodedCert):
Decodes a certificate from base64url encoded DER format to a string.
// pass a base64url encoded DER certconst cert = // returns utf8 encoded PEM cert.
Macaroon
encodeMacaroon(macaroon, format):
Encodes a binary macaroon (String or Buffer) to base64url encoded string.
const macaroonPath = pathconst macaroon = // returns base64url encoded macaroon.
decodeMacaroon(encodedMacaroon):
Decodes a base64url encoded macaroon to a hex encoded macaroon.
// pass a base64url encoded macaroonconst macaroon = // returns hex encoded macaroon.
Testing
Run the tests suite:
npm test
Maintainers
Contribute
Feel free to dive in! Open an issue or submit PRs.
lndconnect follows the Contributor Covenant Code of Conduct.
License
MIT © Tom Kirkpatrick