[][src]Crate iota_client

Modules

responses

IRI responses are parsed into structs contained in this module

Structs

AttachOptions

Struct used to provide named arguments for the attach functions

FindTransactionsOptions

Struct used to provide named arguments for find_transactions

GetBalancesOptions

Struct used to provide named arguments for get_balances

GetInclusionStatesOptions

Struct used to provide named arguments for get_inclusion_states

GetTransactionsToApproveOptions

Struct used to provide named arguments for get_transactions_to_approve

Functions

add_neighbors

Add a list of neighbors to your node. It should be noted that this is only temporary, and the added neighbors will be removed from your set of neighbors after you relaunch IRI.

attach_to_tangle

Performs proof of work

attach_to_tangle_local

Performs proof of work locally

broadcast_transactions

Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by attachToTangle.

check_consistency

Checks for consistency of given hashes, not part of the public api

find_transactions

Finds transactions the match any of the provided parameters

get_balances

Returns the balance based on the latest confirmed milestone. In addition to the balances, it also returns the referencing tips (or milestone), as well as the index with which the confirmed balance was determined. The balances is returned as a list in the same order as the addresses were provided as input.

get_inclusion_states

Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions.

get_neighbors

Returns the set of neighbors you are connected with, as well as their activity count. The activity counter is reset after restarting IRI.

get_node_info

Gets information about the specified node

get_tips

Returns the list of tips

get_transactions_to_approve

Tip selection which returns trunkTransaction and branchTransaction. The input value depth determines how many milestones to go back to for finding the transactions to approve. The higher your depth value, the more work you have to do as you are confirming more transactions. If the depth is too large (usually above 15, it depends on the node's configuration) an error will be returned. The reference is an optional hash of a transaction you want to approve. If it can't be found at the specified depth then an error will be returned.

get_trytes

Returns the raw transaction data (trytes) of a specific transaction. These trytes can then be easily converted into the actual transaction object. See utility functions for more details.

interrupt_attaching_to_tangle

Interupts an existing PoW request if you made one

remove_neighbors

Removes a list of neighbors to your node. This is only temporary, and if you have your neighbors added via the command line, they will be retained after you restart your node.

store_transactions

Store transactions into the local storage. The trytes to be used for this call are returned by attachToTangle.

were_addresses_spent_from

Check if a list of addresses was ever spent from.