iota-lib-rs 0.3.0

A rust implementation of the IOTA API
Documentation

An unofficial implementation of the IOTA api in rust.

Build Status Windows Build status Version Documentation License

This library requires nightly rust until async becomes stable

This is a port of the IOTA Java/JS API into Rust. It works, but I wouldn't trust it with real money yet. Having said that, please let me know if you have any suggestions or run into any issues.

Here are some reasons you might want to use this library:

  1. It has a very fast implementation of local PoW (1-2s with MwM = 14, 4-6ms with MwM = 9 on my laptop)
  2. You'll benefit from Rust's very nice type system
  3. This library is more actively maintained than Jota
  4. Now that the library is working, I'm going to be obsessively going over it to improve safety, performance, and usability
  5. It would make me personally happy :)

Documentation

https://docs.rs/iota-lib-rs

This library currently requires nightly rust to build.

Things that are done:

  • Crypto
    • Curl
    • Kerl
    • PearlDiver
    • ISS
    • HMAC
    • Signing
  • Model
    • Bundle
    • Input
    • Inputs
    • Neighbor
    • Signature
    • Transaction
    • Transfer
  • Utils
    • Checksum
    • Constants
    • Converter
    • InputValidator
    • IotaAPIUtils
    • IotaUnitConversion
    • IotaUnits
    • Multisig
    • SeedRandomGenerator
    • StopWatch
    • TrytesConverter
  • API
    • IRI API calls and responses
      • add neighbors
      • attach_to_tangle
      • find_transactions
      • get_balances
      • broadcastTransactions
      • storeTransactions
      • get_inclusion_states
      • get_neighbors
      • get_node_info
      • get_tips
      • get_transactions_to_approve
      • get_trytes
      • remove_neighbor
      • were_addresses_spent_from
      • check_consistency
    • Ease of use wrappers/helpers
      • new_address
      • get_new_address
      • send_trytes
      • store_and_broadcast
      • get_inputs
      • prepare_transfers
      • traverse_bundle
      • send_transfer
      • get_bundle

Here's an example of how to send a transaction: (Note that we're using the address as the seed in send_transfer()...don't do this)

use iota_api::options::SendTransferOptions;
use iota_lib_rs::prelude::*;
use iota_model::Transfer;
use iota_conversion::trytes_converter;

fn main() {
    let trytes =
        "HELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDD";
    let message = trytes_converter::to_trytes("Hello World").unwrap();
    let transfer = Transfer {
        address: trytes.to_string(),
        // Don't need to specify the field 
        // because the field and variable
        // have the same name
        message,
        // Populate the rest of the fields with default values
        ..Transfer::default()
    };
    let api = iota_api::API::new("https://node01.iotatoken.nl");
    let tx = api
        .send_transfers(
            transfer.into(),
            &trytes,
            SendTransferOptions {
                local_pow: true,
                threads: 2,
                ..SendTransferOptions::default()
            },
        )
        .unwrap();
    println!("{:?}", tx);
}

Donations:

If you feel so inclined, you can find my address for donations at:

https://ecosystem.iota.org/projects/iota-lib-rs