Bringing bdk-dart binding #2

chavic · 2025-10-28T20:31:21Z

This PR brings experimental Dart bindings generation using uniffi-dart. Once the latest fixes from chavic/bdk-fixes (the callback alignment work and the optional-sequence guard) are merged into main without regressions, bdk-dart will be ready for battle testing.

To see, generate, and test out the code run:

Regenerate the bindings using our helper script:
scripts/generate_bindings.sh
Run the Dart test suite
dart test

…CI, example update, and dylib loader; ignore local libs and test outputs

…e_bindings.sh; regenerate Dart bindings

….rs); generation now uses submodule UDL via local generator

- drop the outdated build.rs that looked for src/bdk.udl - sync Cargo deps with new bdk-ffi (bdk 2.2, uniffi 0.29.4, uniffi-dart main) - regenerate Cargo.lock to match the updated dependency graph

…s is a checkpoint

Johnosezele · 2025-10-30T03:01:57Z

Awesome work @chavic!

Thankfully dart test all tests successfully pass now!

cACK! File/folder dir looks good to me, consistent with bdk-android, bdk-jvm & bdk-swift

tACK 901b09 dart bindings are successfully generated on my local.

tACK 8fdea0f all dart tests run successfully on my local.

uniffi-bindgen.rs

Johnosezele · 2025-10-30T03:23:25Z

uniffi-bindgen.rs

+    match language {
+        Some(lang) if lang == "dart" => {
+            uniffi_dart::gen::generate_dart_bindings(
+                "bdk-ffi/bdk-ffi/src/bdk.udl".into(),
+                None,
+                Some(output_dir.as_str().into()),
+                library_path.as_str().into(),
+                true,
+            )
+            .expect("Failed to generate dart bindings");
+        }
+        _ => uniffi::uniffi_bindgen_main(),


To keep the cli usable, the wrapper should only unwrap those flags when they're present and otherwise fall to uniffi::uniffi_bindgen_main().

Suggested change

match language {

Some(lang) if lang == "dart" => {

uniffi_dart::gen::generate_dart_bindings(

"bdk-ffi/bdk-ffi/src/bdk.udl".into(),

None,

Some(output_dir.as_str().into()),

library_path.as_str().into(),

true,

)

.expect("Failed to generate dart bindings");

}

_ => uniffi::uniffi_bindgen_main(),

if let Some(lang) = language {

if lang == "dart" {

match (library_path, output_dir) {

(Some(lib), Some(out)) => {

uniffi_dart::gen::generate_dart_bindings(

"bdk-ffi/bdk-ffi/src/bdk.udl".into(),

None,

Some(out.as_str().into()),

lib.as_str().into(),

true,

)

.expect("Failed to generate dart bindings");

return;

}

(Some(_), None) => {

eprintln!("--out-dir is required when using --library; falling back to uniffi CLI");

}

_ => {}

}

}

}

uniffi::uniffi_bindgen_main();

This seems more complicated 🤔

Is there a specific reason to use this approach? @Johnosezele

Agreed, it looks more verbose. The new if let Some(lang) = language { … } branch only calls uniffi_dart::gen::generate_dart_bindings when all flags are present... otherwise it falls back to standard cli, and we log a message if --out-dir is missing.

I think I understand the central idea behind the comments now...

The key assumption is centered around whether other users or CI tools expect the uniffi-rs CLI interface on third party implementations

If possible, before the PR is out of draft, check out some third parties to help align expectations for how bdk-dart may be consumed 🤔

Johnosezele · 2025-10-30T03:32:00Z

.github/workflows/ci.yml

+        run: dart format --output=none --set-exit-if-changed .
+
+      - name: Analyze
+        run: dart analyze --fatal-infos --fatal-warnings || true


wouldn't || true hide analyzer failures?

Yep... it should be removed later... Keeping it in for now till the example has no errors...

wanted to check back in on this, does the example still have errors or can we remove || true now?

reez · 2025-11-03T16:48:53Z

This PR brings experimental Dart bindings generation using uniffi-dart. Once the latest fixes from chavic/bdk-fixes (the callback alignment work and the optional-sequence guard) are merged into main without regressions, bdk-dart will be ready for battle testing.

To see, generate, and test out the code run:

Regenerate the bindings using our helper script:
scripts/generate_bindings.sh

Run the Dart test suite
dart test

Awesome work! I regenerated the bindings, ran dart test, and wired them into a macOS Flutter desktop demo and everything loaded correctly. I'll do a deeper look at the pr this week now too.

chavic · 2025-11-04T09:21:20Z

The unifi-dart fixes have been merged, and we now point to main with the newest rev.

We're ready for review and testing.

reez · 2025-11-04T21:42:05Z

uniffi-bindgen.rs

+        .iter()
+        .position(|arg| arg == "--library")
+        .and_then(|idx| args.get(idx + 1))
+        .expect("specify the library path with --library");


should this parsing happen inside lang == "dart" branch so --help or others dont panic here?

reez · 2025-11-04T21:44:36Z

.github/workflows/ci.yml

+      - name: Analyze
+        run: dart analyze --fatal-infos --fatal-warnings || true
+
+      - name: Run tests (expected to fail until bindings fixed)


should we drop (expected to fail until bindings fixed) now?

reez · 2025-11-04T21:55:32Z

made some additional comemnts/questions, looks like some of it was discussed already but just wanted to ask again or from a different angle of how I was thinking about it.

another broad question that doesnt need to be addressed in this PR necessarily is is there a follow up pr where we support mobile (xcframework, etc), right now I think im only seeing linux/macOS support but let me know if I'm wrong.

otherwise I think this pr looks really great, none of my questions are big blockers either, so good stuff and good job by you!

Johnosezele · 2025-11-05T07:05:02Z

another broad question that doesnt need to be addressed in this PR necessarily is is there a follow up pr where we support mobile (xcframework, etc), right now I think im only seeing linux/macOS support but let me know if I'm wrong.

true! xcframework, android AAR... isn't covered yet. I think it exceeds the scope of this pr. See a follow up issue here

reez · 2025-11-05T15:24:42Z

another broad question that doesnt need to be addressed in this PR necessarily is is there a follow up pr where we support mobile (xcframework, etc), right now I think im only seeing linux/macOS support but let me know if I'm wrong.

true! xcframework, android AAR... isn't covered yet. I think it exceeds the scope of this pr. See a follow up issue here

cool, totally agree doesn't need to be in the scope of this PR I just wanted to mention/ask about it

…ld correctly when it should

chavic added 14 commits September 22, 2025 17:18

chore: remove uniffi-dart submodule from bdk-dart

8a6e894

chore(bdk-dart): migrate Dart package in-repo, add generator script, …

8f4ce44

…CI, example update, and dylib loader; ignore local libs and test outputs

chore(bdk-dart): add local uniffi-dart codegen binary; update generat…

7dfb7e7

…e_bindings.sh; regenerate Dart bindings

chore(bdk-dart): remove unused local Rust scaffolding (src/ and build…

9322165

….rs); generation now uses submodule UDL via local generator

ci: run tests normally (currently failing) to surface issues

e424857

fix: wire root crate to bdk-ffi library sources

de370f4

generated first clean bdk bindings

901b090

chore: align build pipeline with upstream bdk-ffi

f07118e

- drop the outdated build.rs that looked for src/bdk.udl - sync Cargo deps with new bdk-ffi (bdk 2.2, uniffi 0.29.4, uniffi-dart main) - regenerate Cargo.lock to match the updated dependency graph

chore: temp align to specific uniffi version

b79ba38

chore: generated dart code, but we have sequence converter error, thi…

f36571d

…s is a checkpoint

checkpoint... tests passed

8fdea0f

checkpoint with memory profilings upstream

d83dbe6

checkpoint, reverted memory profiling in upstream code

df9f724

chore: added simple ci, and removed bdk.dart from version history

6ab5c20

thunderbiscuit mentioned this pull request Oct 29, 2025

feat: add experimental Dart Bindings generation using uniffi-dart bitcoindevkit/bdk-ffi#862

Closed

Johnosezele reviewed Oct 30, 2025

View reviewed changes

uniffi-bindgen.rs Outdated Show resolved Hide resolved

Johnosezele reviewed Oct 30, 2025

View reviewed changes

uniffi-bindgen.rs Outdated Show resolved Hide resolved

Johnosezele reviewed Oct 30, 2025

View reviewed changes

uniffi-bindgen.rs Outdated Show resolved Hide resolved

Johnosezele reviewed Oct 30, 2025

View reviewed changes

chavic added 2 commits November 4, 2025 10:17

chore: point to uniffi-dart main repo

f762e68

chore: formatted file

2b235ec

chavic marked this pull request as ready for review November 4, 2025 09:19

reez reviewed Nov 4, 2025

View reviewed changes

Johnosezele mentioned this pull request Nov 5, 2025

Extend Dart bindings to mobile platforms (iOS XCFramework, Android AAR integration) #3

Closed

fix: scope dart-only args and refresh CI step label

da17b49

chavic force-pushed the chavic/bdk-x-uniffi-dart-fixes branch from fbd7d01 to da17b49 Compare November 16, 2025 12:29

chavic requested review from Johnosezele and reez November 16, 2025 12:34

chavic added 3 commits November 16, 2025 14:45

chore: formatted test files

d2bf08e

feat: replace network example with wallet bootstrap demo

b681e6c

chore: drop || true guard so dart analyze --fatal-* fails the bui…

47de04c

…ld correctly when it should

reez merged commit f845653 into bitcoindevkit:main Nov 17, 2025

reez mentioned this pull request Nov 17, 2025

Test unffi-dart (PayJoin team) #1

Closed

Bringing bdk-dart binding #2

Bringing bdk-dart binding #2

Uh oh!

Conversation

chavic commented Oct 28, 2025

Uh oh!

Johnosezele commented Oct 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chavic Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reez commented Nov 3, 2025

Uh oh!

chavic commented Nov 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reez commented Nov 4, 2025

Uh oh!

Johnosezele commented Nov 5, 2025

Uh oh!

reez commented Nov 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chavic Oct 30, 2025 •

edited

Loading