Crate cdk_common

Expand description

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.

§CDK Common

ALPHA This library is in early development, the API will change and should be used with caution.

Common types and utilities shared across the Cashu Development Kit (CDK) crates.

§Installation

Add this to your Cargo.toml:

[dependencies]
cdk-common = "*"

§Features

This crate provides common functionality used across CDK crates including:

Common data types and structures
Shared traits and interfaces
Utility functions
Error types

The http feature enables CDK common’s HTTP-facing helpers and re-exports, including cdk-http-client types, the WebSocket client re-export, HTTP error conversion, and OIDC auth helpers.

cdk-common/http selects the default bitreq backend so consumers get a working HTTP client automatically. Applications that need the reqwest backend can add a direct cdk-http-client dependency with the reqwest feature; backend features are additive, and reqwest takes precedence when both are enabled.

§License

This project is licensed under the MIT License.

Re-exports§

pub use common::FinalizedMelt;
pub use error::Error;
pub use melt::MeltQuoteCreateResponse;
pub use melt::MeltQuoteRequest;
pub use melt::MeltQuoteResponse;
pub use mint_quote::MintQuoteRequest;
pub use mint_quote::MintQuoteResponse;
pub use bitcoin;
pub use cashu::lightning_invoice;
pub use parking_lot;

Modules§

amount: CDK Amount
common: Types
database: CDK Database
dhke: Diffie-Hellmann key exchange
error: Errors
melt: Unified Melt Quote types for melt use-cases.
mint: Mint types
mint_quote: Unified Mint Quote types for mint use-cases.
mint_url: Url
nut00: NUT-00: Notation and Models
nut01: NUT-01: Mint public key exchange
nut02: NUT-02: Keysets and keyset ID
nut03: NUT-03: Swap
nut04: NUT-04: Mint Tokens via Bolt11
nut05: NUT-05: Melting Tokens
nut06: NUT-06: Mint Information
nut07: NUT-07: Spendable Check
nut08: NUT-08: Lightning fee return
nut09: NUT-09: Restore signatures
nut10: NUT-10: Spending conditions
nut11: NUT-11: Pay to Public Key (P2PK)
nut12: NUT-12: Offline ecash signature validation
nut13: NUT-13: Deterministic Secrets
nut14: NUT-14: Hashed Time Lock Contacts (HTLC)
nut15: NUT-15: Multipart payments
nut16: NUT-16: Animated QR codes
nut17: Specific Subscription for the cdk crate
nut18: NUT-18: Payment Requests
nut19: NUT-19: Cached Responses
nut20: Mint Quote Signatures
nut21: 21 Clear Auth
nut22: 22 Blind Auth
nut23: Bolt11
nut25: Bolt12
nut26: NUT-26: Payment Request Bech32m Encoding
nut28: Pay-to-Blinded-Key (P2BK) Implementation
nut29: NUT-29: Batch Mint Tokens
nut30: NUT-30 onchain payment method
nuts: Nuts
payment: CDK mint payment backend interface
pub_sub: Publish/Subscribe core
quote_id: Quote ID. The specifications only define a string but CDK uses Uuid, so we use an enum to port compatibility.
redact: Helpers for formatting potentially sensitive values safely.
secret: Secret
state: State transition rules
stream: Supervision for long-lived streaming subscriptions.
subscription: Subscription types and traits
task: Thin wrapper for spawn and spawn_local for native and wasm.
util: Cashu utils
wallet: Wallet Types
ws: Websocket types and functions for the CDK.

Structs§

Amount: Amount can be any unit
AuthProof: Auth Proofs
BatchCheckMintQuoteRequest: Batch check mint quote request per NUT-29
BatchMintRequest: Batch mint request per NUT-29
BlindAuthSettings: Blind auth settings
BlindAuthToken: Blind Auth Token
BlindSignature: Blind Signature (also called promise)
BlindSignatureDleq: Blinded Signature on Dleq
BlindedMessage: Blinded Message (also called output)
Bolt11Invoice: Represents a syntactically and semantically correct lightning BOLT11 invoice.
CheckStateRequest: Check spendable request [NUT-07]
CheckStateResponse: Check Spendable Response [NUT-07]
ClearAuthSettings: Clear Auth Settings
Conditions: P2PK and HTLC spending conditions
ContactInfo: Contact Info
HTLCWitness: HTLC Witness
Id: A keyset ID is an identifier for a specific keyset. It can be derived by anyone who knows the set of public keys of a mint. The keyset ID CAN be stored in a Cashu token such that the token can be used to identify which mint or keyset it was generated from.
KeySet: Keyset
KeySetInfo: KeySetInfo
Keys: Mint public keys per amount.
KeysResponse: Mint Public Keys [NUT-01]
KeysetResponse: Mint Keysets [NUT-02] Ids of mints keyset ids
MeltMethodSettings: Melt Method Settings
MeltOnchainRequest: Melt onchain request
MeltQuoteBolt11Request: BOLT11 melt quote request [NUT-23]
MeltQuoteBolt11Response: Melt quote response [NUT-05]
MeltQuoteBolt12Request: Melt quote request [NUT-18]
MeltQuoteBolt12Response: Melt quote response [NUT-25]
MeltQuoteCustomRequest: Custom payment method melt quote request
MeltQuoteCustomResponse: Custom payment method melt quote response
MeltQuoteOnchainRequest: Melt quote onchain request
MeltQuoteOnchainResponse: Melt quote onchain response
MeltRequest: Melt Bolt11 Request [NUT-05]
MintAuthRequest: Mint auth request [NUT-XX]
MintInfo: Mint Info [NUT-06]
MintKeySet: MintKeyset
MintMethodSettings: Mint Method Settings
MintQuoteBolt11Request: Mint quote request [NUT-04]
MintQuoteBolt11Response: Mint quote response [NUT-04]
MintQuoteBolt12Request: Mint quote request [NUT-24]
MintQuoteBolt12Response: Mint quote response [NUT-24]
MintQuoteCustomRequest: Custom payment method mint quote request
MintQuoteCustomResponse: Custom payment method mint quote response
MintQuoteOnchainRequest: Mint quote onchain request
MintQuoteOnchainResponse: Mint quote onchain response
MintRequest: Mint request [NUT-04]
MintResponse: Mint response [NUT-04]
MintVersion: Mint Version
Mpp: Multi-part payment
MppMethodSettings: Mpp Method Settings
NUT04Settings: Mint Settings
NUT05Settings: Melt Settings
NUT15Settings: Mpp Settings
Nut10Secret: NUT10 Secret
Nut10SecretRequest: Nut10Secret without nonce for payment requests
Nut29Settings: NUT-29 Settings for mint info
Nuts: Supported nuts and settings
P2PKWitness: P2Pk Witness
PaymentRequest: NUT-18 payment request.
PaymentRequestBuilder: Builder for PaymentRequest
PaymentRequestPayload: Payment Request Payload
PreMint: PreMint
PreMintSecrets: Premint Secrets
PreSwap: Preswap information
Proof: Proofs
ProofDleq: Proof Dleq
ProofState: Proof state [NUT-07]
ProtectedEndpoint: List of the methods and paths that are protected
PublicKey: PublicKey
RestoreRequest: Restore Request [NUT-09]
RestoreResponse: Restore Response [NUT-09]
SecretData: Secret Date
SecretKey: Secret key material.
SupportedMethod: Payment method accepted by the receiver for a payment request.
SwapRequest: Swap Request [NUT-03]
SwapResponse: Split Response [NUT-06]
TokenUrDecoder: Reassembles a Token from scanned UR fragments
TokenUrEncoder: Encodes a Token into UR fragments for display as an animated QR code
TokenV3: Token
TokenV4: Token V4
Transport: Transport
TransportBuilder: Builder for Transport

Enums§

AuthRequired: Required Auth
AuthToken: Auth Token
CurrencyUnit: Currency Unit
Kind: NUT10 Secret Kind
MeltOptions: Melt Options
MeltQuoteState: Possible states of a quote
Method: HTTP method
MintQuoteState: Possible states of a quote
NotificationPayload: Subscription response
PaymentMethod: Payment Method
QuoteId: Mint Quote ID
QuoteIdError: Invalid UUID
RoutePath: Route path
SigFlag: Signature flag
SpendingConditions: Spending Conditions
State: State of Proof
Token: Token Enum
TransportType: Transport Type
Witness: Witness

Constants§

MINT_RPC_PROTOCOL_VERSION: Protocol version for gRPC Mint RPC communication
PAYMENT_PROCESSOR_PROTOCOL_VERSION: Protocol version for gRPC Payment Processor communication

Statics§

SECP256K1: Secp256k1 global context

Traits§

ProofsMethods: Utility methods for Proofs
SpendingConditionVerification: Trait for requests that spend proofs (SwapRequest, MeltRequest)

Type Aliases§

Proofs: List of Proof

Crate cdk_common

Crate cdk_common Copy item path

§CDK Common

§Installation

§Features

§License

Re-exports§

Modules§

Structs§

Enums§

Constants§

Statics§

Traits§

Type Aliases§

Crate cdk_common