From 86cb6c3829ebad27d63cab9f4031422d39c34fc9 Mon Sep 17 00:00:00 2001 From: Matthew Date: Wed, 15 Apr 2026 17:37:27 -0500 Subject: [PATCH 1/3] chore: add package-root dart library export --- lib/bdk_dart.dart | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 lib/bdk_dart.dart diff --git a/lib/bdk_dart.dart b/lib/bdk_dart.dart new file mode 100644 index 0000000..96af28c --- /dev/null +++ b/lib/bdk_dart.dart @@ -0,0 +1,7 @@ +/// Package-root export for `bdk_dart`. +/// +/// The generated UniFFI bindings live in `bdk.dart`; this file provides the +/// conventional `package:bdk_dart/bdk_dart.dart` entrypoint expected by pub.dev. +library; + +export 'bdk.dart'; From 55feceb1fb00489897b2e39ca438a0f6019c0de8 Mon Sep 17 00:00:00 2001 From: Matthew Date: Wed, 15 Apr 2026 17:40:35 -0500 Subject: [PATCH 2/3] docs: add changelog for pub.dev release prep --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0b96e14 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +All notable changes to `bdk_dart` will be documented in this file. + +## Unreleased From 611badb03eb76c6a94f10ae6ec5f8f7d1fcfbd70 Mon Sep 17 00:00:00 2001 From: Matthew Date: Fri, 22 May 2026 14:03:25 -0500 Subject: [PATCH 3/3] chore: prepare package for pub.dev publishing --- .pubignore | 19 +++++++++++++++++++ README.md | 15 ++++++++++++--- pubspec.yaml | 7 +++++++ 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 .pubignore diff --git a/.pubignore b/.pubignore new file mode 100644 index 0000000..8c5389b --- /dev/null +++ b/.pubignore @@ -0,0 +1,19 @@ +AGENTS.md +PUBDEV_RELEASE_CHECKLIST.md +justfile +scripts/ +docs/ + +# Local build and generated tool output +**/build/ +**/.dart_tool/ +native/target/ + +# Native libraries are built per consumer by Dart Native Assets. +*.dylib +*.so +*.dll + +# The Flutter reference app is maintained in the repository, but is not needed +# in the published package archive. +bdk_demo/ diff --git a/README.md b/README.md index 411982d..9af0e35 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ key management utilities, and blockchain backends from BDK. | `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. | +| [`bdk_demo/`](https://github.com/bitcoindevkit/bdk-dart/tree/main/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 @@ -22,7 +22,7 @@ To use this package you need: - Dart SDK >= 3.10 or newer (see `pubspec.yaml`). - Rust toolchain with `cargo` and the native targets you intend to build. You can install Rust via [rustup](https://rustup.rs/). -- Flutter SDK if you plan to use the package in a Flutter app or run the [Flutter demo](bdk_demo/). +- Flutter SDK if you plan to use the package in a Flutter app or run the [Flutter demo](https://github.com/bitcoindevkit/bdk-dart/tree/main/bdk_demo). ## Supported targets @@ -42,7 +42,16 @@ dependencies: **Via pub.dev:** -COMING SOON: Currently not published on pub.dev yet. +```yaml +dependencies: + bdk_dart: ^ +``` + +Import the package entrypoint: + +```dart +import 'package:bdk_dart/bdk_dart.dart'; +``` ## Usage diff --git a/pubspec.yaml b/pubspec.yaml index de7c7ac..6b27f75 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -8,6 +8,13 @@ issue_tracker: https://github.com/bitcoindevkit/bdk-dart/issues environment: sdk: "^3.10.0" +platforms: + android: + ios: + linux: + macos: + windows: + dependencies: ffi: ^2.1.4 hooks: ^1.0.0