v4v 0.5.22

Value-for-value helper utilities for Podcasting 2.0
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use serde_json::Value;

use crate::pc20::tlv::Record;
pub use crate::svix::webhooks::{HeaderMap, WebhookError as Error};

/// Verifies Alby webhook requests.
///
/// ## Example Axum usage
/// ```ignore
/// use axum::{
///     extract::Json,
///     routing::post,
///     Router,
///     http::StatusCode,
/// };
///
/// fn router() -> Router {
///     Router::new()
///         .route(
///             "/alby-webhook",
///             post(webhook_handler)
///         )
/// }
///
/// async fn webhook_handler(
///     headers: http::header::HeaderMap,
///     Json(body): Json<serde_json::Value>,
/// ) -> StatusCode {
///     match v4v::alby::webhooks::verify_signature(&secret, body.to_string().as_bytes(), &headers) {
///         Ok(()) => {}
///         Err(e) => {
///             log::error!("Failed to verify webhook: {:?}", e);
///             return StatusCode::BAD_REQUEST;
///         }
///     };
///
///     match save_to_db(&body).await {
///         Ok(_) => StatusCode::NO_CONTENT,
///         Err(e) => {
///             log::error!("Failed to record Alby payment: {}", e);
///             StatusCode::INTERNAL_SERVER_ERROR
///         }
///     }
/// }
/// ```
pub fn verify_signature<HM: HeaderMap>(
    secret: &str,
    payload: &[u8],
    headers: &HM,
) -> Result<(), Error> {
    crate::svix::webhooks::Webhook::new(secret)?.verify(payload, headers)
}

/// Alby invoice obtained via webhook request.
#[derive(Debug, serde::Deserialize, Clone)]
pub struct AlbyInvoice {
    /// 24 alphanumeric characters
    pub identifier: String,

    /// e.g., "incoming" or "outgoing"
    #[serde(rename = "type")]
    pub type_: String,

    /// Description.
    #[serde(default)]
    pub memo: Option<String>,

    /// State of the invoice, e.g., "SETTLED">
    pub state: String,

    /// Arbitrary data added during the invoice creation.
    #[serde(default)]
    pub metadata: Value,

    /// Payer name.
    #[serde(default)]
    pub payer_name: Option<String>,

    /// Amount in sats.
    #[serde(rename = "amount")]
    pub num_sats: u64,

    /// When the invoice was created.
    pub created_at: chrono::DateTime<chrono::Utc>,

    /// bLIP-10 TLV record.
    #[serde(
        default,
        deserialize_with = "crate::pc20::tlv::deserialize_untrusted_tlv_record"
    )]
    pub boostagram: Option<Record>,
}

/// Extracts an Alby invoice from a webhook request body.
pub fn extract_alby_invoice(body: &Value) -> Result<AlbyInvoice, String> {
    serde_json::from_value(body.clone()).map_err(|e| e.to_string())
}