> ## 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.

# Rust SDK

> Referencia completa del SDK de Rust l402-kit — middleware de axum para APIs de pago por llamada con Bitcoin Lightning.

## Instalación

```bash theme={null}
cargo add l402kit
```

O en `Cargo.toml`:

```toml theme={null}
[dependencies]
l402kit = "1.9"
```

**Requisitos**: Rust 1.75+, runtime asíncrono Tokio

***

## Inicio rápido

La forma más rápida utiliza `ManagedProvider` — no se necesita nodo Lightning, comisión del 0.3%:

```rust theme={null}
use axum::{middleware, routing::get, Router, Json};
use l402kit::{l402_middleware, Options, ManagedProvider};
use serde_json::{json, Value};
use std::sync::Arc;

#[tokio::main]
async fn main() {
    let provider = ManagedProvider::new("you@yourdomain.com".into());
    let opts = Arc::new(Options::new(10, provider));

    let app = Router::new()
        .route("/api/data", get(handler))
        .route_layer(middleware::from_fn_with_state(opts, l402_middleware));

    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
    axum::serve(listener, app).await.unwrap();
}

async fn handler() -> Json<Value> {
    Json(json!({ "data": "premium content" }))
}
```

Para el modo soberano (0% de comisión), implementa el trait `LightningProvider` — consulta [Proveedor personalizado](#custom-provider) más abajo.

***

## Proveedor personalizado

```rust theme={null}
use std::sync::Arc;
use l402kit::{Options, LightningProvider, Invoice, BoxFuture, L402Error};

struct MyProvider;

impl LightningProvider for MyProvider {
    fn create_invoice<'a>(&'a self, amount_sats: u64) -> BoxFuture<'a, Result<Invoice, L402Error>> {
        Box::pin(async move {
            Ok(Invoice {
                payment_request: "lnbc...".into(),
                payment_hash: "abc123...".into(),
                macaroon: "eyJ...".into(),
                amount_sats,
            })
        })
    }
}

let opts = Arc::new(Options::new(10, Arc::new(MyProvider)));
```

***

## `Options`

| Campo        | Tipo                                  | Descripción                                    |
| ------------ | ------------------------------------- | ---------------------------------------------- |
| `price_sats` | `u64`                                 | Precio por llamada en satoshis (**requerido**) |
| `lightning`  | `Arc<dyn LightningProvider>`          | Tu backend de Lightning (**requerido**)        |
| `on_payment` | `Option<Box<dyn Fn(L402Token, u64)>>` | Callback ejecutado tras cada pago verificado   |

### Obsoleto: `with_address()`

`Options::with_address(address)` fue eliminado en v1.4.0. Usa `Options::new(sats, ManagedProvider::new(address))` en su lugar:

```rust theme={null}
use l402kit::{Options, ManagedProvider};
use std::sync::Arc;

let provider = ManagedProvider::new("you@yourdomain.com".into());
let opts = Arc::new(Options::new(10, provider));
```

***

## `l402_middleware(opts: Options)`

Devuelve un `axum::middleware::Layer` compatible con axum 0.8+.

### Comportamiento

| Solicitud                           | Respuesta                                                          |
| ----------------------------------- | ------------------------------------------------------------------ |
| Sin encabezado `Authorization`      | `402` + `WWW-Authenticate: L402 macaroon="...", invoice="lnbc..."` |
| `L402 <macaroon>:<preimage>` válido | El handler se ejecuta                                              |
| Token inválido o expirado           | `401 Unauthorized`                                                 |
| preimage reutilizado                | `401 Token already used`                                           |

### Cuerpo de la respuesta 402

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

***

## Callback `on_payment`

```rust theme={null}
use l402kit::{Options, L402Token};

let opts = Arc::new(
    Options::new(10, provider).on_payment(|token: L402Token, amount_sats: u64| {
        println!("payment received: {} sats", amount_sats);
    }),
);
```

***

## Feature flags

```toml theme={null}
[features]
default = ["axum-middleware"]
axum-middleware = ["dep:axum", "dep:reqwest", "dep:http"]
```

Desactiva `axum-middleware` para usar únicamente las funciones de verificación del núcleo sin axum ni reqwest:

```toml theme={null}
l402kit = { version = "1.9", default-features = false }
```

***

## Verificación

`SHA256(preimage) == paymentHash` se verifica localmente usando el crate `sha2` — sin llamada de red en la ruta crítica. La expiración del token se comprueba en la misma operación.

***

## Códigos de error

| Estado | Significado                         |
| ------ | ----------------------------------- |
| `402`  | Sin token de pago — paga la factura |
| `401`  | Token inválido o macaroon expirado  |
| `401`  | preimage reutilizado (ya usado)     |

***

## Ejecución

```bash theme={null}
cargo run

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

# Paga la factura, luego:
curl -H "Authorization: L402 <macaroon>:<preimage>" http://localhost:3000/api/data
```