Steve Myers 71583eca7f
Merge bitcoindevkit/bdk-ffi#150: Add new BumpFeeTxBuilder interface
0787d9c446a3390f0e020dcabd5f30a9d760391d Fix order of BumpFeeTxBuilder parameters (Steve Myers)
390d12703eb12fc3b58a14f62a64f8582ebbeaf2 Change TxBuilder and BumpFeeTxBuilder build() to finish() (Steve Myers)
9f903932dc59e1cc955112492b699330b8806d93 Add BumpFeeTxBuilder (Steve Myers)

Pull request description:

  Add BumpFeeTxBuilder to bump the fee on an unconfirmed tx created by the Wallet. The structure of the new interface is:

  ```udl
  interface BumpFeeTxBuilder {
    constructor(string txid, float new_fee_rate);
    BumpFeeTxBuilder allow_shrinking(string address);
    BumpFeeTxBuilder enable_rbf();
    BumpFeeTxBuilder enable_rbf_with_sequence(u32 nsequence);
    [Throws=BdkError]
    PartiallySignedBitcoinTransaction build([ByRef] Wallet wallet);
  };
  ```
  Fixes #150

Top commit has no ACKs.

Tree-SHA512: a24ed41f7b897a0e091ef55d4c1347b3973cbe628b7d1bd69c95e663bc6f049de8f7e3b019115d763cff3fa6d5cb4d31ed474022c3087e8404a2af37f380d56d
2022-05-10 22:35:32 -07:00
2021-10-16 14:45:32 +05:30
2022-02-08 22:15:10 +01:00
2022-02-27 21:26:23 -08:00
2022-02-27 21:26:23 -08:00
2022-02-27 21:26:23 -08:00

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

  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%