Skip to main content

Getting Started with Rust

Prerequisites

Rust and Cargo are required to use wallet.rs. You can find installation instructions in the Rust documentation.

We recommend you update Rust to the latest stable version. The nightly version should be fine, but there is a chance some changes are not compatible.

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

Dependencies

cmake and openssl are required to run Rust. To run the build process successfully using Cargo, you may need install additional build tools onto your system.

Windows

You can download cmake from the official cmake website. You can install openssl 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_ROOT_DIR environment variable
    set OPENSSL_ROOT_DIR="C:\Program Files\OpenSSL-Win64"

macOS

You can install cmake and openssl with Homebrew by running the following commands:

brew install cmake
brew install [email protected]
# you may want to add this to your .zshrc or .bashrc since you'll need it to compile the crate
OPENSSL_ROOT_DIR=$(brew --prefix [email protected])

Linux

You can install cmake and openssl with your distro's package manager or download them from their websites. On Debian and Ubuntu, you will also need the build-essential package.

Usage

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

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

Initialisation

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?;
manager.set_stronghold_password("password").await?;
// If no mnemonic is provided, then the Stronghold file is the only way for a backup
manager.store_mnemonic(SignerType::Stronghold, None).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)?
.signer_type(SignerType::Stronghold)
.initialise()
.await?;
let address = account.generate_address().await?;
println!("Address: {}", address.address().to_bech32());
Ok(())
}