> ## Documentation Index
> Fetch the complete documentation index at: https://shinydapps-bd9fa40b.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Python SDK

> Referência completa do SDK Python l402kit — decorator para FastAPI e Flask para APIs pay-per-call com Bitcoin Lightning.

## Instalação

```bash theme={null}
pip install l402kit
```

**Requisitos**: Python 3.11+, FastAPI ou Flask (opcional)

***

## Modo Soberano (você fica com 100%)

Traga seu próprio provedor Lightning — os pagamentos vão diretamente para sua carteira, 0% de taxas.

```python theme={null}
import os
from fastapi import FastAPI, Request
from l402kit import l402_required
from l402kit.providers.blink import BlinkProvider

app = FastAPI()

lightning = BlinkProvider(
    api_key=os.environ["BLINK_API_KEY"],
    wallet_id=os.environ["BLINK_WALLET_ID"],
)

@app.get("/api/data")
@l402_required(price_sats=10, lightning=lightning)
async def get_data(request: Request):
    return {"data": "premium content"}
```

<Note>
  O Python também suporta o **modo Gerenciado** — use `ManagedProvider.from_address("voce@blink.sv")` (taxa de 0,3%, sem necessidade de nó). Veja a seção [Provedores](#providers) abaixo.
</Note>

***

## Flask

```python theme={null}
import os
from flask import Flask, jsonify
from l402kit import l402_required
from l402kit.providers.blink import BlinkProvider

app = Flask(__name__)

lightning = BlinkProvider(
    api_key=os.environ["BLINK_API_KEY"],
    wallet_id=os.environ["BLINK_WALLET_ID"],
)

@app.route("/api/data")
@l402_required(price_sats=10, lightning=lightning)
def get_data():
    return jsonify({"data": "premium content"})

if __name__ == "__main__":
    app.run(port=3000)
```

<Warning>
  **Flask + Gunicorn com workers gevent/eventlet**: `l402_required` chama o provedor Lightning assíncrono a partir de um handler Flask síncrono. Se seu worker do Gunicorn usar monkey-patching com gevent ou eventlet (que cria um event loop em execução), o decorator detecta isso automaticamente e executa a chamada assíncrona em uma thread dedicada — nenhuma ação é necessária. Workers síncronos padrão do Gunicorn e uvicorn (FastAPI) não são afetados.
</Warning>

***

## `@l402_required` — decorator

### Parâmetros

| Parâmetro    | Tipo                | Padrão          | Descrição                                      |
| ------------ | ------------------- | --------------- | ---------------------------------------------- |
| `price_sats` | `int`               | **obrigatório** | Preço por chamada em satoshis                  |
| `lightning`  | `LightningProvider` | **obrigatório** | Seu backend Lightning                          |
| `replay`     | `ReplayAdapter`     | em memória      | Backend de proteção contra replay substituível |

### Comportamento

| Requisição                          | Resposta                           |
| ----------------------------------- | ---------------------------------- |
| Sem cabeçalho `Authorization`       | `402` com invoice, macaroon, preço |
| `L402 <macaroon>:<preimage>` válido | Handler executa normalmente        |
| Token inválido ou expirado          | `401 Unauthorized`                 |
| preimage repetido                   | `401 Token already used`           |

### Resposta 402

```json theme={null}
{
  "error": "Payment Required",
  "price_sats": 10,
  "invoice": "lnbc100n1...",
  "macaroon": "eyJoYXNoIjoiYWJjMTIzIiwiZXhwIjoxNzAwMDAwMDAwfQ=="
}
```

***

## Provedores

### `BlinkProvider`

[Blink](https://blink.sv) — carteira Lightning custodial gratuita, sem KYC para pequenos valores.

```python theme={null}
from l402kit.providers.blink import BlinkProvider

blink = BlinkProvider(
    api_key=os.environ["BLINK_API_KEY"],    # dashboard.blink.sv → API Keys
    wallet_id=os.environ["BLINK_WALLET_ID"],
)
```

### `LNbitsProvider`

```python theme={null}
from l402kit.providers.lnbits import LNbitsProvider

lnbits = LNbitsProvider(
    api_key=os.environ["LNBITS_API_KEY"],
    base_url="https://your-lnbits.com",  # optional
)
```

### `OpenNodeProvider`

```python theme={null}
from l402kit.providers.opennode import OpenNodeProvider

opennode = OpenNodeProvider(
    api_key=os.environ["OPENNODE_API_KEY"],
    test_mode=False,  # True for sandbox
)
```

### `ManagedProvider` — modo cloud (taxa de 0,3%)

l402kit.com hospeda o nó Lightning. Você recebe 99,7% de cada pagamento — sem necessidade de configurar um nó.

```python theme={null}
from l402kit import ManagedProvider

lightning = ManagedProvider.from_address("you@blink.sv")

# Opcional: registre no diretório público de APIs
lightning = ManagedProvider.from_address("you@blink.sv", register_directory={
    "url": "https://api.you.com/v1/weather",
    "name": "Weather API",
    "price_sats": 10,
    "category": "weather",
})
```

***

## Proteção contra replay

### Padrão — em memória (desenvolvimento)

Integrado, sem necessidade de configuração. Reinicia ao reiniciar o processo.

### Redis (produção — múltiplas instâncias)

Para implantações com múltiplos workers Gunicorn/uvicorn, compartilhe o estado de replay via Redis:

```python theme={null}
import os, redis
from l402kit import l402_required, RedisReplayAdapter

r = redis.Redis.from_url(os.environ["REDIS_URL"])
replay = RedisReplayAdapter(r, ttl_seconds=86400)

@app.get("/api/data")
@l402_required(
    price_sats=10,
    lightning=lightning,
    replay=replay,
)
async def get_data(request: Request):
    return {"data": "premium content"}
```

`RedisReplayAdapter` usa `SET key 1 NX EX ttl` — atômico e livre de condições de corrida.

***

## Utilitários avulsos

```python theme={null}
from l402kit.verify import verify_token
from l402kit.replay import check_and_mark_preimage

# Verificar um token (True / False)
is_valid = verify_token("eyJoYXNoIjoiYWJjMTIzIiwiZXhwIjoxNzAwMDAwMDAwfQ==:deadbeef...")

# Verificação manual de replay
is_first_use = check_and_mark_preimage(preimage)
# True = primeiro uso, False = já utilizado
```

***

## Provedor personalizado

```python theme={null}
from l402kit.types import LightningProvider, Invoice
import base64, json, time

class MyProvider(LightningProvider):
    async def create_invoice(self, amount_sats: int) -> Invoice:
        result = await my_node.create_invoice(amount_sats)
        exp = int((time.time() + 3600) * 1000)
        macaroon = base64.b64encode(
            json.dumps({"hash": result.hash, "exp": exp}).encode()
        ).decode()
        return Invoice(
            payment_request=result.bolt11,
            payment_hash=result.hash,
            macaroon=macaroon,
            amount_sats=amount_sats,
            expires_at=exp,
        )

    async def check_payment(self, payment_hash: str) -> bool:
        return await my_node.is_paid(payment_hash)
```

***

## Testes

```python theme={null}
import hashlib, base64, json, time, os
from l402kit.verify import verify_token

def make_test_token() -> str:
    preimage = os.urandom(32).hex()
    payment_hash = hashlib.sha256(bytes.fromhex(preimage)).hexdigest()
    exp = int((time.time() + 3600) * 1000)
    macaroon = base64.b64encode(
        json.dumps({"hash": payment_hash, "exp": exp}).encode()
    ).decode()
    return f"{macaroon}:{preimage}"

assert verify_token(make_test_token()) is True
```

***

## Execução

```bash theme={null}
# FastAPI
uvicorn main:app --port 3000

# Flask
python app.py

# Teste — dispara 402
curl http://localhost:3000/api/data

# Pague a invoice e então:
curl -H "Authorization: L402 <macaroon>:<preimage>" http://localhost:3000/api/data
```

***

## L402Client — pagamento automático

`L402Client` encapsula o `httpx` e gerencia automaticamente o fluxo completo de 402 → pagamento → nova tentativa.

```python theme={null}
from l402kit import L402Client
from l402kit.wallets import BlinkWallet

wallet = BlinkWallet(
    api_key=os.environ["BLINK_API_KEY"],
    wallet_id=os.environ["BLINK_WALLET_ID"],
)

client = L402Client(wallet=wallet)
data = client.get("https://api.example.com/premium").json()
```

### Carteiras

| Classe        | Instalação            | Descrição                                          |
| ------------- | --------------------- | -------------------------------------------------- |
| `BlinkWallet` | `pip install l402kit` | Pague via API GraphQL do [Blink](https://blink.sv) |
| `AlbyWallet`  | `pip install l402kit` | Pague via API REST do [Alby](https://getalby.com)  |

```python theme={null}
from l402kit.wallets import BlinkWallet, AlbyWallet

blink = BlinkWallet(api_key="...", wallet_id="...")
alby  = AlbyWallet(access_token=os.environ["ALBY_TOKEN"])
```

***

## AsyncL402Client — async/await

`AsyncL402Client` usa `httpx.AsyncClient` internamente — ideal para FastAPI, asyncio e frameworks de agentes de IA que rodam em um event loop assíncrono.

```python theme={null}
import asyncio
from l402kit import AsyncL402Client
from l402kit.wallets import BlinkWallet

async def main():
    async with AsyncL402Client(
        wallet=BlinkWallet(os.environ["BLINK_API_KEY"], os.environ["BLINK_WALLET_ID"]),
        budget_sats=500,
    ) as client:
        r = await client.get("https://api.example.com/premium")
        print(r.json())

asyncio.run(main())
```

### Diferença em relação ao `L402Client`

|                | `L402Client`       | `AsyncL402Client`                   |
| -------------- | ------------------ | ----------------------------------- |
| Cliente HTTP   | `httpx` (síncrono) | `httpx.AsyncClient`                 |
| `get` / `post` | síncrono           | `async`                             |
| Melhor para    | Scripts, Flask     | FastAPI, asyncio, LangChain `_arun` |
| Budget / cache | ✅ igual            | ✅ igual                             |

***

## DevProvider + DevWallet — desenvolvimento local

Desenvolvimento local sem configuração — sem nó Lightning, sem pagamentos reais. Criptograficamente idêntico à produção: `SHA256(preimage) === paymentHash`.

```python theme={null}
from l402kit.dev import DevProvider, DevWallet
from l402kit import L402Client, l402_required
from fastapi import FastAPI, Request

app = FastAPI()
provider = DevProvider()
wallet   = DevWallet(provider)

@app.get("/premium")
@l402_required(price_sats=1, lightning=provider)
async def premium(request: Request):
    return {"data": "premium content"}

# Cliente — paga automaticamente sem Lightning real
client = L402Client(wallet=wallet)
data   = client.get("http://localhost:8000/premium").json()
```