one.harmony.cmd

Class Contract

java.lang.Object

one.harmony.cmd.Contract

public abstract class Contract
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BIN_NOT_PROVIDED
protected java.lang.String	contractAddress
protected java.lang.String	contractBinary
protected org.web3j.protocol.core.DefaultBlockParameter	defaultBlockParameter
protected java.util.Map<java.lang.String,java.lang.String>	deployedAddresses
static java.lang.String	FUNC_DEPLOY
protected org.web3j.tx.gas.ContractGasProvider	gasProvider
protected org.web3j.protocol.core.methods.response.TransactionReceipt	transactionReceipt

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Contract(java.lang.String contractBinary, java.lang.String contractAddress, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit)
protected	Contract(java.lang.String contractBinary, java.lang.String contractAddress, org.web3j.tx.gas.ContractGasProvider gasProvider)
protected	Contract(java.lang.String contractBinary, java.lang.String contractAddress, Handler handler, org.web3j.tx.gas.ContractGasProvider gasProvider)

Method Summary

Modifier and Type	Method and Description
protected static <S extends org.web3j.abi.datatypes.Type,T> java.util.List<T>	convertToNative(java.util.List<S> arr)
protected static <T extends Contract> T	deploy(java.lang.Class<T> type, Handler handler, 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, Handler handler, org.web3j.tx.gas.ContractGasProvider contractGasProvider, java.lang.String binary, java.lang.String encodedConstructor, java.math.BigInteger value)
static <T extends Contract> org.web3j.protocol.core.RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Handler handler, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor)
static <T extends Contract> org.web3j.protocol.core.RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Handler handler, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit, java.lang.String binary, java.lang.String encodedConstructor, java.math.BigInteger value)
static <T extends Contract> org.web3j.protocol.core.RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Handler handler, org.web3j.tx.gas.ContractGasProvider contractGasProvider, java.lang.String binary, java.lang.String encodedConstructor)
static <T extends Contract> org.web3j.protocol.core.RemoteCall<T>	deployRemoteCall(java.lang.Class<T> type, Handler handler, org.web3j.tx.gas.ContractGasProvider contractGasProvider, 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 org.web3j.protocol.core.RemoteCall<java.util.List<org.web3j.abi.datatypes.Type>>	executeRemoteCallMultipleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T extends org.web3j.abi.datatypes.Type> org.web3j.protocol.core.RemoteCall<T>	executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function)
protected <T> org.web3j.protocol.core.RemoteCall<T>	executeRemoteCallSingleValueReturn(org.web3j.abi.datatypes.Function function, java.lang.Class<T> returnType)
protected org.web3j.protocol.core.RemoteCall<org.web3j.protocol.core.methods.response.TransactionReceipt>	executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function)
protected org.web3j.protocol.core.RemoteCall<org.web3j.protocol.core.methods.response.TransactionReceipt>	executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function, java.math.BigInteger weiValue)
protected org.web3j.protocol.core.methods.response.TransactionReceipt	executeTransaction(org.web3j.abi.datatypes.Function function)
protected org.web3j.abi.EventValues	extractEventParameters(org.web3j.abi.datatypes.Event event, org.web3j.protocol.core.methods.response.Log log)
protected java.util.List<org.web3j.abi.EventValues>	extractEventParameters(org.web3j.abi.datatypes.Event event, org.web3j.protocol.core.methods.response.TransactionReceipt transactionReceipt)
protected Contract.EventValuesWithLog	extractEventParametersWithLog(org.web3j.abi.datatypes.Event event, org.web3j.protocol.core.methods.response.Log log)
protected java.util.List<Contract.EventValuesWithLog>	extractEventParametersWithLog(org.web3j.abi.datatypes.Event event, org.web3j.protocol.core.methods.response.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<org.web3j.protocol.core.methods.response.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 org.web3j.protocol.core.methods.response.TransactionReceipt	send(java.lang.String to, java.lang.String data, java.math.BigInteger value, java.math.BigInteger gasPrice, java.math.BigInteger gasLimit)
void	setContractAddress(java.lang.String contractAddress)
void	setDefaultBlockParameter(org.web3j.protocol.core.DefaultBlockParameter defaultBlockParameter) Sets the default block parameter.
void	setDeployedAddress(java.lang.String networkId, java.lang.String address)
void	setGasProvider(org.web3j.tx.gas.ContractGasProvider gasProvider)
void	setHandler(Handler handler)
void	setTransactionReceipt(org.web3j.protocol.core.methods.response.TransactionReceipt transactionReceipt)
static org.web3j.abi.EventValues	staticExtractEventParameters(org.web3j.abi.datatypes.Event event, org.web3j.protocol.core.methods.response.Log log)
protected static Contract.EventValuesWithLog	staticExtractEventParametersWithLog(org.web3j.abi.datatypes.Event event, org.web3j.protocol.core.methods.response.Log log)

Methods inherited from class java.lang.Object

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

Field Detail

BIN_NOT_PROVIDED

public static final java.lang.String BIN_NOT_PROVIDED

See Also:

Constant Field Values

FUNC_DEPLOY

public static final java.lang.String FUNC_DEPLOY

See Also:

Constant Field Values

contractBinary

protected final java.lang.String contractBinary

contractAddress

protected java.lang.String contractAddress

gasProvider

protected org.web3j.tx.gas.ContractGasProvider gasProvider

transactionReceipt

protected org.web3j.protocol.core.methods.response.TransactionReceipt transactionReceipt

deployedAddresses

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

defaultBlockParameter

protected org.web3j.protocol.core.DefaultBlockParameter defaultBlockParameter

Constructor Detail

Contract

protected Contract(java.lang.String contractBinary,
                   java.lang.String contractAddress,
                   Handler handler,
                   org.web3j.tx.gas.ContractGasProvider gasProvider)

Contract

protected Contract(java.lang.String contractBinary,
                   java.lang.String contractAddress,
                   org.web3j.tx.gas.ContractGasProvider gasProvider)

Contract

protected Contract(java.lang.String contractBinary,
                   java.lang.String contractAddress,
                   java.math.BigInteger gasPrice,
                   java.math.BigInteger gasLimit)

Method Detail

setHandler

public void setHandler(Handler handler)

setContractAddress

public void setContractAddress(java.lang.String contractAddress)

getContractAddress

public java.lang.String getContractAddress()

setTransactionReceipt

public void setTransactionReceipt(org.web3j.protocol.core.methods.response.TransactionReceipt transactionReceipt)

getContractBinary

public java.lang.String getContractBinary()

setGasProvider

public void setGasProvider(org.web3j.tx.gas.ContractGasProvider gasProvider)

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<org.web3j.protocol.core.methods.response.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(org.web3j.protocol.core.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

executeCallSingleValueReturn

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

Throws:

java.lang.Exception

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.lang.Exception

Throws:

java.lang.Exception

executeCallMultipleValueReturn

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

Throws:

java.lang.Exception

executeTransaction

protected org.web3j.protocol.core.methods.response.TransactionReceipt executeTransaction(org.web3j.abi.datatypes.Function function)
                                                                                  throws java.lang.Exception,
                                                                                         org.web3j.protocol.exceptions.TransactionException

Throws:

java.lang.Exception

org.web3j.protocol.exceptions.TransactionException

executeRemoteCallSingleValueReturn

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

executeRemoteCallSingleValueReturn

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

executeRemoteCallMultipleValueReturn

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

executeRemoteCallTransaction

protected org.web3j.protocol.core.RemoteCall<org.web3j.protocol.core.methods.response.TransactionReceipt> executeRemoteCallTransaction(org.web3j.abi.datatypes.Function function)

executeRemoteCallTransaction

protected org.web3j.protocol.core.RemoteCall<org.web3j.protocol.core.methods.response.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,
                                               Handler handler,
                                               org.web3j.tx.gas.ContractGasProvider contractGasProvider,
                                               java.lang.String binary,
                                               java.lang.String encodedConstructor,
                                               java.math.BigInteger value)
                                        throws java.lang.RuntimeException,
                                               org.web3j.protocol.exceptions.TransactionException

Throws:

java.lang.RuntimeException

org.web3j.protocol.exceptions.TransactionException

deploy

protected static <T extends Contract> T deploy(java.lang.Class<T> type,
                                               Handler handler,
                                               java.math.BigInteger gasPrice,
                                               java.math.BigInteger gasLimit,
                                               java.lang.String binary,
                                               java.lang.String encodedConstructor,
                                               java.math.BigInteger value)
                                        throws java.lang.RuntimeException,
                                               org.web3j.protocol.exceptions.TransactionException

Throws:

java.lang.RuntimeException

org.web3j.protocol.exceptions.TransactionException

deployRemoteCall

public static <T extends Contract> org.web3j.protocol.core.RemoteCall<T> deployRemoteCall(java.lang.Class<T> type,
                                                                                          Handler handler,
                                                                                          org.web3j.tx.gas.ContractGasProvider contractGasProvider,
                                                                                          java.lang.String binary,
                                                                                          java.lang.String encodedConstructor,
                                                                                          java.math.BigInteger value)

deployRemoteCall

public static <T extends Contract> org.web3j.protocol.core.RemoteCall<T> deployRemoteCall(java.lang.Class<T> type,
                                                                                          Handler handler,
                                                                                          java.math.BigInteger gasPrice,
                                                                                          java.math.BigInteger gasLimit,
                                                                                          java.lang.String binary,
                                                                                          java.lang.String encodedConstructor,
                                                                                          java.math.BigInteger value)

deployRemoteCall

public static <T extends Contract> org.web3j.protocol.core.RemoteCall<T> deployRemoteCall(java.lang.Class<T> type,
                                                                                          Handler handler,
                                                                                          java.math.BigInteger gasPrice,
                                                                                          java.math.BigInteger gasLimit,
                                                                                          java.lang.String binary,
                                                                                          java.lang.String encodedConstructor)

deployRemoteCall

public static <T extends Contract> org.web3j.protocol.core.RemoteCall<T> deployRemoteCall(java.lang.Class<T> type,
                                                                                          Handler handler,
                                                                                          org.web3j.tx.gas.ContractGasProvider contractGasProvider,
                                                                                          java.lang.String binary,
                                                                                          java.lang.String encodedConstructor)

send

protected org.web3j.protocol.core.methods.response.TransactionReceipt send(java.lang.String to,
                                                                           java.lang.String data,
                                                                           java.math.BigInteger value,
                                                                           java.math.BigInteger gasPrice,
                                                                           java.math.BigInteger gasLimit)
                                                                    throws java.lang.Exception,
                                                                           org.web3j.protocol.exceptions.TransactionException

Throws:

java.lang.Exception

org.web3j.protocol.exceptions.TransactionException

staticExtractEventParameters

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

extractEventParameters

protected org.web3j.abi.EventValues extractEventParameters(org.web3j.abi.datatypes.Event event,
                                                           org.web3j.protocol.core.methods.response.Log log)

extractEventParameters

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

extractEventParametersWithLog

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

staticExtractEventParametersWithLog

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

extractEventParametersWithLog

protected java.util.List<Contract.EventValuesWithLog> extractEventParametersWithLog(org.web3j.abi.datatypes.Event event,
                                                                                    org.web3j.protocol.core.methods.response.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)

convertToNative

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