e797efea57
b207464fe6Update README.md with bdk-ffi-bindgen info (Steve Myers)fca5d1602bAdd workspace and move bin to bdk-ffi-bindgen package (Steve Myers)f4e097c4acOnly print python fix up lib path if used (Steve Myers)c66dfdd52aUse structopt to capture generate options (Steve Myers)ce848725b4Add binary to remove the need for uniffi-bindgen cli tool (thunderbiscuit) Pull request description: This PR is based on the mozilla/application-services [embedded-uniffi-bindgen](https://github.com/mozilla/application-services/tree/main/tools/embedded-uniffi-bindgen) tool. The purpose is to keep the bdk-ffi and bdk-ffi-bindgen tool in sync with the same version of uniffi-rs. Fixes #124, this PR replaces #122. The `bdkffi` library code remains unchanged but the `bin/generate` and `bin/generate-bindings` bins are combined and put in a new workspace binary package called `bdk-ffi-bindgen`. The `bdk-ffi-bindgen` binary uses the following options, defaults, and environment variables: ```shell % cargo run -p bdk-ffi-bindgen -- --help bdk-ffi-bindgen 0.1.0 A tool to generate bdk-ffi language bindings USAGE: bdk-ffi-bindgen [OPTIONS] --language <language> --out-dir <out-dir> FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -l, --language <language> Language to generate bindings for [env: BDKFFI_BINDGEN_LANGUAGE=] [possible values: kotlin, swift, python] -o, --out-dir <out-dir> Output directory to put generated language bindings [env: BDKFFI_BINDGEN_OUTPUT_DIR=] -p, --python-fixup-path <python-fixup-path> Python fix up lib path [env: BDKFFI_BINDGEN_PYTHON_FIXUP_PATH=] -u, --udl-file <udl-file> UDL file [env: BDKFFI_BINDGEN_UDL=] [default: src/bdk.udl] ``` Top commit has no ACKs. Tree-SHA512: fa1a1c097fe5d0e704d76078c10f82c466dad5d045c8c93d579c2d13c448c52fb6a4f99dfd3dbc46be30471477ae2d1f9264201e14bae7948b408c8e0b3c9b81
69 lines
2.5 KiB
Markdown
69 lines
2.5 KiB
Markdown
# 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:
|
|
```shell
|
|
cargo run -p bdk-ffi-bindgen -- --help
|
|
```
|
|
|
|
[bdk]: https://github.com/bitcoindevkit/bdk
|
|
[Bitcoin Dev Kit]: https://github.com/bitcoindevkit
|
|
[git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
|
|
[uniffi-rs]: https://github.com/mozilla/uniffi-rs
|
|
|
|
[bdk-kotlin]: https://github.com/bitcoindevkit/bdk-kotlin
|
|
[bdk-swift]: https://github.com/bitcoindevkit/bdk-swift
|
|
[bdk-python]: https://github.com/thunderbiscuit/bdk-python
|
|
|
|
## Contributing
|
|
|
|
### Adding new structs and functions
|
|
|
|
See the [UniFFI User Guide](https://mozilla.github.io/uniffi-rs/)
|
|
|
|
#### For pass by value objects
|
|
|
|
1. create new rust struct with only fields that are supported UniFFI types
|
|
1. update mapping `bdk.udl` file with new `dictionary`
|
|
|
|
#### For pass by reference values
|
|
|
|
1. create wrapper rust struct/impl with only fields that are `Sync + Send`
|
|
1. update mapping `bdk.udl` file with new `interface`
|
|
|
|
## Goals
|
|
|
|
1. Language bindings should feel idiomatic in target languages/platforms
|
|
1. Adding new targets should be easy
|
|
1. Getting up and running should be easy
|
|
1. Contributing should be easy
|
|
1. Get it right, then automate
|
|
|
|
## Thanks
|
|
|
|
This project is made possible thanks to the wonderful work by the [mozilla/uniffi-rs] team.
|
|
|
|
[mozilla/uniffi-rs]: https://github.com/mozilla/uniffi-rs
|