Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenAssociateTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.TokenAssociateTransaction

public class TokenAssociateTransaction
extends Transaction<TokenAssociateTransaction>

Associate a Hedera Token Service (HTS) token and an account. An association MUST exist between an account and a token before that account may transfer or receive that token.
If the identified account is not found, the transaction SHALL return `INVALID_ACCOUNT_ID`.
If the identified account has been deleted, the transaction SHALL return `ACCOUNT_DELETED`.
If any of the identified tokens is not found, the transaction SHALL return `INVALID_TOKEN_REF`.
If any of the identified tokens has been deleted, the transaction SHALL return `TOKEN_WAS_DELETED`.
If an association already exists for any of the identified tokens, the transaction SHALL return `TOKEN_ALREADY_ASSOCIATED_TO_ACCOUNT`.
The identified account MUST sign this transaction. ### 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
TokenAssociateTransaction()	Constructor.
TokenAssociateTransaction(TransactionBody txBody)	Constructor.
TokenAssociateTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) TokenAssociateTransactionBody.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.
List<TokenId>	getTokenIds()	Extract the list of token id's.
(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.
TokenAssociateTransaction	setAccountId(AccountId accountId)	An account identifier.
TokenAssociateTransaction	setTokenIds(List<TokenId> tokens)	A list of token identifiers.
(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

TokenAssociateTransaction

public TokenAssociateTransaction()

Constructor.

TokenAssociateTransaction

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

TokenAssociateTransaction

TokenAssociateTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getAccountId

@Nullable
public AccountId getAccountId()

Extract the account id.

Returns:

the account id

setAccountId

public TokenAssociateTransaction setAccountId(AccountId accountId)

An account identifier.

The identified account SHALL be associated to each of the tokens identified in the `tokens` field.
This field is REQUIRED and MUST be a valid account identifier.
The identified account MUST exist in state.
The identified account MUST NOT be deleted.
The identified account MUST NOT be expired.

Parameters:

accountId - the account id

Returns:

this

getTokenIds

public List<TokenId> getTokenIds()

Extract the list of token id's.

Returns:

the list of token id's

setTokenIds

public TokenAssociateTransaction setTokenIds(List<TokenId> tokens)

A list of token identifiers.

Each token identified in this list SHALL be separately associated with the account identified in the `account` field.
This list MUST NOT be empty. Each entry in this list MUST be a valid token identifier.
Each entry in this list MUST NOT be currently associated to the account identified in `account`.
Each entry in this list MUST NOT be expired.
Each entry in this list MUST NOT be deleted.

Parameters:

tokens - the list of token id's

Returns:

this

build

TokenAssociateTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenAssociateTransactionBody

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenAssociateTransaction>

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

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