one.block.eosiojava.session

Class TransactionProcessor

java.lang.Object

one.block.eosiojava.session.TransactionProcessor

public class TransactionProcessor
extends java.lang.Object

Wrapper class for an EOS Transaction. This class allows the developer to use the Transaction object in several ways.

The TransactionProcessor allows the developer to:

- Get input Action

- Create transaction

- Serialize Transaction

- Sign Transaction

- Broadcast Transaction

Constructor Summary

Constructors

Constructor and Description
TransactionProcessor(@NotNull ISerializationProvider serializationProvider, @NotNull IRPCProvider rpcProvider, @NotNull IABIProvider abiProvider, @NotNull ISignatureProvider signatureProvider) Constructor with all provider references from TransactionSession
TransactionProcessor(@NotNull ISerializationProvider serializationProvider, @NotNull IRPCProvider rpcProvider, @NotNull IABIProvider abiProvider, @NotNull ISignatureProvider signatureProvider, @NotNull Transaction transaction) Constructor with all provider references from TransactionSession and preset Transaction

Method Summary

Modifier and Type	Method and Description
@NotNull PushTransactionResponse	broadcast() Broadcast transaction to blockchain.
@Nullable Transaction	getOriginalTransaction() Gets Transaction instance that holds the original transaction reference after signature provider returns the signing result.
@Nullable java.lang.String	getSerializedTransaction() Gets serialized version of Transaction.
@NotNull java.util.List<java.lang.String>	getSignatures() List of signatures that will be available after they are returned from the signature provider.
@Nullable Transaction	getTransaction() Gets transaction instance which holds all data relating to EOS Transaction
@NotNull TransactionConfig	getTransactionConfig() Gets configuration for Transaction which offers ability to set:
boolean	isTransactionModificationAllowed() Should the signature provider be able to modify the transaction?
void	prepare(@NotNull java.util.List<Action> actions) Prepare action's data from input and create new instance of Transaction if it is not set.
void	prepare(@NotNull java.util.List<Action> actions, @NotNull java.util.List<Action> contextFreeActions) Prepare action's data from input and create new instance of Transaction if it is not set.
@Nullable java.lang.String	serialize() Getting serialized version of Transaction
void	setAvailableKeys(@NotNull java.util.List<java.lang.String> availableKeys) Set value for available keys list.
void	setChainId(@Nullable java.lang.String chainId) Sets chain id value.
void	setIsTransactionModificationAllowed(boolean isTransactionModificationAllowed) True: The transaction could be modified and updated to current transaction by Signature provider.
void	setRequiredKeys(@NotNull java.util.List<java.lang.String> requiredKeys) Set value for required keys list
void	setTransactionConfig(@NotNull TransactionConfig transactionConfig) Sets configuration for Transaction which offers ability to set:
boolean	sign() Sign the transaction by passing EosioTransactionSignatureRequest to signature provider
@NotNull PushTransactionResponse	signAndBroadcast() Sign and broadcast the transaction and signature/s to chain
@Nullable java.lang.String	toJSON() Return transaction in JSON string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionProcessor

public TransactionProcessor(@NotNull
                            @NotNull ISerializationProvider serializationProvider,
                            @NotNull
                            @NotNull IRPCProvider rpcProvider,
                            @NotNull
                            @NotNull IABIProvider abiProvider,
                            @NotNull
                            @NotNull ISignatureProvider signatureProvider)

Constructor with all provider references from TransactionSession

Parameters:

serializationProvider - the serialization provider.

rpcProvider - the rpc provider.

abiProvider - the abi provider.

signatureProvider - the signature provider.

TransactionProcessor

public TransactionProcessor(@NotNull
                            @NotNull ISerializationProvider serializationProvider,
                            @NotNull
                            @NotNull IRPCProvider rpcProvider,
                            @NotNull
                            @NotNull IABIProvider abiProvider,
                            @NotNull
                            @NotNull ISignatureProvider signatureProvider,
                            @NotNull
                            @NotNull Transaction transaction)
                     throws TransactionProcessorConstructorInputError

Constructor with all provider references from TransactionSession and preset Transaction

Parameters:

serializationProvider - the serialization provider.

rpcProvider - the rpc provider.

abiProvider - the abi provider.

signatureProvider - the signature provider.

transaction - - preset Transaction

Throws:

TransactionProcessorConstructorInputError - thrown if the input transaction has an empty action list.

Method Detail

prepare

public void prepare(@NotNull
                    @NotNull java.util.List<Action> actions,
                    @NotNull
                    @NotNull java.util.List<Action> contextFreeActions)
             throws TransactionPrepareError

Prepare action's data from input and create new instance of Transaction if it is not set.

Check prepare() flow in "Complete Workflow" doc for more detail

Parameters:

actions - - List of actions with data. If the transaction is preset or has a value and it has its own actions, that list will be over-ridden by this input list.

contextFreeActions - - List of context free actions with data.

Throws:

TransactionPrepareError - thrown if:
- chainId from IRPCProvider.getInfo() is blank
- chainId returned from the chain does not match with input chainId
- There is a problem with parsing head block time from GetInfoResponse.getHeadBlockTime()
It throws a base error class if:
TransactionPrepareInputError thrown if inputs are invalid
TransactionPrepareRpcError thrown if any RPC call (IRPCProvider.getInfo() and IRPCProvider.getBlock(GetBlockRequest)) return or throw an error

prepare

public void prepare(@NotNull
                    @NotNull java.util.List<Action> actions)
             throws TransactionPrepareError

Prepare action's data from input and create new instance of Transaction if it is not set.

Use this method if you don't want to provide context free actions.

Check prepare() flow in "Complete Workflow" doc for more detail.

Parameters:

actions - - List of actions with data. If the transaction is preset or has a value and it has its own actions, that list will be over-ridden by this input list.

Throws:

TransactionPrepareError - thrown if:
- chainId from IRPCProvider.getInfo() is blank
- chainId returned from the chain does not match with input chainId
- There is a problem with parsing head block time from GetInfoResponse.getHeadBlockTime()
It throws a base error class if:
TransactionPrepareInputError thrown if input is invalid
TransactionPrepareRpcError thrown if any RPC call (IRPCProvider.getInfo() and IRPCProvider.getBlock(GetBlockRequest)) return or throw an error

sign

public boolean sign()
             throws TransactionSignError

Sign the transaction by passing EosioTransactionSignatureRequest to signature provider

Check sign() flow in "Complete Workflow" document for more detail

Returns:

success or not

Throws:

TransactionSignError - thrown if there are any exceptions during the following:
- Creating signature. Cause: TransactionCreateSignatureRequestError
- Signing. Cause: TransactionGetSignatureError or SignatureProviderError

broadcast

@NotNull
public @NotNull PushTransactionResponse broadcast()
                                                    throws TransactionBroadCastError

Broadcast transaction to blockchain.

Check broadcast() flow in "Complete Workflow" document for more detail.

Returns:

broadcast result from chain

Throws:

TransactionBroadCastError - thrown under the following conditions:
- The transaction has not been prepared or serialized yet.
- The transaction has not been signed yet (no signature).
- An error has been returned from the blockchain. Cause: TransactionPushTransactionError

signAndBroadcast

@NotNull
public @NotNull PushTransactionResponse signAndBroadcast()
                                                           throws TransactionSignAndBroadCastError

Sign and broadcast the transaction and signature/s to chain

Returns:

PushTransactionResponse from blockchain.

Throws:

TransactionSignAndBroadCastError - thrown under the following conditions:
- Exception while creating signature. Cause: TransactionCreateSignatureRequestError
- Exception while signing. Cause: TransactionGetSignatureError or SignatureProviderError
- The transaction has not been prepared or serialized yet.
- The transaction has not been signed yet (no signature).
- An error has been returned from the blockchain. Cause: TransactionPushTransactionError

toJSON

@Nullable
public @Nullable java.lang.String toJSON()

Return transaction in JSON string format.

Returns:

JSON String of transaction

serialize

@Nullable
public @Nullable java.lang.String serialize()
                                               throws TransactionSerializeError

Getting serialized version of Transaction

Check serialize() flow in "Complete Workflow" document for more detail.

Returns:

serialized Transaction

Throws:

TransactionSerializeError - thrown if there are any exceptions while serializing transaction. Cause: TransactionCreateSignatureRequestError
- Exception while trying to clone transaction for runtime handling. Method used Utils.clone(Serializable)
Thrown as parent error class for:
- TransactionCreateSignatureRequestRpcError, which is thrown if any Rpc call (IRPCProvider.getInfo()) causes an exception
- TransactionCreateSignatureRequestAbiError thrown if any error occurs while calling IABIProvider.getAbi(String, EOSIOName) to get the ABI needed to serialize each action
- TransactionCreateSignatureRequestSerializationError, which is thrown if any error happens while calling ISerializationProvider.serialize(AbiEosSerializationObject) to serialize each action or calling ISerializationProvider.serializeTransaction(String) to serialize the whole transaction.

getTransaction

@Nullable
public @Nullable Transaction getTransaction()

Gets transaction instance which holds all data relating to EOS Transaction

This object holds the non-serialized version of Transaction

Returns:

the current transaction

getOriginalTransaction

@Nullable
public @Nullable Transaction getOriginalTransaction()

Gets Transaction instance that holds the original transaction reference after signature provider returns the signing result. Check getSignature() flow in "Complete Workflow" document for more details.

Returns:

the original transaction

getSignatures

@NotNull
public @NotNull java.util.List<java.lang.String> getSignatures()

List of signatures that will be available after they are returned from the signature provider.

Check getSignature() flow in "Complete Workflow" document for more details.

Returns:

list of EOS format signature.

getSerializedTransaction

@Nullable
public @Nullable java.lang.String getSerializedTransaction()

Gets serialized version of Transaction. This is stored to later determine whether the signature provider modified the transaction.

If the transaction has been modified, this object needs to be cleared or updated.

Check getSignature() flow in "Complete Workflow" document for more details.

Returns:

the serialized transaction.

getTransactionConfig

@NotNull
public @NotNull TransactionConfig getTransactionConfig()

Gets configuration for Transaction which offers ability to set:

- The expiration period for the transaction in seconds

- How many blocks behind

Returns:

the configuration for transaction

setTransactionConfig

public void setTransactionConfig(@NotNull
                                 @NotNull TransactionConfig transactionConfig)

Sets configuration for Transaction which offers ability to set:

- The expiration period for the transaction in seconds

- How many blocks behind

Parameters:

transactionConfig - the input configuration for transaction

setChainId

public void setChainId(@Nullable
                       @Nullable java.lang.String chainId)

Sets chain id value. If the value has not been set yet, the getInfo() RPC call will be used to get it.

Parameters:

chainId - - input chain id

setAvailableKeys

public void setAvailableKeys(@NotNull
                             @NotNull java.util.List<java.lang.String> availableKeys)

Set value for available keys list.

List of available keys which most likely come from signature provider.

If this list is set, TransactionProcessor won't ask for available keys from the signature provider and will use this list.

Check createSignatureRequest() flow in "Complete Workflow" document for more details.

Parameters:

availableKeys - the input available keys

setRequiredKeys

public void setRequiredKeys(@NotNull
                            @NotNull java.util.List<java.lang.String> requiredKeys)

Set value for required keys list

List of required keys to sign the transaction.

If this list is set, TransactionProcessor won't make RPC call for getRequiredKeys().

Check createSignatureRequest() flow in "Complete Workflow" document for more details.

Parameters:

requiredKeys - the input required keys

isTransactionModificationAllowed

public boolean isTransactionModificationAllowed()

Should the signature provider be able to modify the transaction?

Returns:

Whether to allow transaction to be modified by Signature Provider.

setIsTransactionModificationAllowed

public void setIsTransactionModificationAllowed(boolean isTransactionModificationAllowed)

True: The transaction could be modified and updated to current transaction by Signature provider.

False: No modification. TransactionGetSignatureNotAllowModifyTransactionError will be thrown if transaction is modified.

Parameters:

isTransactionModificationAllowed - Whether allow transaction to be modified by Signature Provider.