5ffe9ff331
9a3d6098261a73e8005e78a7ea2791734321af93 Match bdk API and return a boolean when signing a PSBT (thunderbiscuit) Pull request description: This is a fix for #160. I was looking at the `get_transactions()` method just below and I'm not sure which syntax is best (let me know if you have opinions on this) between What I have: ```rust fn sign(&self, psbt: &PartiallySignedBitcoinTransaction) -> Result<bool, Error> { let mut psbt = psbt.internal.lock().unwrap(); self.get_wallet().sign(&mut psbt, SignOptions::default()) } ``` If I mirrored `get_transactions()`: ```rust fn sign(&self, psbt: &PartiallySignedBitcoinTransaction) -> Result<bool, Error> { let mut psbt = psbt.internal.lock().unwrap(); let finalized = self.get_wallet().sign(&mut psbt, SignOptions::default())?; Ok(finalized) } ``` ACKs for top commit: notmandatory: reACK 9a3d6098261a73e8005e78a7ea2791734321af93 Tree-SHA512: c220929ea9bf7f670c850aebef1c2ebefcbf354f3887e692be36dced30e0e180816426bd58c5a58f61a9759e2f9f451b56e9448f42c23e26f96cf857fd6aa37c
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.