Skip to main content

Overview

IOTA Client Library Overview

The iota.rs library is designed to simplify how you connect and interact with nodes in the IOTA network. You can use it to generate addresses, send messages, sign and send transactions, and more.

Beyond establishing the initial connection to a node, iota.rs has no state. Operations use only the data you pass during a call and have no effect on your software beyond returning a value. You are in complete control of the data flow in your application.

This stateless approach makes iota.rs easy to use and understand. But since you are in full control of data management, you are also fully responsible for it, which could feel overwhelming if you handle complex or sensitive data. If you plan on managing funds in your application, take a look at our wallet.rs library instead. It allows you to manage your user's funds safely, and it already includes our best security practices. It uses stronghold.rs to store sensitive data and iota.rs to communicate with the IOTA network and, unlike iota.rs, it has a state.

Supported Languages

We implemented the iota.rs library in Rust and prepared bindings for JavaScript, Python , Java, and Wasm. Every binding is adjusted for the language's conventions and best practices. For example, Python developers avoid the Builder programming pattern, so our Python binding uses named constructor arguments. However, we never change the meaning behind our API, which is equally powerful no matter which language you choose.

Your Application In the IOTA Network

Your application communicates with iota.rs either directly in Rust or through one of the language bindings. The iota.rs library turns your requests into REST API calls and sends them to a node through the Internet. The node, in turn, interacts with the rest of an IOTA network, which could be the main operational network (mainnet) or a network for testing purposes (devnet).

Different nodes can run on different software, but they always expose the same interface to clients. For example, one node could be a Hornet node, and the other could be a Bee node, and they both would appear the same for any client.

A diagram that illustrates the text above. It has three layers: the application layer that includes iota.rs and its bindings, communication layer (the Internet network), and IOTA network layer with nodes that operate on one of the IOTA networks.

API Design

The iota.rs library exposes operations of two types. Clients interact with nodes by calling their REST API, and the first group of operations mirrors the available calls. When your program invokes such an operation, it directly translates it into a REST call to a node. See the node's REST API reference for a complete list of available endpoints.

Operations from the first group tend to be too atomic and basic to use conveniently. The second group provides you with higher-level helper functions. These functions represent an actual task and combine multiple basic operations internally. For example, you can get your token balance by calling getBalance. It will first call getAddresses, then call getAddressBalances for each address, and add the results together to return the total balance. See the full specification for details.