Add to cargo.toml:
toml
[dependencies]
factom = "^2"
```rust use factom::*; // Get current block height from open node
async fn main() { //Create a re-usable client let client = Factom::open_node(); // Call the heights function, handle the request result let response = factomd::heights(&client).await.expect("Network Request"); assert!(response.result.leaderheight > 0); } ```
See the examples folder for common workflows, or use cargo run --example to
view all those you can run.
rust
let client = Factom::new();
rust
// factom-walletd is at `http://localhost:8089`
let client = Factom::open_node();
rust
// factom-walletd is located at: 'http://localhost:8089`
let client = Factom::testnet_node();
rust
let factomd = "https://api.factomd.net/";
let factom_walletd = "http://192.168.1.42:18089";
let client = Factom::custom_node(factomd, factom_walletd)
rust
let client = factom.testnet_node();
let testnet_address = "FA2jK2HcLnRdS94dEcU27rF3meoJfpUcZPSinpb7AwQvPRY6RL1Q";
let response = balance::factoid_balance(&client, testnet_address).await.unwrap();
// factoid balance returns factoshis, convert
let factoids = utils::factoshis_to_fct(response.result.balance);
println!("The testnet balance of {} is {} factoids", FCT_PUB, factoids);
rust
let client = factom.testnet_node();
let hash = "97c4e7adce9ed277b62adfb9fb7a31ca4778181e49dcdfebca967102dd424fbc";
let response = entry::entry(hash).await.unwrap();
dbg!(response);
This library re-exports the tokio runtime and executor by default, to disable this
and use a different runtime modify your cargo.toml with a feature flag:
toml
[dependencies]
factom = {version="^2", features="no-runtime"}
Most of the functions are covered by the test modules along with all the documentation examples.
Beware that running cargo test with nocapture will produce a huge amount of output.
For many of the tests to pass you will need to be running factom-walletd, any
test transactions or addresses are cleaned up afterward.
See the testing readme for instructions.
A criterion benching harness is provided, if gnuplot is installed it will also automatically
generate plots for any benchmarks run, they can be found at <LIBRARY>/target/criterion/report/index.html. This
can be used to test the performance of factomd, factom-walletd, network connections
and the library functions themselves. See the benches folder readme for more information.
A fuzzing suite is provided using the rust implementation of American Fuzzy Lop, with appropriate setup this can be used to fuzz both the Factom rust library along with a simulated Factom network and factom-walletd. See the fuzz folder readme for more information.
PR's welcome. Fork the library and submit to dev branch. By contributing to this library you agree to it being Apache 2.0 licensed