Package org.web3j.tx

Class Contract

java.lang.Object

org.web3j.tx.ManagedTransaction

org.web3j.tx.Contract

Direct Known Subclasses:

ENS, ENSRegistryWithFallbackContract, PublicResolver

public abstract class Contract
extends ManagedTransaction

Solidity contract type abstraction for interacting with smart contracts via native Java types.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Contract.EventValuesWithLog	Adds a log field to EventValues.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BIN_NOT_PROVIDED
protected String	contractAddress
protected final String	contractBinary
protected DefaultBlockParameter	defaultBlockParameter
protected Map<String,String>	deployedAddresses
static final String	FUNC_DEPLOY
static final BigInteger	GAS_LIMIT	Deprecated. ...
protected ContractGasProvider	gasProvider
protected TransactionReceipt	transactionReceipt

Fields inherited from class org.web3j.tx.ManagedTransaction

ensResolver, GAS_PRICE, transactionManager, web3j

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Contract(String contractBinary, String contractAddress, Web3j web3j, org.web3j.crypto.Credentials credentials, BigInteger gasPrice, BigInteger gasLimit)	Deprecated.
protected	Contract(String contractBinary, String contractAddress, Web3j web3j, org.web3j.crypto.Credentials credentials, ContractGasProvider gasProvider)
protected	Contract(String contractBinary, String contractAddress, Web3j web3j, TransactionManager transactionManager, BigInteger gasPrice, BigInteger gasLimit)	Deprecated.
protected	Contract(String contractBinary, String contractAddress, Web3j web3j, TransactionManager transactionManager, ContractGasProvider gasProvider)
protected	Contract(String contractAddress, Web3j web3j, org.web3j.crypto.Credentials credentials, BigInteger gasPrice, BigInteger gasLimit)	Deprecated.
protected	Contract(String contractAddress, Web3j web3j, TransactionManager transactionManager, BigInteger gasPrice, BigInteger gasLimit)	Deprecated.
protected	Contract(EnsResolver ensResolver, String contractBinary, String contractAddress, Web3j web3j, TransactionManager transactionManager, ContractGasProvider gasProvider)

Method Summary

Modifier and Type	Method	Description
protected static <S extends org.web3j.abi.datatypes.Type, T> List<T>	convertToNative(List<S> arr)
protected static <T extends Contract> T	deploy(Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, BigInteger gasPrice, BigInteger gasLimit, String binary, String encodedConstructor, BigInteger value)	Deprecated.
protected static <T extends Contract> T	deploy(Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, ContractGasProvider contractGasProvider, String binary, String encodedConstructor, BigInteger value)
protected static <T extends Contract> T	deploy(Class<T> type, Web3j web3j, TransactionManager transactionManager, BigInteger gasPrice, BigInteger gasLimit, String binary, String encodedConstructor, BigInteger value)	Deprecated.
protected static <T extends Contract> T	deploy(Class<T> type, Web3j web3j, TransactionManager transactionManager, ContractGasProvider contractGasProvider, String binary, String encodedConstructor, BigInteger value)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, BigInteger gasPrice, BigInteger gasLimit, String binary, String encodedConstructor)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, BigInteger gasPrice, BigInteger gasLimit, String binary, String encodedConstructor, BigInteger value)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, ContractGasProvider contractGasProvider, String binary, String encodedConstructor)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, ContractGasProvider contractGasProvider, String binary, String encodedConstructor, BigInteger value)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, TransactionManager transactionManager, BigInteger gasPrice, BigInteger gasLimit, String binary, String encodedConstructor)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, TransactionManager transactionManager, BigInteger gasPrice, BigInteger gasLimit, String binary, String encodedConstructor, BigInteger value)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, TransactionManager transactionManager, ContractGasProvider contractGasProvider, String binary, String encodedConstructor)
static <T extends Contract> RemoteCall<T>	deployRemoteCall(Class<T> type, Web3j web3j, TransactionManager transactionManager, ContractGasProvider contractGasProvider, String binary, String encodedConstructor, BigInteger value)
protected List<org.web3j.abi.datatypes.Type>	executeCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T extends org.web3j.abi.datatypes.Type> T	executeCallSingleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T extends org.web3j.abi.datatypes.Type, R> R	executeCallSingleValueReturn(org.web3j.abi.datatypes.Function function, Class<R> returnType)
protected String	executeCallWithoutDecoding(org.web3j.abi.datatypes.Function function)
protected RemoteFunctionCall<List<org.web3j.abi.datatypes.Type>>	executeRemoteCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T extends org.web3j.abi.datatypes.Type> RemoteFunctionCall<T>	executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T> RemoteFunctionCall<T>	executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function, Class<T> returnType)
protected RemoteFunctionCall<TransactionReceipt>	executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function)
protected RemoteFunctionCall<TransactionReceipt>	executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function, BigInteger weiValue)
protected TransactionReceipt	executeTransaction(org.web3j.abi.datatypes.Function function)
protected org.web3j.abi.EventValues	extractEventParameters(org.web3j.abi.datatypes.Event event, Log log)
protected List<org.web3j.abi.EventValues>	extractEventParameters(org.web3j.abi.datatypes.Event event, TransactionReceipt transactionReceipt)
protected Contract.EventValuesWithLog	extractEventParametersWithLog(org.web3j.abi.datatypes.Event event, Log log)
protected List<Contract.EventValuesWithLog>	extractEventParametersWithLog(org.web3j.abi.datatypes.Event event, TransactionReceipt transactionReceipt)
String	getContractAddress()
String	getContractBinary()
final String	getDeployedAddress(String networkId)
BigInteger	getGasPrice()	Deprecated. use ContractGasProvider
protected String	getStaticDeployedAddress(String networkId)	Subclasses should implement this method to return pre-existing addresses for deployed contracts.
Optional<TransactionReceipt>	getTransactionReceipt()	If this Contract instance was created at deployment, the TransactionReceipt associated with the initial creation will be provided, e.g.
boolean	isValid()	Check that the contract deployed at the address associated with this smart contract wrapper is in fact the contract you believe it is.
protected String	resolveContractAddress(String contractAddress)
void	setContractAddress(String contractAddress)
void	setDefaultBlockParameter(DefaultBlockParameter defaultBlockParameter)	Sets the default block parameter.
final void	setDeployedAddress(String networkId, String address)
void	setGasPrice(BigInteger newPrice)	Deprecated. use ContractGasProvider
void	setGasProvider(ContractGasProvider gasProvider)
void	setTransactionReceipt(TransactionReceipt transactionReceipt)
static org.web3j.abi.EventValues	staticExtractEventParameters(org.web3j.abi.datatypes.Event event, Log log)
protected static Contract.EventValuesWithLog	staticExtractEventParametersWithLog(org.web3j.abi.datatypes.Event event, Log log)
protected static List<Contract.EventValuesWithLog>	staticExtractEventParametersWithLog(org.web3j.abi.datatypes.Event event, TransactionReceipt transactionReceipt)

Methods inherited from class org.web3j.tx.ManagedTransaction

call, getSyncThreshold, requestCurrentGasPrice, send, send, sendEIP1559, sendEIP1559, setSyncThreshold

Methods inherited from class java.lang.Object

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

Field Details

GAS_LIMIT

public static final BigInteger GAS_LIMIT

Deprecated.

...

See Also:

• DefaultGasProvider

BIN_NOT_PROVIDED

public static final String BIN_NOT_PROVIDED

See Also:

• Constant Field Values

FUNC_DEPLOY

public static final String FUNC_DEPLOY

See Also:

• Constant Field Values

contractBinary

protected final String contractBinary

contractAddress

protected String contractAddress

gasProvider

protected ContractGasProvider gasProvider

transactionReceipt

protected TransactionReceipt transactionReceipt

deployedAddresses

protected Map<String,String> deployedAddresses

defaultBlockParameter

protected DefaultBlockParameter defaultBlockParameter

Constructor Details

Contract

protected Contract(String contractBinary,
 String contractAddress,
 Web3j web3j,
 TransactionManager transactionManager,
 ContractGasProvider gasProvider)

Contract

protected Contract(EnsResolver ensResolver,
 String contractBinary,
 String contractAddress,
 Web3j web3j,
 TransactionManager transactionManager,
 ContractGasProvider gasProvider)

Contract

protected Contract(String contractBinary,
 String contractAddress,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 ContractGasProvider gasProvider)

Contract

@Deprecated
protected Contract(String contractBinary,
 String contractAddress,
 Web3j web3j,
 TransactionManager transactionManager,
 BigInteger gasPrice,
 BigInteger gasLimit)

Deprecated.

Contract

@Deprecated
protected Contract(String contractBinary,
 String contractAddress,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 BigInteger gasPrice,
 BigInteger gasLimit)

Deprecated.

Contract

@Deprecated
protected Contract(String contractAddress,
 Web3j web3j,
 TransactionManager transactionManager,
 BigInteger gasPrice,
 BigInteger gasLimit)

Deprecated.

Contract

@Deprecated
protected Contract(String contractAddress,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 BigInteger gasPrice,
 BigInteger gasLimit)

Deprecated.

Method Details

setContractAddress

public void setContractAddress(String contractAddress)

getContractAddress

public String getContractAddress()

setTransactionReceipt

public void setTransactionReceipt(TransactionReceipt transactionReceipt)

getContractBinary

public String getContractBinary()

setGasProvider

public void setGasProvider(ContractGasProvider gasProvider)

setGasPrice

public void setGasPrice(BigInteger newPrice)

Deprecated.

use ContractGasProvider

Allow gasPrice to be set.

Parameters:

newPrice - gas price to use for subsequent transactions

getGasPrice

public BigInteger getGasPrice()

Deprecated.

use ContractGasProvider

Get the current gasPrice value this contract uses when executing transactions.

Returns:

the gas price set on this contract

isValid

public boolean isValid()
                throws IOException

Check that the contract deployed at the address associated with this smart contract wrapper is in fact the contract you believe it is.

This method uses the eth_getCode method to get the contract byte code and validates it against the byte code stored in this smart contract wrapper.

Returns:

true if the contract is valid

Throws:

IOException - if unable to connect to web3j node

getTransactionReceipt

public Optional<TransactionReceipt> getTransactionReceipt()

If this Contract instance was created at deployment, the TransactionReceipt associated with the initial creation will be provided, e.g. via a deploy method. This will not persist for Contracts instances constructed via a load method.

Returns:

the TransactionReceipt generated at contract deployment

setDefaultBlockParameter

public void setDefaultBlockParameter(DefaultBlockParameter defaultBlockParameter)

Sets the default block parameter. This use useful if one wants to query historical state of a contract.

Parameters:

defaultBlockParameter - the default block parameter

executeCallWithoutDecoding

protected String executeCallWithoutDecoding(org.web3j.abi.datatypes.Function function)
                                     throws IOException

Throws:

IOException

executeCallSingleValueReturn

protected <T extends org.web3j.abi.datatypes.Type>
T executeCallSingleValueReturn(org.web3j.abi.datatypes.Function function)
                        throws IOException

Throws:

IOException

executeCallSingleValueReturn

protected <T extends org.web3j.abi.datatypes.Type,
R>
R executeCallSingleValueReturn(org.web3j.abi.datatypes.Function function,
 Class<R> returnType)
                        throws IOException

Throws:

IOException

executeCallMultipleValueReturn

protected List<org.web3j.abi.datatypes.Type> executeCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)
                                                                     throws IOException

Throws:

IOException

executeTransaction

protected TransactionReceipt executeTransaction(org.web3j.abi.datatypes.Function function)
                                         throws IOException,
TransactionException

Throws:

IOException

TransactionException

executeRemoteCallSingleValueReturn

protected <T extends org.web3j.abi.datatypes.Type>
RemoteFunctionCall<T> executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function)

executeRemoteCallSingleValueReturn

protected <T> RemoteFunctionCall<T> executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function,
 Class<T> returnType)

executeRemoteCallMultipleValueReturn

protected RemoteFunctionCall<List<org.web3j.abi.datatypes.Type>> executeRemoteCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)

executeRemoteCallTransaction

protected RemoteFunctionCall<TransactionReceipt> executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function)

executeRemoteCallTransaction

protected RemoteFunctionCall<TransactionReceipt> executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function,
 BigInteger weiValue)

deploy

protected static <T extends Contract> T deploy(Class<T> type,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 ContractGasProvider contractGasProvider,
 String binary,
 String encodedConstructor,
 BigInteger value)
                                        throws RuntimeException,
TransactionException

Throws:

RuntimeException

TransactionException

deploy

protected static <T extends Contract> T deploy(Class<T> type,
 Web3j web3j,
 TransactionManager transactionManager,
 ContractGasProvider contractGasProvider,
 String binary,
 String encodedConstructor,
 BigInteger value)
                                        throws RuntimeException,
TransactionException

Throws:

RuntimeException

TransactionException

deploy

@Deprecated
protected static <T extends Contract> T deploy(Class<T> type,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 BigInteger gasPrice,
 BigInteger gasLimit,
 String binary,
 String encodedConstructor,
 BigInteger value)
                                        throws RuntimeException,
TransactionException

Deprecated.

Throws:

RuntimeException

TransactionException

deploy

@Deprecated
protected static <T extends Contract> T deploy(Class<T> type,
 Web3j web3j,
 TransactionManager transactionManager,
 BigInteger gasPrice,
 BigInteger gasLimit,
 String binary,
 String encodedConstructor,
 BigInteger value)
                                        throws RuntimeException,
TransactionException

Deprecated.

Throws:

RuntimeException

TransactionException

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 BigInteger gasPrice,
 BigInteger gasLimit,
 String binary,
 String encodedConstructor,
 BigInteger value)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 BigInteger gasPrice,
 BigInteger gasLimit,
 String binary,
 String encodedConstructor)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 ContractGasProvider contractGasProvider,
 String binary,
 String encodedConstructor,
 BigInteger value)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 org.web3j.crypto.Credentials credentials,
 ContractGasProvider contractGasProvider,
 String binary,
 String encodedConstructor)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 TransactionManager transactionManager,
 BigInteger gasPrice,
 BigInteger gasLimit,
 String binary,
 String encodedConstructor,
 BigInteger value)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 TransactionManager transactionManager,
 BigInteger gasPrice,
 BigInteger gasLimit,
 String binary,
 String encodedConstructor)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 TransactionManager transactionManager,
 ContractGasProvider contractGasProvider,
 String binary,
 String encodedConstructor,
 BigInteger value)

deployRemoteCall

public static <T extends Contract> RemoteCall<T> deployRemoteCall(Class<T> type,
 Web3j web3j,
 TransactionManager transactionManager,
 ContractGasProvider contractGasProvider,
 String binary,
 String encodedConstructor)

staticExtractEventParameters

public static org.web3j.abi.EventValues staticExtractEventParameters(org.web3j.abi.datatypes.Event event,
 Log log)

resolveContractAddress

protected String resolveContractAddress(String contractAddress)

extractEventParameters

protected org.web3j.abi.EventValues extractEventParameters(org.web3j.abi.datatypes.Event event,
 Log log)

extractEventParameters

protected List<org.web3j.abi.EventValues> extractEventParameters(org.web3j.abi.datatypes.Event event,
 TransactionReceipt transactionReceipt)

extractEventParametersWithLog

protected Contract.EventValuesWithLog extractEventParametersWithLog(org.web3j.abi.datatypes.Event event,
 Log log)

staticExtractEventParametersWithLog

protected static Contract.EventValuesWithLog staticExtractEventParametersWithLog(org.web3j.abi.datatypes.Event event,
 Log log)

extractEventParametersWithLog

protected List<Contract.EventValuesWithLog> extractEventParametersWithLog(org.web3j.abi.datatypes.Event event,
 TransactionReceipt transactionReceipt)

staticExtractEventParametersWithLog

protected static List<Contract.EventValuesWithLog> staticExtractEventParametersWithLog(org.web3j.abi.datatypes.Event event,
 TransactionReceipt transactionReceipt)

getStaticDeployedAddress

protected String getStaticDeployedAddress(String networkId)

Subclasses should implement this method to return pre-existing addresses for deployed contracts.

Parameters:

networkId - the network id, for example "1" for the main-net, "3" for ropsten, etc.

Returns:

the deployed address of the contract, if known, and null otherwise.

setDeployedAddress

public final void setDeployedAddress(String networkId,
 String address)

getDeployedAddress

public final String getDeployedAddress(String networkId)

convertToNative

protected static <S extends org.web3j.abi.datatypes.Type,
T>
List<T> convertToNative(List<S> arr)