Skip to content

feat(ffi): Refactor ffi README file #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 13, 2025
Merged

feat(ffi): Refactor ffi README file #96

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ead73a2
feat(ffi): Refactor ffi README file
DaughterOfMars Aug 13, 2025
30e3685
Merge branch 'sdk-bindings' into feat/fix-readme
DaughterOfMars Aug 13, 2025
ced0c11
Update crates/iota-sdk-ffi/README.md
thibault-martinez Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 5 additions & 17 deletions crates/iota-sdk-ffi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
# IOTA SDK FFI

This crate can generate bindings for various languages (Go, Kotlin, Python, etc.) using [UniFFI](https://github.com/mozilla/uniffi-rs).
This crate can generate bindings for various languages using [UniFFI](https://github.com/mozilla/uniffi-rs).

Start by building the library to generate the appropriate dylib files.
## Supported languages

```sh
cargo build -p iota-sdk-ffi --lib --release
```

Next, run the binary to generate the bindings for the desired language.

```sh
cargo run --bin iota_sdk_bindings -- generate --library "target/release/libiota_sdk_ffi.dylib" --language python --out-dir bindings/python/lib --no-format
```

Finally, copy the dylib file to the output directory.

```sh
cp target/release/libiota_sdk_ffi.dylib bindings/python/lib/
```
- [Go](../../bindings/go)
- [Kotlin](../../bindings/kotlin)
- [Python](../../bindings/python)