org.web3j.tx

Class Contract

java.lang.Object

org.web3j.tx.ManagedTransaction

org.web3j.tx.Contract

Direct Known Subclasses:

ENS, PublicResolver

public abstract class Contract
extends ManagedTransaction

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	contractAddress
protected java.lang.String	contractBinary
protected java.util.Map<java.lang.String,java.lang.String>	deployedAddresses
static java.math.BigInteger	GAS_LIMIT
protected java.math.BigInteger	gasLimit
protected java.math.BigInteger	gasPrice
protected TransactionReceipt	transactionReceipt

Fields inherited from class org.web3j.tx.ManagedTransaction

ensResolver, GAS_PRICE, transactionManager, web3j

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Contract(java.lang.String contractBinary, java.lang.String contractAddress, Web3j web3j, org.web3j.crypto.Credentials credentials, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit)
protected	Contract(java.lang.String contractBinary, java.lang.String contractAddress, Web3j web3j, TransactionManager transactionManager, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit)
protected	Contract(java.lang.String contractAddress, Web3j web3j, org.web3j.crypto.Credentials credentials, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit) Deprecated.
protected	Contract(java.lang.String contractAddress, Web3j web3j, TransactionManager transactionManager, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected static <T extends Contract> T	deploy(java.lang.Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor, java.math.BigInteger value)
protected static <T extends Contract> T	deploy(java.lang.Class<T> type, Web3j web3j, TransactionManager transactionManager, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor, java.math.BigInteger value)
protected static <T extends Contract> RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor)
protected static <T extends Contract> RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Web3j web3j, org.web3j.crypto.Credentials credentials, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor, java.math.BigInteger value)
protected static <T extends Contract> RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Web3j web3j, TransactionManager transactionManager, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor)
protected static <T extends Contract> RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Web3j web3j, TransactionManager transactionManager, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor, java.math.BigInteger value)
protected java.util.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, java.lang.Class<R> returnType)
protected RemoteCall<java.util.List<org.web3j.abi.datatypes.Type>>	executeRemoteCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T extends org.web3j.abi.datatypes.Type> RemoteCall<T>	executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T> RemoteCall<T>	executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function, java.lang.Class<T> returnType)
protected RemoteCall<TransactionReceipt>	executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function)
protected RemoteCall<TransactionReceipt>	executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function, java.math.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 java.util.List<org.web3j.abi.EventValues>	extractEventParameters(org.web3j.abi.datatypes.Event event, TransactionReceipt transactionReceipt)
java.lang.String	getContractAddress()
java.lang.String	getContractBinary()
java.lang.String	getDeployedAddress(java.lang.String networkId)
protected java.lang.String	getStaticDeployedAddress(java.lang.String networkId) Subclasses should implement this method to return pre-existing addresses for deployed contracts.
java.util.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.
void	setContractAddress(java.lang.String contractAddress)
void	setDeployedAddress(java.lang.String networkId, java.lang.String address)
void	setTransactionReceipt(TransactionReceipt transactionReceipt)
static org.web3j.abi.EventValues	staticExtractEventParameters(org.web3j.abi.datatypes.Event event, Log log)

Methods inherited from class org.web3j.tx.ManagedTransaction

getGasPrice, getSyncThreshold, send, setSyncThreshold

Methods inherited from class java.lang.Object

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

Field Detail

GAS_LIMIT

public static final java.math.BigInteger GAS_LIMIT

contractBinary

protected final java.lang.String contractBinary

contractAddress

protected java.lang.String contractAddress

gasPrice

protected java.math.BigInteger gasPrice

gasLimit

protected java.math.BigInteger gasLimit

transactionReceipt

protected TransactionReceipt transactionReceipt

deployedAddresses

protected java.util.Map<java.lang.String,java.lang.String> deployedAddresses

Constructor Detail

Contract

protected Contract(java.lang.String contractBinary,
                   java.lang.String contractAddress,
                   Web3j web3j,
                   TransactionManager transactionManager,
                   java.math.BigInteger gasPrice,
                   java.math.BigInteger gasLimit)

Contract

protected Contract(java.lang.String contractBinary,
                   java.lang.String contractAddress,
                   Web3j web3j,
                   org.web3j.crypto.Credentials credentials,
                   java.math.BigInteger gasPrice,
                   java.math.BigInteger gasLimit)

Contract

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

Deprecated.

Contract

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

Deprecated.

Method Detail

setContractAddress

public void setContractAddress(java.lang.String contractAddress)

getContractAddress

public java.lang.String getContractAddress()

setTransactionReceipt

public void setTransactionReceipt(TransactionReceipt transactionReceipt)

getContractBinary

public java.lang.String getContractBinary()

isValid

public boolean isValid()
                throws java.io.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:

java.io.IOException - if unable to connect to web3j node

getTransactionReceipt

public java.util.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

executeCallSingleValueReturn

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

Throws:

java.io.IOException

executeCallSingleValueReturn

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

Throws:

java.io.IOException

executeCallMultipleValueReturn

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

Throws:

java.io.IOException

executeTransaction

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

Throws:

java.io.IOException

TransactionException

executeRemoteCallSingleValueReturn

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

executeRemoteCallSingleValueReturn

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

executeRemoteCallMultipleValueReturn

protected RemoteCall<java.util.List<org.web3j.abi.datatypes.Type>> executeRemoteCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)

executeRemoteCallTransaction

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

executeRemoteCallTransaction

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

deploy

protected static <T extends Contract> T deploy(java.lang.Class<T> type,
                                               Web3j web3j,
                                               org.web3j.crypto.Credentials credentials,
                                               java.math.BigInteger gasPrice,
                                               java.math.BigInteger gasLimit,
                                               java.lang.String binary,
                                               java.lang.String encodedConstructor,
                                               java.math.BigInteger value)
                                        throws java.io.IOException,
                                               TransactionException

Throws:

java.io.IOException

TransactionException

deploy

protected static <T extends Contract> T deploy(java.lang.Class<T> type,
                                               Web3j web3j,
                                               TransactionManager transactionManager,
                                               java.math.BigInteger gasPrice,
                                               java.math.BigInteger gasLimit,
                                               java.lang.String binary,
                                               java.lang.String encodedConstructor,
                                               java.math.BigInteger value)
                                        throws java.io.IOException,
                                               TransactionException

Throws:

java.io.IOException

TransactionException

deployRemoteCall

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

deployRemoteCall

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

deployRemoteCall

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

deployRemoteCall

protected static <T extends Contract> RemoteCall<T> deployRemoteCall(java.lang.Class<T> type,
                                                                     Web3j web3j,
                                                                     TransactionManager transactionManager,
                                                                     java.math.BigInteger gasPrice,
                                                                     java.math.BigInteger gasLimit,
                                                                     java.lang.String binary,
                                                                     java.lang.String encodedConstructor)

staticExtractEventParameters

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

extractEventParameters

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

extractEventParameters

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

getStaticDeployedAddress

protected java.lang.String getStaticDeployedAddress(java.lang.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(java.lang.String networkId,
                                     java.lang.String address)

getDeployedAddress

public final java.lang.String getDeployedAddress(java.lang.String networkId)