org.iota.jota.account

Interface AccountStore

All Known Implementing Classes:

AccountFileStore, AccountStoreImpl, DatabaseStore, MongoStore

public interface AccountStore

This interface defines a persistence layer which takes care of reading and storing account data.

Method Summary

Modifier and Type	Method and Description
void	addDepositAddress(String id, int index, StoredDepositAddress address) Stores the deposit address under the given account with the used key index.
void	addPendingTransfer(String id, Hash tailTx, Trytes[] bundleTrytes, int... indices) Stores the pending transfer under the given account with the origin tail tx hash as a key and removes all deposit addresses which correspond to the used key indices for the transfer.
void	addTailHash(String id, Hash tailHash, Hash newTailTxHash) Adds the given new tail transaction hash (presumably from a reattachment) under the given pending transfer indexed by the given origin tail transaction hash.
ExportedAccountState	exportAccount(String id) Axports the given account from the store.
Map<Integer,StoredDepositAddress>	getDepositAddresses(String id) Loads the stored deposit addresses of the given account.
Map<String,PendingTransfer>	getPendingTransfers(String id) Returns all pending transfers of the given account.
void	importAccount(ExportedAccountState state) Imports the given account state into the store.
AccountState	loadAccount(String id) Loads an existing or allocates a new account state from/in the database and returns the state.
int	readIndex(String id) Reads and returns the last used key index.
void	removeAccount(String id) Removes the accoutn state linekd to this account.
void	removeDepositAddress(String id, int index) Removes the deposit address with the given key index under the given account.
void	removePendingTransfer(String id, Hash tailHash) Removes the pending transfer with the given origin tail transaction hash from the given account.
void	saveAccount(String id, AccountState state) Saves this specific account state to the store, regardless of what was stored.
void	writeIndex(String id, int index) Stores the given index as the last used key index for the given account.

Method Detail

loadAccount

AccountState loadAccount(String id)

Loads an existing or allocates a new account state from/in the database and returns the state.

Parameters:

id - The account we are loading or creating

Returns:

The loaded account state

saveAccount

void saveAccount(String id,
                 AccountState state)

Saves this specific account state to the store, regardless of what was stored.

Parameters:

id - The id of the account we are storing

state - The state we are storing for the account

removeAccount

void removeAccount(String id)

Removes the accoutn state linekd to this account.

Parameters:

id - The id of the account

readIndex

int readIndex(String id)

Reads and returns the last used key index.

Parameters:

id - The id of the account we check for

Returns:

The last used index, always at least 0

writeIndex

void writeIndex(String id,
                int index)

Stores the given index as the last used key index for the given account.

Parameters:

id - The id of the account

index - The new index of this account

addDepositAddress

void addDepositAddress(String id,
                       int index,
                       StoredDepositAddress address)

Stores the deposit address under the given account with the used key index.

Parameters:

id - The id of the account

index - The index used for this address

address - The deposit address we are adding

removeDepositAddress

void removeDepositAddress(String id,
                          int index)

Removes the deposit address with the given key index under the given account.

Parameters:

id - The id of the account

index - The index of the deposit we are removing

getDepositAddresses

Map<Integer,StoredDepositAddress> getDepositAddresses(String id)

Loads the stored deposit addresses of the given account.

Parameters:

id - The id of the account

Returns:

A map of deposit addresses with their stored index

addPendingTransfer

void addPendingTransfer(String id,
                        Hash tailTx,
                        Trytes[] bundleTrytes,
                        int... indices)

Stores the pending transfer under the given account with the origin tail tx hash as a key and removes all deposit addresses which correspond to the used key indices for the transfer.

Parameters:

id - The id of the account

tailTx - The tail tx of this transfer

bundleTrytes - The trytes/essense of this transfer

indices - indexes to remove for this transfer, currently unused since we remove when we ask for inputs

removePendingTransfer

void removePendingTransfer(String id,
                           Hash tailHash)

Removes the pending transfer with the given origin tail transaction hash from the given account.

Parameters:

id - The id of the account

tailHash - The tail tx of the transfer we are remiving

addTailHash

void addTailHash(String id,
                 Hash tailHash,
                 Hash newTailTxHash)

Adds the given new tail transaction hash (presumably from a reattachment) under the given pending transfer indexed by the given origin tail transaction hash.

Parameters:

id - The id of the account

tailHash - The tail tx of the initial transfer

newTailTxHash - The tail tx of the newly added transfer

getPendingTransfers

Map<String,PendingTransfer> getPendingTransfers(String id)

Returns all pending transfers of the given account.

Parameters:

id - The id of the account

Returns:

A map of pending transfers linked to their initial tail tx hash

importAccount

void importAccount(ExportedAccountState state)

Imports the given account state into the store. An existing account is overridden by this method.

Parameters:

state - The state of the account we are storing

exportAccount

ExportedAccountState exportAccount(String id)

Axports the given account from the store.

Parameters:

id - The id of the account we want to export

Returns:

The exported account state