org.iota.jota.account

Interface Account

All Superinterfaces:

TaskService

All Known Implementing Classes:

IotaAccount

public interface Account
extends TaskService

Method Summary

Modifier and Type	Method and Description
long	availableBalance() Runs the input selection with the CDAs in order to determine the usable balance for funding transfers.
String	getId() Returns the account’s unique identifier which is a sha256 hash of the account’s seed.
boolean	isNew() Checks whether the state of the account is new.
void	load() Loads the account’s inner event loop to accept commands and provided plugins using current the account settings
Future<ConditionalDepositAddress>	newDepositAddress(Date timeOut, boolean multiUse, long expectedAmount, ExpireCondition... otherConditions) Allocates a new CDA in the underlying store.
Future<Bundle>	send(Recipient recipient) Sends the specified amounts to the given recipient.
void	shutdown() Shutdowns the account’s inner event loop and shutdowns all plugins.
boolean	start() Starts the account event loop
long	totalBalance() Uses all stored CDAs to determine the current total balance.
void	updateSettings(AccountOptions newSettings) Updates the settings of the account in a synchronized manner by shutting down all plugins, stopping the event loop, applying the settings and starting the newly defined plugins and kicking off the event loop again.

Method Detail

getId

String getId()
      throws AccountError

Returns the account’s unique identifier which is a sha256 hash of the account’s seed.

Returns:

the account ID

Throws:

AccountError - When we failed to generate the ID

load

void load()
   throws AccountError

Loads the account’s inner event loop to accept commands and provided plugins using current the account settings

Specified by:

load in interface TaskService

Throws:

AccountError - When loading the account failed

start

boolean start()
       throws AccountError

Starts the account event loop

Specified by:

start in interface TaskService

Returns:

true if loaded successful. otherwise false

Throws:

AccountError - When an error occurred during start-up

shutdown

void shutdown()
       throws AccountError

Shutdowns the account’s inner event loop and shutdowns all plugins. Will gracefully shut down all plugins

Specified by:

shutdown in interface TaskService

Throws:

AccountError

send

Future<Bundle> send(Recipient recipient)
             throws AccountError

Sends the specified amounts to the given recipient.

Parameters:

recipient - Information about the receiving end of the transactions

Returns:

The bundle we sent

Throws:

AccountError

newDepositAddress

Future<ConditionalDepositAddress> newDepositAddress(Date timeOut,
                                                    boolean multiUse,
                                                    long expectedAmount,
                                                    ExpireCondition... otherConditions)
                                             throws AccountError

Allocates a new CDA in the underlying store. Note: Specifying both multi-use and an expected amount is not allowed

Parameters:

timeOut - The date this address expires

multiUse - If we expect multiple deposits

expectedAmount - The final balance we expect to have in this address before we expire

otherConditions - Currently unused, used to specify custom conditions

Returns:

ConditionalDepositAddress The newly generated CDA

Throws:

AccountError - When we were not able to generate a new address

AccountError - When invalid conditions were given

availableBalance

long availableBalance()
               throws AccountError

Runs the input selection with the CDAs in order to determine the usable balance for funding transfers.

Returns:

The amount of balance for this account which you can immediately use

Throws:

AccountError - When we failed to get the balance

totalBalance

long totalBalance()
           throws AccountError

Uses all stored CDAs to determine the current total balance.

Returns:

The total balance of this account

Throws:

AccountError - When we failed to get the balance

isNew

boolean isNew()

Checks whether the state of the account is new. An account is considered new if no pending transfers or CDAs are stored.

Returns:

true if it is new, otherwise false

updateSettings

void updateSettings(AccountOptions newSettings)
             throws AccountError

Updates the settings of the account in a synchronized manner by shutting down all plugins, stopping the event loop, applying the settings and starting the newly defined plugins and kicking off the event loop again.

Parameters:

newSettings - The new settings for this account

Throws:

AccountError - When we failed to update the settings