Awesome

A Rust-C FFI library exposing composite functionality from rust-bitcoin & bdk; to create cross-platform descriptor wallets.

Currently used by Stackmate Wallet.

Table of Contents

• Acknowledgements
• Overview
• Test
• Build
• Documentation
• Contributions
• Community
• Maintainers
• License

Acknowledgements

Immense love to our friend and sponsor Prashant Balani for being patient and supportive throughout the 3 years of R&D that was required to make this project come to life!

Massive thanks to the bdk & cyphernode teams for all the support and feedback which saved us a lot of time and improved the quality of our work.

Overview

The entire ffi uses a string interface; defined in src/lib.rs

1. Inputs are converted into native rust types as the first sanitization step.

2. Native types are then used in pure rust modules.

3. All native structs being returned (responses and errors) impl a c_stringify method which converts the native struct into stringified JSON outputted as a CString.

Test

Test everything!

bash tests/test.sh

Test individual units with printing.

cargo test -- --nocapture <test_name>

Build

Refer to docs/build.md for pre-build configuration and considerations.

bash scripts/build.sh

Currently only supports android builds.

Binaries are placed in builds.

Documentation

All documentation can be found in docs.

Docs.rs

This library expects the client to build a policy (string) by themselves - refer to http://bitcoin.sipa.be/miniscript/ for more info.

The FFI API is defined in docs/api.md

Build support can be found in docs/build.md

Contributions

We are looking for active contributions in the following areas:

• General code review

• IOS builds

• Taproot support

• Neutrino support

Community

Join us on the Bitcoin-only India group where we are openly working on tools required for a Bitcoin standard, within the context of India.

Discord: https://discord.gg/PdRERkyNt4

Maintainers

ishi

mocodesmo

License

MIT