Update to 2.3.0 alpha.0 with Native Assets #12

kumulynja · 2025-11-24T01:47:49Z

This PR updates bdk dart to v2.3.0-alpha.0 which uses uniffi 0.30 and updates uniffi-dart to the version with Native Assets support. Native Assets/Build hooks is the new and recommended way in Dart and Flutter to use native libraries, as it eliminates the need to bundle/distribute precompiled binaries.

It also removes the git submodule to bdk-ffi and instead adds a small wrapper in the /native folder so bdk-dart can be published to pub.dev

- Add patterns for all native binary types (.so, .dylib, .dll, .a) - Remove lib/bdk.dart from .gitignore to include in published package

…ve Assets hook

Generated bindings are now tracked in version control to enable publishing to pub.dev. Users should not need to generate bindings themselves when installing the package.

…fork - Bump version to 2.3.0-alpha.0 - Upgrade uniffi from 0.29.4 to 0.30.0 - Switch to kumulynja/uniffi-dart fork - Add camino dependency for uniffi 0.30.0 compatibility - Update bdk_kyoto from 0.15.1 to 0.15.3

- Use placeholder UDL path (metadata extracted from library) - Auto-detect library file by extension instead of --library flag - Use camino::Utf8Path required by uniffi 0.30.0 - Simplify code with match expression

- Add path variables for cleaner navigation - Add submodule init/update and version checkout - Remove manual fat binary creation (handled by Native Assets) - Add rsync to copy bdk-ffi source to native/ for publishing - Update to work with uniffi 0.30.0 library mode

Add hook/build.dart to compile native libraries automatically for the\ user's platform during dart/flutter pub get, eliminating manual build\ steps for users and the need to manage pre-compiled binaries.

reez · 2025-11-24T14:47:22Z

@Johnosezele if you can review this too

kumulynja · 2025-11-24T15:10:14Z

@reez @Johnosezele Don't be scared by the big number of files changed, you don't have to review the /native folder since that is really just a copy of the /bkd-ffi/bdk-ffi folder so that the build hook has the source to build the lib from.
For publishing of the package it is needed that this source code is in the package like this, since git submodules do not work for pub.dev. Also the native_toolchain_rs package used in the build hook expects this code to be either in a folder named native or rust. So that's the main reason of the file changes, I didn't find a way around it to be able to publish the package.
This copy is being done automatically in the generate_bindings.sh script by the way.

Johnosezele · 2025-11-24T20:19:16Z

@Johnosezele if you can review this too

Sure!

reez · 2025-11-25T19:16:10Z

side note: ci on repo passes now via #11 not sure if you need to rebase on that and/or if we can get this PR ci passing even though it targets 0.30.0

reez · 2025-11-26T15:38:37Z

I really like the ideas in this pr, but as I've been looking at this pr more I think things would be clearer as separate PRs, as an example splitting things like these out from each other:

uniffi upgrade to 0.30.0
native assets migration

Thoughts?

kumulynja · 2025-11-26T17:27:17Z

I really like the ideas in this pr, but as I've been looking at this pr more I think things would be clearer as separate PRs, as an example splitting things like these out from each other:

uniffi upgrade to 0.30.0

native assets migration

Thoughts?

Yes, although I think there is not much done around migration to uniffi v0.30.0 specifically in this PR other than using bdk-ffi v2.3.0-alpha, which is the first bdk-ffi version using uniffi v0.30.0 if I am not mistaken. Most (if not all) of the migration work is done in bdk-ffi for that.

The reason why I needed that is because the version of uniffi-dart that has Native Assets support doesn't work for < 0.30.0, and this PR actually is more (pretty much completely) about setting bdk-dart up for Native Assets support and so to avoid needing to have platform specific code or binary publishing/binding.

So yeah, not sure if you want to have bdk-ffi-v2.3.0-alpha working without Native Assets first as well?

Aniket-pd · 2025-11-29T21:42:08Z

Most of the large diff comes from the native source copy, so I focused on the functional parts. The build hook and pubspec changes look reasonable. I agree splitting uniffi 0.30 upgrade and Native Assets migration into separate PRs would make review much easier.

kumulynja · 2025-11-29T21:50:41Z

Most of the large diff comes from the native source copy, so I focused on the functional parts. The build hook and pubspec changes look reasonable. I agree splitting uniffi 0.30 upgrade and Native Assets migration into separate PRs would make review much easier.

@Aniket-pd As mentioned in previous comments:

The native source copy is needed for the build hook to be able to build the native library dynamically when pulled/run into a project, but yes, it's an exact copy of bdk-ffi, so nothing to review there indeed.
There is really nothing specifically done for migrating to uniffi v0.30 in this PR. The whole PR is about the setup to use the uniffi-dart version with Native Assets which requires uniffi v0.30 for the moment. And that's why bdk-ffi v2.3.0-alpha.0 was used. Other than changing the bdk-ffi version, there is nothing done for migration to uniffi v0.30 in this PR.

Johnosezele · 2025-12-10T03:01:03Z

Thanks @kumulynja this native assets approach really makes things seamless to publish to pub.dev with just the build hook and less maintenance overhead in the future. I'll leave some of my observations.

Johnosezele · 2025-12-10T03:01:41Z

The dart CLI example lives in /example, but we already have an /examples/ directory beside it. Could we rename /example to something specific like /bdk-dart-cli to avoid confusion?
On my m/c is it took up to 6 mins for the build hook to run completely on dart run for the first time. Not a blocker, just fyi in case we want to mention expected build time or look into caching....

Cargo.toml

scripts/generate_bindings.sh

Johnosezele · 2025-12-10T03:27:56Z

Can we add native/ to .gitignore instead? To solve the publishing requirement, we can use a pre_publish script that copies the files over just before running pub publish.

kumulynja · 2025-12-10T09:32:52Z

Can we add native/ to .gitignore instead? To solve the publishing requirement, we can use a pre_publish script that copies the files over just before running pub publish.

That would be a good idea, but with a different approach as mentioned above, I think we will not need it anymore as the native folder will not have anything copied anymore and be way leaner.

Thanks a lot for the thorough review and great remarks, all valid points.

I will work on this PR in the coming weekend again to get it right.

…n_rust

…y adding a simple bdk-ffi wrapper in the native folder

…llowing: https://dart.dev/tools/pub/package-layout#examples

…ssary anymore with Native Assets hook

…nstead of examples

kumulynja · 2025-12-13T23:50:38Z

@reez @Johnosezele I resolved all issues. The native folder is now the place where bdk-ffi is "wrapped"/exposed to generate the Dart bindings from and it also has everything for the build hook as well. So copying from the root to the native folder isn't needed anymore, and neither is the submodule. It also makes the script to generate bindings simpler.
I also updated and cleaned up everything from the README to the example, demo, tests, ci and scripts.

The only thing that we should wait for before merging maybe is removing the patch to my fork of bdk-ffi in which "lib" is added as crate-type: bitcoindevkit/bdk-ffi#924
This change in bdk-ffi is needed to be able to expose bdk-ffi in lib.rs in the native folder. Once it is merged there, the patch to my fork can be removed here.

Let me know if you have any other remarks. Thanks!

Johnosezele · 2025-12-16T07:38:27Z

uTACK! the /native folder looks cleaner now. I was going to ask why targets was removed intially but thankfully it was re-added in 0eae013. I shall wait for #924 so I can eventually test. Thanks!

reez · 2025-12-19T15:02:19Z

very cool, bdk-ffi pr will take some time to let reviewers think on it on it so I wouldn't expect that to get merged ASAP, but everything here is looking nice! good job @kumulynja and good review @Johnosezele @Aniket-pd , and we will just figure out timing wise what works best for merging this based on the bdk-ffi pr status

reez · 2025-12-29T19:38:41Z

very cool, bdk-ffi pr will take some time to let reviewers think on it on it so I wouldn't expect that to get merged ASAP, but everything here is looking nice! good job @kumulynja and good review @Johnosezele @Aniket-pd , and we will just figure out timing wise what works best for merging this based on the bdk-ffi pr status

(just added my review + ack on the bdk-ffi pr)

kumulynja · 2026-01-05T22:27:32Z

@reez @Johnosezele The bdk-ffi PR was merged so I removed the patch to my fork. I also made it more clear in the README.md that users of the package will need the Rust toolchain installed for the build hook to work when they build their app. Let me know if you see anything else to fix and thanks for the support.

Johnosezele · 2026-01-08T10:04:33Z

tACK d6a2b64
I would suggest squashing commit history into a few commits.

Johnosezele · 2026-01-08T10:03:21Z

native/Cargo.toml

+bdk-ffi = { package = "bdk-ffi", git = "https://github.com/bitcoindevkit/bdk-ffi.git", branch = "master" }
+uniffi = { version = "=0.30.0", features = ["cli"] }
+uniffi-dart = { git = "https://github.com/Uniffi-Dart/uniffi-dart" }


I'm thinking we can pin to a tag/commit 'rev = ' here, so we always build against the same code. Does this work?

I can address this in a follow up pr

#17 followed up here

reez

ACK d6a2b64

I'll squash to address the comment about the commits

kumulynja added 14 commits November 23, 2025 16:25

chore: ignore native binaries and track generated bindings

263052c

- Add patterns for all native binary types (.so, .dylib, .dll, .a) - Remove lib/bdk.dart from .gitignore to include in published package

chore: bump to 2.3.0-alpha.0 with SDK 3.10.0 and code_assets for Nati…

0a9984d

…ve Assets hook

chore: remove lib/README.md explaining untracked bindings

997714c

Generated bindings are now tracked in version control to enable publishing to pub.dev. Users should not need to generate bindings themselves when installing the package.

refactor: update uniffi-bindgen for uniffi 0.30.0 compatibility

a706915

- Use placeholder UDL path (metadata extracted from library) - Auto-detect library file by extension instead of --library flag - Use camino::Utf8Path required by uniffi 0.30.0 - Simplify code with match expression

docs: add README.md

7fc5ee1

feat: add Native Assets build hook for automatic native compilation

9f12641

Add hook/build.dart to compile native libraries automatically for the\ user's platform during dart/flutter pub get, eliminating manual build\ steps for users and the need to manage pre-compiled binaries.

fix: correct paths for bdk-ffi submodule in generate_bindings.sh

13e8b1a

chore: ignore target in automatically copied /native folder

8d0b697

chore: exclude /target folder from /native copy

385c02a

chore: run generate_bindings.sh with latest bdk-ffi master

e9f6cbb

chore: declare build hook in pubspec.yaml

666f688

refactor: update to native assets with build hook

ca0282a

kumulynja mentioned this pull request Nov 24, 2025

Shift to Native Assets + update to uniffi 0.30.0 Uniffi-Dart/uniffi-dart#99

Merged

reez mentioned this pull request Nov 25, 2025

Dart bindings bitcoindevkit/bdk-ffi#913

Closed

15 tasks

kumulynja added 2 commits November 26, 2025 18:38

Merge branch 'main' into update-to-2.3.0-alpha.0

56238fb

fix merge conflict + regenerate bindings

37a06ae

Johnosezele reviewed Dec 10, 2025

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

Johnosezele reviewed Dec 10, 2025

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

Johnosezele reviewed Dec 10, 2025

View reviewed changes

scripts/generate_bindings.sh Outdated Show resolved Hide resolved

kumulynja added 2 commits December 13, 2025 10:54

chore: change native_toolchain_rs to new package name native_toolchai…

9a3fe31

…n_rust

refactor: avoid hack of copying files in native folder or submodule b…

6784b9f

…y adding a simple bdk-ffi wrapper in the native folder

kumulynja mentioned this pull request Dec 13, 2025

add lib crate-type to bdk-ffi to be able to reuse it for other bindings like bdk-dart bitcoindevkit/bdk-ffi#924

Merged

5 tasks

kumulynja added 8 commits December 13, 2025 20:49

remove example of cmd line app

98bd23f

rename examples folder and file to follow dart package conventions fo…

2078c99

…llowing: https://dart.dev/tools/pub/package-layout#examples

fix: lib name

0eae013

fix merge conflicts

dba3677

cleanup submodule cmds in justfile + remove scripts that are not nece…

fbe5112

…ssary anymore with Native Assets hook

update bdk_demo flutter version to work with Native Assets

a389abd

refactor simple widget test in bdk_demo

3abecd5

cleanup ci workflow to remove submodule step and use example folder i…

c21a2b3

…nstead of examples

kumulynja requested a review from Johnosezele December 13, 2025 23:27

format files following dart format

89b5bfd

kumulynja added 2 commits December 14, 2025 10:26

add back accidentally deleted generate_bindings.sh script

9f7fe07

update relative path of bdk-ffi fork to git url and regenerate bindings

2c5cd9c

kumulynja added 2 commits January 5, 2026 23:11

use original bdk-ffi dependency and regenerate bindings

74acd57

clarify users of the package also need the Rust toolchain

d6a2b64

Johnosezele reviewed Jan 8, 2026

View reviewed changes

reez approved these changes Jan 12, 2026

View reviewed changes

reez merged commit 34ad41c into bitcoindevkit:main Jan 12, 2026
2 checks passed

reez mentioned this pull request Jan 12, 2026

Follow ups to PR 12 #17

Merged

Update to 2.3.0 alpha.0 with Native Assets #12

Update to 2.3.0 alpha.0 with Native Assets #12

Uh oh!

Conversation

kumulynja commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

reez commented Nov 24, 2025

Uh oh!

kumulynja commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Johnosezele commented Nov 24, 2025

Uh oh!

reez commented Nov 25, 2025

Uh oh!

reez commented Nov 26, 2025

Uh oh!

kumulynja commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Aniket-pd commented Nov 29, 2025

Uh oh!

kumulynja commented Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Johnosezele commented Dec 10, 2025

Uh oh!

Johnosezele commented Dec 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Johnosezele commented Dec 10, 2025

Uh oh!

kumulynja commented Dec 10, 2025

Uh oh!

kumulynja commented Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Johnosezele commented Dec 16, 2025

Uh oh!

reez commented Dec 19, 2025

Uh oh!

reez commented Dec 29, 2025

Uh oh!

kumulynja commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Johnosezele commented Jan 8, 2026

Uh oh!

Johnosezele Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

reez Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

reez Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

reez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kumulynja commented Nov 24, 2025 •

edited

Loading

kumulynja commented Nov 24, 2025 •

edited

Loading

kumulynja commented Nov 26, 2025 •

edited

Loading

kumulynja commented Nov 29, 2025 •

edited

Loading

kumulynja commented Dec 13, 2025 •

edited

Loading

kumulynja commented Jan 5, 2026 •

edited

Loading