https://github.com/bitkarrot/plebnetlink
Plebnet.link - this ia modified clone of Satspay Session
https://github.com/bitkarrot/plebnetlink
Last synced: 12 months ago
JSON representation
Plebnet.link - this ia modified clone of Satspay Session
- Host: GitHub
- URL: https://github.com/bitkarrot/plebnetlink
- Owner: bitkarrot
- Created: 2024-01-12T23:56:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T21:15:03.000Z (about 2 years ago)
- Last Synced: 2024-05-06T22:27:54.625Z (about 2 years ago)
- Language: Python
- Homepage: https://plebnetlink.vercel.app
- Size: 633 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Plebnet.link
- this ia modified clone of Satspay Session
This micro app delivers a custom Invoice amount from the SatsPayExtension fron LNbits via an FastAPI endpoint.
Why do this? Because we want to be able to specify a lightning invoice in sats with the USD amount (or any other fiat equivalent amount) with a link instead of creating it manually from within the LNBits web interface.
This is a personal service, so in order to use it with your LNBits account you'll need to put in your credentials and then 1 Click deploy to vercel ( See below ) or self host it yourself.
### Flow Diagram:
Create LINK ---> convert fiat amt to sats, add optional message ---->
----> forward to SatsPayServer on LNBits --> Display Timed QR Code
### LINK Pattern:
https://pblink.vercel.app/fiat/{currency}/amt/{value}
### Example:
This is a live example, where the repo is deployed at satspaylink.vercel.app and the user specifies currency type and amount at the url:
https://pblink.vercel.app/fiat/usd/amt/100
The above link, given the parameters of 100 USD, will calculate the equivalent amount of sats and
then redirect the user to a lightning invoice created by the satspayserver extension.
Clicking on the above link will redirect to the lnbits satspay extension with the lightning invoice conversion automatically.
## Environment variables
For More information about how SatsPay Server works in LNBits, please visit the [extension page](https://github.com/lnbits/satspay)
and the [LNbits.com website](https://lnbits.com)
set your LNBits environment variables in vercel
```sh
LNBITS_WALLET='your data here'
ONCHAIN_WALLET='your data here'
LNBITS_URL='https://legend.lnbits.com'
INVOICE_API_KEY='your data here'
WEBHOOK='https://yoururlhere.com'
```
```
headers = {
"Content-Type": "application/json",
"X-Api-Key": INVOICE_API_KEY,
}
```
## Json passed in body
```
{
"onchainwallet": "string",
"lnbitswallet": "string",
"description": "string",
"webhook": "string",
"completelink": "string",
"completelinktext": "string",
"custom_css": "string",
"time": 1,
"amount": 1,
"extra": "{\"mempool_endpoint\": \"https://mempool.space\", \"network\": \"Mainnet\"}"
}
```
# FastAPI + Vercel
This example shows how to use FastAPI on Vercel with Serverless Functions using the [Python Runtime](https://vercel.com/docs/concepts/functions/serverless-functions/runtimes/python).
## 1-Click Deploy to Vercel
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fbitkarrot%2Fplebnetlink&env=LNBITS_WALLET,ONCHAIN_WALLET,LNBITS_URL,WEBHOOK,INVOICE_API_KEY)
## To install
```sh
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
## To run this app locally
```sh
uvicorn src.app:app --reload
```
### running with ssl cert
```sh
openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365
```
then
```sh
uvicorn src.app:app --ssl-keyfile key.pem --ssl-certfile cert.pem
```
Your application is now available at `http://localhost:8000`.