com.klaytn.caver.contract

Class Contract

java.lang.Object

com.klaytn.caver.contract.Contract

Direct Known Subclasses:

KIP13, KIP17, KIP37, KIP7

public class Contract
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Contract(Caver caver, java.lang.String abi) Creates a Contract instance.
Contract(Caver caver, java.lang.String abi, java.lang.String contractAddress) Creates a Contract instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<org.web3j.abi.datatypes.Type>	call(CallObject callObject, java.lang.String methodName, java.lang.Object... methodArguments) Execute smart contract method in the EVM without sending any transaction.
java.util.List<org.web3j.abi.datatypes.Type>	call(java.lang.String methodName, java.lang.Object... methodArguments) Execute smart contract method in the EVM without sending any transaction.
java.util.List<org.web3j.abi.datatypes.Type>	callWithSolidityType(CallObject callObject, java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Execute smart contract method in the EVM without sending any transaction.
java.util.List<org.web3j.abi.datatypes.Type>	callWithSolidityType(java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Execute smart contract method in the EVM without sending any transaction.
Contract	deploy(ContractDeployParams deployParam, SendOptions sendOptions) Deploy a contract.
Contract	deploy(ContractDeployParams deployParam, SendOptions sendOptions, TransactionReceiptProcessor processor) Deploy a contract
Contract	deploy(SendOptions sendOptions, java.lang.String contractBinaryData, java.lang.Object... constructorParams) Deploy a contract
Contract	deploy(SendOptions sendOptions, TransactionReceiptProcessor receiptProcessor, java.lang.String contractBinaryData, java.lang.Object... constructorParams) Deploy a contract
java.lang.String	encodeABI(java.lang.String methodName, java.lang.Object... methodArguments) Encodes the ABI for the method in Contract.
java.lang.String	encodeABIWithSolidityType(java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Encodes the ABI for the method in Contract with Solidity type wrapper reference.
java.lang.String	estimateGas(CallObject callObject, java.lang.String methodName, java.lang.Object... methodArguments) Estimate the gas to execute the contract's method.
java.lang.String	estimateGasWithSolidityType(CallObject callObject, java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Estimate the gas to execute the contract's method with Solidity type wrapper reference.
java.lang.String	getAbi() Getter function for contract's abi.
Caver	getCaver() Getter function for caver.
ContractMethod	getConstructor() Getter function for Contract's constructor function info.
java.lang.String	getContractAddress() Getter function for contract address.
SendOptions	getDefaultSendOptions() Getter function for DefaultSendOptions
ContractEvent	getEvent(java.lang.String eventName) Returns the ContractEvent instance corresponding to the event name.
java.util.Map<java.lang.String,ContractEvent>	getEvents() Getter function for events.
ContractMethod	getMethod(java.lang.String methodName) Returns the ContractMethod instance corresponding to the method name.
java.util.Map<java.lang.String,ContractMethod>	getMethods() Getter function for methods.
KlayLogs	getPastEvent(java.lang.String eventName, KlayLogFilter filterOption) Get past events for this contract.
IWallet	getWallet() Getter function for wallet
io.reactivex.disposables.Disposable	once(java.lang.String eventName, EventFilterOptions paramsOption, io.reactivex.functions.Consumer<org.web3j.protocol.websocket.events.LogNotification> callback) Subscribes to an event and unsubscribes immediately after the first event or error.
TransactionReceipt.TransactionReceiptData	send(SendOptions options, java.lang.String methodName, java.lang.Object... methodArguments) Send a transaction to smart contract and execute its method.
TransactionReceipt.TransactionReceiptData	send(SendOptions options, TransactionReceiptProcessor receiptProcessor, java.lang.String methodName, java.lang.Object... methodArguments) Send a transaction to smart contract and execute its method.
TransactionReceipt.TransactionReceiptData	send(java.lang.String methodName, java.lang.Object... methodArguments) Send a transaction to smart contract and execute its method.
TransactionReceipt.TransactionReceiptData	sendWithSolidityType(SendOptions options, java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Send a transaction to smart contract and execute its method using solidity type wrapper class.
TransactionReceipt.TransactionReceiptData	sendWithSolidityType(SendOptions options, TransactionReceiptProcessor receiptProcessor, java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Send a transaction to smart contract and execute its method using solidity type wrapper class.
TransactionReceipt.TransactionReceiptData	sendWithSolidityType(java.lang.String methodName, org.web3j.abi.datatypes.Type... methodArguments) Send a transaction to smart contract and execute its method using solidity type wrapper class.
void	setDefaultSendOptions(SendOptions defaultSendOptions) Setter function for defaultSendOption
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

Contract

public Contract(Caver caver,
                java.lang.String abi)
         throws java.io.IOException

Creates a Contract instance.

Parameters:

caver - A Caver instance.

abi - A contract's ABI(Application Binary interface) json string.

Throws:

java.io.IOException

Contract

public Contract(Caver caver,
                java.lang.String abi,
                java.lang.String contractAddress)
         throws java.io.IOException

Creates a Contract instance.

Parameters:

caver - A Caver instance

abi - A contract's ABI(Application Binary Interface) json string.

contractAddress - An address string of contract deployed on Klaytn.

Throws:

java.io.IOException

Method Detail

deploy

public Contract deploy(SendOptions sendOptions,
                       java.lang.String contractBinaryData,
                       java.lang.Object... constructorParams)
                throws org.web3j.protocol.exceptions.TransactionException,
                       java.io.IOException,
                       java.lang.NoSuchMethodException,
                       java.lang.InstantiationException,
                       java.lang.ClassNotFoundException,
                       java.lang.IllegalAccessException,
                       java.lang.reflect.InvocationTargetException

Deploy a contract

Parameters:

sendOptions - A SendOption instance.

contractBinaryData - A smart contract binary data.

constructorParams - The smart contract constructor parameters.

Returns:

Contract

Throws:

org.web3j.protocol.exceptions.TransactionException

java.lang.NoSuchMethodException

java.io.IOException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

deploy

public Contract deploy(SendOptions sendOptions,
                       TransactionReceiptProcessor receiptProcessor,
                       java.lang.String contractBinaryData,
                       java.lang.Object... constructorParams)
                throws org.web3j.protocol.exceptions.TransactionException,
                       java.io.IOException,
                       java.lang.NoSuchMethodException,
                       java.lang.InstantiationException,
                       java.lang.ClassNotFoundException,
                       java.lang.IllegalAccessException,
                       java.lang.reflect.InvocationTargetException

Deploy a contract

Parameters:

sendOptions - A SendOption instance

receiptProcessor - A TransactionReceiptProcessor instance.

contractBinaryData - A smart contract binary data.

constructorParams - The smart contract constructor parameters.

Returns:

Contract

Throws:

org.web3j.protocol.exceptions.TransactionException

java.lang.NoSuchMethodException

java.io.IOException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

deploy

public Contract deploy(ContractDeployParams deployParam,
                       SendOptions sendOptions)
                throws org.web3j.protocol.exceptions.TransactionException,
                       java.io.IOException,
                       java.lang.NoSuchMethodException,
                       java.lang.InstantiationException,
                       java.lang.ClassNotFoundException,
                       java.lang.IllegalAccessException,
                       java.lang.reflect.InvocationTargetException

Deploy a contract. It sets TransactionReceiptProcessor to PollingTransactionReceiptProcessor instance.

Parameters:

deployParam - A DeployParam instance.

sendOptions - A SendOption instance.

Returns:

Contract

Throws:

org.web3j.protocol.exceptions.TransactionException

java.io.IOException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

deploy

public Contract deploy(ContractDeployParams deployParam,
                       SendOptions sendOptions,
                       TransactionReceiptProcessor processor)
                throws org.web3j.protocol.exceptions.TransactionException,
                       java.io.IOException,
                       java.lang.NoSuchMethodException,
                       java.lang.InstantiationException,
                       java.lang.ClassNotFoundException,
                       java.lang.IllegalAccessException,
                       java.lang.reflect.InvocationTargetException

Deploy a contract

Parameters:

deployParam - A DeployParam instance.

sendOptions - A SendOption instance.

processor - A TransactionReceiptProcessor instance.

Returns:

Contract

Throws:

org.web3j.protocol.exceptions.TransactionException

java.io.IOException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

once

public io.reactivex.disposables.Disposable once(java.lang.String eventName,
                                                EventFilterOptions paramsOption,
                                                io.reactivex.functions.Consumer<org.web3j.protocol.websocket.events.LogNotification> callback)
                                         throws java.lang.ClassNotFoundException,
                                                java.lang.NoSuchMethodException,
                                                java.lang.reflect.InvocationTargetException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException

Subscribes to an event and unsubscribes immediately after the first event or error.

Parameters:

eventName - The name of the event in the contract.

paramsOption - The filter events by indexed parameters.

callback - The callback function that handled to returned data.

Returns:

Disposable instance that able to unsubscribe.

Throws:

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

java.lang.IllegalAccessException

getPastEvent

public KlayLogs getPastEvent(java.lang.String eventName,
                             KlayLogFilter filterOption)
                      throws java.io.IOException

Get past events for this contract.

Parameters:

eventName - The name of the event in the contract.

filterOption - The KlayLogFilter instance to filter event.

Returns:

KlayLogs

Throws:

java.io.IOException

call

public java.util.List<org.web3j.abi.datatypes.Type> call(java.lang.String methodName,
                                                         java.lang.Object... methodArguments)
                                                  throws java.io.IOException,
                                                         java.lang.ClassNotFoundException,
                                                         java.lang.NoSuchMethodException,
                                                         java.lang.reflect.InvocationTargetException,
                                                         java.lang.InstantiationException,
                                                         java.lang.IllegalAccessException

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

Parameters:

methodName - The smart contract method name to execute.

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

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

java.lang.IllegalAccessException

call

public java.util.List<org.web3j.abi.datatypes.Type> call(CallObject callObject,
                                                         java.lang.String methodName,
                                                         java.lang.Object... methodArguments)
                                                  throws java.io.IOException,
                                                         java.lang.ClassNotFoundException,
                                                         java.lang.NoSuchMethodException,
                                                         java.lang.reflect.InvocationTargetException,
                                                         java.lang.InstantiationException,
                                                         java.lang.IllegalAccessException

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:

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

methodName - The smart contract method name to execute.

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

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

java.lang.IllegalAccessException

callWithSolidityType

public java.util.List<org.web3j.abi.datatypes.Type> callWithSolidityType(java.lang.String methodName,
                                                                         org.web3j.abi.datatypes.Type... methodArguments)
                                                                  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:

methodName - The smart contract method name to execute.

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

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

callWithSolidityType

public java.util.List<org.web3j.abi.datatypes.Type> callWithSolidityType(CallObject callObject,
                                                                         java.lang.String methodName,
                                                                         org.web3j.abi.datatypes.Type... methodArguments)
                                                                  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. When creating CallObject, it need not to fill 'data', 'to' fields. The 'data', 'to' fields automatically filled in call() method.

Parameters:

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

methodName - The smart contract method name to execute.

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

Returns:

List

Throws:

java.io.IOException

java.lang.ClassNotFoundException

send

public TransactionReceipt.TransactionReceiptData send(java.lang.String methodName,
                                                      java.lang.Object... methodArguments)
                                               throws org.web3j.protocol.exceptions.TransactionException,
                                                      java.io.IOException,
                                                      java.lang.NoSuchMethodException,
                                                      java.lang.InstantiationException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException

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

Parameters:

methodName - The smart contract method name to execute

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

Returns:

TransactionReceiptData

Throws:

org.web3j.protocol.exceptions.TransactionException

java.io.IOException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

send

public TransactionReceipt.TransactionReceiptData send(SendOptions options,
                                                      java.lang.String methodName,
                                                      java.lang.Object... methodArguments)
                                               throws org.web3j.protocol.exceptions.TransactionException,
                                                      java.io.IOException,
                                                      java.lang.NoSuchMethodException,
                                                      java.lang.InstantiationException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException

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

Parameters:

options - An option to execute smart contract method.

methodName - The smart contract method name to execute

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

Returns:

TransactionReceiptData

Throws:

org.web3j.protocol.exceptions.TransactionException

java.io.IOException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

send

public TransactionReceipt.TransactionReceiptData send(SendOptions options,
                                                      TransactionReceiptProcessor receiptProcessor,
                                                      java.lang.String methodName,
                                                      java.lang.Object... methodArguments)
                                               throws org.web3j.protocol.exceptions.TransactionException,
                                                      java.io.IOException,
                                                      java.lang.NoSuchMethodException,
                                                      java.lang.InstantiationException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException

Send a transaction to smart contract and execute its method.

Parameters:

options - An option to execute smart contract method.

receiptProcessor - A TransactionReceiptProcessor to get receipt.

methodName - The smart contract method name to execute

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

Returns:

TransactionReceiptData

Throws:

org.web3j.protocol.exceptions.TransactionException

java.io.IOException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

sendWithSolidityType

public TransactionReceipt.TransactionReceiptData sendWithSolidityType(java.lang.String methodName,
                                                                      org.web3j.abi.datatypes.Type... methodArguments)
                                                               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:

methodName - The smart contract method name to execute

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

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

sendWithSolidityType

public TransactionReceipt.TransactionReceiptData sendWithSolidityType(SendOptions options,
                                                                      java.lang.String methodName,
                                                                      org.web3j.abi.datatypes.Type... methodArguments)
                                                               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:

options - An option to execute smart contract method.

methodName - The smart contract method name to execute

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

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

sendWithSolidityType

public TransactionReceipt.TransactionReceiptData sendWithSolidityType(SendOptions options,
                                                                      TransactionReceiptProcessor receiptProcessor,
                                                                      java.lang.String methodName,
                                                                      org.web3j.abi.datatypes.Type... methodArguments)
                                                               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:

options - An option to execute smart contract method.

receiptProcessor - A TransactionReceiptProcessor to get receipt.

methodName - The smart contract method name to execute

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

Returns:

TransactionReceiptData

Throws:

java.io.IOException

org.web3j.protocol.exceptions.TransactionException

encodeABI

public java.lang.String encodeABI(java.lang.String methodName,
                                  java.lang.Object... methodArguments)
                           throws java.lang.ClassNotFoundException,
                                  java.lang.NoSuchMethodException,
                                  java.lang.reflect.InvocationTargetException,
                                  java.lang.InstantiationException,
                                  java.lang.IllegalAccessException

Encodes the ABI for the method in Contract. The resulting hex string is 32-bit function signature hash plus the passed parameters in Solidity tightly packed format.

Parameters:

methodName - The smart contract method name to encode.

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

Returns:

String

Throws:

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

java.lang.IllegalAccessException

encodeABIWithSolidityType

public java.lang.String encodeABIWithSolidityType(java.lang.String methodName,
                                                  org.web3j.abi.datatypes.Type... methodArguments)

Encodes the ABI for the method in Contract with Solidity type wrapper reference. The resulting hex string is 32-bit function signature hash plus the passed parameters in Solidity tightly packed format. It is recommended to use this function when you want to execute one of the functions with the same number of parameters.

Parameters:

methodName - The smart contract method name to encode.

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

Returns:

String

estimateGas

public java.lang.String estimateGas(CallObject callObject,
                                    java.lang.String methodName,
                                    java.lang.Object... methodArguments)
                             throws java.lang.NoSuchMethodException,
                                    java.io.IOException,
                                    java.lang.InstantiationException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException,
                                    java.lang.ClassNotFoundException

Estimate the gas to execute the contract's method.

Parameters:

callObject - An option to execute smart contract method.

methodName - The smart contract method name.

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

Returns:

String

Throws:

java.lang.NoSuchMethodException

java.io.IOException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.ClassNotFoundException

estimateGasWithSolidityType

public java.lang.String estimateGasWithSolidityType(CallObject callObject,
                                                    java.lang.String methodName,
                                                    org.web3j.abi.datatypes.Type... methodArguments)
                                             throws java.io.IOException

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

Parameters:

callObject - An option to execute smart contract method.

methodName - The smart contract method name.

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

Returns:

String

Throws:

java.io.IOException

getMethod

public ContractMethod getMethod(java.lang.String methodName)

Returns the ContractMethod instance corresponding to the method name.

Parameters:

methodName - The method name.

Returns:

ContractMethod

getEvent

public ContractEvent getEvent(java.lang.String eventName)

Returns the ContractEvent instance corresponding to the event name.

Parameters:

eventName - The event name.

Returns:

ContractEvent

getCaver

public Caver getCaver()

Getter function for caver.

Returns:

Caver

getAbi

public java.lang.String getAbi()

Getter function for contract's abi.

Returns:

String

getContractAddress

public java.lang.String getContractAddress()

Getter function for contract address.

Returns:

String

getMethods

public java.util.Map<java.lang.String,ContractMethod> getMethods()

Getter function for methods.

Returns:

Map

getEvents

public java.util.Map<java.lang.String,ContractEvent> getEvents()

Getter function for events.

Returns:

Map

getConstructor

public ContractMethod getConstructor()

Getter function for Contract's constructor function info.

Returns:

ContractMethod.

getDefaultSendOptions

public SendOptions getDefaultSendOptions()

Getter function for DefaultSendOptions

Returns:

SendOptions

getWallet

public IWallet getWallet()

Getter function for wallet

Returns:

IWallet

setWallet

public void setWallet(IWallet wallet)

Setter function for wallet

Parameters:

wallet - The class instance implemented IWallet to sign transaction.

setDefaultSendOptions

public void setDefaultSendOptions(SendOptions defaultSendOptions)

Setter function for defaultSendOption

Parameters:

defaultSendOptions - The sendOptions to set DefaultSendOptions field.