ddk

The main DLC Dev Kit library for building DLC applications with an integrated BDK wallet.

DDK provides a high-level, pluggable framework with an actor-based architecture for thread-safe, lock-free DLC operations. It integrates wallet management, transport layers, storage backends, and oracle clients into a unified API.

Usage

$ cargo add ddk

Example

use ddk::builder::{Builder, SeedConfig};
use ddk::oracle::kormir::KormirOracleClient;
use ddk::storage::sled::SledStorage;
use ddk::transport::lightning::LightningTransport;
use std::sync::Arc;

type ApplicationDdk = ddk::DlcDevKit<LightningTransport, SledStorage, KormirOracleClient>;

#[tokio::main]
async fn main() -> Result<(), ddk::error::Error> {
    let transport = Arc::new(LightningTransport::new(&[0u8; 32], 1776, logger.clone())?);
    let storage = Arc::new(SledStorage::new("/tmp/ddk-example", logger.clone())?);
    let oracle = Arc::new(KormirOracleClient::new("http://localhost:8082", None, logger.clone()).await?);

    let mut builder: Builder<LightningTransport, SledStorage, KormirOracleClient> = Builder::new();
    builder.set_seed_bytes(SeedConfig::Random)?;
    builder.set_transport(transport);
    builder.set_storage(storage);
    builder.set_oracle(oracle);

    let ddk: ApplicationDdk = builder.finish().await?;

    ddk.start()?;

    // Send a DLC offer
    let offer = ddk.send_dlc_offer(&contract_input, counterparty, announcements).await?;

    // Accept a DLC offer  
    let (contract_id, counter_party, accept) = ddk.accept_dlc_offer(contract_id).await?;

    // Get wallet balance
    let balance = ddk.balance().await?;

    ddk.stop()?;
    Ok(())
}

Key Types

Features

License

This project is licensed under the MIT License.