org.iota.jota.connection

Interface IotaNodeApi

All Known Subinterfaces:

Connection

All Known Implementing Classes:

HttpConnector

public interface IotaNodeApi

Method Summary

Modifier and Type	Method and Description
AddNeighborsResponse	addNeighbors(IotaNeighborsRequest request) Add a list of neighbors to the node.
GetAttachToTangleResponse	attachToTangle(IotaAttachToTangleRequest request) Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work.
BroadcastTransactionsResponse	broadcastTransactions(IotaBroadcastTransactionRequest request) Broadcast a list of transactions to all neighbors.
CheckConsistencyResponse	checkConsistency(IotaCheckConsistencyRequest request) Checks the consistency of the subtangle described by the provided tails.
IotaCustomResponse	customRequest(IotaCustomRequest findTransRequest) Custom API call used to call IXI modules.
FindTransactionResponse	findTransactions(IotaFindTransactionsRequest request) Find the transactions which match the specified input and return.
GetBalancesResponse	getBalances(IotaGetBalancesRequest request) It returns the confirmed balance which a list of addresses have at the latest confirmed milestone.
GetInclusionStateResponse	getInclusionStates(IotaGetInclusionStateRequest request) Get the inclusion states of a set of transactions.
GetNeighborsResponse	getNeighbors(IotaCommandRequest request) Get the list of neighbors from the node.
GetNodeInfoResponse	getNodeInfo(IotaCommandRequest request) Returns information about the node.
GetTipsResponse	getTips(IotaCommandRequest request) Get the list of latest tips (unconfirmed transactions).
GetTransactionsToApproveResponse	getTransactionsToApprove(IotaGetTransactionsToApproveRequest request) Tip selection which returns trunkTransaction and branchTransaction.
GetTrytesResponse	getTrytes(IotaGetTrytesRequest request) Returns the raw trytes data of a transaction.
InterruptAttachingToTangleResponse	interruptAttachingToTangle(IotaCommandRequest request) Interrupts and completely aborts the attachToTangle process.
RemoveNeighborsResponse	removeNeighbors(IotaNeighborsRequest request) Removes a list of neighbors from the node.
StoreTransactionsResponse	storeTransactions(IotaStoreTransactionsRequest request) Store transactions into the nodes local storage.
WereAddressesSpentFromResponse	wereAddressesSpentFrom(IotaWereAddressesSpentFromRequest request) Check if a list of addresses was ever spent from, in the current epoch, or in previous epochs.

Method Detail

getNodeInfo

GetNodeInfoResponse getNodeInfo(IotaCommandRequest request)
                         throws ArgumentException

Returns information about the node.

Throws:

Exception

ArgumentException

getNeighbors

GetNeighborsResponse getNeighbors(IotaCommandRequest request)
                           throws ArgumentException

Get the list of neighbors from the node.

Throws:

Exception

ArgumentException

addNeighbors

AddNeighborsResponse addNeighbors(IotaNeighborsRequest request)
                           throws ArgumentException

Add a list of neighbors to the node.

Throws:

Exception

ArgumentException

removeNeighbors

RemoveNeighborsResponse removeNeighbors(IotaNeighborsRequest request)
                                 throws ArgumentException

Removes a list of neighbors from the node.

Throws:

Exception

ArgumentException

getTips

GetTipsResponse getTips(IotaCommandRequest request)
                 throws ArgumentException

Get the list of latest tips (unconfirmed transactions).

Throws:

Exception

ArgumentException

findTransactions

FindTransactionResponse findTransactions(IotaFindTransactionsRequest request)
                                  throws ArgumentException

Find the transactions which match the specified input and return.

Throws:

Exception

ArgumentException

getTrytes

GetTrytesResponse getTrytes(IotaGetTrytesRequest request)
                     throws ArgumentException

Returns the raw trytes data of a transaction.

Throws:

Exception

ArgumentException

getInclusionStates

GetInclusionStateResponse getInclusionStates(IotaGetInclusionStateRequest request)
                                      throws ArgumentException

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.

Throws:

Exception

ArgumentException

getBalances

GetBalancesResponse getBalances(IotaGetBalancesRequest request)
                         throws ArgumentException

It returns the confirmed balance which a list of addresses have at the latest confirmed milestone.

Throws:

Exception

ArgumentException

getTransactionsToApprove

GetTransactionsToApproveResponse getTransactionsToApprove(IotaGetTransactionsToApproveRequest request)
                                                   throws ArgumentException

Tip selection which returns trunkTransaction and branchTransaction. The input value is the latest coordinator milestone, as provided through the getNodeInfo API call.

Throws:

Exception

ArgumentException

attachToTangle

GetAttachToTangleResponse attachToTangle(IotaAttachToTangleRequest request)
                                  throws ArgumentException

Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work.

Throws:

Exception

ArgumentException

interruptAttachingToTangle

InterruptAttachingToTangleResponse interruptAttachingToTangle(IotaCommandRequest request)
                                                       throws ArgumentException

Interrupts and completely aborts the attachToTangle process.

Throws:

Exception

ArgumentException

broadcastTransactions

BroadcastTransactionsResponse broadcastTransactions(IotaBroadcastTransactionRequest request)
                                             throws ArgumentException

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

Throws:

Exception

ArgumentException

storeTransactions

StoreTransactionsResponse storeTransactions(IotaStoreTransactionsRequest request)
                                     throws ArgumentException

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

Throws:

Exception

ArgumentException

wereAddressesSpentFrom

WereAddressesSpentFromResponse wereAddressesSpentFrom(IotaWereAddressesSpentFromRequest request)
                                               throws ArgumentException

Check if a list of addresses was ever spent from, in the current epoch, or in previous epochs.

Throws:

Exception

ArgumentException

checkConsistency

CheckConsistencyResponse checkConsistency(IotaCheckConsistencyRequest request)
                                   throws ArgumentException

Checks the consistency of the subtangle described by the provided tails.

Throws:

Exception

ArgumentException

customRequest

IotaCustomResponse customRequest(IotaCustomRequest findTransRequest)

Custom API call used to call IXI modules.