Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenGrantKycTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.TokenGrantKycTransaction

public class TokenGrantKycTransaction
extends Transaction<TokenGrantKycTransaction>

Grant "Know Your Customer"(KYC) for one account for a single token. This transaction MUST be signed by the `kyc_key` for the token.
The identified token MUST have a `kyc_key` set to a valid `Key` value.
The token `kyc_key` MUST NOT be an empty `KeyList`.
The identified token MUST exist and MUST NOT be deleted.
The identified account MUST exist and MUST NOT be deleted.
The identified account MUST have an association to the identified token.
On success the association between the identified account and the identified token SHALL be marked as "KYC granted". ### 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
TokenGrantKycTransaction()	Configure.
TokenGrantKycTransaction(TransactionBody txBody)	Constructor.
TokenGrantKycTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) TokenGrantKycTransactionBody.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.
TokenGrantKycTransaction	setAccountId(AccountId accountId)	An account identifier.
TokenGrantKycTransaction	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

TokenGrantKycTransaction

public TokenGrantKycTransaction()

Configure.

TokenGrantKycTransaction

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

TokenGrantKycTransaction

TokenGrantKycTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getTokenId

@Nullable
public TokenId getTokenId()

Extract the token id.

Returns:

the token id

setTokenId

public TokenGrantKycTransaction setTokenId(TokenId tokenId)

A token identifier.

The identified token SHALL grant "KYC" for the account identified by the `account` field.
The identified token MUST be associated to the account identified by the `account` field.

Parameters:

tokenId - the token id

Returns:

this

getAccountId

@Nullable
public AccountId getAccountId()

Extract the account id.

Returns:

the account id

setAccountId

public TokenGrantKycTransaction setAccountId(AccountId accountId)

An account identifier.

The token identified by the `token` field SHALL grant "KYC" for the identified account.
This account MUST be associated to the token identified by the `token` field.

Parameters:

accountId - the account id

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

TokenGrantKycTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenGrantKycTransactionBody

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenGrantKycTransaction>

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

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