Struct DlcDevKit 

pub struct DlcDevKit<T: Transport, S: Storage, O: Oracle> {
    pub runtime: Arc<RwLock<Option<Runtime>>>,
    pub wallet: Arc<DlcDevKitWallet>,
    pub manager: Arc<Manager<Arc<DlcDevKitWallet>, Arc<CachedContractSignerProvider<Arc<DlcDevKitWallet>, SimpleSigner>>, Arc<EsploraClient>, Arc<S>, Arc<O>, Arc<SystemTimeProvider>, Arc<DlcDevKitWallet>, SimpleSigner, Arc<Logger>>>,
    pub sender: Sender<DlcManagerMessage>,
    pub transport: Arc<T>,
    pub storage: Arc<S>,
    pub oracle: Arc<O>,
    pub network: Network,
    pub stop_signal: Receiver<bool>,
    pub stop_signal_sender: Sender<bool>,
    pub logger: Arc<Logger>,
}

DDK object with all services Main DDK instance that encapsulates all DLC functionality.

This struct manages:

1. Runtime Context:

   • Single tokio runtime for all async operations
   • Background task management
   • Graceful shutdown handling

2. Core Components:

   • Wallet for Bitcoin operations
   • DLC manager for contract operations
   • Transport layer for peer communication
   • Storage backend for persistence
   • Oracle client for external data

3. Communication:

   • Message channel to the DLC manager actor
   • Stop signal broadcasting for shutdown coordination

The struct is designed to be thread-safe and can be shared across multiple threads using Arc.

Fields

runtime: Arc<RwLock<Option<Runtime>>>

Tokio runtime for async operations

wallet: Arc<DlcDevKitWallet>

Bitcoin wallet instance

manager: Arc<Manager<Arc<DlcDevKitWallet>, Arc<CachedContractSignerProvider<Arc<DlcDevKitWallet>, SimpleSigner>>, Arc<EsploraClient>, Arc<S>, Arc<O>, Arc<SystemTimeProvider>, Arc<DlcDevKitWallet>, SimpleSigner, Arc<Logger>>>

DLC manager instance

sender: Sender<DlcManagerMessage>

Channel for sending messages to the DLC manager

transport: Arc<T>

Transport layer implementation

storage: Arc<S>

Storage backend implementation

oracle: Arc<O>

Oracle client implementation

network: Network

Bitcoin network (mainnet, testnet, regtest)

stop_signal: Receiver<bool>

Receiver for stop signal

stop_signal_sender: Sender<bool>

Sender for stop signal

logger: Arc<Logger>

Logger instance for structured logging

Implementations

impl<T, S, O> DlcDevKit<T, S, O>

where T: Transport, S: Storage, O: Oracle,

pub fn start(&self) -> Result<(), Error>

Starts the DDK runtime with a new multi-threaded tokio runtime. This spawns all necessary background tasks:

• Transport layer listeners
• Wallet synchronization
• Periodic contract checks

pub fn start_with_runtime(&self, runtime: Runtime) -> Result<(), Error>

Starts the DDK runtime with a provided tokio runtime. Useful when integrating with existing async applications.

This method spawns three critical background tasks:

1. Transport Listener Thread:

• Handles incoming DLC messages
• Manages peer connections
• Routes messages to DLC manager
• Gracefully shuts down on stop signal

2. Wallet Sync Thread:

• Runs every 60 seconds
• Updates UTXO set
• Syncs with blockchain
• Maintains wallet state

3. Contract Monitor Thread:

• Runs every 30 seconds
• Checks contract states
• Triggers necessary updates
• Maintains contract lifecycle

Arguments

• runtime - A tokio runtime to use for async operations

Returns

• Ok(()) if runtime started successfully
• Err(Error::RuntimeExists) if runtime is already running

pub fn stop(&self) -> Result<(), Error>

Gracefully stops the DDK runtime and all background tasks. This ensures:

• All listeners are closed
• Background tasks are terminated
• Resources are properly cleaned up

pub fn network(&self) -> Network

Returns the configured Bitcoin network

pub async fn send_dlc_offer( &self, contract_input: &ContractInput, counter_party: PublicKey, oracle_announcements: Vec<OracleAnnouncement>, ) -> Result<OfferDlc, Error>

Creates and sends a new DLC offer to a counterparty.

This method:

1. Creates a DLC offer message
2. Sends it through the transport layer
3. Returns the created offer for further processing

pub async fn accept_dlc_offer( &self, contract: [u8; 32], ) -> Result<(String, String, AcceptDlc), Error>

Accepts an existing DLC offer.

This method:

1. Processes the acceptance
2. Creates acceptance message
3. Sends it to the counterparty
4. Returns the acceptance details

pub async fn refund_dlc( &self, contract_id: &[u8; 32], ) -> Result<Contract, Error>

Refunds a DLC contract.

This method checks if the refund locktime has passed and broadcasts the refund transaction if it has.

Arguments

• contract_id - The ID of the contract to refund

Errors if the contract maturity has not passed to broadcast refund

pub async fn balance(&self) -> Result<Balance, Error>

Retrieves the current balance state, including:

• Confirmed balance
• Unconfirmed changes
• Funds locked in contracts
• Total profit/loss from closed contracts

Trait Implementations

impl<T: Debug + Transport, S: Debug + Storage, O: Debug + Oracle> Debug for DlcDevKit<T, S, O>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.