Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,26 @@ jobs:
- name: Build and test
run: cargo test -vv


android-cross-compile:
name: Cross-Compile for Android (${{ matrix.package }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
Comment thread
jaoleal marked this conversation as resolved.
matrix:
package:
- android-aarch64
- android-armv7
- android-x86_64
steps:
- uses: actions/checkout@v4

- name: Install Nix
uses: cachix/install-nix-action@v31

- name: Build
run: nix build .#${{ matrix.package }} -L

fuzz-corpus:
name: Verify Fuzz Corpus
runs-on: ubuntu-latest
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/target
Cargo.lock
coverage_report
result
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- Added Nix package outputs for Android with bundled NDK r24, Rust toolchains, Boost, and cmake.
- Added `Block::check` to perform context-free validation of a block (size, weight, coinbase, transactions, sigops), with optional proof-of-work and merkle-root checks toggled via the `BLOCK_CHECK_BASE` / `_POW` / `_MERKLE` / `_ALL` flags. Returns a `BlockCheckResult` enum carrying the validation state on failure.

### Changed
Expand All @@ -16,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [0.2.1] 2026-05-20

### Added
- Added Nix package outputs for Android with bundled NDK r27, Rust toolchains, Boost, and cmake.
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to go in a new ###Added entry in the unreleased section.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be removed from the ## [0.2.1] 2026-05-20 section.

- Added `BlockTreeEntry::ancestor` to look up an ancestor block at a given height. Returns `None` if the height is out of range. This operation is O(log N).
- Added `Transaction::locktime()` to retrieve a transaction's `nLockTime` value as a `u32`.
- Added `TxIn::sequence()` to retrieve an input's `nSequence` value as a `u32`.
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,23 @@ dependencies. Once setup, run:
cargo b
```

### Android Cross-Compilation
Comment thread
jaoleal marked this conversation as resolved.

Android cross-compilation requires [Nix](https://nixos.org/).

Nix handles the exact NDK version, Rust toolchains, Boost, and cmake
automatically, giving you a reproducible build environment with no manual setup.

```bash
nix build .#android-aarch64
nix build .#android-armv7
nix build .#android-x86_64
```

The resulting libraries are placed in `result/lib/`.

Output targets Android API 24+ (Nougat) minimum.

## MSRV (Minimum Supported Rust Version)

The minimum supported Rust version is 1.71. Users on rustc older than
Expand Down
124 changes: 123 additions & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@
};

rustVersion = "1.71.0";
rustToolchainSha256 = "sha256-ks0nMEGGXKrHnfv4Fku+vhQ7gx76ruv6Ij4fKZR3l78=";
rustToolchain = fenix.packages.${system}.fromToolchainName {
name = rustVersion;
sha256 = "sha256-ks0nMEGGXKrHnfv4Fku+vhQ7gx76ruv6Ij4fKZR3l78=";
sha256 = rustToolchainSha256;
};
rustBuildToolchain = fenix.packages.${system}.combine [
rustToolchain.rustc
Expand Down Expand Up @@ -85,6 +86,127 @@
pkgs.gcc.cc.lib
];
};

packages =
# Android build infrastructure (unfree NDK + SDK).
let
ndkVersion = "27.2.12479018"; # which NDK release to download
lockfile = ./Cargo-minimal.lock;
Comment thread
jaoleal marked this conversation as resolved.
ANDROID_API_LEVEL = "24";
crateVersion =
(builtins.fromTOML (builtins.readFile ./libbitcoinkernel-sys/Cargo.toml)).package.version;

androidPkgs = import nixpkgs {
inherit system;
config.android_sdk.accept_license = true;
config.allowUnfree = true;
};
androidComposition = androidPkgs.androidenv.composeAndroidPackages {
# platformVersions is the SDK tooling version, not the minimum API level.
# The NDK target floor is set via ANDROID_API_LEVEL in build.rs (default 24).
platformVersions = [ "34" ];
ndkVersions = [ ndkVersion ];
includeNDK = true;
};
androidSdk = androidComposition.androidsdk;
androidNdk = "${androidSdk}/libexec/android-sdk/ndk/${ndkVersion}";

runTests = system == "x86_64-linux";

# x86_64-linux-android is excluded from tests: Rust 1.71's
# compiler_builtins lacks the f128 routines (__eqtf2, __multf3, …)
# that bionic's static libc.a requires on x86_64.
testableTargets = [
"aarch64-linux-android"
"armv7-linux-androideabi"
];

mkAndroidPackage =
rustTarget:
let
canTest = runTests && builtins.elem rustTarget testableTargets;
rustTargetToolchain = fenix.packages.${system}.combine [
rustToolchain.rustc
rustToolchain.cargo
rustToolchain.rust-src
rustToolchain.rust-std
(fenix.packages.${system}.targets.${rustTarget}.fromToolchainName {
name = rustVersion;
sha256 = rustToolchainSha256;
}).rust-std
];
rustPlatform = androidPkgs.makeRustPlatform {
cargo = rustTargetToolchain;
rustc = rustTargetToolchain;
};
qemuBin =
if builtins.match "aarch64.*" rustTarget != null then
"qemu-aarch64"
else if builtins.match "armv7.*" rustTarget != null then
"qemu-arm"
else
throw "Unsupported Android target: ${rustTarget}";
# NDK clang wrapper triple: armv7 uses "armv7a-linux-androideabi",
# all others match the Rust target triple.
ndkClangTriple =
if builtins.match "armv7.*" rustTarget != null then "armv7a-linux-androideabi" else rustTarget;
ndkLinker = "${androidNdk}/toolchains/llvm/prebuilt/linux-x86_64/bin/${ndkClangTriple}${ANDROID_API_LEVEL}-clang";
cargoTargetPrefix = "CARGO_TARGET_${
builtins.replaceStrings [ "-" ] [ "_" ] (pkgs.lib.toUpper rustTarget)
}";
cargoRunnerEnvVar = "${cargoTargetPrefix}_RUNNER";
cargoLinkerEnvVar = "${cargoTargetPrefix}_LINKER";
in
rustPlatform.buildRustPackage {
pname = "libbitcoinkernel-${rustTarget}";
version = crateVersion;
src = ./.;
cargoLock.lockFile = lockfile;
postPatch = ''
cp ${lockfile} Cargo.lock
'';
nativeBuildInputs = [
androidPkgs.cmake
androidPkgs.boost.dev
androidSdk
]
++ pkgs.lib.optionals canTest [
pkgs.qemu
];

ANDROID_HOME = "${androidSdk}/libexec/android-sdk";
ANDROID_NDK_HOME = androidNdk;
CMAKE_PREFIX_PATH = "${androidPkgs.boost.dev}";

# cargoBuildHook hardcodes the host --target at
# derivation time, so we bypass it for cross builds.
dontCargoBuild = true;
doCheck = canTest;
buildPhase = ''
cargo build -p libbitcoinkernel-sys --target ${rustTarget} --offline --release
'';
checkPhase = pkgs.lib.optionalString canTest ''
Comment thread
jaoleal marked this conversation as resolved.
export ${cargoLinkerEnvVar}=${ndkLinker}
export ${cargoRunnerEnvVar}=${pkgs.qemu}/bin/${qemuBin}
export QEMU_LD_PREFIX=${androidNdk}/toolchains/llvm/prebuilt/linux-x86_64/sysroot
export RUSTFLAGS="-C target-feature=+crt-static"
cargo test --target ${rustTarget} --offline --release --verbose
'';
installPhase = ''
mkdir -p $out/lib $out/include
find target/${rustTarget}/release -path "*/out/install/lib/*.a" \
-exec cp {} $out/lib/ \;
find target/${rustTarget}/release -path "*/out/install/include/*" \
-exec cp {} $out/include/ \;
'';
};
in
{
android-aarch64 = mkAndroidPackage "aarch64-linux-android";
android-armv7 = mkAndroidPackage "armv7-linux-androideabi";
android-x86_64 = mkAndroidPackage "x86_64-linux-android";
Comment thread
jaoleal marked this conversation as resolved.
# i686 omitted: not a current target
};
}
);
}
1 change: 1 addition & 0 deletions libbitcoinkernel-sys/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
- Added build support for android

## [0.3.0] - 2026-05-20

Expand Down
89 changes: 84 additions & 5 deletions libbitcoinkernel-sys/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,34 @@ use std::env;
use std::path::Path;
use std::process::Command;

// Rust target triple -> NDK ABI name.
fn android_abi(target: &str) -> Option<&'static str> {
match target {
t if t.contains("aarch64") => Some("arm64-v8a"),
t if t.contains("armv7") => Some("armeabi-v7a"),
t if t.contains("x86_64") => Some("x86_64"),
_ => panic!("Unsupported Android ABI: {target}"),
}
}
Comment thread
jaoleal marked this conversation as resolved.

// Rust target triple -> NDK sysroot lib directory triple.
// armv7 differs: Rust says `armv7-linux-androideabi`, NDK says `arm-linux-androideabi`.
fn android_sysroot_triple(target: &str) -> &str {
if target.starts_with("armv7") {
"arm-linux-androideabi"
} else {
target
}
}

fn android_host_tag() -> &'static str {
match std::env::consts::OS {
"macos" => "darwin-x86_64",
"linux" => "linux-x86_64",
os => panic!("unsupported build host for Android cross-compilation: {os}"),
}
}

fn main() {
let bitcoin_dir = Path::new("bitcoin");
let out_dir = env::var("OUT_DIR").unwrap();
Expand All @@ -15,7 +43,8 @@ fn main() {

let build_config = "RelWithDebInfo";

Command::new("cmake")
let mut cmake_configure = Command::new("cmake");
cmake_configure
.arg("-B")
.arg(&build_dir)
.arg("-S")
Expand All @@ -38,7 +67,45 @@ fn main() {
.arg("-DBUILD_SHARED_LIBS=OFF")
.arg("-DCMAKE_INSTALL_LIBDIR=lib")
.arg("-DENABLE_IPC=OFF")
.arg(format!("-DCMAKE_INSTALL_PREFIX={}", install_dir.display()))
.arg(format!("-DCMAKE_INSTALL_PREFIX={}", install_dir.display()));

let target = env::var("TARGET").unwrap();
let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap();
let is_android = target_os == "android";

if is_android {
let ndk = env::var("ANDROID_NDK_HOME")
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are fetching this twice. Any chance we can reuse this?

.expect("Android target detected but ANDROID_NDK_HOME is not set");
let toolchain_file = format!("{ndk}/build/cmake/android.toolchain.cmake");

let abi = android_abi(&target).unwrap();

// API level 24+ is required because Bitcoin Core uses getifaddrs
// which was introduced in Android API 24 (Nougat).
//
// This can be overriden by setting ANDROID_API_LEVEL.
let api_level = match env::var("ANDROID_API_LEVEL") {
Ok(level) => {
let n: u32 = level.parse().expect("ANDROID_API_LEVEL must be a number");
assert!(n >= 24, "ANDROID_API_LEVEL must be 24+");
level
}
_ => "24".to_string(),
};

cmake_configure
.arg(format!("-DCMAKE_TOOLCHAIN_FILE={toolchain_file}"))
.arg(format!("-DANDROID_ABI={abi}"))
.arg(format!("-DANDROID_PLATFORM=android-{api_level}"))
.arg("-DCMAKE_SYSTEM_NAME=Android")
.arg(format!("-DCMAKE_ANDROID_NDK={ndk}"))
// The Android NDK toolchain sets CMAKE_FIND_ROOT_PATH_MODE_PACKAGE
// to ONLY, which prevents cmake from finding host packages via
// CMAKE_PREFIX_PATH. Override it so Boost headers can be located.
.arg("-DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH");
}

cmake_configure
.status()
.expect("cmake should be installed and available in PATH");

Expand Down Expand Up @@ -70,19 +137,31 @@ fn main() {
} else {
install_dir.join("lib")
};

println!("cargo:rustc-link-search=native={}", lib_dir.display());

println!("cargo:rustc-link-lib=static=bitcoinkernel");

let compiler = cc::Build::new().get_compiler();
let target_os = std::env::var("CARGO_CFG_TARGET_OS").unwrap();

if target_os == "windows" {
println!("cargo:rustc-link-lib=bcrypt");
println!("cargo:rustc-link-lib=shell32");
}
} else if is_android {
// Android NDK ships libc++_static.a and libc++abi.a in the
// per-architecture sysroot directory (not the API-level subdirectory).
let ndk = env::var("ANDROID_NDK_HOME").expect("We called ANDROID_NDK_HOME before.");

let ndk_triple = android_sysroot_triple(&target);

let host_tag = android_host_tag();

if compiler.is_like_clang() {
let ndk_lib_dir =
format!("{ndk}/toolchains/llvm/prebuilt/{host_tag}/sysroot/usr/lib/{ndk_triple}");
println!("cargo:rustc-link-search=native={ndk_lib_dir}");
println!("cargo:rustc-link-lib=static=c++_static");
println!("cargo:rustc-link-lib=static=c++abi");
} else if compiler.is_like_clang() {
if target_os == "macos" {
println!("cargo:rustc-link-lib=dylib=c++");
} else {
Expand Down
Loading