com.beowulfchain.beowulfj.plugins.apis.condenser

Class CondenserApi

java.lang.Object

com.beowulfchain.beowulfj.plugins.apis.condenser.CondenserApi

public class CondenserApi
extends Object

This class implements the "condenser_api".

Method Summary

Modifier and Type	Method and Description
static void	broadcastBlock(CommunicationHandler communicationHandler, SignedBlock signedBlock) Broadcast a whole block.
static TransactionId	broadcastTransaction(CommunicationHandler communicationHandler, SignedTransaction transaction) Broadcast a transaction on the Beowulf blockchain.
static BroadcastTransactionSynchronousReturn	broadcastTransactionSynchronous(CommunicationHandler communicationHandler, SignedTransaction transaction) Broadcast a transaction on the Beowulf blockchain.
static List<FindSmtTokenByName>	findSmtTokenByName(CommunicationHandler communicationHandler, List<String> names) (find_smt_tokens_by_name)
static org.joou.ULong	getAccountCount(CommunicationHandler communicationHandler) (get_account_count
static List<AccountHistoryReturn>	getAccountHistory(CommunicationHandler communicationHandler, String account, long start, long limit) Deprecated.
static List<Account>	getAccounts(CommunicationHandler communicationHandler, List<AccountName> accounts) (get_accounts)
static List<AccountName>	getActiveSuperNodes(CommunicationHandler communicationHandler) (get_active_supernodes)
static Asset	getBalance(CommunicationHandler communicationHandler, String accountName, AssetInfo assetInfo) Broadcast a whole block.
static Block	getBlock(CommunicationHandler communicationHandler, long blockNum) (get_block)
static BlockHeader	getBlockHeader(CommunicationHandler communicationHandler, long blockNum) (get_block_header)
static Config	getConfig(CommunicationHandler communicationHandler) (get_config)
static ExtendedDynamicGlobalProperties	getDynamicGlobalProperties(CommunicationHandler communicationHandler) Like DatabaseApi.getDynamicGlobalProperties(CommunicationHandler), but returns an ExtendedDynamicGlobalProperties object providing additional information.
static List<ExtendedAccount>	getExtAccounts(CommunicationHandler communicationHandler, List<AccountName> accounts)
static String	getHardforkVersion(CommunicationHandler communicationHandler) Get the hardfork version the node you are connected to is using.
static List<String>	getKeyReferences(CommunicationHandler communicationHandler, List<PublicKey> publicKeys) (get_key_references)
static ScheduledHardfork	getNextScheduleHardfork(CommunicationHandler communicationHandler) (get_next_scheduled_hardfork)
static Supernode	getSupernodeByAccount(CommunicationHandler communicationHandler, AccountName supernodeAccount) (get_supernode_by_account)
static int	getSupernodeCount(CommunicationHandler communicationHandler) (get_supernode_count)
static List<Supernode>	getSupernodesByVote(CommunicationHandler communicationHandler, AccountName supernodeAccount, int limit, int vestingShare) (get_supernodes_by_vote)
static SupernodeSchedule	getSupernodeSchedule(CommunicationHandler communicationHandler) (get_supernode_schedule)
static CompletedTransaction	getTransactionDetail(CommunicationHandler communicationHandler, String trx_id) (get_transaction)
static String	getTransactionHex(CommunicationHandler communicationHandler, SignedTransaction transaction) (get_transaction_hex)
static List<String>	lookupAccounts(CommunicationHandler communicationHandler, String pattern, int limit) (lookupSupernodeAccounts)
static List<String>	lookupSupernodeAccounts(CommunicationHandler communicationHandler, String pattern, int limit) (lookupSupernodeAccounts)
static Boolean	verifyAccountAuthority(CommunicationHandler communicationHandler, AccountName accountName, List<PublicKey> publicKeys)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDynamicGlobalProperties

public static ExtendedDynamicGlobalProperties getDynamicGlobalProperties(CommunicationHandler communicationHandler)
                                                                  throws BeowulfCommunicationException,
                                                                         BeowulfResponseException

Like DatabaseApi.getDynamicGlobalProperties(CommunicationHandler), but returns an ExtendedDynamicGlobalProperties object providing additional information.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

ExtendedDynamicGlobalProperties

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getExtAccounts

public static List<ExtendedAccount> getExtAccounts(CommunicationHandler communicationHandler,
                                                   List<AccountName> accounts)
                                            throws BeowulfCommunicationException,
                                                   BeowulfResponseException

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

accounts - List accounts name.

Returns:

List ExtendedAccount

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getHardforkVersion

public static String getHardforkVersion(CommunicationHandler communicationHandler)
                                 throws BeowulfCommunicationException,
                                        BeowulfResponseException

Get the hardfork version the node you are connected to is using.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

The hardfork version that the connected node is running on.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getBlockHeader

public static BlockHeader getBlockHeader(CommunicationHandler communicationHandler,
                                         long blockNum)
                                  throws BeowulfCommunicationException,
                                         BeowulfResponseException

(get_block_header)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

blockNum - The block number.

Returns:

BlockHeader

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getBlock

public static Block getBlock(CommunicationHandler communicationHandler,
                             long blockNum)
                      throws BeowulfCommunicationException,
                             BeowulfResponseException

(get_block)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

blockNum - The block number.

Returns:

Block

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getActiveSuperNodes

public static List<AccountName> getActiveSuperNodes(CommunicationHandler communicationHandler)
                                             throws BeowulfCommunicationException,
                                                    BeowulfResponseException

(get_active_supernodes)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

List AccountName The block number.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getConfig

public static Config getConfig(CommunicationHandler communicationHandler)
                        throws BeowulfCommunicationException,
                               BeowulfResponseException

(get_config)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

Config

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getAccounts

public static List<Account> getAccounts(CommunicationHandler communicationHandler,
                                        List<AccountName> accounts)
                                 throws BeowulfCommunicationException,
                                        BeowulfResponseException

(get_accounts)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

accounts - List account name.

Returns:

List Account

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getAccountHistory

@Deprecated
public static List<AccountHistoryReturn> getAccountHistory(CommunicationHandler communicationHandler,
                                                                       String account,
                                                                       long start,
                                                                       long limit)
                                                                throws BeowulfCommunicationException,
                                                                       BeowulfResponseException

Deprecated.

Get all operations performed by the specified accountName.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

account - get account history param include [name, start, limit]

start - start position

limit - limitation fo history

Returns:

A map containing the activities. The key is the id of the activity.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getTransactionHex

public static String getTransactionHex(CommunicationHandler communicationHandler,
                                       SignedTransaction transaction)
                                throws BeowulfCommunicationException,
                                       BeowulfResponseException

(get_transaction_hex)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

transaction - get serialized of Signed Transaction.

Returns:

String

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

findSmtTokenByName

public static List<FindSmtTokenByName> findSmtTokenByName(CommunicationHandler communicationHandler,
                                                          List<String> names)
                                                   throws BeowulfCommunicationException,
                                                          BeowulfResponseException

(find_smt_tokens_by_name)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

names - List name token.

Returns:

List FindSmtTokenByName

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getNextScheduleHardfork

public static ScheduledHardfork getNextScheduleHardfork(CommunicationHandler communicationHandler)
                                                 throws BeowulfCommunicationException,
                                                        BeowulfResponseException

(get_next_scheduled_hardfork)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

ScheduledHardfork

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getKeyReferences

public static List<String> getKeyReferences(CommunicationHandler communicationHandler,
                                            List<PublicKey> publicKeys)
                                     throws BeowulfCommunicationException,
                                            BeowulfResponseException

(get_key_references)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

publicKeys - List public keys.

Returns:

List String

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getAccountCount

public static org.joou.ULong getAccountCount(CommunicationHandler communicationHandler)
                                      throws BeowulfCommunicationException,
                                             BeowulfResponseException

(get_account_count

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

ULong

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getSupernodeByAccount

public static Supernode getSupernodeByAccount(CommunicationHandler communicationHandler,
                                              AccountName supernodeAccount)
                                       throws BeowulfCommunicationException,
                                              BeowulfResponseException

(get_supernode_by_account)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

supernodeAccount - The acoount name.

Returns:

Supernode

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getSupernodesByVote

public static List<Supernode> getSupernodesByVote(CommunicationHandler communicationHandler,
                                                  AccountName supernodeAccount,
                                                  int limit,
                                                  int vestingShare)
                                           throws BeowulfCommunicationException,
                                                  BeowulfResponseException

(get_supernodes_by_vote)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

supernodeAccount - The acoount name.

limit - The number limit.

vestingShare - The number coin.

Returns:

List Supernode

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getSupernodeSchedule

public static SupernodeSchedule getSupernodeSchedule(CommunicationHandler communicationHandler)
                                              throws BeowulfCommunicationException,
                                                     BeowulfResponseException

(get_supernode_schedule)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

SupernodeSchedule

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getSupernodeCount

public static int getSupernodeCount(CommunicationHandler communicationHandler)
                             throws BeowulfCommunicationException,
                                    BeowulfResponseException

(get_supernode_count)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

int

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

lookupSupernodeAccounts

public static List<String> lookupSupernodeAccounts(CommunicationHandler communicationHandler,
                                                   String pattern,
                                                   int limit)
                                            throws BeowulfCommunicationException,
                                                   BeowulfResponseException

(lookupSupernodeAccounts)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

pattern - The pattern name to search.

limit - The number limit.

Returns:

List String

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

lookupAccounts

public static List<String> lookupAccounts(CommunicationHandler communicationHandler,
                                          String pattern,
                                          int limit)
                                   throws BeowulfCommunicationException,
                                          BeowulfResponseException

(lookupSupernodeAccounts)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

pattern - The pattern name to search.

limit - The number limit.

Returns:

List String

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getTransactionDetail

public static CompletedTransaction getTransactionDetail(CommunicationHandler communicationHandler,
                                                        String trx_id)
                                                 throws BeowulfCommunicationException,
                                                        BeowulfResponseException

(get_transaction)

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

trx_id - The transaction id.

Returns:

CompletedTransaction

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

verifyAccountAuthority

public static Boolean verifyAccountAuthority(CommunicationHandler communicationHandler,
                                             AccountName accountName,
                                             List<PublicKey> publicKeys)
                                      throws BeowulfCommunicationException,
                                             BeowulfResponseException

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

accountName - The account name.

publicKeys - List public keys.

Returns:

Boolean

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getBalance

public static Asset getBalance(CommunicationHandler communicationHandler,
                               String accountName,
                               AssetInfo assetInfo)
                        throws BeowulfCommunicationException,
                               BeowulfResponseException

Broadcast a whole block.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

accountName - account get balance

assetInfo - asset type

Returns:

Asset balance of accountName

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

broadcastBlock

public static void broadcastBlock(CommunicationHandler communicationHandler,
                                  SignedBlock signedBlock)
                           throws BeowulfCommunicationException,
                                  BeowulfResponseException

Broadcast a whole block.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

signedBlock - The SignedBlock object to broadcast.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

broadcastTransaction

public static TransactionId broadcastTransaction(CommunicationHandler communicationHandler,
                                                 SignedTransaction transaction)
                                          throws BeowulfCommunicationException,
                                                 BeowulfResponseException,
                                                 BeowulfInvalidTransactionException

Broadcast a transaction on the Beowulf blockchain. This method will validate the transaction and return immediately. Please notice that this does not mean that the operation has been accepted and has been processed. If you want to make sure that this is the case use the broadcastTransaction(CommunicationHandler, SignedTransaction) method.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

transaction - The SignedTransaction object to broadcast.

Returns:

transactionId the local generate transaction id

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

BeowulfInvalidTransactionException - In case the provided transaction is not valid.

broadcastTransactionSynchronous

public static BroadcastTransactionSynchronousReturn broadcastTransactionSynchronous(CommunicationHandler communicationHandler,
                                                                                    SignedTransaction transaction)
                                                                             throws BeowulfCommunicationException,
                                                                                    BeowulfResponseException,
                                                                                    BeowulfInvalidTransactionException

Broadcast a transaction on the Beowulf blockchain. This method will validate the transaction and return after it has been accepted and applied.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

transaction - The SignedTransaction object to broadcast.

Returns:

A BroadcastTransactionSynchronousReturn object providing information about the block in which the transaction has been applied.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

BeowulfInvalidTransactionException - In case the provided transaction is not valid.