-
@ plebdevs.com
2024-11-15 21:45:12Voltage Tipper ⚡
A Simple Lightning tipping app template built with NextJS and Voltage.
Voltage Tipper Video Walkthrough
To deploy, click the button below, create a free Vercel account if you don't have one, fill in the required environment variables from your Voltage node, deploy, and everything should work!
Run on Replit https://replit.com/@voltage-cloud/voltage-tipper
Table of Contents
Deployment
To deploy, click the button below, create a free Vercel account if you don't have one, fill in the required environment variables from your Voltage node, deploy, and everything should work!
Environment Variables
NEXT_PUBLIC_HOST: The host URL for your LND lightning node (not including port).NEXT_PUBLIC_INVOICE_MACAROON: The invoice macaroon.NEXT_PUBLIC_READ_MACAROON: The read-only macaroon.
Host
The host is your Node's 'API endpoint' you can copy it from your Voltage Dashboard, be sure to include 'https://'. Example:
https://plebdev.m.voltageapp.ioMacaroons
The Invoice and Read macaroons are authentication tokens that allows you to interact with your LND node's REST API with permissions for reading data, and creating invoices. You can also grab a "Admin" macaroon for permissions to spend but that is not required here since we are only receiving through this webapp, so your funds are safu.
You can find your Macaroons in your Voltage Dashboard by visiting Manage Access -> Macaroon Bakery
API
-
/api/lnurlReturns lnurlPay response object defined in LUD-06 -
/api/getlnurlReturns bech32 encoded lnurlPay -
/.well-known/lnurlp/{NodeAlias}This is your lightning address endpoint, returns lnurlPay response defined in LUD-16 -
/api/callback?amount=21000This is your callback endpoint that will return an invoice whenamountquery parameter is passed with millisat value
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.