Package org.symbol.sdk.symbol.descriptors

Class SecretLockTransactionV1Descriptor

java.lang.Object

org.symbol.sdk.symbol.descriptors.SecretLockTransactionV1Descriptor

All Implemented Interfaces:

SymbolTransactionDescriptor, SymbolTypedDescriptor, TypedDescriptor

---

public final class SecretLockTransactionV1Descriptor extends Object implements SymbolTransactionDescriptor

SecretLockTransactionV1Descriptor

Type safe descriptor used to generate a descriptor map for SecretLockTransactionV1Descriptor.

Start a token swap between different chains (V1, latest). Use a SecretLockTransaction to transfer mosaics between two accounts. The mosaics sent remain locked until a valid SecretProofTransaction unlocks them. The default expiration date is 365 days after announcement (See the maxSecretLockDuration network property). If the lock expires before a valid SecretProofTransaction is announced the locked amount goes back to the initiator of the SecretLockTransaction.

• Constructor Summary

  Constructors

  Constructor

  Description

  SecretLockTransactionV1Descriptor(Address recipientAddress, CryptoTypes.Hash256 secret, UnresolvedMosaicDescriptor mosaic, BlockDuration duration, LockHashAlgorithm hashAlgorithm)

  Creates a descriptor for SecretLockTransactionV1.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Map<String,Object>

  toMap()

  Builds a representation of this descriptor that can be passed to a factory function.

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • SecretLockTransactionV1Descriptor

    public SecretLockTransactionV1Descriptor(Address recipientAddress, CryptoTypes.Hash256 secret, UnresolvedMosaicDescriptor mosaic, BlockDuration duration, LockHashAlgorithm hashAlgorithm)

    Creates a descriptor for SecretLockTransactionV1.

    Parameters:

    recipientAddress - Address that receives the funds once successfully unlocked by a SecretProofTransaction.

    secret - Hashed proof.

    mosaic - Locked mosaics.

    duration - Number of blocks to wait for the SecretProofTransaction.

    hashAlgorithm - Algorithm used to hash the proof.

• Method Details

  • toMap

    public Map<String,Object> toMap()

    SecretLockTransactionV1Descriptor.toMap

    Builds a representation of this descriptor that can be passed to a factory function.

    Specified by:

    toMap in interface TypedDescriptor

    Returns:

    Descriptor map that can be passed to a transaction factory.