com.klaytn.caver.contract

Class ContractMethod

java.lang.Object

com.klaytn.caver.contract.ContractMethod

public class ContractMethod
extends java.lang.Object

Representing a Contract's method information.

Constructor Summary

Constructors

Constructor and Description
ContractMethod() Creates a ContractMethod instance.
ContractMethod(Caver caver, java.lang.String type, java.lang.String name, java.util.List<ContractIOType> inputs, java.util.List<ContractIOType> outputs, java.lang.String signature, java.lang.String contractAddress) Creates a ContractMethod instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<Type>	call(java.util.List<java.lang.Object> arguments) Execute smart contract method in the EVM without sending any transaction.
java.util.List<Type>	call(java.util.List<java.lang.Object> arguments, CallObject callObject) Execute smart contract method in the EVM without sending any transaction.
java.util.List<Type>	callWithSolidityWrapper(java.util.List<Type> arguments) Execute smart contract method in the EVM without sending any transaction.
java.util.List<Type>	callWithSolidityWrapper(java.util.List<Type> arguments, CallObject callObject) Execute smart contract method in the EVM without sending any transaction.
void	checkTypeValid(java.util.List<java.lang.Object> types) Check that passed parameter is valid to execute smart contract method.
java.lang.String	encodeABI(java.util.List<java.lang.Object> arguments) Encodes the ABI for this method.
java.lang.String	encodeABIWithSolidityWrapper(java.util.List<Type> wrapperArguments) Encodes the ABI for this method.
java.lang.String	estimateGas(java.util.List<java.lang.Object> arguments, CallObject callObject) Estimate the gas to execute the contract's method.
java.lang.String	estimateGasWithSolidityWrapper(java.util.List<Type> arguments, CallObject callObject) Estimate the gas to execute the Contract's method using Solidity type wrapper class.
Caver	getCaver() Getter function for Caver.
java.lang.String	getContractAddress() Getter function for contract address
SendOptions	getDefaultSendOptions() Getter function for DefaultSendOptions
java.util.List<ContractIOType>	getInputs() Getter function for input.
java.lang.String	getName() Getter function for name.
java.util.List<ContractMethod>	getNextContractMethods()
java.util.List<ContractIOType>	getOutputs() Getter function for output.
java.lang.String	getSignature() Getter function for signature.
java.lang.String	getType() Getter function for type.
SendOptions	makeSendOption(SendOptions sendOption) Make SendOptions instance by comparing with defaultSendOption and passed parameter "options" Passed parameter "options" has higher priority than "defaultSendOption" field.
TransactionReceipt.TransactionReceiptData	send(java.util.List<java.lang.Object> arguments) Send a transaction to smart contract and execute its method.
TransactionReceipt.TransactionReceiptData	send(java.util.List<java.lang.Object> arguments, SendOptions options) Send a transaction to smart contract and execute its method.
TransactionReceipt.TransactionReceiptData	send(java.util.List<java.lang.Object> arguments, SendOptions options, TransactionReceiptProcessor processor) Send a transaction to smart contract and execute its method.
TransactionReceipt.TransactionReceiptData	sendWithSolidityWrapper(java.util.List<Type> wrapperArguments) Send a transaction to smart contract and execute its method using solidity type wrapper class.
TransactionReceipt.TransactionReceiptData	sendWithSolidityWrapper(java.util.List<Type> wrapperArguments, SendOptions options) Send a transaction to smart contract and execute its method using solidity type wrapper class.
TransactionReceipt.TransactionReceiptData	sendWithSolidityWrapper(java.util.List<Type> wrapperArguments, SendOptions options, TransactionReceiptProcessor processor) Send a transaction to smart contract and execute its method using solidity type wrapper class.
void	setWallet(IWallet wallet) Setter function for wallet

Methods inherited from class java.lang.Object

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

Constructor Detail

ContractMethod

public ContractMethod()

Creates a ContractMethod instance.

ContractMethod

public ContractMethod(Caver caver,
                      java.lang.String type,
                      java.lang.String name,
                      java.util.List<ContractIOType> inputs,
                      java.util.List<ContractIOType> outputs,
                      java.lang.String signature,
                      java.lang.String contractAddress)

Creates a ContractMethod instance.

Parameters:

caver - A Caver instance.

type - The input type. It always set "function"

name - The function name

inputs - The list of ContractIOType contains to function parameter information.

outputs - The list of ContractIOType

signature - The function signature string.

contractAddress - The contract address

Method Detail

call

public java.util.List<Type> call(java.util.List<java.lang.Object> arguments)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException,
                                 java.lang.NoSuchMethodException,
                                 java.lang.InstantiationException,
                                 java.lang.IllegalAccessException,
                                 java.lang.reflect.InvocationTargetException

Execute smart contract method in the EVM without sending any transaction.

Parameters:

arguments - A List of parameter to call smart contract method.

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

call

public java.util.List<Type> call(java.util.List<java.lang.Object> arguments,
                                 CallObject callObject)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException,
                                 java.lang.NoSuchMethodException,
                                 java.lang.InstantiationException,
                                 java.lang.IllegalAccessException,
                                 java.lang.reflect.InvocationTargetException

Execute smart contract method in the EVM without sending any transaction. When creating CallObject, it need not to fill 'data', 'to' fields. The 'data', 'to' fields automatically filled in call() method.

Parameters:

arguments - A List of parameter to call smart contract method.

callObject - A CallObject instance to 'call' smart contract method.

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

callWithSolidityWrapper

public java.util.List<Type> callWithSolidityWrapper(java.util.List<Type> arguments)
                                             throws java.io.IOException,
                                                    java.lang.ClassNotFoundException

Execute smart contract method in the EVM without sending any transaction. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

arguments - A List of parameter that solidity wrapper type to call smart contract method.

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

callWithSolidityWrapper

public java.util.List<Type> callWithSolidityWrapper(java.util.List<Type> arguments,
                                                    CallObject callObject)
                                             throws java.io.IOException,
                                                    java.lang.ClassNotFoundException

Execute smart contract method in the EVM without sending any transaction. When creating CallObject, it need not to fill 'data', 'to' fields. The 'data', 'to' fields automatically filled in call() method. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

arguments - A List of parameter that solidity wrapper type to call smart contract method.

callObject - A CallObject instance to 'call' smart contract method.

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

send

public TransactionReceipt.TransactionReceiptData send(java.util.List<java.lang.Object> arguments)
                                               throws java.io.IOException,
                                                      org.web3j.protocol.exceptions.TransactionException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.NoSuchMethodException,
                                                      java.lang.InstantiationException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException

Send a transaction to smart contract and execute its method. It is used defaultSendOption field to sendOptions

Parameters:

arguments - A List of parameter to call smart contract method.

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

send

public TransactionReceipt.TransactionReceiptData send(java.util.List<java.lang.Object> arguments,
                                                      SendOptions options)
                                               throws java.io.IOException,
                                                      org.web3j.protocol.exceptions.TransactionException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.NoSuchMethodException,
                                                      java.lang.InstantiationException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException

Send a transaction to smart contract and execute its method. It sets TransactionReceiptProcessor to PollingTransactionReceiptProcessor.

Parameters:

arguments - A List of parameter to call smart contract method.

options - An option to execute smart contract method.

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

send

public TransactionReceipt.TransactionReceiptData send(java.util.List<java.lang.Object> arguments,
                                                      SendOptions options,
                                                      TransactionReceiptProcessor processor)
                                               throws java.io.IOException,
                                                      org.web3j.protocol.exceptions.TransactionException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.NoSuchMethodException,
                                                      java.lang.InstantiationException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException

Send a transaction to smart contract and execute its method.

Parameters:

arguments - A List of parameter to call smart contract method.

options - An option to execute smart contract method.

processor - A TransactionReceiptProcessor to get receipt.

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

sendWithSolidityWrapper

public TransactionReceipt.TransactionReceiptData sendWithSolidityWrapper(java.util.List<Type> wrapperArguments)
                                                                  throws java.io.IOException,
                                                                         org.web3j.protocol.exceptions.TransactionException

Send a transaction to smart contract and execute its method using solidity type wrapper class. It is used defaultSendOption field to sendOptions It sets TransactionReceiptProcessor to PollingTransactionReceiptProcessor. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

wrapperArguments - A List of parameter that wrapped solidity wrapper class.

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

sendWithSolidityWrapper

public TransactionReceipt.TransactionReceiptData sendWithSolidityWrapper(java.util.List<Type> wrapperArguments,
                                                                         SendOptions options)
                                                                  throws java.io.IOException,
                                                                         org.web3j.protocol.exceptions.TransactionException

Send a transaction to smart contract and execute its method using solidity type wrapper class. It sets TransactionReceiptProcessor to PollingTransactionReceiptProcessor. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

wrapperArguments - A List of parameter that wrapped solidity wrapper class.

options - An option to execute smart contract method.

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

sendWithSolidityWrapper

public TransactionReceipt.TransactionReceiptData sendWithSolidityWrapper(java.util.List<Type> wrapperArguments,
                                                                         SendOptions options,
                                                                         TransactionReceiptProcessor processor)
                                                                  throws java.io.IOException,
                                                                         org.web3j.protocol.exceptions.TransactionException

Send a transaction to smart contract and execute its method using solidity type wrapper class. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

wrapperArguments - A List of parameter that wrapped solidity wrapper class.

options - An option to execute smart contract method.

processor - A TransactionReceiptProcessor to get receipt.

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

encodeABI

public java.lang.String encodeABI(java.util.List<java.lang.Object> arguments)
                           throws java.lang.ClassNotFoundException,
                                  java.lang.NoSuchMethodException,
                                  java.lang.InstantiationException,
                                  java.lang.IllegalAccessException,
                                  java.lang.reflect.InvocationTargetException

Encodes the ABI for this method. It returns 32-bit function signature hash plus the encoded passed parameters.

Parameters:

arguments - A List of parameter to encode function signature and parameters

Returns:

The encoded ABI byte code to send via a transaction or call.

Throws:

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

encodeABIWithSolidityWrapper

public java.lang.String encodeABIWithSolidityWrapper(java.util.List<Type> wrapperArguments)

Encodes the ABI for this method. It returns 32-bit function signature hash plus the encoded passed parameters. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

wrapperArguments - A List of parameter that solidity wrapper class

Returns:

The encoded ABI byte code to send via a transaction or call.

estimateGas

public java.lang.String estimateGas(java.util.List<java.lang.Object> arguments,
                                    CallObject callObject)
                             throws java.io.IOException,
                                    java.lang.ClassNotFoundException,
                                    java.lang.NoSuchMethodException,
                                    java.lang.InstantiationException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException

Estimate the gas to execute the contract's method.

Parameters:

arguments - A List of parameter that solidity wrapper type

callObject - An option to execute smart contract method.

Returns:

String

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

estimateGasWithSolidityWrapper

public java.lang.String estimateGasWithSolidityWrapper(java.util.List<Type> arguments,
                                                       CallObject callObject)
                                                throws java.io.IOException

Estimate the gas to execute the Contract's method using Solidity type wrapper class. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

arguments - The arguments that need to execute smart contract method.

callObject - An option to execute smart contract method.

Returns:

String

Throws:

java.io.IOException

checkTypeValid

public void checkTypeValid(java.util.List<java.lang.Object> types)

Check that passed parameter is valid to execute smart contract method. - check parameter count. - check defined parameter solidity type and parameter solidity wrapper type.

Parameters:

types - A List of parameter that solidity wrapper type

getCaver

public Caver getCaver()

Getter function for Caver.

Returns:

Caver

getType

public java.lang.String getType()

Getter function for type.

Returns:

String

getName

public java.lang.String getName()

Getter function for name.

Returns:

String

getInputs

public java.util.List<ContractIOType> getInputs()

Getter function for input.

Returns:

List

getOutputs

public java.util.List<ContractIOType> getOutputs()

Getter function for output.

Returns:

List

getSignature

public java.lang.String getSignature()

Getter function for signature.

Returns:

String

getContractAddress

public java.lang.String getContractAddress()

Getter function for contract address

Returns:

String

getDefaultSendOptions

public SendOptions getDefaultSendOptions()

Getter function for DefaultSendOptions

Returns:

SendOptions

getNextContractMethods

public java.util.List<ContractMethod> getNextContractMethods()

setWallet

public void setWallet(IWallet wallet)

Setter function for wallet

Parameters:

wallet - The class instance implemented IWallet interface to sign transaction.

makeSendOption

public SendOptions makeSendOption(SendOptions sendOption)

Make SendOptions instance by comparing with defaultSendOption and passed parameter "options" Passed parameter "options" has higher priority than "defaultSendOption" field.

Parameters:

sendOption - SendOptions instance

Returns:

SendOption