3 unstable releases

0.4.0 Oct 9, 2019
0.2.1 Oct 14, 2019
0.2.0 Jun 24, 2019
0.1.0 Jun 20, 2019

40 downloads per month
Used in iota-lib-rs

MIT license

33KB
756 lines

iota.rs

Official Rust library.

The goal of this library is to have one source code of truth, which means there is one implementation in Rust and bindings to other programming languages.

For value transfers we recommend to use wallet.rs.

This library allows you to do the following:

  • Create messages with indexation and transaction payloads
  • Get messages and outputs
  • Sign transactions
  • Generate addresses
  • Interact with an IOTA node

Requirements

To use the library, we recommend you update Rust to latest stable version $ rustup update stable. Nightly should be fine but some changes might not be compatible.

no_std is not currently supported, but we are working on it in bee, and will provide it as feature once the new implementation is ready.

Using the library

Using the library is easy, just add it as dependency in Cargo.toml:

[dependencies]
iota-client = "1.0"

or for the latest changes

[dependencies]
iota-client = { git = "https://github.com/iotaledger/iota.rs", branch = "dev" }

And then you can use the library in your code with use iota_client;.

When using the "MQTT" feature, connecting to a MQTT broker using raw ip doesn't work with TCP. This is a limitation of rustls.

API reference

You can read the API reference here, or generate it yourself.

If you'd like to explore the implementation in more depth, the following command generates docs for the whole crate, including private modules:

cargo doc --document-private-items --no-deps --open

Examples

You can see the examples in the examples directory and try them like:

cargo run --example 01_get_info

For the examples where a seed is required you have to rename .env.example to .env.

Bindings

Bindings to other programming languages.

Joining the discussion

If you want to get involved in the community, need help with setting up, have any issues or just want to discuss IOTA with other people, feel free to join our Discord in the #clients-dev and #clients-discussion channels.

License

The Apache 2.0 license can be found here.

Dependencies

~775KB
~15K SLoC