hera.wallet

Interface WalletApi

All Superinterfaces:

Signer, TxSigner, WithPrincipal

All Known Implementing Classes:

WalletApiImpl

@ApiAudience.Public
 @ApiStability.Unstable
public interface WalletApi
extends Signer

A wallet api holding single identity. It interact with KeyStore. Has a signing role.

Method Summary

Modifier and Type	Method and Description
void	bind(AergoClient aergoClient) Bind an aergo client to use.
AccountAddress	getPrincipal() Get an principal of current wallet.
boolean	lock(Authentication authentication) Lock an account.
QueryApi	queryApi() Get query api.
TransactionApi	transactionApi() Get transaction api.
boolean	unlock(Authentication authentication) Unlock an account and bind it to wallet api.

Methods inherited from interface hera.key.Signer

sign

Method Detail

getPrincipal

AccountAddress getPrincipal()

Get an principal of current wallet. null if not binded.

Specified by:

getPrincipal in interface WithPrincipal

Returns:

an principal of current wallet. null if not binded

bind

void bind(AergoClient aergoClient)

Bind an aergo client to use.

Parameters:

aergoClient - an aergo client

unlock

boolean unlock(Authentication authentication)

Unlock an account and bind it to wallet api.

Parameters:

authentication - an authentication to unlock account

Returns:

an unlock result

Throws:

WalletException - on wallet error

lock

boolean lock(Authentication authentication)

Lock an account.

Parameters:

authentication - an authentication to lock account binded to wallet api

Returns:

a lock result

Throws:

WalletException - on wallet error

transactionApi

TransactionApi transactionApi()

Get transaction api.

Returns:

a transaction api

Throws:

WalletException - on wallet error

queryApi

QueryApi queryApi()

Get query api.

Returns:

a query api

Throws:

WalletException - on wallet error