Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenFreezeTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.TokenFreezeTransaction

public class TokenFreezeTransaction
extends Transaction<TokenFreezeTransaction>

Block transfers of a token type for an account.
This, effectively, freezes assets of one account with respect to one token type. While frozen, that account cannot send or receive tokens of the identified type. The token MUST have a `freeze_key` set and that key MUST NOT be an empty `KeyList`.
The token `freeze_key` MUST sign this transaction.
The identified token MUST exist, MUST NOT be deleted, MUST NOT be paused, and MUST NOT be expired.
The identified account MUST exist, MUST NOT be deleted, and MUST NOT be expired.
If the identified account is already frozen with respect to the identified token, the transaction SHALL succeed, but no change SHALL be made.
An association between the identified account and the identified token MUST exist. ### Block Stream Effects None

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
TokenFreezeTransaction()	Constructor.
TokenFreezeTransaction(TransactionBody txBody)	Constructor.
TokenFreezeTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) TokenFreezeAccountTransactionBody.Builder	build()	Build the transaction body.
AccountId	getAccountId()	Extract the account id.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
TokenId	getTokenId()	Extract the token id.
(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.
TokenFreezeTransaction	setAccountId(AccountId accountId)	An account identifier.
TokenFreezeTransaction	setTokenId(TokenId tokenId)	A token identifier.
(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

TokenFreezeTransaction

public TokenFreezeTransaction()

Constructor.

TokenFreezeTransaction

TokenFreezeTransaction(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

TokenFreezeTransaction

TokenFreezeTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getTokenId

@Nullable
public TokenId getTokenId()

Extract the token id.

Returns:

the token id

setTokenId

public TokenFreezeTransaction setTokenId(TokenId tokenId)

A token identifier.

This SHALL identify the token type to "freeze".
The identified token MUST exist, MUST NOT be deleted, and MUST be associated to the identified account.

Parameters:

tokenId - the token id

Returns:

this

getAccountId

@Nullable
public AccountId getAccountId()

Extract the account id.

Returns:

the account id

setAccountId

public TokenFreezeTransaction setAccountId(AccountId accountId)

An account identifier.

This shall identify the account to "freeze".
The identified account MUST exist, MUST NOT be deleted, MUST NOT be expired, and MUST be associated to the identified token.
The identified account SHOULD NOT be "frozen" with respect to the identified token.

Parameters:

accountId - the account id

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

TokenFreezeAccountTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenFreezeAccountTransactionBody

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenFreezeTransaction>

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<TokenFreezeTransaction,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<TokenFreezeTransaction>

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<TokenFreezeTransaction>