Steve Myers cafa8dacab Merge bitcoindevkit/bdk-ffi#104: Add PSBT deserialize and serialize functions, remove details
c039281ffcbaab8048ff87426a413c953a1e5ece Add PSBT deserialize and serialize functions, remove details (Steve Myers)
1f0b053872889f5dff340035a9e3cd3488688152 Fix bin/generate with no features (Steve Myers)

Pull request description:

  1. Fix bin/generate with no features
  2. Add `PartiallySignedBitcoinTransaction::deserialize` function as named constructor to decode from a string per [BIP 0174]
  3. Add `PartiallySignedBitcoinTransaction::serialize` function to encode to a string per [BIP 0174]
  4. Remove `PartiallySignedBitcoinTransaction.details` struct field

  [BIP 0174]:https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#encoding

  Fixes #103

Top commit has no ACKs.

Tree-SHA512: 0ba34d96625d71434d41573089a150d09fcfb6439648a7eed6e36dcdddd2682c969525b7c6efda898b2f979a7ca6ce51dc2158acf65da7f1f4c554d98b60f4ff
2022-02-25 14:47:47 -08:00
2021-10-16 14:45:32 +05:30
2022-02-08 22:15:10 +01:00
2022-02-08 22:15:10 +01:00
2021-12-21 22:16:27 -08:00

Native language bindings for BDK

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.

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

Contributing

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.

Adding new structs and functions

See the UniFFI User Guide

For pass by value objects

  1. create new rust struct with only fields that are supported UniFFI types
  2. 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
  2. update mapping bdk.udl file with new interface

Goals

  1. Language bindings should feel idiomatic in target languages/platforms
  2. Adding new targets should be easy
  3. Getting up and running should be easy
  4. Contributing should be easy
  5. Get it right, then automate

Thanks

This project is made possible thanks to the wonderful work by the mozilla/uniffi-rs team.

Description
Frost experimentation on bdk-ffi
Readme 22 MiB
Languages
Rust 64.6%
Kotlin 18.1%
Swift 9.5%
Python 4.6%
Shell 2.2%
Other 1%