Skip to content
Draft
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
19 changes: 19 additions & 0 deletions .pubignore
Original file line number Diff line number Diff line change
@@ -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/
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

All notable changes to `bdk_dart` will be documented in this file.

## Unreleased
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -42,7 +42,16 @@ dependencies:

**Via pub.dev:**

COMING SOON: Currently not published on pub.dev yet.
```yaml
dependencies:
bdk_dart: ^<published-version>
```

Import the package entrypoint:

```dart
import 'package:bdk_dart/bdk_dart.dart';
```

## Usage

Expand Down
7 changes: 7 additions & 0 deletions lib/bdk_dart.dart
Original file line number Diff line number Diff line change
@@ -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';
7 changes: 7 additions & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading