Web3j Transaction Managers
A Transaction Manager in Web3j is an abstraction that controls how transactions are signed and broadcast to the Ethereum network, via a connected client. You can pass an implementation to a smart contract wrapper when deploying or loading a contract, or you can use it to directly send transactions in a more manual way.
There are multiple different Transaction Manager implementations included, all extending the
TransactionManager abstract class. Each extending class must implement the abstract
public abstract EthSendTransaction sendTransaction( BigInteger gasPrice, BigInteger gasLimit, String to, String data, BigInteger value) throws IOException;
In this article we describe and compare the Transaction Managers provided by Web3j.
The client transaction manager does not perform any transaction signing, and instead, delegates to the connected Ethereum client to sign, using one of its managed accounts. Because of this, the client must unlock the sender account which means that the client has access to the private key of the account.
The non-signed transaction data is passed to the Ethereum client via the
eth_sendTransaction JSON RPC endpoint of the connected client. For more information on this endpoint, read the geth JSON RPC documentation.
Like signing, calculating the transaction nonce is delegated to the connected node.
For most production use cases it is not recommended to use the
ClientTransactionManager. This is because the sender account needs to be unlocked, which adds a significant attack vector into your architecture. If the client is not configured correctly, or the server security is generally lacking, then an attacker could potentially steal the funds from the unlocked account.
To reduce risk, you should only use the
ClientTransactionManager for testing purposes, or for unlocked accounts with a small Ether balance.
RawTransactionManager takes a
Credentials file as a constructor argument, and uses the private key of these credentials to sign the transaction on the Java side, before forwarding to the connected Ethereum client. This means that account management is not handled on the client side at all, and the account does not need to be unlocked.
The encoded and signed raw transaction is broadcast to the Ethereum network via the
eth_sendRawTransaction JSON RPC endpoint.
Before generating and signing the raw transaction, retrieve the nonce for the sender account by calling eth_getTransactionCount on the Ethereum client. As you can probably see, this retrieves the total number of transactions sent from the account, including pending transactions that have not yet been included in a block. As the nonce is zero indexed, this count should equal the nonce for the next transaction to be sent.
RawTransactionManager is signing server-side before forwarding to the client, it is not a requirement for an Ethereum client account to be unlocked. This means that you can use third party nodes, such as Infura, rather than hosting your own. However, because of the way the nonce is calculated, this transaction manager is not suitable for applications with high transaction throughput from a single account. More on this below.
As you've probably gathered from the name, the
RawTransactionManager and builds and signs transaction exactly the same way, with the nonce value being the only exception.
eth_sendRawTransaction, just like in the
Nonce management is where the
FastRawTransactionManager differs from the vanilla
RawTransactionManager. Rather than calling
eth_getTransactionCount every time a transaction is sent, the manager maintains an in memory transaction count and increments it every time the manager sends a transaction. The count management is synchronized and is therefore thread-safe.
As the name implies, this
TransactionManager is useful in applications that intend to send transactions quickly from a single account, potentially on multiple threads. With a standard
RawTransactionManager, in high throughput situations there is a chance of a race condition where
RawTransactionManager sends multiple transactions with the same nonce value, causing all but one of the transactions to fail. This is not the case with the
FastRawTransactionManager because of the thread-safe in memory transaction count.
This is a stub
TransactionManager, which throws an
sentTransaction is called.
You can use this in situations where you would like to use an abstraction that takes a
TransactionManager as an argument, such as calling the
load(..) method of a contract wrapper, but the smart contract only makes call (read-only) operations, so you do not have to worry about credentials / private keys.
There are a number of
TransactionManager implementations bundled with Web3j, each with different characteristics. The right choice for you depends on the manner of transactions (or lack of) that you will send from the application that you are building. And if there isn't an implementation that fits your use case, you can always extend the existing ones with your desired functionality!
- Kauri original title: Web3j Transaction Managers
- Kauri original link: https://kauri.io/web3j-transaction-managers/4cb780bb4d0846438d11885a25b6d7e7/a
- Kauri original author: Craig Williams (@craig)
- Kauri original Publication date: 2019-09-09
- Kauri original tags: ethereum, java, web3j, transaction
- Kauri original hash: QmSzg1kCYrTe1kSXGxHiq863R1Kn17KDhGDZndQKPU5bSx
- Kauri original checkpoint: QmRS3wCLX2MRi62bg9NTM89qNkgm3XjpKXciLvCKAr1f1g