cdk-common 0.18.0-rc.0

CDK common types and traits
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

//! This crate is the base foundation to build things that can interact with the CDK (Cashu
//! Development Kit) and their internal crates.
//!
//! This is meant to contain the shared types, traits and common functions that are used across the
//! internal crates.

#![doc = include_str!("../README.md")]

pub mod task;

/// Authentication related types and utilities
///
/// Enabled by the `http` feature because OIDC auth helpers fetch discovery and
/// JWK documents through `cdk-http-client`.
#[cfg(feature = "http")]
pub mod auth;

/// Protocol version for gRPC Mint RPC communication
pub const MINT_RPC_PROTOCOL_VERSION: &str = "1.0.0";

/// Protocol version for gRPC Payment Processor communication
pub const PAYMENT_PROCESSOR_PROTOCOL_VERSION: &str = "4.0.0";

#[cfg(feature = "grpc")]
pub mod grpc;

pub mod common;
pub mod database;
pub mod error;
pub mod melt;
#[cfg(feature = "mint")]
pub mod mint;
pub mod mint_quote;
#[cfg(feature = "mint")]
pub mod payment;
pub mod pub_sub;
/// Client-side request rate limiting (GCRA token bucket + HTTP transport
/// decorator).
///
/// Needs `wallet` for the KV-store persistence backend and `http` for the
/// `Transport` trait it decorates.
#[cfg(all(feature = "wallet", feature = "http"))]
pub mod rate_limit;
pub mod redact;
#[cfg(feature = "mint")]
pub mod state;
pub mod stream;
pub mod subscription;
#[cfg(feature = "wallet")]
pub mod wallet;
pub mod ws;

// re-exporting external crates
pub use bitcoin;
pub use cashu::amount::{self, Amount};
pub use cashu::lightning_invoice::{self, Bolt11Invoice};
pub use cashu::nuts::{self, *};
#[cfg(feature = "mint")]
pub use cashu::quote_id::{self, *};
pub use cashu::{dhke, ensure_cdk, mint_url, secret, util, SECP256K1};
/// Re-export `cdk-http-client` WebSocket client.
///
/// The `http` feature enables CDK common's HTTP-facing helpers and re-exports,
/// and selects the default `bitreq` backend. Add `cdk-http-client/reqwest`
/// elsewhere in the dependency graph to use `reqwest`; it takes precedence when
/// both backend features are enabled.
#[cfg(feature = "http")]
pub use cdk_http_client::ws as ws_client;
/// Re-export `cdk-http-client` types.
///
/// The `http` feature exposes these helpers and selects the default `bitreq`
/// backend. Applications that need SOCKS proxy or invalid-certificate support
/// can enable `cdk-http-client/reqwest`, which takes precedence over `bitreq`.
#[cfg(feature = "http")]
pub use cdk_http_client::{
    fetch, HttpClient, HttpClientBuilder, HttpError, RawResponse, RequestBuilder, Response,
};
// Re-export common types
pub use common::FinalizedMelt;
pub use error::Error;
pub use melt::{MeltQuoteCreateResponse, MeltQuoteRequest, MeltQuoteResponse};
pub use mint_quote::{MintQuoteRequest, MintQuoteResponse};
/// Re-export parking_lot for reuse
pub use parking_lot;