IOTA Wallet Library

Introduction

The wallet library is a stateful package with a standardised interface for developers to build applications involving IOTA value transactions. It offers abstractions to handle IOTA payments and can optionally interact with IOTA Stronghold for seed handling, seed storage and state backup. It uses RocksDB as a database. See the full specification here.

Documentation

You can find the latest version of the documentation in the official Wallet.rs documentation site. Alternatively, you can run the documentation site locally following the instructions in the documentation/README.md file.

Prerequisites

Rust and Cargo are required. Install them here.

We recommend you update Rust to the latest stable version rustup update stable. Nightly should be fine but there's a chance some changes are not compatible.

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

Dependencies

cmake, clang and openssl are required. In order to run the build process succesfully using Cargo you might need install additional build tools on your system.

Windows

cmake can be downloaded on the official website and openssl can be installed with vcpkg or chocolatey.

• Installing openssl with vcpkg:

./vcpkg.exe install openssl:x64-windows
./vcpkg.exe integrate install
# you may want to add this to the system environment variables since you'll need it to compile the crate
set VCPKGRS_DYNAMIC=1

• Installing openssl with chocolatey:

choco install openssl
# you may need to set the OPENSSL_DIR environment variable
set OPENSSL_DIR="C:\Program Files\OpenSSL-Win64"

macOS

cmake and openssl can be installed with Homebrew:

brew install cmake openssl@1.1

Linux

Install cmake, clang and openssl with your distro's package manager or download from their websites. On Debian and Ubuntu you will also need build-essential and libudev-dev .

Usage

To use the library, add this to your Cargo.toml:

[dependencies]
iota-wallet = { git = "https://github.com/iotaledger/wallet.rs", branch = "dev", default-features = false, features = ["stronghold"] }

Initialisation

In order to use the library you first need to create an AccountManager:

use iota_wallet::{
    account_manager::AccountManager, client::ClientOptionsBuilder, signing::SignerType,
};
use std::path::PathBuf;

#[tokio::main]
async fn main() -> iota_wallet::Result<()> {
    let storage_folder: PathBuf = "./my-db".into();
    let manager =
        AccountManager::builder()
            .with_storage(&storage_folder, None)
            .finish()
            .await?;
    let client_options = ClientOptionsBuilder::new().with_node("https://api.lb-0.h.chrysalis-devnet.iota.cafe")?.build();
    let account = manager
        .create_account(client_options)?
        .initialise()
        .await?;
    Ok(())
}

API reference

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

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --document-private-items --no-deps --open

Other Examples

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

cargo run --example # lists the available examples
cargo run --example transfer # execute the `transfer` example

Joining the discussion

If you want to get involved in discussions about this library, or you're looking for support, go to the #clients-discussion channel on Discord.

License