Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class ContractCallQuery

java.lang.Object

com.hedera.hashgraph.sdk.Executable<ContractCallQuery,Query,Response,ContractFunctionResult>

com.hedera.hashgraph.sdk.Query<ContractFunctionResult,ContractCallQuery>

com.hedera.hashgraph.sdk.ContractCallQuery

public final class ContractCallQuery
extends Query<ContractFunctionResult,ContractCallQuery>

Call a function of the given smart contract instance, giving it functionParameters as its inputs. It will consume the entire given amount of gas.

This is performed locally on the particular node that the client is communicating with. It cannot change the state of the contract instance (and so, cannot spend anything from the instance's cryptocurrency account).

It will not have a consensus timestamp. It cannot generate a record or a receipt. The response will contain the output returned by the function call. This is useful for calling getter functions, which purely read the state and don't change it. It is faster and cheaper than a normal call, because it is purely local to a single node.

Nested Class Summary

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

Executable.GrpcRequest

Field Summary

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

paymentTransactionId, paymentTransactions

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
ContractCallQuery()	Constructor.

Method Summary

Modifier and Type	Method	Description
ContractId	getContractId()	Extract the contract id.
CompletableFuture<Hbar>	getCostAsync(Client client)	Fetch the expected cost asynchronously.
com.google.protobuf.ByteString	getFunctionParameters()	Extract the function parameters.
long	getGas()	Extract the gas.
long	getMaxResultSize()	Deprecated. with no replacement
(package private) io.grpc.MethodDescriptor<Query,Response>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
AccountId	getSenderAccountId()	Get the sender account ID
(package private) QueryHeader	mapRequestHeader(Query request)	The derived class should access its request header and return.
(package private) ContractFunctionResult	mapResponse(Response response, AccountId nodeId, Query request)	Called after receiving the query response from Hedera.
(package private) ResponseHeader	mapResponseHeader(Response response)	The derived class should access its response header and return.
(package private) void	onMakeRequest(Query.Builder queryBuilder, QueryHeader header)	Called in Query.makeRequest() just before the query is built.
ContractCallQuery	setContractId(ContractId contractId)	Sets the contract instance to call, in the format used in transactions.
ContractCallQuery	setFunction(String name)	Sets the function name to call.
ContractCallQuery	setFunction(String name, ContractFunctionParameters params)	Sets the function to call, and the parameters to pass to the function.
ContractCallQuery	setFunctionParameters(byte[] functionParameters)	Sets the function parameters as their raw bytes.
ContractCallQuery	setGas(long gas)	Sets the amount of gas to use for the call.
ContractCallQuery	setMaxResultSize(long size)	Deprecated. with no replacement Sets the max number of bytes that the result might include.
ContractCallQuery	setSenderAccountId(AccountId senderAccountId)	Sets the account that is the "sender." If not present it is the accountId from the transactionId.
(package private) void	validateChecksums(Client client)	Validate the checksums.

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

getCost, getCost, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getOperatorFromClient, getPaymentTransaction, getPaymentTransactionId, getTransactionIdInternal, isPaymentRequired, makeRequest, mapResponseStatus, onExecute, onExecuteAsync, setMaxQueryPayment, setPaymentTransactionId, setQueryPayment, toString

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ContractCallQuery

public ContractCallQuery()

Constructor.

Method Details

getContractId

@Nullable
public ContractId getContractId()

Extract the contract id.

Returns:

the contract id

setContractId

public ContractCallQuery setContractId(ContractId contractId)

Sets the contract instance to call, in the format used in transactions.

Parameters:

contractId - The ContractId to be set

Returns:

this

getGas

public long getGas()

Extract the gas.

Returns:

the gas

setGas

public ContractCallQuery setGas(long gas)

Sets the amount of gas to use for the call.

All of the gas offered will be charged for.

Parameters:

gas - The long to be set as gas

Returns:

this

getCostAsync

public CompletableFuture<Hbar> getCostAsync(Client client)

Description copied from class: Query

Fetch the expected cost asynchronously.

Overrides:

getCostAsync in class Query<ContractFunctionResult,ContractCallQuery>

Parameters:

client - the client

Returns:

Future result of the cost in hbar

getFunctionParameters

public com.google.protobuf.ByteString getFunctionParameters()

Extract the function parameters.

Returns:

the byte string representation

setFunctionParameters

public ContractCallQuery setFunctionParameters(byte[] 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.

Parameters:

functionParameters - The function parameters to be set

Returns:

this

setFunction

public ContractCallQuery 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 function name to be set

Returns:

this

setFunction

public ContractCallQuery setFunction(String name,
 ContractFunctionParameters params)

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

Parameters:

name - The function name to be set

params - The parameters to pass

Returns:

this

getMaxResultSize

@Deprecated
public long getMaxResultSize()

Deprecated.

with no replacement

Get the max number of bytes that the result might include

Returns:

the max number of byes

setMaxResultSize

@Deprecated
public ContractCallQuery setMaxResultSize(long size)

Deprecated.

with no replacement
Sets the max number of bytes that the result might include. The run will fail if it had returned more than this number of bytes.

Parameters:

size - The long to be set as size

Returns:

this

getSenderAccountId

@Nullable
public AccountId getSenderAccountId()

Get the sender account ID

Returns:

the account that is the "sender"

setSenderAccountId

public ContractCallQuery setSenderAccountId(AccountId senderAccountId)

Sets the account that is the "sender." If not present it is the accountId from the transactionId. Typically a different value than specified in the transactionId requires a valid signature over either the hedera transaction or foreign transaction data.

Parameters:

senderAccountId - the account that is the "sender"

Returns:

this

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Description copied from class: Query

Validate the checksums.

Specified by:

validateChecksums in class Query<ContractFunctionResult,ContractCallQuery>

Throws:

BadEntityIdException

onMakeRequest

void onMakeRequest(Query.Builder queryBuilder,
 QueryHeader header)

Description copied from class: Query

Called in Query.makeRequest() just before the query is built. The intent is for the derived class to assign their data variant to the query.

Specified by:

onMakeRequest in class Query<ContractFunctionResult,ContractCallQuery>

mapResponseHeader

ResponseHeader mapResponseHeader(Response response)

Description copied from class: Query

The derived class should access its response header and return.

Specified by:

mapResponseHeader in class Query<ContractFunctionResult,ContractCallQuery>

mapRequestHeader

QueryHeader mapRequestHeader(Query request)

Description copied from class: Query

The derived class should access its request header and return.

Specified by:

mapRequestHeader in class Query<ContractFunctionResult,ContractCallQuery>

mapResponse

ContractFunctionResult mapResponse(Response response,
 AccountId nodeId,
 Query request)

Description copied from class: Executable

Called after receiving the query response from Hedera. The derived class should map into its output type.

Specified by:

mapResponse in class Executable<ContractCallQuery,Query,Response,ContractFunctionResult>

getMethodDescriptor

io.grpc.MethodDescriptor<Query,Response> 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<ContractCallQuery,Query,Response,ContractFunctionResult>