BDK Build Tool 🛠️

BDK Build Tool is a CLI utility designed to build and verify binaries for:

• bdk-flutter – Bitcoin Dev Kit for Flutter
• lwk-dart – Lightning Wallet Kit for Dart
• boltz-dart – Boltz Swap integration for Dart

Why Use BDK Build Tool?

Security Matters: Trust, but Verify

Unaudited binaries are significantly harder to inspect. Meaning binaries you download online might do things you don't expect or even run malware.

With BDK Build Tool, you can build and verify reproduciblity of your own binaries, to ensure that binaries you ship do exactly what you expect.

How It Works

BDK Build Tool reverse-engineers Cargokit's magic to run on top docker for Android and Linux targets. All this while handling all the cross-compiling troubles for you.

Get Started

What you'll Need

For MacOS and iOS targets, you'll need a Mac host to build. Android and Linux targets can be built on any machine so long as Docker is installed.

Android and Linux Targets	MacOS and iOS Targets
Docker	Dart and Flutter
Dart and Flutter	Rustup (NOT installed via Homebrew)
Git	Git
	Xcode (for iOS)

💡 NB: If Rust is installed via Homebrew

Run brew unlink rust to unlink.
Run curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh to install rustup BDK-buildtool can use.

How to Use

Clone this repo and check in to it via CLI. Give bdk-rep-build.sh executable permissions by running

 chmod +x bdk-rep-build.sh

Building your Own Binaries

Building binaries for any target needs you to pass the library and target you wish to build. You can specify the version of the release tag, without which bdk-build-tool resolves to building at the latest commit of the repository.

./bdk-rep-build build

• Build binaries for a supported target

 ./bdk-rep-build build boltz-dart x86_64-unknown-linux-gnu

• Build binaries for supported for a specific release tag

 ./bdk-rep-build build bdk-flutter x86_64-unknown-linux-gnu 0.1.6

• Build binaries for all targets for a platforms(ios, macos, android, linux)

 ./bdk-rep-build build lwk-dart ios 0.1.6

After building your binaries, you will find them in the release folder under the specified version, inside a folder named after the target:

• release/
  • latest/
    • linux
      • x86_64-unknown-linux-gnu
        • YOUR-BINARIES
  • 0.1.6/
    • ios/
      • aarch64-apple-ios
        • YOUR-BINARIES

Verifying your Binaries

Verifing binaries follows the same format as building except you can only verify binaries you've built and exist in the release folder.

• Verifying binaries for a supported target

 ./bdk-rep-build verify boltz-dart x86_64-unknown-linux-gnu

• Verify binaries for supported for a specific release tag

 ./bdk-rep-build verify bdk-flutter x86_64-unknown-linux-gnu 0.1.6

• Verify binaries for all targets for a platforms(ios, macos, android, linux)

 ./bdk-rep-build verify lwk-dart ios 0.1.6

Gotchas

💡 NB:

• Regularly prune Docker images to free up space.
  To remove unused Docker images, run:

 docker image prune -a -f

• Ensure a stable internet connection to avoid failed downloads or slow builds.

Acknowlegments: