Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class ContractExecuteTransaction

java.lang.Object

com.hedera.hashgraph.sdk.Executable<ContractExecuteTransaction,Transaction,TransactionResponse,TransactionResponse>

com.hedera.hashgraph.sdk.Transaction<ContractExecuteTransaction>

com.hedera.hashgraph.sdk.ContractExecuteTransaction

public final class ContractExecuteTransaction
extends Transaction<ContractExecuteTransaction>

Call a function of the given smart contract instance, giving it parameters as its inputs.

It can use the given amount of gas, and any unspent gas will be refunded to the paying account.

If this function stores information, it is charged gas to store it. There is a fee in hbars to maintain that storage until the expiration time, and that fee is added as part of the transaction fee.

Nested Class Summary

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Transaction

Transaction.SignableNodeTransactionBodyBytes

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Executable

Executable.GrpcRequest

Field Summary

Fields inherited from class com.hedera.hashgraph.sdk.Transaction

customFeeLimits, DEFAULT_AUTO_RENEW_PERIOD, defaultMaxTransactionFee, DUMMY_ACCOUNT_ID, DUMMY_TRANSACTION_ID, frozenBodyBuilder, innerSignedTransactions, outerTransactions, publicKeys, regenerateTransactionId, signers, sigPairLists, sourceTransactionBody, transactionIds

Fields inherited from class com.hedera.hashgraph.sdk.Executable

attemptedAllNodes, blockingUnaryCall, grpcDeadline, logger, maxAttempts, maxBackoff, minBackoff, nodeAccountIds, nodes, random, RST_STREAM

Constructor Summary

Constructors

Constructor	Description
ContractExecuteTransaction()	Constructor.
ContractExecuteTransaction(TransactionBody txBody)	Constructor.
ContractExecuteTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) ContractCallTransactionBody.Builder	build()	Build the transaction body.
ContractId	getContractId()	Extract the contract id.
com.google.protobuf.ByteString	getFunctionParameters()	Extract the function parameters.
long	getGas()	Extract the gas.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
Hbar	getPayableAmount()	Extract the payable amount.
(package private) void	initFromTransactionBody()	Initialize from the transaction body.
(package private) void	onFreeze(TransactionBody.Builder bodyBuilder)	Called in Transaction.freezeWith(Client) just before the transaction body is built.
(package private) void	onScheduled(SchedulableTransactionBody.Builder scheduled)	Called in Transaction.schedule() when converting transaction into a scheduled version.
ContractExecuteTransaction	setContractId(ContractId contractId)	Sets the contract instance to call.
ContractExecuteTransaction	setFunction(String name)	Sets the function name to call.
ContractExecuteTransaction	setFunction(String name, ContractFunctionParameters params)	Sets the function to call, and the parameters to pass to the function.
ContractExecuteTransaction	setFunctionParameters(com.google.protobuf.ByteString functionParameters)	Sets the function parameters as their raw bytes.
ContractExecuteTransaction	setGas(long gas)	A maximum limit to the amount of gas to use for this call.
ContractExecuteTransaction	setPayableAmount(Hbar amount)	Sets the number of hbars sent with this function call.
(package private) void	validateChecksums(Client client)

Methods inherited from class com.hedera.hashgraph.sdk.Transaction

addSignature, addSignature, batchify, buildAllTransactions, buildTransaction, doSchedule, estimateFee, freeze, freezeWith, fromBytes, fromScheduledTransaction, generateTransactionIds, getBatchKey, getDefaultMaxTransactionFee, getExecutionState, getHighVolume, getMaxTransactionFee, getRegenerateTransactionId, getRequiredChunks, getSignableNodeBodyBytesList, getSignatures, getSignaturesAtOffset, getTransactionBodySize, getTransactionHash, getTransactionHashPerNode, getTransactionId, getTransactionIdInternal, getTransactionMemo, getTransactionSize, getTransactionValidDuration, hash, isBatchedAndNotBatchTransaction, isFrozen, keyAlreadySigned, makeRequest, mapResponse, mapResponseStatus, onExecute, onExecuteAsync, regenerateTransactionId, requireNotFrozen, requireOneNodeAccountId, schedule, setBatchKey, setHighVolume, setMaxTransactionFee, setNodeAccountIds, setRegenerateTransactionId, setTransactionId, setTransactionMemo, setTransactionValidDuration, sign, signTransaction, signWith, signWithOperator, spawnBodyBuilder, toBytes, toString, wipeTransactionLists

Methods inherited from class com.hedera.hashgraph.sdk.Executable

advanceRequest, checkNodeAccountIds, execute, execute, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, getGrpcRequest, getMaxAttempts, getMaxBackoff, getMaxRetry, getMinBackoff, getNodeAccountIds, getNodeForExecute, grpcDeadline, logTransaction, mergeFromClient, setGrpcDeadline, setLogger, setMaxAttempts, setMaxBackoff, setMaxRetry, setMinBackoff, setNodesFromNodeAccountIds, setRequestListener, setResponseListener, shouldRetryExceptionally

Methods inherited from class java.lang.Object

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

Constructor Details

ContractExecuteTransaction

public ContractExecuteTransaction()

Constructor.

ContractExecuteTransaction

ContractExecuteTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)
                    throws com.google.protobuf.InvalidProtocolBufferException

Constructor.

Parameters:

txs - Compound list of transaction id's list of (AccountId, Transaction) records

Throws:

com.google.protobuf.InvalidProtocolBufferException - when there is an issue with the protobuf

ContractExecuteTransaction

ContractExecuteTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getContractId

@Nullable
public ContractId getContractId()

Extract the contract id.

Returns:

the contract id

setContractId

public ContractExecuteTransaction setContractId(ContractId contractId)

Sets the contract instance to call.

Parameters:

contractId - The ContractId to be set

Returns:

this

getGas

public long getGas()

Extract the gas.

Returns:

the gas

setGas

public ContractExecuteTransaction setGas(long gas)

A maximum limit to the amount of gas to use for this call.

The network SHALL charge the greater of the following, but SHALL NOT charge more than the value of this field.

1. The actual gas consumed by the smart contract call.
2. `80%` of this value.

The `80%` factor encourages reasonable estimation, while allowing for some overage to ensure successful execution.

Parameters:

gas - The long to be set as gas

Returns:

this

getPayableAmount

public Hbar getPayableAmount()

Extract the payable amount.

Returns:

the payable amount in hbar

setPayableAmount

public ContractExecuteTransaction setPayableAmount(Hbar amount)

Sets the number of hbars sent with this function call.

Parameters:

amount - The Hbar to be set

Returns:

this

getFunctionParameters

public com.google.protobuf.ByteString getFunctionParameters()

Extract the function parameters.

Returns:

the function parameters

setFunctionParameters

public ContractExecuteTransaction setFunctionParameters(com.google.protobuf.ByteString functionParameters)

Sets the function parameters as their raw bytes.

Use this instead of setFunction(String, ContractFunctionParameters) if you have already pre-encoded a solidity function call. This MUST contain The application binary interface (ABI) encoding of the function call per the Ethereum contract ABI standard, giving the function signature and arguments being passed to the function.

Parameters:

functionParameters - The function parameters to be set

Returns:

this

setFunction

public ContractExecuteTransaction setFunction(String name)

Sets the function name to call.

The function will be called with no parameters. Use setFunction(String, ContractFunctionParameters) to call a function with parameters.

Parameters:

name - The String to be set as the function name

Returns:

this

setFunction

public ContractExecuteTransaction setFunction(String name,
 ContractFunctionParameters params)

Sets the function to call, and the parameters to pass to the function.

Parameters:

name - The String to be set as the function name

params - The function parameters to be set

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

ContractCallTransactionBody.Builder build()

Build the transaction body.

Returns:

ContractCallTransactionBody

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<ContractExecuteTransaction>

Throws:

BadEntityIdException

getMethodDescriptor

io.grpc.MethodDescriptor<Transaction,TransactionResponse> getMethodDescriptor()

Description copied from class: Executable

Called to direct the invocation of the query to the appropriate gRPC service.

Specified by:

getMethodDescriptor in class Executable<ContractExecuteTransaction,Transaction,TransactionResponse,TransactionResponse>

onFreeze

void onFreeze(TransactionBody.Builder bodyBuilder)

Description copied from class: Transaction

Called in Transaction.freezeWith(Client) just before the transaction body is built. The intent is for the derived class to assign their data variant to the transaction body.

Specified by:

onFreeze in class Transaction<ContractExecuteTransaction>

onScheduled

void onScheduled(SchedulableTransactionBody.Builder scheduled)

Description copied from class: Transaction

Called in Transaction.schedule() when converting transaction into a scheduled version.

Specified by:

onScheduled in class Transaction<ContractExecuteTransaction>