com.beowulfchain.beowulfj

Class BeowulfJ

java.lang.Object

com.beowulfchain.beowulfj.BeowulfJ

public class BeowulfJ
extends Object

This class is a wrapper for the Beowulf web socket API and provides all features known from the Beowulf CLI Wallet.

Method Summary

Modifier and Type	Method and Description
static Asset	beowulfToWd(Price price, Asset beowulfAsset)
void	broadcastBlock(SignedBlock signedBlock) Broadcast a whole block.
TransactionId	broadcastTransaction(SignedTransaction transaction) Broadcast a transaction on the Beowulf blockchain.
BroadcastTransactionSynchronousReturn	broadcastTransactionSynchronous(SignedTransaction transaction) Broadcast a transaction on the Beowulf blockchain.
AccountCreateOperation	createAccount(AccountName creator, Asset fee, AccountName newAccount, Authority owner, String jsonMetadata)
List<FindSmtTokenByName>	findSmtTokenByName(List<String> names)
long	getAccountCount() Get the current number of registered Beowulf accounts.
List<AccountHistoryReturn>	getAccountHistory(AccountName accountName, org.joou.ULong start, org.joou.UInteger limit) Deprecated.
List<ExtendedAccount>	getAccounts(List<AccountName> accountNames)
List<AccountName>	getActiveSupernodes() Get the list of the current active supernodes.
Asset	getBalance(AccountName accountName, AssetInfo assetInfo)
Block	getBlock(long blockNumber) Get a full, signed block by providing its blockNumber.
BlockHeader	getBlockHeader(long blockNumber) Like getBlock(long), but will only return the header of the requested block instead of the full, signed one.
Config	getConfig()
DynamicGlobalProperty	getDynamicGlobalProperties() Get the global properties.
static BeowulfJ	getInstance()
List<String>	getKeyReferences(List<PublicKey> publicKeys) Search for users under the use of their public key(s).
static BeowulfJ	getNewInstance()
ScheduledHardfork	getNextScheduledHarfork() TODO: Check what this method is supposed to do.
static org.apache.commons.lang3.tuple.ImmutablePair<PublicKey,String>	getPrivateKeyFromPassword(AccountName account, PrivateKeyType role, String beowulfPassword) Get the private and public key of a given type for the given account
Supernode	getSupernodeByAccount(AccountName supernodeName) Get the supernode information for a given supernode account name.
int	getSupernodeCount() Get the current number of active supernodes.
List<Supernode>	getSupernodes() Get all supernodes.
List<Supernode>	getSupernodesByVote(AccountName supernodeName, int limit, int vestingShare) Get a list of supernodes sorted by the amount of votes.
SupernodeSchedule	getSupernodeSchedule() Get the supernode schedule.
CompletedTransaction	getTransactionDetail(String trx_id) Use the Beowulf API to receive the HEX representation of a signed transaction.
String	getTransactionHex(SignedTransaction signedTransaction) Use the Beowulf API to receive the HEX representation of a signed transaction.
List<String>	lookupAccounts(String pattern, int limit) Search for accounts.
List<String>	lookupSupernodeAccounts(String pattern, int limit) Search for supernode accounts.
TransactionId	signAndBroadcast(List<Operation> operations)
BroadcastTransactionSynchronousReturn	signAndBroadcastSynchronous(List<Operation> operations)
TransactionId	signAndBroadcastWithExtension(List<Operation> operations, List<FutureExtensions> extensions)
SmtCreateOperation	smtCreate(AccountName controlAccount, AccountName creator, AssetInfo assetInfo, Asset smtCreationFee, long maxSupply)
TransferOperation	transfer(AccountName from, AccountName to, Asset amount, Asset fee, String memo) Transfer currency from specified account to recipient.
boolean	verifyAuthority(SignedTransaction signedTransaction) Use the Beowulf API to verify the required authorities for this transaction.
static Asset	wdToBeowulf(Price price, Asset wdAsset)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BeowulfJ getInstance()
                            throws BeowulfCommunicationException

Throws:

BeowulfCommunicationException

getNewInstance

public static BeowulfJ getNewInstance()
                               throws BeowulfCommunicationException

Throws:

BeowulfCommunicationException

beowulfToWd

public static Asset beowulfToWd(Price price,
                                Asset beowulfAsset)

wdToBeowulf

public static Asset wdToBeowulf(Price price,
                                Asset wdAsset)

getPrivateKeyFromPassword

public static org.apache.commons.lang3.tuple.ImmutablePair<PublicKey,String> getPrivateKeyFromPassword(AccountName account,
                                                                                                       PrivateKeyType role,
                                                                                                       String beowulfPassword)

Get the private and public key of a given type for the given account

Parameters:

account - The account name to generate the passwords for.

role - The key type that should be generated.

beowulfPassword - The password of the account valid for the Beowulf blockchain.

Returns:

The requested key pair.

getKeyReferences

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

Search for users under the use of their public key(s).

Parameters:

publicKeys - An array containing one or more public keys.

Returns:

A list of arrays containing the matching account names.

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 List<AccountHistoryReturn> getAccountHistory(AccountName accountName,
                                                                org.joou.ULong start,
                                                                org.joou.UInteger limit)
                                                         throws BeowulfCommunicationException,
                                                                BeowulfResponseException

Deprecated.

Get all operations performed by the specified account.

Parameters:

accountName - The user name of the account.

start - The starting point.

limit - The maximum number of entries.

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.

getBlock

public Block getBlock(long blockNumber)
               throws BeowulfCommunicationException,
                      BeowulfResponseException

Get a full, signed block by providing its blockNumber. The returned object contains all information related to the block (e.g. processed transactions, the supernode and the creation time).

Parameters:

blockNumber - Height of the block to be returned.

Returns:

The referenced full, signed block, or null if no matching block was found.

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 BlockHeader getBlockHeader(long blockNumber)
                           throws BeowulfCommunicationException,
                                  BeowulfResponseException

Like getBlock(long), but will only return the header of the requested block instead of the full, signed one.

Parameters:

blockNumber - Height of the block to be returned.

Returns:

The referenced full, signed block, or null if no matching block was found.

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 TransactionId broadcastTransaction(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 broadcastTransactionSynchronous(SignedTransaction) method.

Parameters:

transaction - The SignedTransaction object to broadcast.

Returns:

TransactionId

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 BroadcastTransactionSynchronousReturn broadcastTransactionSynchronous(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:

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.

broadcastBlock

public void broadcastBlock(SignedBlock signedBlock)
                    throws BeowulfCommunicationException,
                           BeowulfResponseException

Broadcast a whole block.

Parameters:

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.

getActiveSupernodes

public List<AccountName> getActiveSupernodes()
                                      throws BeowulfCommunicationException,
                                             BeowulfResponseException

Get the list of the current active supernodes.

Returns:

The list of the current active supernodes.

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.

getDynamicGlobalProperties

public DynamicGlobalProperty getDynamicGlobalProperties()
                                                 throws BeowulfCommunicationException,
                                                        BeowulfResponseException

Get the global properties.

Returns:

The dynamic global properties.

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 Config getConfig()
                 throws BeowulfCommunicationException,
                        BeowulfResponseException

Throws:

BeowulfCommunicationException

BeowulfResponseException

getAccountCount

public long getAccountCount()
                     throws BeowulfCommunicationException,
                            BeowulfResponseException

Get the current number of registered Beowulf accounts.

Returns:

The number of accounts.

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 List<ExtendedAccount> getAccounts(List<AccountName> accountNames)
                                  throws BeowulfCommunicationException,
                                         BeowulfResponseException

Parameters:

accountNames - A list of accounts you want to request the details for.

Returns:

A List of accounts found for the given account names.

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 Asset getBalance(AccountName accountName,
                        AssetInfo assetInfo)
                 throws BeowulfCommunicationException,
                        BeowulfResponseException

Throws:

BeowulfCommunicationException

BeowulfResponseException

getNextScheduledHarfork

public ScheduledHardfork getNextScheduledHarfork()
                                          throws BeowulfCommunicationException,
                                                 BeowulfResponseException

TODO: Check what this method is supposed to do. In a fist test it seems to return the time since the current version is active.

Returns:

???

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 String getTransactionHex(SignedTransaction signedTransaction)
                         throws BeowulfCommunicationException,
                                BeowulfResponseException,
                                BeowulfInvalidTransactionException

Use the Beowulf API to receive the HEX representation of a signed transaction.

Parameters:

signedTransaction - The signed Transaction object you want to receive the HEX representation for.

Returns:

The HEX representation.

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 - The beowulf invalid transaction exception.

getTransactionDetail

public CompletedTransaction getTransactionDetail(String trx_id)
                                          throws BeowulfCommunicationException,
                                                 BeowulfResponseException

Use the Beowulf API to receive the HEX representation of a signed transaction.

Parameters:

trx_id - transaction id for getting data

Returns:

completed transaction detail

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 Supernode getSupernodeByAccount(AccountName supernodeName)
                                throws BeowulfCommunicationException,
                                       BeowulfResponseException

Get the supernode information for a given supernode account name.

Parameters:

supernodeName - The supernode name.

Returns:

A list of supernodes.

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 List<Supernode> getSupernodesByVote(AccountName supernodeName,
                                           int limit,
                                           int vestingShare)
                                    throws BeowulfCommunicationException,
                                           BeowulfResponseException

Get a list of supernodes sorted by the amount of votes. The list begins with the given account name and contains the next supernodes with less votes than given one.

Parameters:

supernodeName - The supernode name to start from.

limit - The number of results.

vestingShare - The number coin.

Returns:

A list of supernodes.

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 int getSupernodeCount()
                      throws BeowulfCommunicationException,
                             BeowulfResponseException

Get the current number of active supernodes.

Returns:

The number of supernodes.

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.

getSupernodes

public List<Supernode> getSupernodes()
                              throws BeowulfCommunicationException,
                                     BeowulfResponseException

Get all supernodes.

Returns:

A list of supernodes.

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 SupernodeSchedule getSupernodeSchedule()
                                       throws BeowulfCommunicationException,
                                              BeowulfResponseException

Get the supernode schedule.

Returns:

The supernode schedule.

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 List<String> lookupAccounts(String pattern,
                                   int limit)
                            throws BeowulfCommunicationException,
                                   BeowulfResponseException

Search for accounts.

Parameters:

pattern - The lower case pattern you want to search for.

limit - The maximum number of account names.

Returns:

A list of matching account names.

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 List<String> lookupSupernodeAccounts(String pattern,
                                            int limit)
                                     throws BeowulfCommunicationException,
                                            BeowulfResponseException

Search for supernode accounts.

Parameters:

pattern - The lower case pattern you want to search for.

limit - The maximum number of account names.

Returns:

A list of matching account names.

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.

verifyAuthority

public boolean verifyAuthority(SignedTransaction signedTransaction)
                        throws BeowulfCommunicationException,
                               BeowulfResponseException

Use the Beowulf API to verify the required authorities for this transaction.

Parameters:

signedTransaction - A SignedTransaction transaction which has been signed.

Returns:

true if the given transaction has been signed correctly, otherwise an Exception will be thrown.

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.

transfer

public TransferOperation transfer(AccountName from,
                                  AccountName to,
                                  Asset amount,
                                  Asset fee,
                                  String memo)

Transfer currency from specified account to recipient. Amount is automatically converted from normalized representation to base representation. For example, to transfer 1.00 W to another account, simply use: BeowulfJ.transfer(new AccountName("accounta"), new AccountName("accountb"), AssetSymbolType.W, 1.0, "My memo"); Attention This method will write data on the blockchain. As all writing operations, a private key is required to sign the transaction. For a transfer operation the private active key of the DefaultAccount needs to be configured in the PrivateKeyStorage.

Parameters:

from - The account from which to transfer currency.

to - The account to which to transfer currency.

amount - An Asset object containing the Asset type (see AssetSymbolType and the amount to transfer.

fee - The fee of transaction.

memo - Message include with transfer (255 char max)

Returns:

The TransferOperation broadcast.

findSmtTokenByName

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

Throws:

BeowulfCommunicationException

BeowulfResponseException

smtCreate

public SmtCreateOperation smtCreate(AccountName controlAccount,
                                    AccountName creator,
                                    AssetInfo assetInfo,
                                    Asset smtCreationFee,
                                    long maxSupply)

createAccount

public AccountCreateOperation createAccount(AccountName creator,
                                            Asset fee,
                                            AccountName newAccount,
                                            Authority owner,
                                            String jsonMetadata)

signAndBroadcastSynchronous

public BroadcastTransactionSynchronousReturn signAndBroadcastSynchronous(List<Operation> operations)
                                                                  throws BeowulfCommunicationException,
                                                                         BeowulfResponseException,
                                                                         BeowulfInvalidTransactionException

Throws:

BeowulfCommunicationException

BeowulfResponseException

BeowulfInvalidTransactionException

signAndBroadcast

public TransactionId signAndBroadcast(List<Operation> operations)
                               throws BeowulfCommunicationException,
                                      BeowulfResponseException,
                                      BeowulfInvalidTransactionException

Throws:

BeowulfCommunicationException

BeowulfResponseException

BeowulfInvalidTransactionException

signAndBroadcastWithExtension

public TransactionId signAndBroadcastWithExtension(List<Operation> operations,
                                                   List<FutureExtensions> extensions)
                                            throws BeowulfCommunicationException,
                                                   BeowulfResponseException,
                                                   BeowulfInvalidTransactionException,
                                                   com.fasterxml.jackson.core.JsonProcessingException

Throws:

BeowulfCommunicationException

BeowulfResponseException

BeowulfInvalidTransactionException

com.fasterxml.jackson.core.JsonProcessingException