2021-12-21 16:40:32 -08:00
|
|
|
# Native language bindings for BDK
|
2021-10-30 00:27:02 +05:30
|
|
|
|
2021-12-21 16:40:32 -08:00
|
|
|
This repository contains source code for generating native language bindings for the rust based
|
|
|
|
|
[bdk] library which is the central artifact of the [Bitcoin Dev Kit] project.
|
|
|
|
|
|
|
|
|
|
Each supported language has it's 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.
|
2021-10-30 00:27:02 +05:30
|
|
|
|
|
|
|
|
## Supported target languages and platforms
|
|
|
|
|
|
2021-12-21 16:40:32 -08:00
|
|
|
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] |
|
|
|
|
|
|
|
|
|
|
[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
|
2021-06-30 17:44:46 -07:00
|
|
|
|
2021-12-21 16:53:57 -08:00
|
|
|
### Install uniffi-bindgen cli tool
|
|
|
|
|
|
|
|
|
|
Install the uniffi-bindgen binary on your system using:
|
|
|
|
|
|
|
|
|
|
`cargo install uniffi_bindgen`
|
|
|
|
|
|
|
|
|
|
The version must be the same as the `uniffi` dependency in `Cargo.toml`.
|
|
|
|
|
|
2021-10-30 00:28:26 +05:30
|
|
|
### Adding new structs and functions
|
2021-10-02 12:08:34 -07:00
|
|
|
|
2021-10-12 18:22:02 -07:00
|
|
|
See the [UniFFI User Guide](https://mozilla.github.io/uniffi-rs/)
|
2021-10-02 12:08:34 -07:00
|
|
|
|
2021-10-30 00:28:26 +05:30
|
|
|
#### For pass by value objects
|
2021-06-30 17:44:46 -07:00
|
|
|
|
2021-10-30 00:27:02 +05:30
|
|
|
1. create new rust struct with only fields that are supported UniFFI types
|
|
|
|
|
1. update mapping `bdk.udl` file with new `dictionary`
|
2021-06-30 17:44:46 -07:00
|
|
|
|
2021-10-30 00:28:26 +05:30
|
|
|
#### For pass by reference values
|
2021-06-30 17:44:46 -07:00
|
|
|
|
2021-10-30 00:27:02 +05:30
|
|
|
1. create wrapper rust struct/impl with only fields that are `Sync + Send`
|
|
|
|
|
1. update mapping `bdk.udl` file with new `interface`
|
2021-10-16 14:45:32 +05:30
|
|
|
|
2021-10-30 00:27:02 +05:30
|
|
|
## Goals
|
2021-10-16 14:45:32 +05:30
|
|
|
|
2021-10-30 00:27:02 +05:30
|
|
|
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
|
2021-10-16 14:45:32 +05:30
|
|
|
|
2021-10-30 00:27:02 +05:30
|
|
|
## Thanks
|
2021-10-16 14:45:32 +05:30
|
|
|
|
2021-12-21 16:40:32 -08:00
|
|
|
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
|
