Foreign Function Interface (FFI) bindings for Iroh
This repo defines Python, Swift and Kotlin bindings for iroh, which is written in Rust.
This is a "tier 2" repo, which means it's a repo we care about, but don't apply the same level of rigor as a "tier 1" repo. All work is done through pull requests, and must pass continuous integration, but the peer review process is much lighter, and our reaction times to issues will not be as fast as tier 1 repositories.
If you're blocked on something, or need to draw attention to an issue, please reach out the iroh discord.
We are not commited to publishing releases for the FFI on a schedule or in tandem with the latest version of iroh, but we try. There may be a gap between the latest version of iroh (or the latest verison of iroh-ffi that is released on github), and the matching versions of the python or swift ffi languages that are published.
If there currently is a gap, and you need a published python or swift package, please file an issue or reach out to us on our discord.
Running cargo build --release will produce a dynamic library and a static library.
For builds targeting older versions of MacOS, build with with: MACOSX_DEPLOYMENT_TARGET=10.7 && cargo build --target x86_64-apple-darwin --release.
Check our our DEVELOPERS.md for guides on how to translate from the iroh rust API to the iroh FFI API, as well as how to set up testing for golang and python.
This project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http:https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http:https://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.