Docs
Wallet teams should start in the repositories. The guides below are the current source for pins, porting rules, and the desktop wallet’s layout. This page links to them. It does not fork them.
For the short comparison with embedded mwebd, and which path to take, see the FAQ.
Decide which path you are on
If you are building the kind of app the desktop wallet is, take the Rust path.
- Rust wallet, desktop, or server
- Use
bdk_walletwith the Litecoin branch ofbdkand themwebfeature. The desktop wallet is the product reference for that Rust path. It is not the UniFFI surface. - iOS, macOS, or Android without Rust in-process
- Use
bdk-ffion thelitecoin-mwebbranch. Apple platforms go through theltc-swiftpackage. Android consumes the AAR from thebdk-ffireleases. The iOS and Android sample apps are checklists for that API, not the desktop product.
A pin to start from
The adoption guide (opens in a new tab) is the source of truth for pins. This SwiftPM pin is one of the blessed consumer tags from that table:
.package(url: "https://github.com/LitecoinDevKit/ltc-swift", exact: "3.1.0-litecoin.2")Start here
- 01
Adopt the library
ADOPTION.md
The map of repositories, the choice between the Rust crates and the mobile bindings, and the blessed dependency pins. This site does not copy that pin table.
Open on GitHub (opens in a new tab)
- 02
Leave embedded mwebd
MIGRATE_FROM_MWEBD.md
Start here if a wallet currently embeds mwebd. Read it before the rest of the adoption guide.
Open on GitHub (opens in a new tab)
- 03
How the port stays thin
PORTING.md
How the Litecoin branch stays a thin layer on upstream BDK: crate names stay put, and Cargo renames the bitcoin dependency onto the litecoin crate. Read it before assuming the fork rewrote the library.
Open on GitHub (opens in a new tab)
- 04
Prove the guide
DOGFOOD_CHECKLIST.md
A timed pass of the adoption guide on a clean clone. Use it to check that the pins and the first session still work.
Open on GitHub (opens in a new tab)
- 05
Wallet architecture
ARCHITECTURE.md
How the desktop wallet is layered: wallet-core as the BDK boundary, the LitVM crate beside it, and a Tauri shell that never sees BDK types directly.
Open on GitHub (opens in a new tab)
- 06
Verify a desktop release
VERIFYING.md
How to check a desktop release: checksums, build provenance, and what an unsigned macOS or Windows build does and does not prove.
Open on GitHub (opens in a new tab)