Skip to content

dylanbathurst/lnnpm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lnnpm ⚡

Lightning Network Package Manager - A wrapper around npm that enables Lightning Network tips for open source developers.

Installation

Install globally via npm:

npm install -g lnnpm

Usage

Use lnnpm exactly like npm, but with Lightning tip opportunities:

# Install packages with optional Lightning tips
lnnpm install lntips

# All other npm commands work normally
lnnpm test
lnnpm run build
lnnpm publish

Cache Management

# List cached payments
lnnpm cache list

# Clear payment cache
lnnpm cache clear

For Package Authors

Add Lightning tip information to your package.json:

{
  "name": "your-awesome-package",
  "version": "1.0.0",
  "lightning": {
    "address": "developer@getalby.com",
    "suggestedTip": {
      "sats": 1000,
      "message": "Thanks for using my package! Your tips help me maintain this project ⚡"
    }
  }
}

Lightning Address Setup

To receive tips, you'll need a Lightning address from providers like:

How It Works

  1. Non-blocking: Package installation always proceeds, whether you tip or not
  2. Caching: Payments are cached for 30 days to avoid repeat prompts
  3. Real Lightning: Generates actual Lightning invoices with QR codes
  4. npm Compatible: Works with all existing npm commands and workflows

Example Flow

$ lnnpm install lntips

🔍 Checking for Lightning tip opportunities...

⚡ Lightning Tip Opportunities Found!

📦 lntips@1.0.0
   Lightning: maintainer@getalby.com
   Suggested tip: 500 sats
   Message: "Thanks for using lntips! ⚡"

💡 Tip lntips developer? (y/N): y
   🔄 Resolving Lightning address...
   ⚡ Lightning Invoice Generated!
   Amount: 500 sats
   Payment Hash: a1b2c3d4e5f6g7h8...

   📱 Scan QR code with your Lightning wallet:
   [QR CODE DISPLAYED]

   💡 Or copy the invoice above to your Lightning wallet
   ⏳ Checking for payment... (will timeout in 30 seconds)
   🎉 Payment received! Thank you for supporting open source! ⚡

📦 Installing packages...

Requirements

  • Node.js 14.0.0 or higher
  • npm (comes with Node.js)
  • Lightning wallet (for making payments)

Privacy & Security

  • No personal data is collected
  • Payment cache is stored locally only
  • All Lightning transactions are peer-to-peer
  • No registration or accounts required

Contributing

This is an open source project. Issues and pull requests welcome!

License

MIT License - see LICENSE file for details

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published