![New axobject-query Maintainer Faces Backlash Over Controversial Decision to Support Legacy Node.js Versions](https://cdn.sanity.io/images/cgdhsj6q/production/86e6ebdea652d20da070ebbda20134b839972db7-1024x1024.webp?w=800&fit=max&auto=format)
Security News
New axobject-query Maintainer Faces Backlash Over Controversial Decision to Support Legacy Node.js Versions
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
lnurl-pay
Advanced tools
Readme
Client library for lnurl-pay and lightning address
Install the package with:
npm i lnurl-pay
# or
yarn add lnurl-pay
import { requestInvoice } from 'lnurl-pay'
const { invoice, params, successAction, validatePreimage } =
await requestInvoice({
lnUrlOrAddress:
'lnurl1dp68gurn8ghj7urp0yh8xarpva5kueewvaskcmme9e5k7tewwajkcmpdddhx7amw9akxuatjd3cz7atnv4erqgfuvv5',
tokens: 333, // satoshis
})
import { requestInvoice } from 'lnurl-pay'
const { invoice, params, successAction, validatePreimage } =
await requestInvoice({
lnUrlOrAddress: 'user@domain.com',
tokens: 333, // satoshis
})
Request an invoice for lnurl o lightning address
{
lnUrlOrAddress: <Bech32 encoded url (lnurl) or lightning address String>
tokens: <Amount in satoshis Number>
[comment]: <Comment String>
[onionAllowed]: <Onion url allowed Bool> // Default to false
[validateInvoice]: <If true validates the invoice amount and description hash Bool> // Default to false
[fetchGet]: <Function to make a GET request Function> // Default to axios get
}
@throws <Error>
@returns
{
invoice: <Invoice returned by pay service String>
successAction: <Success action defined by lnurl-rfc Object>
params: {
callback: <Url used to request the invoice String>
fixed: <Indicates if amount must be a fixed amount Bool>
min: <Min amount in satoshis Number>
max: <Max amount in satoshis Number>
domain: <Callback domain String>
metadata: <Decoded metadata Array>
metadataHash: <Metadata hash String>
identifier: <Metadata identifier String>
description: <Metadata description String>
image: <Metadata base64 image String>
commentAllowed: <Number of characters accepted for the comment query parameter Number> // Default to 0 - not allowed
}
hasValidAmount: <True if the returned invoice amount is equal to tokens param Bool>
hasValidDescriptionHash: <True if the returned invoice description hash is equal to metadata hash Bool>
validatePreimage: <validates if preimage param is valid for invoice Function> // (preimage: string) => boolean
}
Example:
const { invoice, params, successAction } = await requestInvoice({
lnUrlOrAddress:
'lnurl1dp68gurn8ghj7urp0yh8xarpva5kueewvaskcmme9e5k7tewwajkcmpdddhx7amw9akxuatjd3cz7atnv4erqgfuvv5',
tokens: 333,
})
Request pay service params for lnurl o lightning address (1st step)
{
lnUrlOrAddress: <Bech32 encoded url (lnurl) or lightning address String>
[onionAllowed]: <Onion url allowed Bool> // Default to false
[fetchGet]: <Function to make a GET request Function> // Default to axios get
}
@throws <Error>
@returns
{
callback: <Url used to request the invoice String>
fixed: <Indicates if amount must be a fixed amount Bool>
min: <Min amount in satoshis Number>
max: <Max amount in satoshis Number>
domain: <Callback domain String>
metadata: <Decoded metadata Array>
metadataHash: <Metadata hash String>
identifier: <Metadata identifier String>
description: <Metadata description String>
image: <Metadata base64 image String>
commentAllowed: <Number of characters accepted for the comment query parameter Number> // Default to 0 - not allowed
}
Example:
const params = await requestPayServiceParams({
lnUrlOrAddress:
'lnurl1dp68gurn8ghj7urp0yh8xarpva5kueewvaskcmme9e5k7tewwajkcmpdddhx7amw9akxuatjd3cz7atnv4erqgfuvv5',
})
Request an invoice for lnurl o lightning address with the given service params (2nd step)
{
params: {
callback: <Url used to request the invoice String>
fixed: <Indicates if amount must be a fixed amount Bool>
min: <Min amount in satoshis Number>
max: <Max amount in satoshis Number>
domain: <Callback domain String>
metadata: <Decoded metadata Array>
metadataHash: <Metadata hash String>
identifier: <Metadata identifier String>
description: <Metadata description String>
image: <Metadata base64 image String>
commentAllowed: <Number of characters accepted for the comment query parameter Number> // Default to 0 - not allowed
}
tokens: <Amount in satoshis Number>
[comment]: <Comment String>
[onionAllowed]: <Onion url allowed Bool> // Default to false
[validateInvoice]: <If true validates the invoice amount and description hash Bool> // Default to false
[fetchGet]: <Function to make a GET request Function> // Default to axios get
}
@throws <Error>
@returns
{
invoice: <Invoice returned by pay service String>
successAction: <Success action defined by lnurl-rfc Object>
params: {
callback: <Url used to request the invoice String>
fixed: <Indicates if amount must be a fixed amount Bool>
min: <Min amount in satoshis Number>
max: <Max amount in satoshis Number>
domain: <Callback domain String>
metadata: <Decoded metadata Array>
metadataHash: <Metadata hash String>
identifier: <Metadata identifier String>
description: <Metadata description String>
image: <Metadata base64 image String>
commentAllowed: <Number of characters accepted for the comment query parameter Number> // Default to 0 - not allowed
}
hasValidAmount: <True if the returned invoice amount is equal to tokens param>
hasValidDescriptionHash: <True if the returned invoice description hash is equal to metadata hash>
validatePreimage: <validates if preimage param is valid for invoice Function> // (preimage: string) => boolean
}
Example:
const params = await requestInvoiceWithServiceParams({
params,
tokens: 333,
})
Test with Jest framework:
yarn test
Build production (distribution) files in dist folder:
yarn build
It generates CommonJS (in dist/cjs folder), ES Modules (in dist/esm folder), bundled and minified UMD (in dist/umd folder), as well as TypeScript declaration files (in dist/types folder).
Run:
yarn link
# or
npm link
and in your test project run:
yarn link lnurl-pay
# or
npm link lnurl-pay
If you want to remove the symlink, run:
# in your test project
yarn unlink lnurl-pay
# or
npm unlink lnurl-pay
# in lnurl-pay folder
yarn unlink
# or
npm unlink
Please check more details in npm link or yarn link
This library was developed based on:
FAQs
Client library for lnurl-pay and lightning address
The npm package lnurl-pay receives a total of 172 weekly downloads. As such, lnurl-pay popularity was classified as not popular.
We found that lnurl-pay demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.