iota-validation
cargo install iota-validation

iota-validation

Official IOTA Rust library.

by iotaledger

0.4.0 (see all)License:MIT
cargo install iota-validation
Readme

iota.rs (iota-client)

The official, general-purpose IOTA client library in Rust for interaction with the IOTA network (Tangle).

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

For value transfers we recommend using 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

Branching structure for development

This library follows the following branching strategy:

BranchDescription
developOngoing development for future releases of the networks. This branch gets merged into staging on releases.
legacyDeprecated, contains legacy releases supporting pre-Chrysalis features.
productionThe latest releases for the IOTA networks.
stagingThe latest releases for the Shimmer networks.
otherOther branches that may reflect current projects. Similar to develop, they will find their way into staging once they are ready.

Using the library

We recommend you to first update the Rust compiler to the latest stable version:

rustup update stable

The nightly Rust compiler should be fine but some changes might not be compatible.

Add iota-client as a dependency in Cargo.toml:

[dependencies]
iota-client = "1.1.1"

Or, for the latest changes:

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

Then, use the library in code with:

// Note that the hyphen is replaced with an underscore
use iota_client;

Limitations

  • 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.
  • When using the mqtt feature, connecting to a MQTT broker using raw IP doesn't work with TCP. This is a limitation of rustls.

Examples

You can see examples using the library in the examples directory. Try them with:

# cargo run --example <name of the example without .rs>
cargo run --example 01_get_info

For examples where a seed is required (e.g. 03_generate_addresses) you need to create a .env file under the current directory. You can do so by renaming .env.example to .env.

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

Bindings

Bindings to other programming languages are available under the folder bindings.

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 #client-libraries and #client-discussion channels.

License

The Apache 2.0 license can be found here.

GitHub Stars

190

LAST COMMIT

3mos ago

MAINTAINERS

2

CONTRIBUTORS

60

OPEN ISSUES

27

OPEN PRs

8
VersionTagPublished
0.2.1
3yrs ago
0.4.0
3yrs ago
0.2.0
3yrs ago
0.1.0
3yrs ago
No alternatives found
No tutorials found
Add a tutorial