README.md

Bitkit

This repository is the umbrella index for Bitkit. It explains the architecture and points to the production repositories for the native apps and core dependencies.

Overview

Bitkit ships as native iOS and Android apps that share a Rust core via FFI. This repo is intentionally lightweight; build and development instructions live in the app and core repos.

Architecture

flowchart TD
  bitkitIos["bitkit-ios"]
  bitkitAndroid["bitkit-android"]

  subgraph rust["Shared Rust Layer"]
    bitkitCore["bitkit-core"]
    ldkNode["ldk-node"]
    vssFfi["vss-rust-client-ffi"]
    bitkitCore ~~~ ldkNode ~~~ vssFfi
  end

  bitkitIos -->|FFI| rust
  bitkitAndroid -->|FFI| rust

Loading

Related repos

• synonymdev/bitkit-android - Native Android app (Compose).
• synonymdev/bitkit-ios - Native iOS app (SwiftUI).
• synonymdev/bitkit-core - Rust core library with FFI bindings for iOS and Android.
• synonymdev/vss-rust-client-ffi - VSS client FFI bindings for mobile apps.
• synonymdev/ldk-node - Lightning node library dependency.

Deprecated/Archived

• synonymdev/bitkit-react-native - Archived legacy React Native app (in use before 2026). New development happens in the native apps above.

Where to start

• Android app: bitkit-android/README
• iOS app: bitkit-ios/README
• Core library: bitkit-core/README
• VSS client: vss-rust-client-ffi/README
• LDK Node: ldk-node/README

License

This project is licensed under the MIT License. See the LICENSE file for more details.