Update to 2.3.0 alpha.0 with Native Assets

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ main, "**" ]
+    branches: [main, "**"]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   build-and-test:
@@ -15,8 +15,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          submodules: recursive
 
       - name: Setup Rust
         uses: dtolnay/rust-toolchain@stable
@@ -29,7 +27,7 @@ jobs:
       - name: Setup Dart
         uses: dart-lang/setup-dart@v1
         with:
-          sdk: "3.9.2"
+          sdk: "3.10.0"
 
       - name: Install lipo (macOS)
         if: matrix.os == 'macos-latest'
@@ -52,10 +50,10 @@ jobs:
         run: flutter pub get
 
       - name: Format check
-        run: dart format --output=none --set-exit-if-changed lib test examples bdk_demo/lib bdk_demo/test
+        run: dart format --output=none --set-exit-if-changed lib test example bdk_demo/lib bdk_demo/test
 
       - name: Analyze
-        run: dart analyze --fatal-infos --fatal-warnings lib test examples
+        run: dart analyze --fatal-infos --fatal-warnings lib test example
 
       - name: Analyze (bdk_demo)
         working-directory: bdk_demo

.gitignore

@@ -1,5 +1,6 @@
 # Rust
 /target
+native/target/
 **/*.rs.bk
 Cargo.lock
 
@@ -31,11 +32,8 @@ Thumbs.db
 *.log
 
 # Native libs built locally
-libbdkffi.*
-android/libs
-bdk_demo/android/app/src/main/jniLibs
-ios/Release/
-bdk_demo/ios/ios/
+*.dylib
+*.so
+*.dll
 test_output.txt
 test output.txt
-lib/bdk.dart

README.md

@@ -2,57 +2,48 @@
 
 Dart bindings for the [Bitcoin Dev Kit (BDK)](https://bitcoindevkit.org/) wallet library.
 The repo contains the sources for generating UniFFI-based bindings (`lib/bdk.dart`) and the
-`libbdkffi` native library, both of which are produced locally (they are gitignored and not
-checked into the repository) so Dart and Flutter apps can work with descriptor-based wallets,
+`libbdk_dart_ffi` native library, so Dart and Flutter apps can work with descriptor-based wallets,
 key management utilities, and blockchain backends from BDK.
 
 ## Repository layout
 
-| Path | Purpose |
-| ---- | ------- |
-| `bdk-ffi/` | Rust sources and build scripts for the underlying `bdk-ffi` crate. |
-| `lib/` | Dart bindings (`bdk.dart`) generated locally by UniFFI-Dart. |
-| `examples/` | Standalone Dart examples that exercise common workflows. |
-| `test/` | Offline/construction/persistence tests (not full integration tests). |
-| `bdk_demo/` | Flutter sample app you can point at mobile targets once the bindings are built. |
-| `scripts/generate_bindings.sh` | Helper used to rebuild the native library and regenerate the Dart bindings. |
+| Path                           | Purpose                                                                                                                           |
+| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
+| `native/`                      | Rust sources and uniffi-dart build scripts and configs wrapping the underlying `bdk-ffi` crate to be used by the Dart build hook. |
+| `lib/`                         | Dart bindings (`bdk.dart`) generated by UniFFI-Dart.                                                                              |
+| `example/`                     | Standalone Dart example to showcase, test and play with the bindings.                                                             |
+| `test/`                        | Offline/construction/persistence tests (not full integration tests).                                                              |
+| `bdk_demo/`                    | Flutter sample app you can point at mobile targets once the bindings are built.                                                   |
+| `scripts/generate_bindings.sh` | Helper used to rebuild the native library and regenerate the Dart bindings.                                                       |
 
 ## Prerequisites
 
 To build the bindings locally you need:
 
-- Dart SDK 3.2 or newer (see `pubspec.yaml`).
+- Dart SDK >= 3.10 or newer (see `pubspec.yaml`).
 - Rust toolchain with `cargo` and the native targets you intend to build.
 - `clang`/`lld` (or equivalent platform toolchain) for producing the shared library.
 - Flutter (optional) if you plan to run `bdk_demo`.
 
-Make sure submodules are cloned because the Rust crate lives in `bdk-ffi/`:
+### Add to your project
 
-```bash
-git clone --recurse-submodules https://github.com/bitcoindevkit/bdk-dart.git
-cd bdk-dart
+**Via git:**
+
+```yaml
+dependencies:
+  bdk_dart:
+    git:
+      url: https://github.com/bitcoindevkit/bdk-dart.git
+      ref: main # or specific tag
 ```
 
-## Installation
+**Via pub.dev:**
 
-1. Install dependencies:
-   ```bash
-   dart pub get
-   ```
-2. Generate the Dart bindings and native binary (requires a macOS or Linux host):
-   ```bash
-   ./scripts/generate_bindings.sh
-   ```
-   The script builds `bdk-ffi`, runs the local `uniffi-bindgen` wrapper, and drops the
-   resulting `libbdkffi.*` alongside the freshly generated `lib/bdk.dart`.
-3. Make sure the produced library is discoverable at runtime. For CLI usage you can export
-   `LD_LIBRARY_PATH`/`DYLD_LIBRARY_PATH` or keep the binary in the same directory as your
-   Dart entrypoint.
+COMING SOON: Currently not published on pub.dev yet.
 
 ## Usage
 
-After generating the bindings you can run the examples or consume the package from your
-own project. For instance, the `examples/network_example.dart` walkthrough shows how to:
+Check out the example in `example/main.dart` for a walkthrough of how to use the bindings to:
 
 1. Create a new mnemonic and derive BIP84 descriptors.
 2. Instantiate a wallet backed by the in-memory persister.
@@ -62,14 +53,26 @@ own project. For instance, the `examples/network_example.dart` walkthrough shows
 Run it with:
 
 ```bash
-dart run examples/network_example.dart
+dart run example/main.dart
 ```
 
-When embedding in Flutter, add a path or git dependency on this package and ensure the
-native library is bundled per target platform (e.g., via `flutter_rust_bridge`-style
-build steps or platform-specific build scripts).
+The native library will be automatically built by Dart's Native Assets system.
+As a user of the package, you don't need to worry about building the native library or bindings yourself.
+Only if you want to contribute to the bindings or modify the native code yourself, you can follow the instructions in [development](#development) below.
+
+## Development
+
+### Generating bindings
+
+1. Modify the native Rust code and configuration files in `native/` as needed.
+
+2. Run the bindings generator script:
+
+   ```bash
+   bash ./scripts/generate_bindings.sh
+   ```
 
-## Testing
+### Testing
 
 Once you have generated `lib/bdk.dart` and the native library locally you can execute the
 Dart test suite, which covers wallet creation, persistence, offline behavior, and descriptor APIs:
@@ -82,4 +85,4 @@ dart test
 
 The Rust crate and generated bindings are dual-licensed under MIT or Apache 2.0 per the
 `license = "MIT OR Apache-2.0"` entry in `Cargo.toml`. You may choose either license when
-using the library in your project.
+using the library in your project.

bdk_demo/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>12.0</string>
+  <string>13.0</string>
 </dict>
 </plist>

bdk_demo/ios/Flutter/Debug.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "Generated.xcconfig"

bdk_demo/ios/Flutter/Release.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "Generated.xcconfig"

bdk_demo/ios/Podfile

@@ -0,0 +1,43 @@
+# Uncomment this line to define a global platform for your project
+platform :ios, '13.0'
+
+# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
+ENV['COCOAPODS_DISABLE_STATS'] = 'true'
+
+project 'Runner', {
+  'Debug' => :debug,
+  'Profile' => :release,
+  'Release' => :release,
+}
+
+def flutter_root
+  generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__)
+  unless File.exist?(generated_xcode_build_settings_path)
+    raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first"
+  end
+
+  File.foreach(generated_xcode_build_settings_path) do |line|
+    matches = line.match(/FLUTTER_ROOT\=(.*)/)
+    return matches[1].strip if matches
+  end
+  raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get"
+end
+
+require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)
+
+flutter_ios_podfile_setup
+
+target 'Runner' do
+  use_frameworks!
+
+  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
+  target 'RunnerTests' do
+    inherit! :search_paths
+  end
+end
+
+post_install do |installer|
+  installer.pods_project.targets.each do |target|
+    flutter_additional_ios_build_settings(target)
+  end
+end

bdk_demo/ios/Podfile.lock

@@ -0,0 +1,16 @@
+PODS:
+  - Flutter (1.0.0)
+
+DEPENDENCIES:
+  - Flutter (from `Flutter`)
+
+EXTERNAL SOURCES:
+  Flutter:
+    :path: Flutter
+
+SPEC CHECKSUMS:
+  Flutter: cabc95a1d2626b1b06e7179b784ebcf0c0cde467
+
+PODFILE CHECKSUM: 251cb053df7158f337c0712f2ab29f4e0fa474ce
+
+COCOAPODS: 1.16.2