npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lnurl-offline

v1.2.0

Published

Node.js module to support LNURL offline devices

Downloads

1,259

Readme

lnurl-offline

Build Status

Node.js module to support LNURL offline devices. Provides set of helper functions to verify signed URLs and decrypt XOR-encrypted payloads generated by LNURL offline devices such as the Bleskomat ATM, bleskomat-diy, LNPoS, and LNURLVend.

LNURL offline devices can be grouped by whether they use lnurl-withdraw (LUD-03) or lnurl-pay (LUD-06) - ie. whether they facilitate receiving or sending Lightning payments:

  • Point-of-sale terminals and Vending machines use lnurl-pay with an encrypted payload containing the amount and a random PIN. The PIN and amount are learned by the web server by decrypting the payload using a shared secret with the device. After decryption of the payload, the normal lnurl-pay flow is followed. The PIN is revealed to the customer's mobile wallet app once the associated Lightning invoice has been paid and acts as a proof of payment that is easy and quick to read and verify by a human.

  • ATMs use lnurl-withdraw with a signature to ensure the integrity of the amount and fiat currency symbol. The web server can verify the signature by using a shared secret key with the device. A Lightning payment is made by the server only if the signature can be validated.

  • Installation

  • Usage

  • Tests

  • Changelog

  • License

Installation

Add to your application via npm:

npm install lnurl-offline

Usage

Decrypt XOR Payload

Below is an example decrypting a XOR-encrypted payload generated by an LNPoS or LNURLVend device:

const { xor } = require('lnurl-offline');
const url = require('url');
const exampleUrl = 'http://localhost:3000/lnurlpos/device-id?p=AQhnxmlzUf9K7AWNqCRW3RbzzGjqckZA';
const parsedUrl = url.parse(exampleUrl, true);
const { query } = parsedUrl;
const { p } = query;
const key = Buffer.from('super-secret-key', 'utf8');
const payload = Buffer.from(p, 'base64');
const { pin, amount } = xor.decrypt(key, payload);
console.log({ pin, amount });// pin = 1234, amount = 21

HMAC-SHA256 Signature Check

Below is an example HMAC-SHA256 signature check for a signed URL generated by a Bleskomat ATM or DIY device:

const { isValidSignedQuery } = require('lnurl-offline');
const url = require('url');
const apiKey = {
	id: '7f6e30c87012dc3b7bf8',
	key: '5375baf547756f91225dbfcc40b18e7ddba478c4cdf6f18a668a8efa33a0e3b3',
	encoding: 'hex',
};
const exampleUrl = 'http://localhost:3000/lnurl?id=7f6e30c87012dc3b7bf8&n=ac0284a9560f9abe760c&s=bb183dcf8b17fd12641722e718fb75209816a43a60238ecb13db1e4748960dbb&t=w&pn=1000&px=1000&pd=';
const { query } = url.parse(exampleUrl, true);
const key = Buffer.from(apiKey.key, apiKey.encoding);
console.log(isValidSignedQuery(query, key) ? 'OK' : 'INVALID SIGNATURE');

Tests

Run automated tests as follows:

npm test

Changelog

See CHANGELOG.md

License

This software is MIT licensed:

A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. There are many variations of this license in use.