76 lines
3.2 KiB
Markdown
76 lines
3.2 KiB
Markdown
# Native language bindings for BDK
|
|
|
|
<p>
|
|
<a href="https://github.com/bitcoindevkit/bdk-ffi/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
|
|
<a href="https://github.com/bitcoindevkit/bdk-ffi/actions?query=workflow%3ACI"><img alt="CI Status" src="https://github.com/bitcoindevkit/bdk-ffi/workflows/CI/badge.svg"></a>
|
|
<a href="https://blog.rust-lang.org/2022/05/19/Rust-1.61.0.html"><img alt="Rustc Version 1.61.0+" src="https://img.shields.io/badge/rustc-1.61.0%2B-lightgrey.svg"/></a>
|
|
<a href="https://discord.gg/d7NkDKm"><img alt="Chat on Discord" src="https://img.shields.io/discord/753336465005608961?logo=discord"></a>
|
|
</p>
|
|
|
|
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/bitcoindevkit/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
|