evernym / rust-libindy-wrapper

rust-libindy-wrapper

LibIndy major artifact of the SDK is a C-callable library that provides the basic building blocks for the creation of applications on the top of Hyperledger Indy, which provides a distributed-ledger-based foundation for self-sovereign identity.

rust-libindy-wrapper is a library for assisting developers using LibIndy API.

rust-libindy-wrapper does not include LibIndy. This will need to be built separately. See IndySDK github

using rust-libindy-wrapper

Assumptions: LibIndy is installed. And, you understand the basics.

Step 1

Add rust-libindy-wrapper to Cargo.toml

[dependencies]
rust-libindy-wrapper = "0.2.13"

Step 2

setup an environment variable that points to LibIndy library. eg:

LIBINDY_DIR="/Users/developer/indy-sdk/libindy/target/release"

Step 3

Use rust-libindy-wrapper. For now, best recommendation is to check out the tests.

License

Released under Apache 2.0 and MIT. See license files in git repo.

rust-libindy-wrapper's Issues

Non-secrets API isn't exposed

There are not methods to handle libindy non-secrets API

Error types should implement std::error::Error trait

For now all results are Result<T, ErrorCode>. It is hard to use Rust style error handling and libraries like error_chain without implementation of std::error::Error trait for error types

Log API isn't exposed

Log API is part of the current version of libindy (not stable)

Async methods should return tokio.rs Future

tokio.rs is now "default" solution for asynchronous programming in Rust. It can be quite easy to convert callback to Future with single-shot channel. but 90+% of users will have to write it's own Future based wrapper.

I suggest to change API to return Future instead of callback registration.

Async methods must be default

Instead of wallet::create and wallet::create_async pairs it is better to have wallet::create and wallet::create_sync. Synchronous version is usable for testing or PoC applications only, but we force it as a default.

Module name looks foreign to Rust

I suggest to rename rust_indy_sdk to just indy. SDK is set of tools. This wrapper is for libindy only and in Rust lib is redundant. As result the most correct name is just "indy".

Redundant structs

For the current moment all API functions implemented as static structs methods in dedicated submodule. It causes unnecessary usage of structs in code. We can just have public functions in submodule:

indy::wallet::Wallet::create("{}", "{}").unwrap();

can be just replaced with

indy::wallet::create("{}", "{}").unwrap();

It will look much more nature to Rust.