dfb350e206
3c6075ad96afa238dc3ceca71ba82cb10088bb90 Add Balance struct and conversion from BdkBalance (thunderbiscuit) 4e15badb14d34db4911641f345e99987d132a81c Update BDK to version 0.22 (thunderbiscuit) Pull request description: The bindings do not build when attempting this upgrade because `get_balance()` now returns a `Balance` struct (this was merged in bitcoindevkit/bdk#640) ```sh error[E0308]: mismatched types --> src/lib.rs:433:9 | 432 | fn get_balance(&self) -> Result<u64, Error> { | ------------------ expected `Result<u64, bdk::Error>` because of return type 433 | self.get_wallet().get_balance() | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ expected `u64`, found struct `Balance` | = note: expected enum `Result<u64, _>` found enum `Result<Balance, _>` For more information about this error, try `rustc --explain E0308`. error: could not compile `bdk-ffi` due to previous error ``` When we upgrade to `0.22.0` we could decide to add the `Balance` struct to the bindings, or simply return the total by calling `get_total()`, which returns a `u64` (same as we have now). ACKs for top commit: notmandatory: ACK 3c6075ad96afa238dc3ceca71ba82cb10088bb90 Tree-SHA512: 13d2f83f992735f4f9619ae339d7834df08385129edf06bac830c298b433571af3f211e92a6da1f4f9646dec27dbd2c6133a035f26eac8757b7a1c94b54b463d
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.