Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TransferTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.AbstractTokenTransferTransaction<TransferTransaction>

com.hedera.hashgraph.sdk.TransferTransaction

public class TransferTransaction
extends AbstractTokenTransferTransaction<TransferTransaction>

A transaction that transfers hbars and tokens between Hedera accounts. You can enter multiple transfers in a single transaction. The net value of hbars between the sending accounts and receiving accounts must equal zero.

See Hedera Documentation

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.AbstractTokenTransferTransaction

nftTransfers, tokenTransfers

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

Method Summary

Modifier and Type	Method	Description
TransferTransaction	addApprovedHbarTransfer(AccountId accountId, Hbar value)	Add an approved hbar transfer.
TransferTransaction	addHbarTransfer(AccountId accountId, Hbar value)	Add a non approved hbar transfer.
TransferTransaction	addHbarTransfer(EvmAddress evmAddress, Hbar value)	Add a non approved hbar transfer to an EVM address.
TransferTransaction	addHbarTransferWithHook(AccountId accountId, Hbar amount, FungibleHookCall hookCall)	Add an HBAR transfer with a fungible hook.
TransferTransaction	addNftTransferWithHook(NftId nftId, AccountId senderAccountId, AccountId receiverAccountId, NftHookCall senderHookCall, NftHookCall receiverHookCall)	Add an NFT transfer with optional sender/receiver allowance hooks.
TransferTransaction	addTokenTransferWithHook(TokenId tokenId, AccountId accountId, long value, FungibleHookCall hookCall)	Add an token transfer with allowance hook.
(package private) CryptoTransferTransactionBody.Builder	build()	Build the transaction body.
Map<AccountId,Hbar>	getHbarTransfers()	Extract the of hbar transfers.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
(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.
TransferTransaction	setHbarTransferApproval(AccountId accountId, boolean isApproved)	Deprecated. - Use addApprovedHbarTransfer(AccountId, Hbar) instead
(package private) static FungibleHookCall	toFungibleHook(HookCall proto, FungibleHookType type)
(package private) static NftHookCall	toNftHook(HookCall proto, NftHookType type)
(package private) void	validateChecksums(Client client)

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

addApprovedNftTransfer, addApprovedTokenTransfer, addApprovedTokenTransferWithDecimals, addNftTransfer, addTokenTransfer, addTokenTransferWithDecimals, doAddNftTransfer, doAddTokenTransfer, getTokenIdDecimals, getTokenNftTransfers, getTokenTransfers, setNftTransferApproval, setTokenTransferApproval, sortTransfersAndBuild

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

TransferTransaction

public TransferTransaction()

Constructor.

TransferTransaction

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

TransferTransaction

TransferTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getHbarTransfers

public Map<AccountId,Hbar> getHbarTransfers()

Extract the of hbar transfers.

Returns:

list of hbar transfers

addHbarTransfer

public TransferTransaction addHbarTransfer(EvmAddress evmAddress,
 Hbar value)

Add a non approved hbar transfer to an EVM address.

Parameters:

evmAddress - the EVM address

value - the value

Returns:

the updated transaction

addHbarTransfer

public TransferTransaction addHbarTransfer(AccountId accountId,
 Hbar value)

Add a non approved hbar transfer.

Parameters:

accountId - the account id

value - the value

Returns:

the updated transaction

addApprovedHbarTransfer

public TransferTransaction addApprovedHbarTransfer(AccountId accountId,
 Hbar value)

Add an approved hbar transfer.

Parameters:

accountId - the account id

value - the value

Returns:

the updated transaction

addTokenTransferWithHook

public TransferTransaction addTokenTransferWithHook(TokenId tokenId,
 AccountId accountId,
 long value,
 FungibleHookCall hookCall)

Add an token transfer with allowance hook.

Parameters:

tokenId - the tokenId

accountId - the accountId

value - the amount

hookCall - the hook

Returns:

the updated transaction

addNftTransferWithHook

public TransferTransaction addNftTransferWithHook(NftId nftId,
 AccountId senderAccountId,
 AccountId receiverAccountId,
 NftHookCall senderHookCall,
 NftHookCall receiverHookCall)

Add an NFT transfer with optional sender/receiver allowance hooks.

Parameters:

nftId - the NFT id

senderAccountId - the sender

receiverAccountId - the receiver

senderHookCall - optional sender hook call

receiverHookCall - optional receiver hook call

Returns:

the updated transaction

addHbarTransferWithHook

public TransferTransaction addHbarTransferWithHook(AccountId accountId,
 Hbar amount,
 FungibleHookCall hookCall)

Add an HBAR transfer with a fungible hook.

Parameters:

accountId - the account id

amount - the amount to transfer

hookCall - the fungible hook call to execute

Returns:

the updated transaction

Throws:

IllegalArgumentException - if hookCall is null

setHbarTransferApproval

@Deprecated
public TransferTransaction setHbarTransferApproval(AccountId accountId,
 boolean isApproved)

Deprecated.

- Use addApprovedHbarTransfer(AccountId, Hbar) instead

Parameters:

accountId - the account id

isApproved - whether the transfer is approved

Returns:

this

build

CryptoTransferTransactionBody.Builder build()

Build the transaction body.

Returns:

CryptoTransferTransactionBody

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Overrides:

validateChecksums in class AbstractTokenTransferTransaction<TransferTransaction>

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

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

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

toFungibleHook

static FungibleHookCall toFungibleHook(HookCall proto,
 FungibleHookType type)

toNftHook

static NftHookCall toNftHook(HookCall proto,
 NftHookType type)