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.

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.

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

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

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

• 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.
• pubky/paykit-rs - Paykit payment discovery and Pubky routing with mobile FFI bindings.

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

• 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
• Paykit: paykit-rs/README

• Store release-note checks — drafting, translations and store submission readback for both native apps.
• Release QA method — derive release sanity checks and retain test evidence in the E2E repository.

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