Getting started

Welcome to the Lightning Development Kit documentation!

If you have any questions about anything related to LDK, feel free to ask our community on GitHub Discussions (opens new window) or join us on Discord (opens new window).

Installation

Add LDK to a project by configuring the respective config files:

• Rust
• Kotlin

  # Add the following dependencies to your cargo.toml and replace {VERSION} with the version number you want to use.

  [dependencies]
  lightning = { version = {VERSION}, features = ["max_level_trace"] }
  lightning-block-sync = { version = {VERSION}, features = [ "rpc-client" ] }
  lightning-invoice = { version = {VERSION} }
  lightning-net-tokio = { version = {VERSION} }
  lightning-persister = { version = {VERSION} }
  lightning-background-processor = { version = {VERSION} }
  lightning-rapid-gossip-sync = { version = {VERSION} }

/*
For Gradle, add the following dependency to your build.gradle and replace {VERSION} with
the version number you want to use.
*/

dependencies {
 // ...
  implementation 'org.lightningdevkit:ldk-java:{VERSION}'
 // ...
}

/* To include the LDK Kotlin bindings in an Android project download the latest binary from https://github.com/lightningdevkit/ldk-garbagecollected/releases and place it in your libs directory.
Then add to your build.gradle file:
*/

dependencies {
    // ...
    implementation fileTree(include: ['*.aar'], dir: 'libs')
    // ...
}

Example usage after installation is complete:

• Rust
• Kotlin

use lightning::chain::chaininterface::FeeEstimator;

import org.ldk.structs.FeeEstimator

Installing LDK Swift

Add ldk-swift package using the Swift Package Manager.

To import the package, use: import LightningDevKit