#iota #api #async

yanked nightly iota-lib-rs-preview

A rust implementation of the IOTA API

0.1.6 Aug 18, 2018
0.1.5 Aug 16, 2018
0.1.2 Jul 22, 2018

#44 in #iota

26 downloads per month
Used in iota-spammer

MIT license

235KB
5.5K SLoC

An unofficial implementation of the IOTA api in rust.

Build Status Windows Build status Version Documentation License

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-preview

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)

extern crate iota_lib_rs;
extern crate futures;

use iota_lib_rs::iota_api;
use iota_lib_rs::iota_api::SendTransferOptions;
use iota_lib_rs::utils::trytes_converter;
use iota_lib_rs::model::*;

use futures::executor::block_on;

fn main() {
    let trytes = "HELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDHELLOWORLDD";
    let message = trytes_converter::to_trytes("Hello World").unwrap();
    let mut transfer = Transfer::default();
    *transfer.value_mut() = 0;
    *transfer.address_mut() = trytes.to_string();
    *transfer.message_mut() = message;
    let api = iota_api::API::new("https://trinity.iota.fm");
    let options = SendTransferOptions{
        seed: trytes.to_string(),
        depth: 3,
        min_weight_magnitude: 14,
        local_pow: true,
        threads: None,
        inputs: None,
        reference: None,
        remainder_address: None,
        security: None,
        hmac_key: None,
    };    
    // This line is commented out because travis CI can't handle it,
    // but you should uncomment it
    let tx = block_on(api.send_transfers(vec![transfer], options)).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

Dependencies

~19MB
~442K SLoC