mirror of
https://github.com/aljazceru/payments-rest-api.git
synced 2025-12-18 14:14:20 +01:00
adding render.com, reorg of repo
This commit is contained in:
@@ -1,9 +1,9 @@
|
||||
# Breez SDK configuration
|
||||
BREEZ_API_KEY=your_breez_api_key_here
|
||||
SEED_PHRASE=your_mnemonic_seed_phrase_here
|
||||
BREEZ_SEED_PHRASE=your_mnemonic_seed_phrase_here
|
||||
|
||||
# API security
|
||||
API_SECRET=your_api_secret_here
|
||||
|
||||
# Woocommerce webhook (just put the top level link to your shop ie yourshop.com)
|
||||
WEBHOOK_URL=your_wordpress_url
|
||||
WEBHOOK_URL=your_wordpress_url
|
||||
@@ -7,6 +7,7 @@ This document explains deploying breez payments api to fly.io
|
||||
- Poetry (package manager)
|
||||
- [Breez Nodeless SDK API key ](https://breez.technology/request-api-key/#contact-us-form-sdk)
|
||||
- 12 words BIP 39 seed (you can use [Misty Breez](https://github.com/breez/misty-breez) to generate it)
|
||||
- api key that you will use for accessing the API (see [API Key Security](../README.md#api-key-security)). You can use generators like [this](https://1password.com/password-generator) or [this](https://www.uuidgenerator.net/).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -30,10 +31,12 @@ This document explains deploying breez payments api to fly.io
|
||||
fly auth login
|
||||
```
|
||||
3. Clone this repo
|
||||
|
||||
```bash
|
||||
git clone https://github.com/breez/payments-rest-api.git
|
||||
cd payments-rest-api
|
||||
```
|
||||
4. Launch the app:
|
||||
```bash
|
||||
cd <repo>/fly # make sure you are in the fly directory before running fly launch so it picks up fly.toml
|
||||
fly launch
|
||||
```
|
||||
|
||||
31
docs/RENDER.md
Normal file
31
docs/RENDER.md
Normal file
@@ -0,0 +1,31 @@
|
||||
## Deployment to render.com
|
||||
This document explains deploying breez payments api to render.com
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Breez Nodeless SDK API key ](https://breez.technology/request-api-key/#contact-us-form-sdk)
|
||||
- 12 words BIP 39 seed (you can use [Misty Breez](https://github.com/breez/misty-breez) to generate it)
|
||||
- [Render account](https://render.com/)
|
||||
- api key that you will use for accessing the API (see [API Key Security](../README.md#api-key-security)). You can use generators like [this](https://1password.com/password-generator) or [this](https://www.uuidgenerator.net/).
|
||||
|
||||
## Installation
|
||||
Click on **Deploy new service** button in the top right corner of the [Render dashboard](https://dashboard.render.com/).
|
||||
|
||||
|
||||
Select **Public Git Repository** and enter the repository URL: `https://github.com/breez/payments-rest-api`)
|
||||
![[render1.jpg]](./images/render1.jpg)
|
||||
|
||||
You can select your preferred region for deployment:
|
||||
|
||||
|
||||
Select **Instance type**, use `Free` for free deployment that should be enough for small usage:
|
||||
|
||||
|
||||
Configure the **Environment** with the :
|
||||
|
||||
|
||||
|
||||
After you've verified that you've correctly set the Environment variables, you are ready to click **Deploy Web Service** button to start the deployment.
|
||||
|
||||
You will see a screen like this. The circled url (yours will be different) is the url of your newly deployed Breez Payments API instance:
|
||||
|
||||
BIN
docs/images/render0.jpg
Normal file
BIN
docs/images/render0.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 198 KiB |
BIN
docs/images/render1.jpg
Normal file
BIN
docs/images/render1.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
BIN
docs/images/render2.jpg
Normal file
BIN
docs/images/render2.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
BIN
docs/images/render3.jpg
Normal file
BIN
docs/images/render3.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 206 KiB |
BIN
docs/images/render4.jpg
Normal file
BIN
docs/images/render4.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 119 KiB |
BIN
docs/images/render5.jpg
Normal file
BIN
docs/images/render5.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 186 KiB |
@@ -1,228 +0,0 @@
|
||||
import requests
|
||||
import json
|
||||
|
||||
class BreezClient:
|
||||
def __init__(self, api_url, api_key):
|
||||
"""
|
||||
Initialize the Breez client.
|
||||
|
||||
Args:
|
||||
api_url (str): The base URL of the Breez API
|
||||
api_key (str): The API key for authentication
|
||||
"""
|
||||
self.api_url = api_url
|
||||
self.headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'x-api-key': api_key
|
||||
}
|
||||
|
||||
def list_payments(self, from_timestamp=None, to_timestamp=None, offset=None, limit=None):
|
||||
"""
|
||||
List all payments with optional filters.
|
||||
|
||||
Args:
|
||||
from_timestamp (int, optional): Filter payments from this timestamp
|
||||
to_timestamp (int, optional): Filter payments to this timestamp
|
||||
offset (int, optional): Pagination offset
|
||||
limit (int, optional): Pagination limit
|
||||
|
||||
Returns:
|
||||
dict: JSON response with payment list
|
||||
"""
|
||||
params = {}
|
||||
if from_timestamp is not None:
|
||||
params["from_timestamp"] = from_timestamp
|
||||
if to_timestamp is not None:
|
||||
params["to_timestamp"] = to_timestamp
|
||||
if offset is not None:
|
||||
params["offset"] = offset
|
||||
if limit is not None:
|
||||
params["limit"] = limit
|
||||
|
||||
response = requests.get(
|
||||
f"{self.api_url}/list_payments",
|
||||
params=params,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def receive_payment(self, amount, method="LIGHTNING", description=None, asset_id=None):
|
||||
payload = {
|
||||
"amount": amount,
|
||||
"method": method
|
||||
}
|
||||
if description is not None:
|
||||
payload["description"] = description
|
||||
if asset_id is not None:
|
||||
payload["asset_id"] = asset_id
|
||||
response = requests.post(
|
||||
f"{self.api_url}/receive_payment",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def send_payment(self, destination, amount_sat=None, amount_asset=None, asset_id=None, drain=False):
|
||||
payload = {
|
||||
"destination": destination,
|
||||
"drain": drain
|
||||
}
|
||||
if amount_sat is not None:
|
||||
payload["amount_sat"] = amount_sat
|
||||
if amount_asset is not None:
|
||||
payload["amount_asset"] = amount_asset
|
||||
if asset_id is not None:
|
||||
payload["asset_id"] = asset_id
|
||||
response = requests.post(
|
||||
f"{self.api_url}/send_payment",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def health_check(self):
|
||||
"""
|
||||
Check if the API is healthy and responding.
|
||||
|
||||
Returns:
|
||||
dict: JSON response with health status
|
||||
"""
|
||||
response = requests.get(f"{self.api_url}/health")
|
||||
return self._handle_response(response)
|
||||
|
||||
def send_onchain(self, address, amount_sat=None, drain=False, fee_rate_sat_per_vbyte=None):
|
||||
"""
|
||||
Send an onchain (Bitcoin or Liquid) payment.
|
||||
Args:
|
||||
address (str): Destination address
|
||||
amount_sat (int, optional): Amount in satoshis
|
||||
drain (bool, optional): Drain all funds
|
||||
fee_rate_sat_per_vbyte (int, optional): Custom fee rate
|
||||
Returns:
|
||||
dict: JSON response
|
||||
"""
|
||||
payload = {
|
||||
"address": address,
|
||||
"drain": drain
|
||||
}
|
||||
if amount_sat is not None:
|
||||
payload["amount_sat"] = amount_sat
|
||||
if fee_rate_sat_per_vbyte is not None:
|
||||
payload["fee_rate_sat_per_vbyte"] = fee_rate_sat_per_vbyte
|
||||
response = requests.post(
|
||||
f"{self.api_url}/send_onchain",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
# LNURL-related endpoints (all under /v1/ln/)
|
||||
def parse_input(self, input_str):
|
||||
response = requests.post(
|
||||
f"{self.api_url}/v1/ln/parse_input",
|
||||
json={"input": input_str},
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def prepare_lnurl_pay(self, data, amount_sat, comment=None, validate_success_action_url=True):
|
||||
payload = {
|
||||
"data": data,
|
||||
"amount_sat": amount_sat,
|
||||
"comment": comment,
|
||||
"validate_success_action_url": validate_success_action_url
|
||||
}
|
||||
response = requests.post(
|
||||
f"{self.api_url}/v1/ln/prepare_lnurl_pay",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def lnurl_pay(self, prepare_response):
|
||||
payload = {"prepare_response": prepare_response}
|
||||
response = requests.post(
|
||||
f"{self.api_url}/v1/ln/lnurl_pay",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def lnurl_auth(self, data):
|
||||
payload = {"data": data}
|
||||
response = requests.post(
|
||||
f"{self.api_url}/v1/ln/lnurl_auth",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def lnurl_withdraw(self, data, amount_msat, comment=None):
|
||||
payload = {
|
||||
"data": data,
|
||||
"amount_msat": amount_msat,
|
||||
"comment": comment
|
||||
}
|
||||
response = requests.post(
|
||||
f"{self.api_url}/v1/ln/lnurl_withdraw",
|
||||
json=payload,
|
||||
headers=self.headers
|
||||
)
|
||||
return self._handle_response(response)
|
||||
|
||||
def _handle_response(self, response):
|
||||
"""Helper method to handle API responses."""
|
||||
try:
|
||||
if response.status_code == 200:
|
||||
return response.json()
|
||||
else:
|
||||
return {
|
||||
"error": f"Request failed with status {response.status_code}",
|
||||
"details": response.text
|
||||
}
|
||||
except Exception as e:
|
||||
return {"error": f"Failed to process response: {str(e)}"}
|
||||
|
||||
|
||||
# Example usage
|
||||
if __name__ == "__main__":
|
||||
# Configuration
|
||||
API_URL = "<url-to-your-api>" # Change to your deployed API URL
|
||||
API_KEY = "<api-key-you-set>" # Set your API key here
|
||||
|
||||
# Initialize client
|
||||
breez = BreezClient(api_url=API_URL, api_key=API_KEY)
|
||||
|
||||
# Check API health
|
||||
print("🔍 Checking API health...")
|
||||
print(breez.health_check())
|
||||
|
||||
# List payments
|
||||
print("\n🔄 Listing Payments...")
|
||||
print(json.dumps(breez.list_payments(), indent=2))
|
||||
|
||||
# LNURL Example Usage
|
||||
# lnurl = "lnurl1dp68gurn8ghj7mrww4exctnrdakj7mrww4exctnrdakj7mrww4exctnrdakj7" # Replace with a real LNURL
|
||||
# print("\n🔎 Parsing LNURL...")
|
||||
# parsed = breez.parse_input(lnurl)
|
||||
# print(json.dumps(parsed, indent=2))
|
||||
# if parsed.get("type") == "LN_URL_PAY":
|
||||
# print("\n📝 Preparing LNURL-Pay...")
|
||||
# prepare = breez.prepare_lnurl_pay(parsed["data"], amount_sat=1000)
|
||||
# print(json.dumps(prepare, indent=2))
|
||||
# print("\n🚀 Executing LNURL-Pay...")
|
||||
# result = breez.lnurl_pay(prepare)
|
||||
# print(json.dumps(result, indent=2))
|
||||
# elif parsed.get("type") == "LN_URL_AUTH":
|
||||
# print("\n🔐 Executing LNURL-Auth...")
|
||||
# result = breez.lnurl_auth(parsed["data"])
|
||||
# print(json.dumps(result, indent=2))
|
||||
# elif parsed.get("type") == "LN_URL_WITHDRAW":
|
||||
# print("\n💸 Executing LNURL-Withdraw...")
|
||||
# result = breez.lnurl_withdraw(parsed["data"], amount_msat=1000_000)
|
||||
# print(json.dumps(result, indent=2))
|
||||
|
||||
# Onchain payment example (commented out for safety)
|
||||
# print("\n⛓️ Sending Onchain Payment...")
|
||||
# result = breez.send_onchain(address="bitcoin_address_here", amount_sat=10000)
|
||||
# print(json.dumps(result, indent=2))
|
||||
Reference in New Issue
Block a user