3b243efefd
f38f4c6197ec95376beeb2f444f85bd6a8a12fbd Update CHANGELOG (Steve Myers) 11ba16ec1bec922e5ffd7fcf3903eec9caf227e7 Move txid getter to PartiallySignedBitcoinTransaction (Steve Myers) 4665c551dd67f38fe91011e41ed5d3e8de404fcf Update EsploraConfig, Blockchain broadcast, Wallet sync (Steve Myers) 907540d2143b4eff4146643259a068b2f0c8696a Update bdk to 0.18.0 with sqlite-bundled feature (Steve Myers) Pull request description: Changes that were needed to match updated bdk APIs: * new bdk-ffi `Blockchain` interface with `constructo(BlockchainConfig)` and `broadcast()` functions * `Blockchain.broadcast()` function is now void (doesn't return txid) * added `PartiallySignedBitcoinTransaction.txid()` getter function * `Wallet.sync()` function now takes a `Blockchain` and optional `Progress` callback interface Tests performed: * from `bdk-kotlin/bdk-ffi` added local remote to this branch, ran build.sh script * fixed broken `bdk-kotlin` jvm and android tests and confirmed tests all pass Top commit has no ACKs. Tree-SHA512: d50633bbc8fd8a0d141597b30122c72957d2a0d64fc1537b649eeb8a5df1b1fb9a78ee1f03b9c606f47dee3952c9a91ae09eb47eb7a66d5f0fcb5545c86d906b
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.