Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class AccountDeleteTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.AccountDeleteTransaction

public final class AccountDeleteTransaction
extends Transaction<AccountDeleteTransaction>

Delete an account.
This will mark an account deleted, and transfer all tokens to a "sweep" account. A deleted account SHALL NOT hold a balance in any token type.
A deleted account SHALL remain in state until it expires.
Transfers that would increase the balance of a deleted account SHALL fail.
A deleted account MAY be subject of a `cryptoUpdate` transaction to extend its expiration.
When a deleted account expires it SHALL be removed entirely, and SHALL NOT be archived. ### 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
AccountDeleteTransaction()	Constructor.
AccountDeleteTransaction(TransactionBody txBody)	Constructor.
AccountDeleteTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) CryptoDeleteTransactionBody.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.
AccountId	getTransferAccountId()	Extract the receiving account 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.
AccountDeleteTransaction	setAccountId(AccountId deleteAccountId)	An account identifier.
AccountDeleteTransaction	setTransferAccountId(AccountId transferAccountId)	An account 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

AccountDeleteTransaction

public AccountDeleteTransaction()

Constructor.

AccountDeleteTransaction

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

AccountDeleteTransaction

AccountDeleteTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getAccountId

@Nullable
public AccountId getAccountId()

Extract the account id.

Returns:

the account id

setAccountId

public AccountDeleteTransaction setAccountId(AccountId deleteAccountId)

An account identifier.

This account SHALL be deleted if this transaction succeeds.
This account SHOULD NOT hold any balance other than HBAR.
If this account _does_ hold balances, the `transferAccountID` value MUST be set to a valid transfer account.
This account MUST sign this transaction.
This field MUST be set to a valid account identifier.

Parameters:

deleteAccountId - The AccountId to be set

Returns:

this

getTransferAccountId

@Nullable
public AccountId getTransferAccountId()

Extract the receiving account id.

Returns:

the account id that receives the hbar

setTransferAccountId

public AccountDeleteTransaction setTransferAccountId(AccountId transferAccountId)

An account identifier.

The identified account SHALL receive all tokens, token balances, and non-fungible/unique from the deleted account.
The identified account MUST sign this transaction.
If not set, the account to be deleted MUST NOT have a balance in any token, a balance in HBAR, or hold any NFT.

Parameters:

transferAccountId - The AccountId to be set

Returns:

this

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<AccountDeleteTransaction>

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<AccountDeleteTransaction,Transaction,TransactionResponse,TransactionResponse>

build

CryptoDeleteTransactionBody.Builder build()

Build the transaction body.

Returns:

CryptoDeleteTransactionBody

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

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

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