io.nem.sdk.model.transaction

Class LockFundsTransaction

java.lang.Object

io.nem.sdk.model.transaction.Transaction

io.nem.sdk.model.transaction.LockFundsTransaction

public class LockFundsTransaction
extends Transaction

Lock funds transaction is used before sending an Aggregate bonded transaction, as a deposit to announce the transaction. When aggregate bonded transaction is confirmed funds are returned to LockFundsTransaction signer.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
LockFundsTransaction(NetworkType networkType, java.lang.Integer version, Deadline deadline, java.math.BigInteger fee, Mosaic mosaic, java.math.BigInteger duration, SignedTransaction signedTransaction)
LockFundsTransaction(NetworkType networkType, java.lang.Integer version, Deadline deadline, java.math.BigInteger fee, Mosaic mosaic, java.math.BigInteger duration, SignedTransaction signedTransaction, java.lang.String signature, PublicAccount signer, TransactionInfo transactionInfo)

Method Summary

Modifier and Type	Method and Description
static LockFundsTransaction	create(Deadline deadline, Mosaic mosaic, java.math.BigInteger duration, SignedTransaction signedTransaction, NetworkType networkType) Create a lock funds transaction object.
java.math.BigInteger	getDuration() Returns funds lock duration in number of blocks.
Mosaic	getMosaic() Returns locked mosaic.
SignedTransaction	getSignedTransaction() Returns signed transaction for which funds are locked.

Methods inherited from class io.nem.sdk.model.transaction.Transaction

createTransactionHash, getDeadline, getFee, getNetworkType, getSignature, getSigner, getTransactionInfo, getType, getVersion, hasMissingSignatures, isConfirmed, isUnannounced, isUnconfirmed, signWith, toAggregate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LockFundsTransaction

public LockFundsTransaction(NetworkType networkType,
                            java.lang.Integer version,
                            Deadline deadline,
                            java.math.BigInteger fee,
                            Mosaic mosaic,
                            java.math.BigInteger duration,
                            SignedTransaction signedTransaction,
                            java.lang.String signature,
                            PublicAccount signer,
                            TransactionInfo transactionInfo)

LockFundsTransaction

public LockFundsTransaction(NetworkType networkType,
                            java.lang.Integer version,
                            Deadline deadline,
                            java.math.BigInteger fee,
                            Mosaic mosaic,
                            java.math.BigInteger duration,
                            SignedTransaction signedTransaction)

Method Detail

create

public static LockFundsTransaction create(Deadline deadline,
                                          Mosaic mosaic,
                                          java.math.BigInteger duration,
                                          SignedTransaction signedTransaction,
                                          NetworkType networkType)

Create a lock funds transaction object.

Parameters:

deadline - The deadline to include the transaction.

mosaic - The locked mosaic.

duration - The funds lock duration.

signedTransaction - The signed transaction for which funds are locked.

networkType - The network type.

Returns:

a LockFundsTransaction instance

getMosaic

public Mosaic getMosaic()

Returns locked mosaic.

Returns:

locked mosaic.

getDuration

public java.math.BigInteger getDuration()

Returns funds lock duration in number of blocks.

Returns:

funds lock duration in number of blocks.

getSignedTransaction

public SignedTransaction getSignedTransaction()

Returns signed transaction for which funds are locked.

Returns:

signed transaction for which funds are locked.