be.e_contract.ethereum.ra.api

Interface EthereumConnection

All Superinterfaces:

AutoCloseable, javax.resource.cci.Connection

public interface EthereumConnection
extends javax.resource.cci.Connection, AutoCloseable

Interface for Ethereum network connections.

Author:

Frank Cornelis

Method Summary

Modifier and Type	Method and Description
org.web3j.protocol.core.methods.response.TransactionReceipt	deploy(Class<? extends org.web3j.tx.Contract> contractClass, org.web3j.tx.gas.ContractGasProvider contractGasProvider, org.web3j.crypto.Credentials credentials, Long chainId) Deploys a given contract.
org.web3j.protocol.core.methods.response.Transaction	findTransaction(String transactionHash) Gives back the transaction for a given transaction hash.
List<String>	getAccounts() Gives back a list of all accounts managed by the client node.
BigInteger	getBalance(String address) Gives back the balance for the address.
org.web3j.protocol.core.methods.response.EthBlock.Block	getBlock(org.web3j.protocol.core.DefaultBlockParameter defaultBlockParameter, boolean fullTransactions) Gives back a block for the given block number.
org.web3j.protocol.core.methods.response.EthBlock.Block	getBlock(String blockHash, boolean fullTransactions) Gives back a block for the given block hash.
BigInteger	getBlockNumber() Gives back the latest block number.
Long	getChainId() Retrieve the chain identifier of the Ethereum network.
String	getClientVersion() Gives back the web3 client version.
BigInteger	getGasPrice() Gives back the node gas price.
BigInteger	getMaxPriorityFeePerGas() Gives back the node estimate for maximum priority fee per gas.
String	getNetVersion() Gives back the net version.
BigInteger	getPeerCount() Gives back the peer count of the Ethereum client node.
TransactionConfirmation	getTransactionConfirmation(String transactionHash) Gives back the status of a transaction.
BigInteger	getTransactionCount(String address) Gives back the transaction nonce for the given address.
org.web3j.protocol.core.methods.response.EthGetTransactionReceipt	getTransactionReceipt(String transactionHash) Gives back the web3 transaction receipt.
boolean	isSyncing() Returns true if the Ethereum client node is synchronizing.
<T extends org.web3j.tx.Contract> T	load(Class<T> contractClass, String contractAddress, org.web3j.crypto.Credentials credentials, Long chainId, org.web3j.tx.gas.ContractGasProvider contractGasProvider) Loads a contract.
String	sendAccountTransaction(String account, String to, BigInteger value, BigInteger gasPrice, BigInteger nonce) Send transaction via client node account.
String	sendRawTransaction(String rawTransaction) Sends a raw transaction.
String	sendTransaction(org.web3j.crypto.Credentials credentials, String to, BigInteger value, BigInteger maxFeePerGas, BigInteger maxPriorityFeePerGas, Long chainId) Sends an Ethereum EIP-1559 transaction.
String	sendTransaction(org.web3j.crypto.Credentials credentials, String to, BigInteger value, BigInteger gasPrice, Long chainId) Sends an Ethereum transaction.

Methods inherited from interface javax.resource.cci.Connection

close, createInteraction, getLocalTransaction, getMetaData, getResultSetInfo

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getGasPrice

BigInteger getGasPrice()
                throws javax.resource.ResourceException

Gives back the node gas price.

Returns:

the gas price in wei.

Throws:

javax.resource.ResourceException

getMaxPriorityFeePerGas

BigInteger getMaxPriorityFeePerGas()
                            throws javax.resource.ResourceException

Gives back the node estimate for maximum priority fee per gas.

Returns:

the maximum priority fee per gas in wei.

Throws:

javax.resource.ResourceException

getBlockNumber

BigInteger getBlockNumber()
                   throws javax.resource.ResourceException

Gives back the latest block number.

Returns:

the block number.

Throws:

javax.resource.ResourceException

sendRawTransaction

String sendRawTransaction(String rawTransaction)
                   throws javax.resource.ResourceException,
                          EthereumException

Sends a raw transaction. Supports JCA transactions.

Parameters:

rawTransaction -

Returns:

the transaction hash.

Throws:

javax.resource.ResourceException

EthereumException

getTransactionConfirmation

TransactionConfirmation getTransactionConfirmation(String transactionHash)
                                            throws javax.resource.ResourceException

Gives back the status of a transaction.

Parameters:

transactionHash -

Returns:

the transaction confirmation.

Throws:

javax.resource.ResourceException

findTransaction

org.web3j.protocol.core.methods.response.Transaction findTransaction(String transactionHash)
                                                              throws javax.resource.ResourceException

Gives back the transaction for a given transaction hash. Can return null.

Parameters:

transactionHash -

Returns:

the transaction, if available. Otherwise, null.

Throws:

javax.resource.ResourceException

getBlock

org.web3j.protocol.core.methods.response.EthBlock.Block getBlock(String blockHash,
                                                                 boolean fullTransactions)
                                                          throws javax.resource.ResourceException

Gives back a block for the given block hash.

Parameters:

blockHash -

fullTransactions -

Returns:

the Ethereum block.

Throws:

javax.resource.ResourceException

getBlock

org.web3j.protocol.core.methods.response.EthBlock.Block getBlock(org.web3j.protocol.core.DefaultBlockParameter defaultBlockParameter,
                                                                 boolean fullTransactions)
                                                          throws javax.resource.ResourceException

Gives back a block for the given block number.

Parameters:

defaultBlockParameter -

fullTransactions -

Returns:

the Ethereum block.

Throws:

javax.resource.ResourceException

getBalance

BigInteger getBalance(String address)
               throws javax.resource.ResourceException

Gives back the balance for the address.

Parameters:

address -

Returns:

the balance in wei.

Throws:

javax.resource.ResourceException

getTransactionCount

BigInteger getTransactionCount(String address)
                        throws javax.resource.ResourceException

Gives back the transaction nonce for the given address.

Parameters:

address -

Returns:

the transaction count, which equals nonce in case there are no pending transactions.

Throws:

javax.resource.ResourceException

getAccounts

List<String> getAccounts()
                  throws javax.resource.ResourceException

Gives back a list of all accounts managed by the client node.

Returns:

the list of account addresses.

Throws:

javax.resource.ResourceException

sendAccountTransaction

String sendAccountTransaction(String account,
                              String to,
                              BigInteger value,
                              BigInteger gasPrice,
                              BigInteger nonce)
                       throws javax.resource.ResourceException,
                              EthereumException

Send transaction via client node account. This type of Ethereum transaction is not part of the JTA transaction.

Parameters:

account -

to -

value -

gasPrice -

nonce -

Returns:

the transaction hash.

Throws:

javax.resource.ResourceException

EthereumException

deploy

org.web3j.protocol.core.methods.response.TransactionReceipt deploy(Class<? extends org.web3j.tx.Contract> contractClass,
                                                                   org.web3j.tx.gas.ContractGasProvider contractGasProvider,
                                                                   org.web3j.crypto.Credentials credentials,
                                                                   Long chainId)
                                                            throws javax.resource.ResourceException,
                                                                   EthereumException

Deploys a given contract. Contract should have been compiled via web3j. Contract deployment is part of the JTA transaction.

Parameters:

contractClass -

contractGasProvider -

credentials -

chainId -

Returns:

the contract transaction receipt, containing the transaction hash and the contract address.

Throws:

javax.resource.ResourceException

EthereumException

load

<T extends org.web3j.tx.Contract> T load(Class<T> contractClass,
                                         String contractAddress,
                                         org.web3j.crypto.Credentials credentials,
                                         Long chainId,
                                         org.web3j.tx.gas.ContractGasProvider contractGasProvider)
                                  throws javax.resource.ResourceException

Loads a contract. Ethereum contract transactions are part of the JTA transaction. The nonce is managed internally, so fast transactions are possible.

Type Parameters:

T -

Parameters:

contractClass -

contractAddress -

credentials -

chainId -

contractGasProvider -

Returns:

a contract instance.

Throws:

javax.resource.ResourceException

getChainId

Long getChainId()
         throws javax.resource.ResourceException,
                EthereumException

Retrieve the chain identifier of the Ethereum network.

Returns:

the chain identifier, or null if EIP-155 is not active on the network.

Throws:

javax.resource.ResourceException

EthereumException

sendTransaction

String sendTransaction(org.web3j.crypto.Credentials credentials,
                       String to,
                       BigInteger value,
                       BigInteger gasPrice,
                       Long chainId)
                throws javax.resource.ResourceException,
                       EthereumException

Sends an Ethereum transaction. Supports JTA transactions. The nonce is managed internally, so fast transactions are possible.

Parameters:

credentials -

to -

value -

gasPrice -

chainId -

Returns:

the transaction hash.

Throws:

javax.resource.ResourceException

EthereumException

sendTransaction

String sendTransaction(org.web3j.crypto.Credentials credentials,
                       String to,
                       BigInteger value,
                       BigInteger maxFeePerGas,
                       BigInteger maxPriorityFeePerGas,
                       Long chainId)
                throws javax.resource.ResourceException,
                       EthereumException

Sends an Ethereum EIP-1559 transaction. Supports JTA transactions. The nonce is managed internally, so fast transactions are possible.

Parameters:

credentials -

to -

value -

maxFeePerGas -

maxPriorityFeePerGas -

chainId -

Returns:

the transaction hash.

Throws:

javax.resource.ResourceException

EthereumException

getNetVersion

String getNetVersion()
              throws javax.resource.ResourceException

Gives back the net version.

Returns:

the net version.

Throws:

javax.resource.ResourceException

getPeerCount

BigInteger getPeerCount()
                 throws javax.resource.ResourceException

Gives back the peer count of the Ethereum client node.

Returns:

the peer count.

Throws:

javax.resource.ResourceException

isSyncing

boolean isSyncing()
           throws javax.resource.ResourceException

Returns true if the Ethereum client node is synchronizing.

Returns:

true if the client node is still syncing.

Throws:

javax.resource.ResourceException

getClientVersion

String getClientVersion()
                 throws javax.resource.ResourceException

Gives back the web3 client version.

Returns:

the web3 client version.

Throws:

javax.resource.ResourceException

getTransactionReceipt

org.web3j.protocol.core.methods.response.EthGetTransactionReceipt getTransactionReceipt(String transactionHash)
                                                                                 throws javax.resource.ResourceException

Gives back the web3 transaction receipt.

Parameters:

transactionHash -

Returns:

Throws:

javax.resource.ResourceException