Factom API Client

Asynchronous rust client for the Factom API.

Installation

Add to cargo.toml: toml [dependencies] factom = "1.0.1"

Quickstart

```rust use factom::*;

let api = Factom::new(); let response = fetch(api.properties()).expect("Unable to fetch query"); dbg!(response);

/* Response { jsonrpc: "2.0", id: 0, result: result( Object( { "factomdapiversion": String( "2.0" ), "factomdversion": String( "6.1.0" ) } ) ) } */ ```

Usage

rust use factom::*;

Simple synchronous call from remote host

rust let api = Factom::from_host("192.168.27.42"); let height_query = api.heights(); let response = fetch(height_query).unwrap(); dbg!(response)

Synchronous call using Tokio block_on

```rust // Create Tokio runtime let mut runtime = Runtime::new().expect("Unable to create Tokio Runtime"); let api = Factom::new();

let entryhash = "6ecd7c6c40d0e9dbb52457343e083d4306c5b4cd2d6e623ba67cf9d18b39faa7"; let entry_query = api.entry(entryhash);

// blockon waits for future to return result let response = runtime.blockon(entry_query).unwrap(); dbg!(response);

// Shutdown runtime once idle shutdown(runtime); ```

Asynchronous requests using futures

```rust let mut runtime = Runtime::new().unwrap(); let api = Factom::new();

// Closure to parse heights response let heighthandler = |response: Response| { // Parse Result let result = response.getresult().expect("Error fetching request"); // Extract heights let leader = &result["leaderheight"]; let dblockheight = &result["directoryblockheight"]; // Compare if leader == dblockheight{ println!("Factomd fully synced at height: {}", leader); } else { println!("Not synced"); } };

// Main heights request let heightsquery = api.heights() // Handle successful execution of future .map(heighthandler) // Print FetchError info if it occurs .map_err(|err| {dbg!(err);});

// Closure to print entry content let entryhandler = |res: Response| { let result = res.getresult().unwrap(); dbg!(&result["content"]); };

// Main entry request let entryhash = "6ecd7c6c40d0e9dbb52457343e083d4306c5b4cd2d6e623ba67cf9d18b39faa7"; let entryquery = api.entry(entryhash) .map(entryhandler) .map_err(|err| {dbg!(err);});

// Spawn queries into current runtime runtime.spawn(heightsquery); runtime.spawn(entryquery);

shutdown(runtime); ```

Passing messages between async tasks

```rust use futures::sync::oneshot;

let mut runtime = Runtime::new().unwrap(); let api = Factom::from_host("192.168.121.132");

// Oneshot used for passing single values, use mpsc to pass streams. let (tx, rx) = oneshot::channel::();

// Heights query transmits the response data let heights = api.heights() .map(|res| { tx.send(res); }) .map_err(|err| ());

// Spawn into current runtime runtime.spawn(heights);

// Reciever prints out response runtime.spawn(rx.andthen(|res| { println!("response recieved: {:?}", res); Ok(()) }) .maperr(|e| {println!("error: {}", e);}) );

shutdown(runtime);

```

Testing

Setup test environment first, if factomd/walletd are not run locally modify the HOST variable in tests/mod.rs, see the readme for more information. bash cargo test