Skip to content

README.md

Latest commit

 

History

History
62 lines (43 loc) · 1.63 KB

README.md

File metadata and controls

62 lines (43 loc) · 1.63 KB

⚡ Lightning Payment Validator

A simple web application that validates Lightning Network payments by verifying payment preimages against their corresponding invoices.

🌐 Live App

Check out the live application here.

🚀 Features

  • Supports both BOLT11 and BOLT12 invoice formats
  • Automatic invoice format detection
  • Real-time validation feedback
  • Clean and simple user interface
  • URL parameter support for external use

🛠️ Technologies Used

  • React.js
  • light-bolt11-decoder
  • bolt12-decoder

🏃‍♂️ Running Locally

  1. Clone the repository:
git clone https://github.com/yourusername/validate-payment.git
  1. Install dependencies:
cd validate-payment
npm install

Note: This project includes an .npmrc file that automatically uses --legacy-peer-deps to resolve dependency conflicts between React Scripts 5.0.1 and newer TypeScript versions required by bolt12-decoder.

  1. Start the development server:
npm start

The app will open automatically in your browser at http://localhost:3000.

📝 Documentation

URL Parameters

You can validate payments by passing parameters in the URL:

https://validate-payment.netlify.app/?invoice=<INVOICE>&preimage=<PREIMAGE>

Supports both BOLT11 and BOLT12 formats:

  • BOLT11 invoices (starting with lnbc or lntb)
  • BOLT12 invoices (starting with lni)

🤝 Contributing

We welcome contributions from the community.

📜 License

This project is licensed under the MIT License. See the LICENSE file for more information.