Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iotaledger/iota.rs
Official IOTA Rust library.
https://github.com/iotaledger/iota.rs
Last synced: 2 days ago
JSON representation
Official IOTA Rust library.
- Host: GitHub
- URL: https://github.com/iotaledger/iota.rs
- Owner: iotaledger
- License: apache-2.0
- Created: 2018-06-04T00:12:51.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-23T07:37:28.000Z (about 1 year ago)
- Last Synced: 2024-10-28T20:41:02.065Z (7 days ago)
- Language: Rust
- Homepage:
- Size: 38.3 MB
- Stars: 228
- Watchers: 17
- Forks: 97
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-iota - iota.rs - IOTA implementation ( rust ) (Developers / Official by the IOTA Foundation)
- best-of-crypto - GitHub - 2% open · ⏱️ 23.08.2023): (Top Internet of Things (IOT))
README
> **Warning**
> Deprecated - The client has been moved to https://github.com/iotaledger/iota-sdk
# 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](#bindings) to other programming languages.
For value transfers we recommend using [wallet.rs](https://github.com/iotaledger/wallet.rs).
This library allows you to do the following:
* Create blocks with tagged data and transaction payloads
* Get blocks and outputs
* Sign transactions
* Generate addresses
* Interact with an IOTA node
## Using the library
We recommend you to first update the Rust compiler to the latest stable version:
```shell
rustup update stable
```
The nightly Rust compiler should be fine but some changes might not be compatible.
Also for Linux `libudev` is needed for the `ledger_nano` feature and can be installed with `apt install libudev-dev`.
Add `iota-client` as a dependency in `Cargo.toml`:
```toml
[dependencies]
iota-client = "2.0.1-rc.6"
```
Or, for the latest changes:
```toml
[dependencies]
iota-client = { git = "https://github.com/iotaledger/iota.rs", branch = "develop" }
```
Then, use the library in code with:
```rust
// Note that the hyphen is replaced with an underscore
use iota_client;
```
## Limitations
- 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](client/examples/) directory. Try them with:
```shell
# cargo run --example
cargo run --example node_api_core_get_info
```
For examples where a seed is required (e.g. `01_generate_addresses`) you need to create a `.env` file under the current directory. You can do so by renaming [`.env.example`](.env.example) to `.env`.
## API reference
You can read the [API reference](https://docs.rs/iota-client) 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:
```shell
cargo doc --document-private-items --no-deps --open
```
## Bindings
Bindings to other programming languages are available under the folder [bindings](client/bindings/).
* [Node.js binding](client/bindings/nodejs/)
* [Python binding](client/bindings/python/)
* [Java binding](client/bindings/java/)
* [Wasm binding](client/bindings/wasm/)
## 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](https://discord.iota.org/) in the #client-libs channel.
## License
The Apache 2.0 license can be found [here](LICENSE).