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

paymeformyapi

v0.0.5

Published

API Paywall

Downloads

3

Readme

Pay Me For My API

Add lightning paywalls to your api

How to use

You can view this commit to see paymeformyapi being added to a next.js project

npm i --save paymeformyapi
  • Generate an LNBits instance and install the User Manager extension
  • Create a new user & wallet, this will be the user that receives payments for every api request
  • Save the inkey from this user's wallet
// Initialize the package

import PayMeForMyAPI from 'paymeformyapi'

const paywall = new PayMeForMyAPI({
  lnBitsAdminId: process.env.LN_BITS_ADMIN_ID,
  lnBitsApiKey: process.env.LN_BITS_API_KEY,
  lnBitsURL: process.env.LN_BITS_URL,
  lnBitsAdminInvoiceKey: process.env.LN_BITS_ADMIN_INVOICE_KEY,
  refillAmount: 50, // number of satoshis to refill
  requestCost: 1, // number of satoshis per API call
})
// Add a paywall to an API route

const { api_token } = req.query // Get the api_token from the request somehow

const {
    success,           // User successfully paid for this request
    updated_api_token, // User has never paid for api access, or is out of sats, generate a new api token for them
    invoice            // Lightning invoice to refill their API access
} = await paywall.deductBalance(api_token)

if (!success) {
    res.status(402).json({
        message: 'Payment required. Please pay the invoice and update your api token.',
        updated_api_token,
        invoice,
    })

    return
}