#API Documentation

#api::mod::Api

#new()

1pub fn new(host: &str)

Instantiate new Api.

#Parameters

#Return Value

Api

#new_with_client()

1pub fn new_with_client(client: &Client)

Instantiate new Api with an already existing Client.

#Parameters

#Return Value

Api

#api::blocks::Blocks

#new()

1pub fn new(client: Client)

Instantiate new Blocks.

#Parameters

#Return Value

Blocks

#all()

1pub fn all(&self)

Get all blocks.

#Return Value

Result<Vec<Block>>

#all_params()

1pub fn all_params<I, K, V>(&self, parameters: I)

Get all blocks.

#Parameters

#Return Value

Result<Vec<Block>>

#show()

1pub fn show(&self, id: &str)

Get a block by the given id.

#Parameters

#Return Value

Result<Block>

#transactions()

1pub fn transactions(&self, id: &str)

Get all transactions by the given block.

#Parameters

#Return Value

Result<Vec<Transaction>>

#transactions_params()

1pub fn transactions_params<I, K, V>(&self, id: &str, parameters: I)

Get all transactions by the given block.

#Parameters

#Return Value

Result<Vec<Transaction>>

#search()

1pub fn search<I, K, V>(&self, parameters: I)

Filter all blocks by the given parameters.

#Parameters

#Return Value

Result<Vec<Block>>

#api::delegates::Delegates

#new()

1pub fn new(client: Client)

Instantiate new Delegates.

#Parameters

#Return Value

Delegates

#all()

1pub fn all(&self)

Get all accounts.

#Return Value

Result<Vec<Delegate>>

#all_params()

1pub fn all_params<I, K, V>(&self, parameters: I)

Get all accounts.

#Parameters

#Return Value

Result<Vec<Delegate>>

#show()

1pub fn show(&self, id: &str)

Get a delegate by the given id.

#Parameters

#Return Value

Result<Delegate>

#blocks()

1pub fn blocks(&self, id: &str)

Get all blocks for the given delegate.

#Parameters

#Return Value

Result<Vec<Block>>

#blocks_params()

1pub fn blocks_params<I, K, V>(&self, id: &str, parameters: I)

Get all blocks for the given delegate.

#Parameters

#Return Value

Result<Vec<Block>>

#voters()

1pub fn voters(&self, id: &str)

Get all voters for the given delegate.

#Parameters

#Return Value

Result<Vec<Wallet>>

#voters_params()

1pub fn voters_params<I, K, V>(&self, id: &str, parameters: I)

Get all voters for the given delegate.

#Parameters

#Return Value

Result<Vec<Wallet>>

#voters_balances()

1pub fn voters_balances(&self, id: &str)

Returns the voters of a delegate and their balances.

#Parameters

#Return Value

Result<Balances>

#search()

1 pub fn search<I, K, V>(
2        &self,
3        payload: Option<HashMap<&str, &str>>,
4        parameters: I,
5)

Searches the delegates.

#Parameters

#Return Value

Result<Vec<Delegate>>

#api::node::Node

#new()

1pub fn new(client: Client)

Instantiate new Node.

#Parameters

#Return Value

Node

#configuration()

1pub fn configuration(&self)

Get the node configuration.

#Return Value

Result<NodeConfiguration>

#status()

1pub fn status(&self)

Get the node status.

#Return Value

Result<NodeStatus>

#syncing()

1pub fn syncing(&self)

Get the node syncing status.

#Return Value

Result<NodeSyncing>

#api::peers::Peers

#new()

1pub fn new(client: Client)

Instantiate new Peers.

#Parameters

#Return Value

Peers

#all()

1pub fn all(&self)

Get all peers.

#Return Value

Result<Vec<Peer>>

#all_params()

1pub fn all_params<I, K, V>(&self, parameters: I)

Get all peers.

#Parameters

#Return Value

Result<Vec<Peer>>

#show()

1pub fn show(&self, ip_addr: &str)

Get a peer by the given IP address.

#Parameters

#Return Value

Result<Peer>

#api::transactions::Transactions

#new()

1pub fn new(client: Client)

Instantiate new Transactions.

#Parameters

#Return Value

Transactions

#create()

1pub fn create(&self, transactions: Vec<&str>)

Create a new transaction.

#Parameters

#Return Value

Result<Transaction>

#show()

1pub fn show(&self, id: &str)

Get a transaction by the given id.

#Parameters

#Return Value

Result<Transaction>

#all()

1pub fn all(&self)

Get all transactions.

#Return Value

Result<Vec<Transaction>>

#all_params()

1pub fn all_params<I, K, V>(&self, parameters: I)

Get all transactions.

#Parameters

#Return Value

Result<Vec<Transaction>>

#all_unconfirmed()

1pub fn all_unconfirmed(&self)

Get all unconfirmed transactions.

#Return Value

Result<Vec<Transaction>>

#all_unconfirmed_params()

1pub fn all_unconfirmed_params<I, K, V>(&self, parameters: I)

Get all unconfirmed transactions.

#Parameters

#Return Value

Result<Vec<Transaction>>

#show_unconfirmed()

1pub fn show_unconfirmed(&self, id: &str)

Get an unconfirmed transaction by the given id.

#Parameters

#Return Value

Result<Vec<Transaction>>

#search()

1pub fn search<I, K, V>(
2        &self,
3        payload: Option<HashMap<&str, &str>>,
4        parameters: I,
5)

Filter all transactions by the given parameters.

#Parameters

#Return Value

Result<Vec<Transaction>>

#types()

1pub fn types(&self)

Get a list of valid transaction types.

#Return Value

Result<TransactionTypes>

#fees()

1pub fn fees(&self)

Returns the static fees of the last block processed by the node.

#Return Value

Result<TransactionFees>

#api::votes::Votes

#new()

1pub fn new(client: Client)

Instantiate new Votes.

#Parameters

#Return Value

Votes

#all()

1pub fn all(&self)

Get all votes.

#Return Value

Result<Vec<Transaction>>

#all_params()

1pub fn all_params<I, K, V>(&self, parameters: I)

Get all votes.

#Parameters

#Return Value

Result<Vec<Transaction>>

#show()

1pub fn show(&self, id: &str)

Get a vote by the given id.

#Parameters

#Return Value

Result<Transaction>

#api::wallets::Wallets

#new()

1pub fn new(client: Client)

Instantiate new Wallets.

#Parameters

#Return Value

Wallets

#all()

1pub fn all(&self)

Get all wallets.

#Return Value

Result<Vec<Wallet>>

#all_params()

1pub fn all_params<I, K, V>(&self, parameters: I)

Get all wallets.

#Parameters

#Return Value

Result<Vec<Wallet>>

#show()

1pub fn show(&self, id: &str)

Get a wallet by the given id.

#Parameters

#Return Value

Result<Wallet>

#transactions()

1pub fn transactions(&self, id: &str)

Get all transactions for the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#transactions_params()

1pub fn transactions_params<I, K, V>(&self, id: &str, parameters: I)

Get all transactions for the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#received_transactions()

1pub fn received_transactions(&self, id: &str)

Get all transactions received by the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#received_transactions_params()

1pub fn received_transactions_params<I, K, V>(
2        &self,
3        id: &str,
4        parameters: I,
5)

Get all transactions received by the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#sent_transactions()

1pub fn sent_transactions(&self, id: &str)

Get all transactions sent by the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#sent_transactions_params()

1pub fn sent_transactions_params<I, K, V>(
2        &self,
3        id: &str,
4        parameters: I,
5)

Get all transactions sent by the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#votes()

1pub fn votes(&self, id: &str)

Get all votes by the given wallet.

#Parameters

#Return Value

Result<Vec<Transaction>>

#top()

1pub fn top(&self)

Get all wallets sorted by balance in descending order.

#Return Value

Result<Vec<Wallet>>

#top_params()

1pub fn top_params<I, K, V>(&self, parameters: I)

Get all wallets sorted by balance in descending order.

#Parameters

#Return Value

Result<Vec<Wallet>>

#search()

1pub fn search<I, K, V>(&self, parameters: I)

Filter all wallets by the given parameters.

#Parameters

#Return Value

Result<Vec<Wallet>>

#connection::manager::Manager

#new()

1pub fn new()

Instantiate new Manager.

#Return Value

Manager<'a>

#connect()

1pub fn connect(&mut self, connection: &'a Connection)

Connect to the given connection.

#Parameters

#Return Value

Result<(), &str>

#connect_as()

1pub fn connect_as(&mut self, connection: &'a Connection, name: &str)

Connect to the given connection.

#Parameters

#Return Value

Result<(), &str>

#disconnect()

1pub fn disconnect(&mut self, name: &str)

Disconnect from given connection.

#Parameters

#Return Value

Void

#connection()

1pub fn connection(&self)

Get a connection instance.

#Return Value

Option<&'a Connection>

#connection_by_name()

1pub fn connection_by_name(&self, name: &str)

Get the connection by name.

#Parameters

#Return Value

Option<&'a Connection>

#get_default_connection()

1pub fn get_default_connection(&self)

Get the default connection name.

#Return Value

String

#set_default_connection()

1pub fn set_default_connection(&mut self, name: &str)

Set the default connection name.

#Parameters

#Return Value

Void

#connections()

1pub fn connections(&self)

Return all of the created connections.

#Return Value

Values<String, &'a Any>

#connection::mod::Connection

#new()

1pub fn new(host: &str)

Instantiate new Connection.

#Parameters

#Return Value

Connection

#http::client::Client

#new()

1pub fn new(host: &str) -> Client

Instantiate new Client.

#Parameters

#Return Value

Client

#set_version()

1pub fn set_version(&mut self, version: &'static str)

Set the version of the client.

#Parameters

#Return Value

Void

#get()

1pub fn get<T: DeserializeOwned>(&self, endpoint: &str)

GET request on the given endpoint.

#Parameters

#Return Value

Result<T>

#get_with_params()

1pub fn get_with_params<T, I, K, V>(&self, endpoint: &str, parameters: I)

GET request with parameters on the given endpoint.

#Parameters

#Return Value

Result<T>

#post()

1pub fn post<T, V>(&self, endpoint: &str, payload: Option<HashMap<&str, V>>)

POST request on the given endpoint.

#Parameters

#Return Value

Result<T>

#post_with_params()

1pub fn post_with_params<T, H, I, K, V>(
2        &self,
3        endpoint: &str,
4        payload: Option<HashMap<&str, H>>,
5        parameters: I,
6)

POST request with parameters on the given endpoint.

#Parameters

#Return Value

Result<T>