3a07b4838a
29de6f2d060461da34333ea8b52aeaf531434ca2 Bump bdk version to 0.24.0 (thunderbiscuit) Pull request description: ## Description This PR updates BDK to the latest version, `0.24.0`. ### Notes to the reviewers This PR is currently open only for CI testing and review. Only merge once bdk 0.24.0 is out and the PR has been updated. ### Changelog notice ```txt - Update BDK to latest version 0.24.0 [#221] [#221](https://github.com/bitcoindevkit/bdk-ffi/pull/221) ``` #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: notmandatory: ACK 29de6f2d060461da34333ea8b52aeaf531434ca2 Tree-SHA512: 256eb4387728467704f732ce1151de9569b6121916bb1d814bb48c75faf20026846e6170a384ca7e5e9ac3652bd9dfe5511e019f13c972ae755f0b37f9db8b83
Native language bindings for BDK
The workspace in this repository creates the libbdkffi multi-language library for the rust based
bdk library from the Bitcoin Dev Kit project. The bdk-ffi-bindgen package builds a tool for
generating the actual language binding code used to access the libbdkffi library.
Each supported language has its own repository that includes this project as a git submodule. The rust code in this project is a wrapper around the bdk library to expose it's APIs in a uniform way using the mozilla/uniffi-rs bindings generator for each supported target language.
Supported target languages and platforms
The below repositories include instructions for using, building, and publishing the native language binding for bdk supported by this project.
| Language | Platform | Repository |
|---|---|---|
| Kotlin | jvm | bdk-kotlin |
| Kotlin | android | bdk-kotlin |
| Swift | iOS, macOS | bdk-swift |
| Python | linux, macOS | bdk-python |
Language bindings generator tool
Use the bdk-ffi-bindgen tool to generate language binding code for the above supported languages.
To run bdk-ffi-bindgen and see the available options use the command:
cargo run -p bdk-ffi-bindgen -- --help
Contributing
Adding new structs and functions
See the UniFFI User Guide
For pass by value objects
- create new rust struct with only fields that are supported UniFFI types
- update mapping
bdk.udlfile with newdictionary
For pass by reference values
- create wrapper rust struct/impl with only fields that are
Sync + Send - update mapping
bdk.udlfile with newinterface
Goals
- Language bindings should feel idiomatic in target languages/platforms
- Adding new targets should be easy
- Getting up and running should be easy
- Contributing should be easy
- Get it right, then automate
Thanks
This project is made possible thanks to the wonderful work by the mozilla/uniffi-rs team.