Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bennyhodl/dlcdevkit
application tooling for dlc's 🌊
https://github.com/bennyhodl/dlcdevkit
bitcoin dlc finance rust
Last synced: 22 days ago
JSON representation
application tooling for dlc's 🌊
- Host: GitHub
- URL: https://github.com/bennyhodl/dlcdevkit
- Owner: bennyhodl
- License: mit
- Created: 2024-05-14T13:24:59.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-12-18T17:56:20.000Z (25 days ago)
- Last Synced: 2024-12-18T18:41:13.602Z (25 days ago)
- Topics: bitcoin, dlc, finance, rust
- Language: Rust
- Homepage: https://dlcdevkit.com
- Size: 22.5 MB
- Stars: 19
- Watchers: 1
- Forks: 7
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dlc Dev Kit
[](https://crates.io/crates/ddk)
[](https://docs.rs/ddk)
> :warning: `dlcdevkit` is alpha software and should not be used with real money. API is subject to change.
Application tooling to get started with [DLCs](https://github.com/discreetlogcontracts/dlcspecs) build with [rust-dlc](https://github.com/p2pderivatives/rust-dlc) and [bdk](https://github.com/bitcoindevkit/bdk).
Build DLC application by plugging in your own transport, storage, and oracle clients.
## Get Started
```
$ cargo add ddk
```
```rust
use ddk::builder::Builder;
use ddk::storage::SledStorage;
use ddk::transport::lightning::LightningTransport; // with "lightning" feature
use ddk::oracle::KormirOracleClient;
use bitcoin::Network;
use std::sync::Arc;
type ApplicationDdk = ddk::DlcDevKit;
#[tokio::main]
fn main() {
let transport = Arc::new(LightningTransport::new([0u8;32], , Network::Regtest));
let storage = Arc::new(SledStorage::new("")?);
let oracle_client = Arc::new(KormirOracleClient::new("").await?);
let ddk: ApplicationDdk = Builder::new()
.set_seed_bytes([0u8;32])
.set_network(Network::Regtest)
.set_esplora_path("http://127.0.0.1:3000")
.set_transport(transport.clone())
.set_storage(storage.clone())
.set_oracle(oracle_client.clone())
.finish()
.expect("could not build ddk node");
ddk.start().expect("ddk could not start");
}
```
## Crates
Ready-to-go clients for developing applications:
[`ddk`](./ddk/) - DLC management with an internal BDK wallet.
[`ddk-node`](./ddk-node/) - A ready-to-go node with an accompanying cli.
[`payouts`](./payouts/) - Functions to build DLC contracts.
You can create a custom DDK instance by implementing the required traits for storage and transport. DDK traits are defined in [ddk/src/lib.rs](./ddk/src/lib.rs). The traits are super traits from what is required in `bdk` and `rust-dlc`.
To quickly get started building a DDK application, there are pre-built components.
### Storage
[`sled`](./ddk/src/storage/sled) - A simple file based storage using [sled](https://crates.io/crates/sled)
### Transport
[`LDK Peer Manager`](./ddk/src/transport/lightning/) - Communication over Lightning gossip using [`rust-dlc's implementation`](https://github.com/p2pderivatives/rust-dlc/blob/master/dlc-messages/src/message_handler.rs)
[`nostr`](./ddk/src/transport/nostr/) - DLC communication from the [NIP-88 spec](https://github.com/nostr-protocol/nips/pull/919)
### Oracle Clients
[`P2PDerivatives`](./ddk/src/oracle/p2p_derivatives.rs) - Spot price futures on the Bitcoin price [repo](https://github.com/p2pderivatives/p2pderivatives-oracle)
[`kormir`](./ddk/src/oracle/kormir.rs) - Enumeration based oracle with server and nostr support [repo](https://github.com/benthecarman/kormir)
## Development
A bitcoin node, esplora server, and oracle server are required to run DDK. Developers can spin up a development environment with the `justfile` provided.
```
$ just deps
```
Go to the README in [ddk-node](./ddk-node/README.md) to start the project's DDK node example and more development information.