Compare commits

..
Author SHA1 Message Date
9qeklajc 8a74c0543f remove hardcoded deduction (legacy code) 2026-04-13 22:41:04 +02:00
9qeklajcandGitHub 3d16a9b988 Merge pull request #449 from Routstr/apikey-transactions
add apikey refund tracking
2026-04-12 22:38:40 +02:00
9qeklajc 40f98b99aa set collected state 2026-04-12 22:36:52 +02:00
9qeklajcandGitHub 7fcae5b08d Merge pull request #451 from Routstr/feature/update-deployment-docs
Updated deployment docs
2026-04-12 11:23:10 +02:00
redshift f50cb31749 Updated deployment docs 2026-04-11 22:15:50 +01:00
9qeklajc 85a1ea4b4c add apikey refund tracking 2026-04-10 15:34:19 +02:00
6 changed files with 104 additions and 79 deletions
+19 -7
View File
@@ -51,14 +51,26 @@ curl https://api.routstr.com/v1/chat/completions \
## Quick Start (Docker)
If you are a node runner, start a Routstr Core instance and configure upstream access in the dashboard.
If you are a node runner, start a Routstr Core instance using Docker Compose:
```bash
docker run -d \
--name routstr-proxy \
-p 8000:8000 \
ghcr.io/routstr/proxy:latest
```
1. **Prepare your `.env`**:
```bash
ADMIN_PASSWORD=mysecretpassword
NAME="My AI Node"
DESCRIPTION="Fast access to models"
NSEC=yournsec
RECEIVE_LN_ADDRESS=yourname@wallet.com
```
2. **Start the services**:
```bash
docker compose up -d
```
3. **Configure**:
Open [http://localhost:8000/admin/](http://localhost:8000/admin/) to connect your AI providers and set pricing.
For full instructions, see the **[Provider Quick Start Guide](https://docs.routstr.com/provider/quickstart/)**.
## Development
+5 -18
View File
@@ -6,16 +6,7 @@ Production deployment guide for Routstr Provider nodes.
For production, use Docker Compose with persistent storage and optional Tor support.
### Unified Setup (All-in-one)
To build and run the node with the UI integrated in a single container using the multi-stage build:
```bash
docker build -f Dockerfile.full -t routstr-full .
docker run -d -p 8000:8000 --env-file .env routstr-full
```
### Advanced Setup (Separated UI & Node)
Use the included `compose.yml` for a more flexible setup that separates the UI build process from the node execution. This is useful for development or when you want to manage Tor as a separate service.
Use the included `compose.yml` for a flexible setup that handles both the UI and the node execution. This is useful for development or when you want to manage Tor as a separate service.
```bash
docker compose up -d
@@ -184,20 +175,16 @@ docker compose up -d
## Building from Source
### Unified Image (UI + Node)
The easiest way to build everything from source into a single production-ready image:
### Using Docker Compose
The easiest way to build everything from source:
```bash
docker build -f Dockerfile.full -t routstr-full .
docker compose build
```
### Individual Components
If you prefer building them separately or using Docker Compose:
If you prefer building the node only (requires manual UI build first):
```bash
# Build using compose
docker compose build
# Or build the node only (requires manual UI build first)
docker build -t routstr-node .
```
+12 -24
View File
@@ -35,6 +35,7 @@ ADMIN_PASSWORD=mysecretpassword
# Node Identity
NAME="My AI Node"
DESCRIPTION="Fast access to models"
NSEC=yournsec
# Lightning Payouts
RECEIVE_LN_ADDRESS=yourname@wallet.com
@@ -43,32 +44,10 @@ RECEIVE_LN_ADDRESS=yourname@wallet.com
## 2. Start the Node
You can run the pre-built image directly:
The recommended way to run Routstr is using Docker Compose, which handles the node, the UI, and optional services like Tor.
```bash
docker run -d \
--name routstr \
-p 8000:8000 \
--env-file .env \
-v routstr-data:/app/data \
ghcr.io/routstr/proxy:latest
```
*Note: The pre-built image does not contain the UI. For the all-in-one experience with the Admin Dashboard, use the Build from Source instructions below.*
### Build from Source (Recommended)
If you want to build the node and UI yourself from source, use the unified Dockerfile:
```bash
git clone https://github.com/routstr/routstr-core.git
cd routstr-core
# Edit your .env with ADMIN_PASSWORD and API keys
cp .env.example .env
nano .env
docker build -f Dockerfile.full -t routstr-local .
docker run -d -p 8000:8000 --env-file .env --name routstr routstr-local
docker compose up -d
```
Verify it's running:
@@ -77,6 +56,15 @@ Verify it's running:
curl http://localhost:8000/v1/info
```
### Build from Source (Optional)
If you've cloned the repository and want to build the images yourself:
```bash
docker compose build
docker compose up -d
```
---
## 3. Configure via Dashboard
+5 -10
View File
@@ -182,16 +182,11 @@ def _row_to_model(
)
if apply_provider_fee:
max_prompt, max_completion, max_cost = _calculate_usd_max_costs(model)
parsed_pricing = Pricing(
**{
**parsed_pricing.dict(),
"max_prompt_cost": max_prompt,
"max_completion_cost": max_completion,
"max_cost": max_cost,
}
)
model = Model(**{**model.dict(), "pricing": parsed_pricing, "sats_pricing": None})
(
parsed_pricing.max_prompt_cost,
parsed_pricing.max_completion_cost,
parsed_pricing.max_cost,
) = _calculate_usd_max_costs(model)
try:
sats_to_usd = sats_usd_price()
+62 -19
View File
@@ -677,7 +677,9 @@ class BaseUpstreamProvider:
response_json["usage"]["cost_sats"] = (
cost_data.get("total_msats", 0) // 1000
)
response_json["usage"]["remaining_balance_msats"] = remaining_balance_msats
response_json["usage"]["remaining_balance_msats"] = (
remaining_balance_msats
)
# Keep detailed cost
response_json["metadata"] = response_json.get("metadata", {})
@@ -753,7 +755,11 @@ class BaseUpstreamProvider:
raise
async def handle_streaming_responses_completion(
self, response: httpx.Response, key: ApiKey, max_cost_for_model: int, requested_model: str | None = None
self,
response: httpx.Response,
key: ApiKey,
max_cost_for_model: int,
requested_model: str | None = None,
) -> StreamingResponse:
"""Handle streaming Responses API responses with token usage tracking and cost adjustment.
@@ -1000,7 +1006,9 @@ class BaseUpstreamProvider:
response_json["usage"]["cost_sats"] = (
cost_data.get("total_msats", 0) // 1000
)
response_json["usage"]["remaining_balance_msats"] = remaining_balance_msats
response_json["usage"]["remaining_balance_msats"] = (
remaining_balance_msats
)
# Keep detailed cost
response_json["metadata"] = response_json.get("metadata", {})
@@ -1309,7 +1317,9 @@ class BaseUpstreamProvider:
path = self.normalize_request_path(path, model_obj)
url = self.build_request_url(path, model_obj)
original_model_id = (model_obj.forwarded_model_id or model_obj.id) if model_obj else None
original_model_id = (
(model_obj.forwarded_model_id or model_obj.id) if model_obj else None
)
transformed_body = self.prepare_request_body(request_body, model_obj)
@@ -1469,7 +1479,10 @@ class BaseUpstreamProvider:
background_tasks.add_task(response.aclose)
background_tasks.add_task(client.aclose)
result = await self.handle_streaming_chat_completion(
response, key, max_cost_for_model, background_tasks,
response,
key,
max_cost_for_model,
background_tasks,
requested_model=original_model_id,
)
result.background = background_tasks
@@ -1479,7 +1492,10 @@ class BaseUpstreamProvider:
if response.status_code == 200:
try:
return await self.handle_non_streaming_chat_completion(
response, key, session, max_cost_for_model,
response,
key,
session,
max_cost_for_model,
requested_model=original_model_id,
)
finally:
@@ -1595,7 +1611,9 @@ class BaseUpstreamProvider:
path = self.normalize_request_path(path, model_obj)
url = self.build_request_url(path, model_obj)
original_model_id = (model_obj.forwarded_model_id or model_obj.id) if model_obj else None
original_model_id = (
(model_obj.forwarded_model_id or model_obj.id) if model_obj else None
)
transformed_body = self.prepare_responses_request_body(request_body, model_obj)
@@ -1683,7 +1701,9 @@ class BaseUpstreamProvider:
if is_streaming and response.status_code == 200:
result = await self.handle_streaming_responses_completion(
response, key, max_cost_for_model,
response,
key,
max_cost_for_model,
requested_model=original_model_id,
)
background_tasks = BackgroundTasks()
@@ -1695,7 +1715,10 @@ class BaseUpstreamProvider:
if response.status_code == 200:
try:
return await self.handle_non_streaming_responses_completion(
response, key, session, max_cost_for_model,
response,
key,
session,
max_cost_for_model,
requested_model=original_model_id,
)
finally:
@@ -2122,7 +2145,10 @@ class BaseUpstreamProvider:
)
refund_token = await self.send_refund(
refund_amount, unit, mint, payment_token_hash,
refund_amount,
unit,
mint,
payment_token_hash,
request_id=request_id,
)
response_headers["X-Cashu"] = refund_token
@@ -2164,7 +2190,9 @@ class BaseUpstreamProvider:
try:
data_json = json.loads(line[6:])
if "usage" in data_json and data_json["usage"]:
data_json["usage"]["cost_sats"] = cost_data.total_msats // 1000
data_json["usage"]["cost_sats"] = (
cost_data.total_msats // 1000
)
lines[i] = "data: " + json.dumps(data_json)
except json.JSONDecodeError:
pass
@@ -2265,7 +2293,10 @@ class BaseUpstreamProvider:
if refund_amount > 0:
refund_token = await self.send_refund(
refund_amount, unit, mint, payment_token_hash,
refund_amount,
unit,
mint,
payment_token_hash,
request_id=request_id,
)
response_headers["X-Cashu"] = refund_token
@@ -2320,7 +2351,6 @@ class BaseUpstreamProvider:
extra={
"original_amount": amount,
"refund_amount": emergency_refund,
"deduction": 60,
},
)
@@ -2495,7 +2525,10 @@ class BaseUpstreamProvider:
)
refund_token = await self.send_refund(
amount - 60, unit, mint, payment_token_hash,
amount,
unit,
mint,
payment_token_hash,
request_id=getattr(request.state, "request_id", None),
)
@@ -2787,7 +2820,10 @@ class BaseUpstreamProvider:
)
refund_token = await self.send_refund(
amount - 60, unit, mint, payment_token_hash,
amount,
unit,
mint,
payment_token_hash,
request_id=getattr(request.state, "request_id", None),
)
@@ -3051,7 +3087,10 @@ class BaseUpstreamProvider:
)
refund_token = await self.send_refund(
refund_amount, unit, mint, payment_token_hash,
refund_amount,
unit,
mint,
payment_token_hash,
request_id=request_id,
)
response_headers["X-Cashu"] = refund_token
@@ -3093,7 +3132,9 @@ class BaseUpstreamProvider:
try:
data_json = json.loads(line[6:])
if "usage" in data_json and data_json["usage"]:
data_json["usage"]["cost_sats"] = cost_data.total_msats // 1000
data_json["usage"]["cost_sats"] = (
cost_data.total_msats // 1000
)
lines[i] = "data: " + json.dumps(data_json)
except json.JSONDecodeError:
pass
@@ -3182,7 +3223,10 @@ class BaseUpstreamProvider:
if refund_amount > 0:
refund_token = await self.send_refund(
refund_amount, unit, mint, payment_token_hash,
refund_amount,
unit,
mint,
payment_token_hash,
request_id=request_id,
)
response_headers["X-Cashu"] = refund_token
@@ -3237,7 +3281,6 @@ class BaseUpstreamProvider:
extra={
"original_amount": amount,
"refund_amount": emergency_refund,
"deduction": 60,
},
)
+1 -1
View File
@@ -535,7 +535,7 @@ async def periodic_refund_sweep() -> None:
except Exception as e:
error_msg = str(e).lower()
if "already spent" in error_msg:
refund.swept = True
refund.collected = True
session.add(refund)
logger.info(
"Refund already spent (client collected), marking swept",