hera.api

Interface AccountOperation

All Known Implementing Classes:

AccountTemplate

@ApiAudience.Public
 @ApiStability.Unstable
public interface AccountOperation

Provide account related operations. It provides followings:

• lookup account state
• naming related operations
• staking related operations
• voting related operations

Method Summary

Modifier and Type	Method and Description
TxHash	createName(Account account, java.lang.String name, long nonce) Deprecated.
TxHash	createName(Signer signer, java.lang.String name, long nonce) Create name info of an account.
AccountAddress	getNameOwner(java.lang.String name) Get owner of an account name.
AccountAddress	getNameOwner(java.lang.String name, long blockNumber) Get owner of an account name at block blockNumber.
StakeInfo	getStakingInfo(AccountAddress accountAddress) Get staking information of accountAddress.
AccountState	getState(Account account) Deprecated.
AccountState	getState(AccountAddress address) Get account state by address.
AccountTotalVote	getVotesOf(AccountAddress accountAddress) Get votes which accountAddress votes for.
java.util.List<ElectedCandidate>	listElected(java.lang.String voteId, int showCount) Get elected candidates per voteId for current round.
Transaction	sign(Account account, RawTransaction rawTransaction) Deprecated.
TxHash	stake(Account account, Aer amount, long nonce) Deprecated.
TxHash	stake(Signer signer, Aer amount, long nonce) Staking an account with amount.
TxHash	unstake(Account account, Aer amount, long nonce) Deprecated.
TxHash	unstake(Signer signer, Aer amount, long nonce) Unstaking an account with amount.
TxHash	updateName(Account owner, java.lang.String name, AccountAddress newOwner, long nonce) Deprecated.
TxHash	updateName(Signer signer, java.lang.String name, AccountAddress newOwner, long nonce) Update name info of an account.
boolean	verify(Account account, Transaction transaction) Deprecated.
TxHash	vote(Signer signer, java.lang.String voteId, java.util.List<java.lang.String> candidates, long nonce) Vote to candidates with corresponding voteId.

Method Detail

getState

@Deprecated
AccountState getState(Account account)

Deprecated.

Use getState(AccountAddress) instead.

Parameters:

account - an account

Returns:

an account state

getState

AccountState getState(AccountAddress address)

Get account state by address.

Parameters:

address - an account address

Returns:

an account state

createName

@Deprecated
TxHash createName(Account account,
                              java.lang.String name,
                              long nonce)

Deprecated.

Use createName(Signer, String, long) instead.

Parameters:

account - an account

name - an new name

nonce - an nonce which is used in a transaction

Returns:

a create name transaction hash

createName

TxHash createName(Signer signer,
                  java.lang.String name,
                  long nonce)

Create name info of an account. Created name will be owned by signer.

Parameters:

signer - a signer

name - an new name

nonce - an nonce which is used in a transaction

Returns:

a create name transaction hash

updateName

@Deprecated
TxHash updateName(Account owner,
                              java.lang.String name,
                              AccountAddress newOwner,
                              long nonce)

Deprecated.

Use updateName(Signer, String, AccountAddress, long) instead.

Parameters:

owner - an account

name - an already binded name

newOwner - an new owner of name

nonce - an nonce which is used in a transaction

Returns:

a update name transaction hash

updateName

TxHash updateName(Signer signer,
                  java.lang.String name,
                  AccountAddress newOwner,
                  long nonce)

Update name info of an account. An signer must be owner of name.

Parameters:

signer - a signer

name - an already binded name

newOwner - an new owner of name

nonce - an nonce which is used in a transaction

Returns:

a update name transaction hash

getNameOwner

AccountAddress getNameOwner(java.lang.String name)

Get owner of an account name.

Parameters:

name - an name of account

Returns:

an account address binded with name. null if it has no owner

getNameOwner

AccountAddress getNameOwner(java.lang.String name,
                            long blockNumber)

Get owner of an account name at block blockNumber.

Parameters:

name - an name of account

blockNumber - a block number

Returns:

an account address binded with name. null if it has no owner

stake

@Deprecated
TxHash stake(Account account,
                         Aer amount,
                         long nonce)

Deprecated.

Use stake(Signer, Aer, long) instead.

Parameters:

account - an account

amount - an amount to stake

nonce - an nonce which is used in a transaction

Returns:

a staking transaction hash

stake

TxHash stake(Signer signer,
             Aer amount,
             long nonce)

Staking an account with amount. An amount will be staked by signer.

Parameters:

signer - a signer

amount - an amount to stake

nonce - an nonce which is used in a transaction

Returns:

a staking transaction hash

unstake

@Deprecated
TxHash unstake(Account account,
                           Aer amount,
                           long nonce)

Deprecated.

Use unstake(Signer, Aer, long) instead.

Parameters:

account - an account

amount - an amount to stake

nonce - an nonce which is used in a transaction

Returns:

a staking transaction hash

unstake

TxHash unstake(Signer signer,
               Aer amount,
               long nonce)

Unstaking an account with amount.

Parameters:

signer - a signer

amount - an amount to stake

nonce - an nonce which is used in a transaction

Returns:

a staking transaction hash

getStakingInfo

StakeInfo getStakingInfo(AccountAddress accountAddress)

Get staking information of accountAddress.

Parameters:

accountAddress - an account address to check staking information

Returns:

a staking information

vote

TxHash vote(Signer signer,
            java.lang.String voteId,
            java.util.List<java.lang.String> candidates,
            long nonce)

Vote to candidates with corresponding voteId. Pre-defined vote id is followings:

• "voteBP"

A signer must have staked aergo.

Parameters:

signer - a signer

voteId - a vote id

candidates - a candidates

nonce - an nonce which is used in a transaction

Returns:

voting transaction hash

getVotesOf

AccountTotalVote getVotesOf(AccountAddress accountAddress)

Get votes which accountAddress votes for.

Parameters:

accountAddress - an account address

Returns:

voting info

listElected

java.util.List<ElectedCandidate> listElected(java.lang.String voteId,
                                             int showCount)

Get elected candidates per voteId for current round.

Parameters:

voteId - a vote id

showCount - a show count

Returns:

a vote total

sign

@Deprecated
Transaction sign(Account account,
                             RawTransaction rawTransaction)

Deprecated.

Use Signer.sign(RawTransaction) instead.

Parameters:

account - an account to sign

rawTransaction - a raw transaction to sign

Returns:

signed transaction

verify

@Deprecated
boolean verify(Account account,
                           Transaction transaction)

Deprecated.

Use AergoSignVerifier.verify(Transaction) instead.

Parameters:

account - an account to verify

transaction - a signed transaction to verify

Returns:

verification result